Start free trial

Get balance sheet (sectioned)

GET/api/v1/businesses/{business_id}/balance-sheet

Balance sheet grouped by section (Assets, Liabilities, Equity). Each section contains ledger line items with ledger_id, ledger_name, sort_code, and total_amount.

Operation ID: get_balance_sheet_api_v1_businesses__business_id__balance_sheet_get·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

business_idstringrequired

Query

as_of_datestringrequired

As-of date (YYYY-MM-DD)

hide_zero_rowsbooleandefault: False

Exclude line items with a zero balance

period_granularitystring

Optional period grouping: monthly, quarterly, or yearly. When set, requires start_date and adds one as-of balance per period end between start_date and as_of_date.

start_datestring

Start date (YYYY-MM-DD); required when period_granularity is set

Responses

200Successful Response

Schema: SuccessEnvelope_GetBalanceSheetResponse_

successboolean
messagestring
codestring
dataGetBalanceSheetResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject