API OverviewAPI EndpointsReports

Generate financial reports

Generates comprehensive financial statements for an entity, including balance sheet, income statement, and cash flow statement

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

entityIdstringRequired
The ID of the entity to generate reports for
monthintegerOptional>=1<=12

Month number (1-12) for the report period

yearintegerOptional

Year for the report period (e.g., 2024)

startDatedatetimeOptional

Start date for filtering transactions (ISO 8601 format)

endDatedatetimeOptional

End date for filtering transactions (ISO 8601 format, defaults to current date)

typeenumOptional
Type of report to generate
Allowed values:
ledgerIdstringOptional

Optional ledger ID (if not provided, will use entityId)

Response

Reports generated successfully
reportPeriodobject or null
balanceSheetobject or null
incomeStatementobject or null
cashFlowStatementobject or null
reconciliationobject or null
pdf_urlsobject or null

Errors