---
title: "Get a paged array of payments"
method: GET
path: "/payments"
tags: ["payment"]
---

# Get a paged array of payments

`GET /payments`

Get a paged array of payments

## Query parameters

- `id_gt` integer, nullable — The starting object id of the next page
- `id_lt` integer, nullable — The starting object id of the previous page
- `update_gt` union — Search for objects updated after this date time
  - string
  - string
- `update_lt` union — Search for objects updated before this date time
  - string
  - string
- `include_archived` 'true' | 'false', nullable — Whether archived objects should be retrieved, default is false
- `patientId` number, nullable — Search for payments of this patient
- `locationId` number, nullable — Search for payments created at this location

## Response `200`

A paged array of payments

- object
  - `data` object[], required
    - `id` integer, required — Payment id
    - `paymentNumber` string, required — Payment number
    - `amount` number, nullable, required — Total payment amount. 0 for credit allocation
    - `patientId` integer, required — The payment patient id
    - `locationId` integer, required — The payment location id
    - `paymentMethodId` integer, nullable, required — The payment method id, null for credit allocation
    - `paymentDate` union, required — Payment date
      - string
      - string
    - `paymentInvoices` object[], required — Payments made to invoices
      - `invoiceId` integer, required — Invoice id
      - `amount` number, nullable, required — Amount paid
      - `xeroId` string, uuid, nullable, required — Xero payment id
    - `creditAllocations` object[], required — Credit allocated to invoices
      - `invoiceId` integer, required — Invoice id
      - `amount` number, nullable, required — Amount paid
    - `xeroId` string, uuid, nullable, required — Xero batch payment id
    - `archivedAt` union, required — Payment archive date time
      - string
      - string
      - unknown
    - `archived` boolean, nullable — Whether the payment has been archived
  - `links` object, required
    - `previousPage` string — The link to retrieve next page
    - `nextPage` string — The link to retrieve previous page

---

[API](https://skmtc.dev/splose/apis/splose-public-api.md) · [All operations](https://skmtc.dev/splose/apis/splose-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/splose/splose-public-api/revisions/648d60075f00/schema)