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

# Get a paged array of invoices

`GET /invoices`

Get a paged array of invoices

## 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 Invoices of this patient
- `locationId` number, nullable — Search for Invoices created at this location
- `practitionerId` number, nullable — Search for Invoices created by this practitioner
- `status` 'Draft' | 'Awaiting Payment' | 'Paid', nullable — Search for invoices of this status

## Response `200`

A paged array of invoices

- object
  - `data` object[], required
    - `id` integer, required — Invoice id
    - `invoiceNumber` string, required — Invoice number
    - `issueDate` union, required — Invoice issue date time
      - string
      - string
    - `dueDate` union, required — Invoice due date time
      - string
      - string
    - `patientId` integer, required — The invoice patient id
    - `contactId` integer, nullable, required — The invoice contact id
    - `locationId` integer, required — The invoice location id
    - `practitionerId` integer, nullable, required — The invoice practitioner id
    - `extraBillingInfo` string, nullable, required — Invoice extra billing info
    - `subtotal` number, nullable, required — Invoice subtotal amount
    - `taxStatus` 'including' | 'excluding' | 'no tax', required — Invoice tax status
    - `tax` number, nullable, required — Invoice tax amount
    - `total` number, nullable, required — Invoice total amount
    - `paidAmount` number, nullable, required — Invoice paid amount
    - `status` 'Draft' | 'Awaiting Payment' | 'Paid', required — Invoice status
    - `invoiceItems` object[], required
      - `id` integer, required — Invoice item id
      - `type` 'appointment' | 'supportActivity' | 'supportItem' | 'service' | 'productStock' | 'custom' | 'GiftVoucher', required — Invoice item type
      - `typeId` integer, nullable, required — Invoice item object id
      - `code` string, nullable, required — Invoice item code
      - `description` string, nullable, required — Invoice item description
      - `unitPrice` number, nullable, required — Invoice item unit price, in dollar
      - `quantity` number, nullable, required — Invoice item quantity
      - `discount` string, nullable, required — Invoice item discount, in dollar or percentage
      - `taxType` union, required — Tax type, check Splose support for more info
        - 'STANDARD' | 'ZERO' | 'EXEMPT' | 'REDUCED'
        - string
        - unknown
      - `taxRate` number, nullable, required — Tax rate, in percentage
    - `paymentIds` integer[], required
    - `referenceNumbers` string[], nullable, required — Invoice provider numbers
    - `isArchived` boolean, nullable — Whether the invoice is archvied
    - `reference` string, nullable, required — Invoice reference
    - `description` string, nullable, required — Invoice description
    - `createdAt` union — Object creation date time
      - string
      - string
    - `updatedAt` union — Object update date time
      - string
      - string
  - `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)