Get a paged array of invoices

Authorizations

Authorization

string

headerrequired

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

Query Parameters

id_gt

integer | null

The starting object id of the next page

id_lt

integer | null

The starting object id of the previous page

update_gt

Search for objects updated after this date time

update_lt

Search for objects updated before this date time

include_archived

enum<string> | null

default: false

Whether archived objects should be retrieved, default is false

Available options:

true,

false

patientId

number | null

Search for Invoices of this patient

locationId

number | null

Search for Invoices created at this location

practitionerId

number | null

Search for Invoices created by this practitioner

status

enum<string> | null

Search for invoices of this status

Available options:

Draft,

Awaiting Payment,

Paid

Response

200 - application/json

data

object[]

required

data.id

integer

required

Invoice id

Required range: x > 0

data.invoiceNumber

string

required

Invoice number

data.issueDate

required

Invoice issue date time

data.dueDate

required

Invoice due date time

data.patientId

integer

required

The invoice patient id

Required range: x > 0

data.locationId

integer

required

The invoice location id

Required range: x > 0

data.practitionerId

integer | null

required

The invoice practitioner id

Required range: x > 0

data.extraBillingInfo

string | null

required

Invoice extra billing info

data.subtotal

number | null

required

Invoice subtotal amount

data.taxStatus

enum<string>

required

Invoice tax status

Available options:

including,

excluding,

no tax

data.tax

number | null

required

Invoice tax amount

data.total

number | null

required

Invoice total amount

data.paidAmount

number | null

required

Invoice paid amount

data.status

enum<string>

required

Invoice status

Available options:

Draft,

Awaiting Payment,

Paid

data.invoiceItems

object[]

required

data.paymentIds

integer[]

required

data.referenceNumbers

string[] | null

required

Invoice provider numbers

data.isArchived

boolean | null

default: false

Whether the invoice is archvied

data.reference

string | null

required

Invoice reference

data.description

string | null

required

Invoice description

data.createdAt

required

Object creation date time

data.updatedAt

required

Object update date time

links

object

required

Get started

API Reference

Authorizations

Query Parameters

Response