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_id string required
ledger_id string required

Query

start_date string required: Start date (YYYY-MM-DD)
end_date string required: End date (YYYY-MM-DD)
cash_flow boolean default: False: When true, restrict to cash-touching journal entries and use cash flow sign convention

Responses

200 Successful Response

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

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'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/businesses/{business_id}/ledger/{ledger_id}/vendor-breakdown', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.get("https://api.ondayzero.com/api/v1/businesses/{business_id}/ledger/{ledger_id}/vendor-breakdown", headers=headers)
data = response.json()