v1

latestOpenAPI 3.0.02026-07-26550199.6 KB

credit-note

Get a single credit-note

Get credit-note data by id

get/credit-notes/{id}

Path parameters

idinteger required

Example:1

Response

Object with credit-note data.

idinteger required

Credit note id

customNumstring required

Credit note custom number

invoiceIdinteger required

Invoice id

patientIdinteger required

Patient id

subtotalnumber nullable required

Credit note subtotal amount

taxnumber nullable required

Credit note tax amount

totalnumber nullable required

Credit note total amount

sentStatus'Sent' | 'Viewed' nullable

Credit note status

descriptionstring nullable required

Credit note description

Example response

{
  "id": 1,
  "customNum": "CN-0001",
  "invoiceId": 1,
  "patientId": 1,
  "subtotal": 193.99,
  "total": 193.99,
  "sentStatus": "Sent",
  "creditNoteItems": [
    {
      "id": 1,
      "invoiceItemId": 1,
      "unitPrice": 193.99,
      "quantity": 0.5,
      "discount": "$20.00"
    }
  ],
  "creditAllocations": [
    {
      "invoiceId": 1,
      "paymentId": 1,
      "amount": 193.99
    }
  ],
  "description": "Some description"
}