# GET /api/v1/invoices/cash-receipts

> Weekly cash receipts reconciliation

- **Tag:** invoices
- **Operation ID:** `get_cash_receipts_api_v1_invoices_cash_receipts_get`

## Description

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

## Authentication

Bearer token in `Authorization` header.
Required header: `x-business-id: <business uuid>`.

## Parameters

- `start_date` (query, string, optional) — Report start date (YYYY-MM-DD). Default: 12 weeks ago.
- `end_date` (query, string, optional) — 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 · required) → `CashReceiptsWeekSummary` — Weekly breakdown of cash received.
  - `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 · required) → `UnappliedTransaction` — Deposit transactions with remaining unapplied balance.
  - `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 · required) → `CashReceiptsSummary` — Period totals.
  - `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`
  - `loc` (array · string | integer · required)
  - `msg` (string · required)
  - `type` (string · required)
  - `input` (object)
  - `ctx` (object)

## Code samples

### cURL

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

### JavaScript

```javascript
const response = await fetch('https://api.ondayzero.com/api/v1/invoices/cash-receipts', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();
```

### Python

```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", headers=headers)
data = response.json()
```

## See also

- HTML version: https://www.ondayzero.com/docs/reference/invoices/get-cash-receipts
- OpenAPI slice: https://www.ondayzero.com/docs/reference/invoices/get-cash-receipts/openapi.json
- Other endpoints in **invoices**: https://www.ondayzero.com/docs/reference/invoices