# Přehledy · API DameDokladu > Operace ve skupině Přehledy. Source: https://damedoklad.cz/docs/api-reference/reports/ # Přehledy Operace ve skupině Přehledy. ## Get the financial overview: to-do counts, overdue receivables, cash on hand, year result, monthly revenue and expense with a forecast, and breakdowns by account GET `/v1/overview` Get the financial overview: to-do counts, overdue receivables, cash on hand, year result, monthly revenue and expense with a forecast, and breakdowns by account Nástroj MCP: `get-financial-overview` ### Parametry dotazu `year` integer min 2000 max 2100 The year an accounting period starts in, so a hospodářský rok from July 2026 is 2026. Defaults to the current one. `periodId` string One accounting period exactly, for two starting in the same year. Takes precedence over year. `centerId` string ID of the center. ### Odpověď · 200 `asOf` string povinné date-time `regime` string povinné `year` integer povinné `toDo` object povinné `total` integer povinné `documents` integer povinné `movements` integer povinné `overdue` object povinné `amountHaler` integer | null povinné `count` integer povinné `oldestDays` integer povinné `oldestBucket` null | string povinné `money` object povinné `balanceHaler` integer povinné `changePercent` integer | null povinné `result` null | object povinné `amountHaler` integer | null povinné `revenueHaler` integer povinné `expenseHaler` integer povinné `months` object\[\] povinné `month` null | string povinné `revenueHaler` integer povinné `expenseHaler` integer povinné `forecast` null | object povinné `month` null | string povinné `actualProfitHaler` integer povinné `estimatedProfitHaler` integer povinné `estimatedRevenueHaler` integer povinné `estimatedExpenseHaler` integer povinné `expensesByAccount` object\[\] povinné `key` string povinné `label` null | string povinné `amountHaler` integer | null povinné `revenuesByAccount` object\[\] povinné `key` string povinné `label` null | string povinné `amountHaler` integer | null povinné `toFinish` object\[\] povinné `type` string povinné `count` integer povinné `path` null | string povinné `label` null | string `labelEn` string `kind` string `requires` string `from` string date `to` string date `periodId` string ```bash curl https://api.damedoklad.cz/v1/overview \ -H "Authorization: Bearer $DAMEDOKLAD_API_KEY" ``` ```javascript const response = await fetch('https://api.damedoklad.cz/v1/overview', { headers: { Authorization: `Bearer ${process.env.DAMEDOKLAD_API_KEY}`, }, }); const data = await response.json(); ``` ```python import os import requests response = requests.get( "https://api.damedoklad.cz/v1/overview", headers={"Authorization": f"Bearer {os.environ['DAMEDOKLAD_API_KEY']}"}, ) data = response.json() ``` ## Get open receivables or payables by age (not due, 1–30, 31–60, 61–90, over 90 days) in total and per contact GET `/v1/reports/aging` Get open receivables or payables by age (not due, 1–30, 31–60, 61–90, over 90 days) in total and per contact Nástroj MCP: `get-aging-report` ### Parametry dotazu `kind` "receivables" | "payables" výchozí `"receivables"` `asOf` string YYYY-MM-DD Date as YYYY-MM-DD. ### Odpověď · 200 `kind` string povinné `asOf` string povinné date `buckets` object povinné `not_due` integer povinné `d1_30` integer povinné `d31_60` integer povinné `d61_90` integer povinné `d90_plus` integer povinné `totalHaler` integer | null povinné `data` object\[\] povinné `contactId` null | string povinné `contactName` null | string povinné `totalHaler` integer | null povinné `not_due` integer povinné `d1_30` integer povinné `d31_60` integer povinné `d61_90` integer povinné `d90_plus` integer povinné `retainedHaler` integer `retainedBuckets` object `not_due` integer povinné `d1_30` integer povinné `d31_60` integer povinné `d61_90` integer povinné `d90_plus` integer povinné `retainedHaler` integer ```bash curl https://api.damedoklad.cz/v1/reports/aging \ -H "Authorization: Bearer $DAMEDOKLAD_API_KEY" ``` ```javascript const response = await fetch('https://api.damedoklad.cz/v1/reports/aging', { headers: { Authorization: `Bearer ${process.env.DAMEDOKLAD_API_KEY}`, }, }); const data = await response.json(); ``` ```python import os import requests response = requests.get( "https://api.damedoklad.cz/v1/reports/aging", headers={"Authorization": f"Bearer {os.environ['DAMEDOKLAD_API_KEY']}"}, ) data = response.json() ``` ## Get money in, money out, and closing balance per month for a year GET `/v1/reports/cash-flow` Get money in, money out, and closing balance per month for a year Nástroj MCP: `get-cash-flow-report` ### Parametry dotazu `year` integer min 2000 max 2100 The year an accounting period starts in, so a hospodářský rok from July 2026 is 2026. Defaults to the current one. `periodId` string One accounting period exactly, for two starting in the same year. Takes precedence over year. `centerId` string ID of the center. ### Odpověď · 200 `year` integer povinné `openingHaler` integer povinné `data` object\[\] povinné `month` null | string povinné `inflowHaler` integer povinné `outflowHaler` integer povinné `closingHaler` integer povinné `from` string date `to` string date ```bash curl https://api.damedoklad.cz/v1/reports/cash-flow \ -H "Authorization: Bearer $DAMEDOKLAD_API_KEY" ``` ```javascript const response = await fetch('https://api.damedoklad.cz/v1/reports/cash-flow', { headers: { Authorization: `Bearer ${process.env.DAMEDOKLAD_API_KEY}`, }, }); const data = await response.json(); ``` ```python import os import requests response = requests.get( "https://api.damedoklad.cz/v1/reports/cash-flow", headers={"Authorization": f"Bearer {os.environ['DAMEDOKLAD_API_KEY']}"}, ) data = response.json() ``` ## Download a report or document list as XLSX or CSV GET `/v1/reports/export` Download a report or document list as XLSX or CSV Nástroj MCP: `export-report` ### Parametry dotazu `kind` "income\_expense" | "cash\_flow" | "aging" | "payment\_discipline" | "top\_contacts" | "issued\_invoices" | "received\_invoices" | "contacts" povinné `format` "xlsx" | "csv" výchozí `"xlsx"` `year` integer min 2000 max 2100 The year an accounting period starts in, so a hospodářský rok from July 2026 is 2026. Defaults to the current one. `periodId` string One accounting period exactly, for two starting in the same year. Takes precedence over year. `from` string YYYY-MM-DD Date as YYYY-MM-DD. `to` string YYYY-MM-DD Date as YYYY-MM-DD. ### Odpověď · 200 Vrací soubor application/octet-stream. ```bash curl https://api.damedoklad.cz/v1/reports/export \ -H "Authorization: Bearer $DAMEDOKLAD_API_KEY" \ -o soubor ``` ```javascript const response = await fetch('https://api.damedoklad.cz/v1/reports/export', { headers: { Authorization: `Bearer ${process.env.DAMEDOKLAD_API_KEY}`, }, }); const file = await response.arrayBuffer(); ``` ```python import os import requests response = requests.get( "https://api.damedoklad.cz/v1/reports/export", headers={"Authorization": f"Bearer {os.environ['DAMEDOKLAD_API_KEY']}"}, ) content = response.content ``` ## Get monthly revenue, expense, and result for a year (accrual under double entry, cash under tax records) GET `/v1/reports/income-expense` Get monthly revenue, expense, and result for a year (accrual under double entry, cash under tax records) Nástroj MCP: `get-income-expense-report` ### Parametry dotazu `year` integer min 2000 max 2100 The year an accounting period starts in, so a hospodářský rok from July 2026 is 2026. Defaults to the current one. `periodId` string One accounting period exactly, for two starting in the same year. Takes precedence over year. `centerId` string ID of the center. ### Odpověď · 200 `year` integer povinné `data` object\[\] povinné `month` null | string povinné `revenueHaler` integer povinné `expenseHaler` integer povinné `resultHaler` integer povinné `from` string date `to` string date ```bash curl https://api.damedoklad.cz/v1/reports/income-expense \ -H "Authorization: Bearer $DAMEDOKLAD_API_KEY" ``` ```javascript const response = await fetch('https://api.damedoklad.cz/v1/reports/income-expense', { headers: { Authorization: `Bearer ${process.env.DAMEDOKLAD_API_KEY}`, }, }); const data = await response.json(); ``` ```python import os import requests response = requests.get( "https://api.damedoklad.cz/v1/reports/income-expense", headers={"Authorization": f"Bearer {os.environ['DAMEDOKLAD_API_KEY']}"}, ) data = response.json() ``` ## Get how each customer pays (Platební kázeň): share paid on time, average and longest days late, and what is overdue now GET `/v1/reports/payment-discipline` Get how each customer pays (Platební kázeň): share paid on time, average and longest days late, and what is overdue now. For issued invoices, debit notes, and other receivables of the period, in CZK. Average late days are weighted by amount. A retention falls due on its own date. A set-off counts as paid on its date, an advance as on time. Nástroj MCP: `get-payment-discipline-report` ### Parametry dotazu `from` string YYYY-MM-DD Invoices issued from this day. Defaults to 1 January of the asOf year. `to` string YYYY-MM-DD Invoices issued up to this day. Defaults to asOf. `asOf` string YYYY-MM-DD What counts as overdue is read on this day. Defaults to today. `contactId` string ID of the contact. Find it with list-contacts. `year` integer min 2000 max 2100 The year an accounting period starts in, so a hospodářský rok from July 2026 is 2026. Defaults to the current one. `periodId` string One accounting period exactly, for two starting in the same year. Takes precedence over year. ### Odpověď · 200 `from` string povinné date `to` string povinné date `asOf` string povinné date `data` object\[\] povinné `contactId` null | string povinné `contactName` null | string povinné `documents` integer povinné `settledHaler` integer povinné `lateHaler` integer povinné `maxLateDays` integer povinné `openHaler` integer povinné `overdueHaler` integer povinné `overdueDays` integer povinné `averageLateDays` number povinné `onTimePercent` null | number povinné `rating` string povinné ```bash curl https://api.damedoklad.cz/v1/reports/payment-discipline \ -H "Authorization: Bearer $DAMEDOKLAD_API_KEY" ``` ```javascript const response = await fetch('https://api.damedoklad.cz/v1/reports/payment-discipline', { headers: { Authorization: `Bearer ${process.env.DAMEDOKLAD_API_KEY}`, }, }); const data = await response.json(); ``` ```python import os import requests response = requests.get( "https://api.damedoklad.cz/v1/reports/payment-discipline", headers={"Authorization": f"Bearer {os.environ['DAMEDOKLAD_API_KEY']}"}, ) data = response.json() ``` ## Get the largest customers or suppliers by turnover excluding VAT for a year GET `/v1/reports/top-contacts` Get the largest customers or suppliers by turnover excluding VAT for a year Nástroj MCP: `get-top-contacts-report` ### Parametry dotazu `kind` "customers" | "suppliers" výchozí `"customers"` `year` integer min 2000 max 2100 The year an accounting period starts in, so a hospodářský rok from July 2026 is 2026. Defaults to the current one. `periodId` string One accounting period exactly, for two starting in the same year. Takes precedence over year. ### Odpověď · 200 `kind` string povinné `year` integer povinné `data` object\[\] povinné `contactId` null | string povinné `contactName` null | string povinné `documents` integer povinné `netHaler` integer povinné `totalHaler` integer | null povinné `hasMore` boolean povinné `from` string date `to` string date ```bash curl https://api.damedoklad.cz/v1/reports/top-contacts \ -H "Authorization: Bearer $DAMEDOKLAD_API_KEY" ``` ```javascript const response = await fetch('https://api.damedoklad.cz/v1/reports/top-contacts', { headers: { Authorization: `Bearer ${process.env.DAMEDOKLAD_API_KEY}`, }, }); const data = await response.json(); ``` ```python import os import requests response = requests.get( "https://api.damedoklad.cz/v1/reports/top-contacts", headers={"Authorization": f"Bearer {os.environ['DAMEDOKLAD_API_KEY']}"}, ) data = response.json() ```