---
title: "Get a paged array of credit-notes"
method: GET
path: "/credit-notes"
tags: ["credit-note"]
---

# Get a paged array of credit-notes

`GET /credit-notes`

Get a paged array of credit-notes

## 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 credit notes of this patient
- `invoiceId` number, nullable — Search for credit notes of this invoice
- `practitionerId` number, nullable — Search for credit notes created by this practitioner
- `sentStatus` 'Sent' | 'Viewed', nullable — Search for credit notes of this sent status

## Response `200`

A paged array of credit-notes

- object
  - `data` object[], required
    - `id` integer, required — Credit note id
    - `customNum` string, required — Credit note custom number
    - `invoiceId` integer, required — Invoice id
    - `patientId` integer, required — Patient id
    - `subtotal` number, nullable, required — Credit note subtotal amount
    - `tax` number, nullable, required — Credit note tax amount
    - `total` number, nullable, required — Credit note total amount
    - `sentStatus` 'Sent' | 'Viewed', nullable — Credit note status
    - `creditNoteItems` object[], required
      - `id` integer, required — Credit note item id
      - `invoiceItemId` integer, required — Credit note item's invoice item id
      - `unitPrice` number, nullable, required — Credit note item unit price, in dollar
      - `quantity` number, nullable, required — Credit note item quantity
      - `discount` string, nullable, required — Credit note item discount, in dollar or percentage
    - `creditAllocations` object[]
      - `invoiceId` integer, required — Allocated credit to invoice id
      - `paymentId` integer, required — Allocated credit to payment id
      - `amount` number, nullable, required — Allocated credit amount
    - `description` string, nullable, required — Credit note description
    - `createdAt` union — Object creation date time
      - string
      - string
    - `updatedAt` union — Object update date time
      - string
      - string
    - `deletedAt` union, required — Object archived date time
      - string
      - string
      - unknown
  - `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)