read

The trial balance of one entity for a date range inside one fiscal year, with its calculation.

Per account: opening, debit, credit and closing in the base currency, each on its normal side, computed by the Magistry finance engine from one aggregate of the ledger. trace is the engine's step-by-step calculation (ids and data, no prose) and trace_url opens the same report in Books. balanced is false when the ledger does not balance — it is never hidden. Give from and to, or as_of alone: the balance at the end of that day, i.e. from the first day of the fiscal year holding it (range says which). Amounts are { "amount": "<decimal string>", "currency": "<ISO 4217>" } — never a JSON number.

post/api/v1/finance/reports/trial-balance

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/finance/reports/trial-balance
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.magistry.io/api/oauth/authorize, token URL https://app.magistry.io/api/oauth/token, scopes: finance:read)

Request body

entity_idstring uuid required

The entity, one of those this app was granted (GET /api/v1/finance/entities lists them). In a GET query string entity is accepted too.

fromstring date

First day of the range.

tostring date

Last day of the range, in the same fiscal year.

as_ofstring date

Instead of from and to: the day the balance is taken at, from the start of its fiscal year.

Response

Result

okboolean required
resultunknown required

Changes

No recorded changes to this operation across all 3 revisions of this API.