Authorizations

Authorization
string
headerrequired

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

Path Parameters

id
integer
required

Response

200 - application/json
id
integer
required

Invoice id

invoiceNumber
string
required

Invoice number

issueDate
required

Invoice issue date time

dueDate
required

Invoice due date time

patientId
integer
required

The invoice patient id

locationId
integer
required

The invoice location id

practitionerId
integer | null
required

The invoice practitioner id

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

isArchived
boolean | null
default: false

Whether the invoice is archvied

reference
string | null
required

Invoice reference

description
string | null
required

Invoice description

createdAt
required

Object creation date time

updatedAt
required

Object update date time

Get a paged array of invoicesGet a paged array of payment-methods