Start free trial

Get vendor breakdown across all periods for a ledger

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

Returns vendor/counterparty breakdown with per-period amounts for pivot-table display.

Operation ID: get_ledger_vendor_period_matrix_api_v1_businesses__business_id__ledger__ledger_id__vendor_period_matrix_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)

period_granularitystringdefault: monthly

monthly, quarterly, or yearly

cash_flowbooleandefault: False

When true, restrict to cash-touching journal entries and use cash flow sign convention

Responses

200Successful Response

Schema: SuccessEnvelope_GetLedgerVendorPeriodMatrixResponse_

successboolean
messagestring
codestring
dataGetLedgerVendorPeriodMatrixResponse

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