---
title: "Get a single credit-note"
method: GET
path: "/credit-notes/{id}"
tags: ["credit-note"]
---

# Get a single credit-note

`GET /credit-notes/{id}`

Get credit-note data by id

## Path parameters

- `id` integer, required

## Response `200`

Object with credit-note data.

- object
  - `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

---

[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)