Weekly cash receipts reconciliation

GET /api/v1/invoices/cash-receipts

Returns a weekly breakdown of cash received (bank deposits) versus amounts applied to invoices and bills. Highlights unapplied deposits to aid reconciliation.

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

start_date string

Report start date (YYYY-MM-DD). Default: 12 weeks ago.

end_date string

Report end date (YYYY-MM-DD). Default: today.

Responses

200 Successful Response

Schema: CashReceiptsResponse

start_date string required

Report start date (YYYY-MM-DD).

end_date string required

Report end date (YYYY-MM-DD).

weeks array · CashReceiptsWeekSummary requiredCashReceiptsWeekSummary

Weekly breakdown of cash received.

6 fields
week_start string required

Start of the ISO week (YYYY-MM-DD).

week_end string required

End of the ISO week (YYYY-MM-DD).

total_received integer required

Total deposits received in cents.

total_applied integer required

Amount applied to invoices/bills in cents.

unapplied integer required

Unapplied remainder in cents.

transaction_count integer required

Number of deposit transactions.

unapplied_transactions array · UnappliedTransaction requiredUnappliedTransaction

Deposit transactions with remaining unapplied balance.

8 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
summary CashReceiptsSummary requiredCashReceiptsSummary

Period totals.

4 fields
total_received integer required

Total deposits in cents.

total_applied integer required

Total applied to invoices/bills in cents.

total_unapplied integer required

Total unapplied in cents.

transaction_count integer required

Total deposit transactions.

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