---
title: "List Receipts"
method: GET
path: "/receipts"
tags: ["Receipts"]
---

# List Receipts

`GET /receipts`

## Request

- Base URL: `https://api.alto.zoopladev.co.uk`
- URL: `https://api.alto.zoopladev.co.uk/receipts`
- Auth: `appAuth` (a scheme the document does not define)

Retrieves a paginated list of receipts for a given AgencyRef and all permissible branches,
ordered by receipt id. Returns the same detail as GET /receipts/{receiptId}.

## Query parameters

- `next-token` string
- `max-results` integer
- `sort-order` 'Asc' | 'Desc'
- `reversal` boolean
- `reversed` boolean

## Headers

- `AgencyRef` string, required

## Response `200`

Success

- AltoPropertyManagementApiModelsResponsesPagedResults1AltoPropertyManagementApiModelsResponsesReceiptDetail
  - `meta` AltoPropertyManagementApiModelsResponsesMeta
    - `nextToken` string, nullable
    - `totalItems` integer
  - `items` AltoPropertyManagementApiModelsResponsesReceiptDetail[], nullable
    - `id` string, nullable
    - `branchId` string, nullable
    - `receiptReference` string, nullable
    - `totalReceived` number, double
    - `currencyCode` string, nullable
    - `receiptDate` string, date-time
    - `documentStatus` string, nullable
    - `contactId` string, nullable
    - `tenancyId` string, nullable
    - `isReversal` boolean: True when this receipt is itself a reversal of another.
    - `originalReceiptId` string, nullable: The receipt this one reverses, from accounts.ReceiptReversalAudit.
    - `isReversed` boolean: True when this receipt has been reversed.
    - `reversalReceiptId` string, nullable: The receipt that reversed this one, from accounts.ReceiptReversalAudit.
    - `receiptDocumentId` string, nullable
    - `links` AltoApiMaterialHateoasLink[], nullable
      - `href` string, nullable
      - `rel` string, nullable

## Other responses

- `400`: Bad request

---

[API](https://skmtc.dev/alto/apis/alto-api.md) - [All operations](https://skmtc.dev/alto/apis/alto-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alto/apis/alto-api/revisions/1b729d9b15a8?raw)