Get vendor/counterparty breakdown for a ledger account

GET/api/v1/businesses/{business_id}/ledger/{ledger_id}/vendor-breakdown

Returns vendors/counterparties that contributed to a ledger account total in the given date range, with amounts and percentages.

Operation ID: get_ledger_vendor_breakdown_api_v1_businesses__business_id__ledger__ledger_id__vendor_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
ledger_idstringrequired

Query

start_datestringrequired: Start date (YYYY-MM-DD)
end_datestringrequired: End date (YYYY-MM-DD)
cash_flowbooleandefault: False: When true, restrict to cash-touching journal entries and use cash flow sign convention

Responses

200Successful Response

Schema: SuccessEnvelope_GetLedgerVendorBreakdownResponse_

successboolean
messagestring
codestring
dataGetLedgerVendorBreakdownResponse

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}/ledger/{ledger_id}/vendor-breakdown

bash

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