Reports
Financial statements and ledger reports.
GET /reports/trial-balanceTrial balanceGET /reports/profit-and-lossIncome statementGET /reports/balance-sheetBalance sheetGET /reports/cash-flowStatement of cash flowsGET /reports/general-ledgerGeneral ledger detailGET /reports/ar-agingAccounts receivable agingGET /reports/ap-agingAccounts payable agingGET /reports/combined/{report}Combined report for a group of companies
Trial balance
GET /reports/trial-balance
Sends Vortex-Entity.
Parameters
| Name | In | Type | About |
|---|---|---|---|
as_of required | query | string (date) | |
basis | query | string | Accrual, or cash: invoices and bills count when paid, each payment taking its share of every line, including an invoice's cost of goods sold, so unpaid goods stay in inventory. Imported receivables and payables stay until settled. Aging has no cash basis ( |
dimensions | query | object | Filter by dimension values, for example |
Answers
Income statement
GET /reports/profit-and-loss
Sends Vortex-Entity.
Parameters
| Name | In | Type | About |
|---|---|---|---|
start_date required | query | string (date) | |
end_date required | query | string (date) | |
basis | query | string | Accrual, or cash: invoices and bills count when paid, each payment taking its share of every line, including an invoice's cost of goods sold, so unpaid goods stay in inventory. Imported receivables and payables stay until settled. Aging has no cash basis ( |
dimensions | query | object | Filter by dimension values, for example |
columns_by | query | string | Split columns by period or by a dimension code (for example |
Answers
Balance sheet
GET /reports/balance-sheet
Sends Vortex-Entity.
Parameters
| Name | In | Type | About |
|---|---|---|---|
as_of required | query | string (date) | |
basis | query | string | Accrual, or cash: invoices and bills count when paid, each payment taking its share of every line, including an invoice's cost of goods sold, so unpaid goods stay in inventory. Imported receivables and payables stay until settled. Aging has no cash basis ( |
dimensions | query | object | Filter by dimension values, for example |
Answers
Statement of cash flows
GET /reports/cash-flow
Sends Vortex-Entity.
Indirect method, from each account's cash-flow class.
Parameters
| Name | In | Type | About |
|---|---|---|---|
basis | query | string | Accrual, or cash: invoices and bills count when paid, each payment taking its share of every line, including an invoice's cost of goods sold, so unpaid goods stay in inventory. Imported receivables and payables stay until settled. Aging has no cash basis ( |
start_date required | query | string (date) | |
end_date required | query | string (date) | |
dimensions | query | object | Filter by dimension values, for example |
Answers
General ledger detail
GET /reports/general-ledger
Sends Vortex-Entity.
Parameters
| Name | In | Type | About |
|---|---|---|---|
start_date required | query | string (date) | |
end_date required | query | string (date) | |
basis | query | string | Accrual, or cash: invoices and bills count when paid, each payment taking its share of every line, including an invoice's cost of goods sold, so unpaid goods stay in inventory. Imported receivables and payables stay until settled. Aging has no cash basis ( |
dimensions | query | object | Filter by dimension values, for example |
account_id | query | string |
Answers
Accounts receivable aging
GET /reports/ar-aging
Sends Vortex-Entity.
Parameters
| Name | In | Type | About |
|---|---|---|---|
as_of required | query | string (date) |
Answers
Accounts payable aging
GET /reports/ap-aging
Sends Vortex-Entity.
Parameters
| Name | In | Type | About |
|---|---|---|---|
as_of required | query | string (date) |
Answers
Combined report for a group of companies
GET /reports/combined/{report}
Sends Vortex-Entity.
A parent company's report with each of its subsidiaries' added in: a column for each company, an Eliminations column when any of them marked accounts as intercompany (not on the cash flow statement), and a combined column (combined debit and credit on the trial balance). Accounts combine when their code and name both match. Ask on the parent company; a subsidiary answers 422 not_group_parent. A company with no subsidiaries gets its own report in this shape.
Being in a group never opens one company's numbers to another's people, so the report combines only the subsidiaries the caller could read on its own: for an API key or app token, those whose reports the person who made the key (or approved the app) can still open, with their role there; for a platform, those it has an active connection to that allows reports:read. An AI agent's key combines the parent only. Subsidiaries left out are counted in left_out.no_access, and ones in another currency are listed in left_out.other_currency. Requires reports:read.
Parameters
| Name | In | Type | About |
|---|---|---|---|
report required | path | string | |
start_date | query | string (date) | Required for profit-and-loss and cash-flow. |
end_date | query | string (date) | Required for profit-and-loss and cash-flow. |
as_of | query | string (date) | Required for balance-sheet and trial-balance. |
basis | query | string | Accrual, or cash: invoices and bills count when paid, each payment taking its share of every line, including an invoice's cost of goods sold, so unpaid goods stay in inventory. Imported receivables and payables stay until settled. Aging has no cash basis ( |
Answers
- 200 CombinedReport. The combined report.
- 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
- 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

