Top categories and vendors by cash outflow

GET/api/v1/businesses/{business_id}/cash-flow-statement/outflow-breakdown

Returns the top N ledger categories and counterparties that powered cash outflows during the requested period, ranked by absolute cash leaving. Powers the 'Where the cash went' tile on /books/cash-flow.

Operation ID: get_cash_flow_outflow_breakdown_api_v1_businesses__business_id__cash_flow_statement_outflow_breakdown_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_datestring · daterequired: Start date (YYYY-MM-DD)
end_datestring · daterequired: End date (YYYY-MM-DD)
limitintegerdefault: 5: Max rows per list (categories and vendors are returned separately)

Responses

200Successful Response

Schema: SuccessEnvelope_GetCashFlowOutflowBreakdownResponse_

successboolean
messagestring
codestring
dataGetCashFlowOutflowBreakdownResponse

400Bad Request - Invalid input

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}/cash-flow-statement/outflow-breakdown

bash

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