Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required
Required range: x > 0

Response

200 - application/json
id
integer
required

Invoice id

Required range: x > 0
invoiceNumber
string
required

Invoice number

issueDate
required

Invoice issue date time

dueDate
required

Invoice due date time

patientId
integer
required

The invoice patient id

Required range: x > 0
locationId
integer
required

The invoice location id

Required range: x > 0
practitionerId
integer | null
required

The invoice practitioner id

Required range: x > 0
extraBillingInfo
string | null
required

Invoice extra billing info

subtotal
number | null
required

Invoice subtotal amount

taxStatus
enum<string>
required

Invoice tax status

Available options:
including,
excluding,
no tax
tax
number | null
required

Invoice tax amount

total
number | null
required

Invoice total amount

paidAmount
number | null
required

Invoice paid amount

status
enum<string>
required

Invoice status

Available options:
Draft,
Awaiting Payment,
Paid
invoiceItems
object[]
required
paymentIds
integer[]
required
referenceNumbers
string[] | null
required

Invoice provider numbers

reference
string | null
required

Invoice reference

description
string | null
required

Invoice description

createdAt
required

Object creation date time

updatedAt
required

Object update date time

isArchived
boolean | null
default: false

Whether the invoice is archvied