Cash receipts week detail

GET /api/v1/invoices/cash-receipts/week-detail

Returns individual deposit transactions for a given week, including which invoices and bills each deposit was applied to.

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

Query

week_start string required: Monday of the target week (YYYY-MM-DD).

Responses

200 Successful Response

Schema: WeekDetailResponse

week_start string required

week_end string required

total_received integer required

Total deposits in this week in cents.

total_applied integer required

Total applied in this week in cents.

unapplied integer required

Unapplied remainder in cents.

transactions array · WeekTransactionDetail requiredWeekTransactionDetail

Individual deposit transactions for the week.

9 fields

id string required
date string
description string
counterparty string
amount integer required: Full transaction amount in cents.
applied integer required: Amount already applied in cents.
unapplied integer required: Remaining unapplied amount in cents.
ledger_name string
applications array · TransactionApplication: Invoice/bill payments linked to this transaction.

400 Bad Request - Invalid input

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

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/invoices/cash-receipts/week-detail

bash

curl -X GET 'https://api.ondayzero.com/api/v1/invoices/cash-receipts/week-detail' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/invoices/cash-receipts/week-detail', {
  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/invoices/cash-receipts/week-detail", headers=headers)
data = response.json()