---
title: "List customer receipts"
method: GET
path: "/api/v1/iqbooks/organisations/{organisationId}/customer-receipts"
tags: ["IQ Books — Settlements"]
---

# List customer receipts

`GET /api/v1/iqbooks/organisations/{organisationId}/customer-receipts`

## Request

- Base URL: `https://api.reconcileiq.com`
- URL: `https://api.reconcileiq.com/api/v1/iqbooks/organisations/{organisationId}/customer-receipts`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Paginated list. Filters: `?contact_id`, `?search`, `?date_from`, `?date_to`, `?limit`/`?offset`. Requires scope `iqbooks:read`.

## Path parameters

- `organisationId` integer, required

## Query parameters

- `limit` integer
- `offset` integer
- `contact_id` integer
- `search` string
- `date_from` string, date
- `date_to` string, date

## Response `200`

Paginated receipts/payments.

- object
  - `data` Settlement[], required
    - `id` integer
    - `organisation_id` integer
    - `contact_id` integer
    - `contact_name` string, nullable
    - `bank_account_id` integer
    - `bank_account_name` string, nullable
    - `journal_entry_id` integer, nullable
    - `date` string, date, nullable
    - `currency` string
    - `amount` number
    - `reference` string, nullable
    - `description` string, nullable
    - `created_at` string, date-time
    - `allocations` object[]
      - `id` integer
      - `invoice_id` integer
      - `invoice_number` string, nullable
      - `amount` number
  - `pagination` object, required
    - `limit` integer, required
    - `offset` integer, required
    - `count` integer, required: Number of rows in this page (data.length).
    - `total` integer: Total matching rows when the native service reports it; may be absent.

## Other responses

- `401`: Missing, invalid, or revoked API key.
- `403`: Authenticated but the key lacks the required scope.
- `404`: Resource not found, or not visible to the caller (no existence leak).

---

[API](https://skmtc.dev/reconcileiq/apis/reconcileiq-public-api.md) · [All operations](https://skmtc.dev/reconcileiq/apis/reconcileiq-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/reconcileiq/apis/reconcileiq-public-api/revisions/5401beef8653?raw)