Sign in

v1

latestOpenAPI 3.0.02026-07-26550199.6 KB
credit-note

Get a paged array of credit-notes

Get a paged array of credit-notes

get/credit-notes

Query parameters

id_gtinteger nullable

The starting object id of the next page

Example:200
id_ltinteger nullable

The starting object id of the previous page

Example:100
string
OR
string
string
OR
string
include_archived'true' | 'false' nullable

Whether archived objects should be retrieved, default is false

patientIdnumber nullable

Search for credit notes of this patient

Example:1
invoiceIdnumber nullable

Search for credit notes of this invoice

Example:1
practitionerIdnumber nullable

Search for credit notes created by this practitioner

Example:1
sentStatus'Sent' | 'Viewed' nullable

Search for credit notes of this sent status

Example:Sent

Response

A paged array of credit-notes

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}