Get income statement (sectioned)

GET/api/v1/businesses/{business_id}/income-statement

Income statement grouped by section. Each section contains ledger line items with period values as top-level keys.

Operation ID: get_income_statement_api_v1_businesses__business_id__income_statement_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

start_datestringrequired: Start date (YYYY-MM-DD)
end_datestringrequired: End date (YYYY-MM-DD)
hide_zero_rowsbooleandefault: False: Exclude line items with all-zero values
period_granularitystringdefault: monthly: Period grouping: monthly, quarterly, or yearly
tag_idsarray · stringdefault: []: Filter by tag UUIDs — only line entries tagged with at least one of these tags are included

Responses

200Successful Response

Schema: SuccessEnvelope_GetIncomeStatementResponse_

successboolean
messagestring
codestring
dataGetIncomeStatementResponse

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

Code samples

GET/api/v1/businesses/{business_id}/income-statement

bash

curl -X GET 'https://api.ondayzero.com/api/v1/businesses/{business_id}/income-statement' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'