API OverviewAPI EndpointsReports

Get general ledger report

Generates a detailed general ledger report with account balances and journal entries

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 the report 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)

Response

General ledger report generated successfully
accountslist of objects or null
entrieslist of objects or null
Journal entries for the period
pdf_urlstring or null
URL to the generated PDF report
hierarchyobject or null
Hierarchical view of accounts

Errors