API Docs / Operations / Client - Books / Get Books Trial Balance

Get Books Trial Balance

GET /tenants/{tenant}/clients/{clientCode}/books/trial-balance

Runs a trial balance over the client's own books — one signed balance per nominal account, positive for debit and negative for credit, in the platform's own order. The period is named the same way as the profit and loss endpoint's. Only platforms whose metadata says 'supportsTrialBalance' can answer; the rest answer with 400 saying so.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

clientCode* path string
dateFrom query string (date)
dateRange query enum

ThisWeek NextWeek Last7Days Next7Days Last30Days Next30Days PreviousMonth ThisMonth NextMonth PreviousQuarter ThisQuarter NextQuarter PreviousYear ThisYear NextYear YearToDate PreviousTaxYear ThisTaxYear NextTaxYear TaxYearToDate Today PreviousWeek CustomDateRange

ThisWeek NextWeek Last7Days Next7Days Last30Days Next30Days PreviousMonth ThisMonth NextMonth PreviousQuarter ThisQuarter NextQuarter PreviousYear ThisYear NextYear YearToDate PreviousTaxYear ThisTaxYear NextTaxYear TaxYearToDate Today PreviousWeek CustomDateRange

dateTo query string (date)

Responses

400 Bad Request
401 Unauthorized – Invalid or missing API key
404 Not Found