Reports
Operations in the Reports group.
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
/v1/overviewGet the financial overview: to-do counts, overdue receivables, cash on hand, year result, monthly revenue and expense with a forecast, and breakdowns by account
MCP tool: get-financial-overview
Query parameters
yearintegermin 2000max 2100periodIdstringcenterIdstringResponse · 200
asOfstringrequireddate-timeregimestringrequiredyearintegerrequiredtoDoobjectrequiredtotalintegerrequireddocumentsintegerrequiredmovementsintegerrequiredoverdueobjectrequiredamountHalerinteger | nullrequiredcountintegerrequiredoldestDaysintegerrequiredoldestBucketnull | stringrequiredmoneyobjectrequiredbalanceHalerintegerrequiredchangePercentinteger | nullrequiredresultnull | objectrequiredamountHalerinteger | nullrequiredrevenueHalerintegerrequiredexpenseHalerintegerrequiredmonthsobject[]requiredmonthnull | stringrequiredrevenueHalerintegerrequiredexpenseHalerintegerrequiredforecastnull | objectrequiredmonthnull | stringrequiredactualProfitHalerintegerrequiredestimatedProfitHalerintegerrequiredestimatedRevenueHalerintegerrequiredestimatedExpenseHalerintegerrequiredexpensesByAccountobject[]requiredkeystringrequiredlabelnull | stringrequiredamountHalerinteger | nullrequiredrevenuesByAccountobject[]requiredkeystringrequiredlabelnull | stringrequiredamountHalerinteger | nullrequiredtoFinishobject[]requiredtypestringrequiredcountintegerrequiredpathnull | stringrequiredlabelnull | stringlabelEnstringkindstringrequiresstringfromstringdatetostringdateperiodIdstringGet open receivables or payables by age (not due, 1–30, 31–60, 61–90, over 90 days) in total and per contact
/v1/reports/agingGet open receivables or payables by age (not due, 1–30, 31–60, 61–90, over 90 days) in total and per contact
MCP tool: get-aging-report
Query parameters
kind"receivables" | "payables"default "receivables"asOfstringYYYY-MM-DDResponse · 200
kindstringrequiredasOfstringrequireddatebucketsobjectrequirednot_dueintegerrequiredd1_30integerrequiredd31_60integerrequiredd61_90integerrequiredd90_plusintegerrequiredtotalHalerinteger | nullrequireddataobject[]requiredcontactIdnull | stringrequiredcontactNamenull | stringrequiredtotalHalerinteger | nullrequirednot_dueintegerrequiredd1_30integerrequiredd31_60integerrequiredd61_90integerrequiredd90_plusintegerrequiredretainedHalerintegerretainedBucketsobjectnot_dueintegerrequiredd1_30integerrequiredd31_60integerrequiredd61_90integerrequiredd90_plusintegerrequiredretainedHalerintegerGet money in, money out, and closing balance per month for a year
/v1/reports/cash-flowGet money in, money out, and closing balance per month for a year
MCP tool: get-cash-flow-report
Query parameters
yearintegermin 2000max 2100periodIdstringcenterIdstringResponse · 200
yearintegerrequiredopeningHalerintegerrequireddataobject[]requiredmonthnull | stringrequiredinflowHalerintegerrequiredoutflowHalerintegerrequiredclosingHalerintegerrequiredfromstringdatetostringdateDownload a report or document list as XLSX or CSV
/v1/reports/exportDownload a report or document list as XLSX or CSV
MCP tool: export-report
Query parameters
kind"income_expense" | "cash_flow" | "aging" | "payment_discipline" | "top_contacts" | "issued_invoices" | "received_invoices" | "contacts"requiredformat"xlsx" | "csv"default "xlsx"yearintegermin 2000max 2100periodIdstringfromstringYYYY-MM-DDtostringYYYY-MM-DDResponse · 200
Returns a application/octet-stream file.
Get monthly revenue, expense, and result for a year (accrual under double entry, cash under tax records)
/v1/reports/income-expenseGet monthly revenue, expense, and result for a year (accrual under double entry, cash under tax records)
MCP tool: get-income-expense-report
Query parameters
yearintegermin 2000max 2100periodIdstringcenterIdstringResponse · 200
yearintegerrequireddataobject[]requiredmonthnull | stringrequiredrevenueHalerintegerrequiredexpenseHalerintegerrequiredresultHalerintegerrequiredfromstringdatetostringdateGet how each customer pays (Platební kázeň): share paid on time, average and longest days late, and what is overdue now
/v1/reports/payment-disciplineGet 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.
MCP tool: get-payment-discipline-report
Query parameters
fromstringYYYY-MM-DDtostringYYYY-MM-DDasOfstringYYYY-MM-DDcontactIdstringyearintegermin 2000max 2100periodIdstringResponse · 200
fromstringrequireddatetostringrequireddateasOfstringrequireddatedataobject[]requiredcontactIdnull | stringrequiredcontactNamenull | stringrequireddocumentsintegerrequiredsettledHalerintegerrequiredlateHalerintegerrequiredmaxLateDaysintegerrequiredopenHalerintegerrequiredoverdueHalerintegerrequiredoverdueDaysintegerrequiredaverageLateDaysnumberrequiredonTimePercentnull | numberrequiredratingstringrequiredGet the largest customers or suppliers by turnover excluding VAT for a year
/v1/reports/top-contactsGet the largest customers or suppliers by turnover excluding VAT for a year
MCP tool: get-top-contacts-report
Query parameters
kind"customers" | "suppliers"default "customers"yearintegermin 2000max 2100periodIdstringResponse · 200
kindstringrequiredyearintegerrequireddataobject[]requiredcontactIdnull | stringrequiredcontactNamenull | stringrequireddocumentsintegerrequirednetHalerintegerrequiredtotalHalerinteger | nullrequiredhasMorebooleanrequiredfromstringdatetostringdate