Reports

Financial statements and ledger reports.

Trial balance

GET /reports/trial-balance

Sends Vortex-Entity.

Parameters

NameInTypeAbout
as_of requiredquerystring (date)
basisquerystring

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 (422 basis_not_supported).

dimensionsqueryobject

Filter by dimension values, for example dimensions[location]=maui.

Answers

  • 200 Report. The 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

Income statement

GET /reports/profit-and-loss

Sends Vortex-Entity.

Parameters

NameInTypeAbout
start_date requiredquerystring (date)
end_date requiredquerystring (date)
basisquerystring

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 (422 basis_not_supported).

dimensionsqueryobject

Filter by dimension values, for example dimensions[location]=maui.

columns_byquerystring

Split columns by period or by a dimension code (for example location).

Answers

  • 200 Report. The 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

Balance sheet

GET /reports/balance-sheet

Sends Vortex-Entity.

Parameters

NameInTypeAbout
as_of requiredquerystring (date)
basisquerystring

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 (422 basis_not_supported).

dimensionsqueryobject

Filter by dimension values, for example dimensions[location]=maui.

Answers

  • 200 Report. The 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

Statement of cash flows

GET /reports/cash-flow

Sends Vortex-Entity.

Indirect method, from each account's cash-flow class.

Parameters

NameInTypeAbout
basisquerystring

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 (422 basis_not_supported).

start_date requiredquerystring (date)
end_date requiredquerystring (date)
dimensionsqueryobject

Filter by dimension values, for example dimensions[location]=maui.

Answers

  • 200 Report. The 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

General ledger detail

GET /reports/general-ledger

Sends Vortex-Entity.

Parameters

NameInTypeAbout
start_date requiredquerystring (date)
end_date requiredquerystring (date)
basisquerystring

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 (422 basis_not_supported).

dimensionsqueryobject

Filter by dimension values, for example dimensions[location]=maui.

account_idquerystring

Answers

  • 200 Report. The 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

Accounts receivable aging

GET /reports/ar-aging

Sends Vortex-Entity.

Parameters

NameInTypeAbout
as_of requiredquerystring (date)

Answers

  • 200 Report. The 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

Accounts payable aging

GET /reports/ap-aging

Sends Vortex-Entity.

Parameters

NameInTypeAbout
as_of requiredquerystring (date)

Answers

  • 200 Report. The 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

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

NameInTypeAbout
report requiredpathstring
start_datequerystring (date)

Required for profit-and-loss and cash-flow.

end_datequerystring (date)

Required for profit-and-loss and cash-flow.

as_ofquerystring (date)

Required for balance-sheet and trial-balance.

basisquerystring

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 (422 basis_not_supported).

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