Get a master ledger
Lists the same journal activity as the general ledger, but grouped by the record that produced it rather than by account — so you see each entry's debits and credits side by side. Requires the reports:read permission.
Authorization
AuthorizationstringrequiredQuery parameters
basisenum<string>requiredcash counts money when it moves; accrual counts it when it is earned or owed. The two give different numbers from the same data.
reportTypeenum<string>requiredproperty reports on the properties' books — what the owners' money did. company reports on the management company's own books. An entry belongs to one or the other, never both.
startDatestring · daterequiredFirst day of the period, read in the company's timezone.
endDatestring · daterequiredLast day of the period, read in the company's timezone.
portfolioIdsstring[]Only these portfolios.
propertyIdsstring[]Only these properties.
coaIdsstring[]Only entries touching these chart-of-account entries. Omit for everything.
Response
200 · An array of journal entries, each with its lines.
postingDatestring · dateThe date the entry is posted on, in the company's timezone.
sourceenum<string>What sort of record produced the entry.
sourceIdstringThe id of that record.
linesLine[]The entry's debit and credit lines. Their debits and credits balance.
400 · `basis`, `reportType`, `startDate` or `endDate` is missing or not a recognised value.
401 · The access token is missing, expired, or not for this company.
403 · The caller does not hold the `reports:read` permission.
The response is a bare JSON array, not an object with a wrapper. Within each entry the debit lines and the credit lines balance.
Nothing is stored. Every call rebuilds the report from the ledger as it stands right now, so two calls with the same parameters can differ if anything was posted in between. Only manual journal entries that have been posted are included.