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

Get Books Balance Sheet

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

Runs a balance sheet over the client's own books as at one date — 'asAt', defaulting to today. A statement of position, so unlike the profit and loss it takes a single date rather than a period. The 'asAt' that comes back is the date the platform actually ran to, which is not always the one asked for: Xero's report runs to a month end, so a mid-month date is answered as at that month's end. Sections come back as the platform grouped them, and a section with a title and no lines is a heading it emitted. Only platforms whose metadata says 'supportsBalanceSheet' can answer; the rest answer with 400 saying so.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

clientCode* path string
asAt query string (date)

Responses

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