v1

latestOpenAPI 3.0.02026-07-26550199.6 KB

invoice

Get a single invoice

Get invoice data by id

get/invoices/{id}

Path parameters

idinteger required

Example:1

Response

Object with invoice data.

idinteger required

Invoice id

invoiceNumberstring required

Invoice number

patientIdinteger required

The invoice patient id

contactIdinteger nullable required

The invoice contact id

locationIdinteger required

The invoice location id

practitionerIdinteger nullable required

The invoice practitioner id

extraBillingInfostring nullable required

Invoice extra billing info

subtotalnumber nullable required

Invoice subtotal amount

taxStatus'including' | 'excluding' | 'no tax' required

Invoice tax status

taxnumber nullable required

Invoice tax amount

totalnumber nullable required

Invoice total amount

paidAmountnumber nullable required

Invoice paid amount

status'Draft' | 'Awaiting Payment' | 'Paid' required

Invoice status

paymentIdsinteger[] required

referenceNumbersstring[] nullable required

Invoice provider numbers

isArchivedboolean nullable

Whether the invoice is archvied

referencestring nullable required

Invoice reference

descriptionstring nullable required

Invoice description

Example response

{
  "id": 1,
  "invoiceNumber": "INV-0001",
  "patientId": 1,
  "contactId": 1,
  "locationId": 1,
  "practitionerId": 1,
  "extraBillingInfo": "Some extra info",
  "subtotal": 193.99,
  "taxStatus": "excluding",
  "total": 193.99,
  "paidAmount": 193.99,
  "status": "Paid",
  "invoiceItems": [
    {
      "id": 1,
      "type": "appointment",
      "typeId": 1,
      "description": "Wed 30 Aug 2023, 09:00am - Initial Assessment",
      "unitPrice": 193.99,
      "quantity": 0.5,
      "discount": "$20.00",
      "taxRate": 10
    }
  ],
  "paymentIds": [
    1
  ],
  "referenceNumbers": [
    "Medicare: 12345678"
  ],
  "reference": "Some references",
  "description": "Some description"
}