v1
latestOpenAPI 3.0.02026-07-26550199.6 KBinvoice
Get a paged array of invoices
Get a paged array of invoices
get/invoices
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
include_archived'true' | 'false' nullable
Whether archived objects should be retrieved, default is false
patientIdnumber nullable
Search for Invoices of this patient
Example:1
locationIdnumber nullable
Search for Invoices created at this location
Example:1
practitionerIdnumber nullable
Search for Invoices created by this practitioner
Example:1
status'Draft' | 'Awaiting Payment' | 'Paid' nullable
Search for invoices of this status
Example:Paid
Response
A paged array of invoices
Example response
{
"data": [
{
"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"
}
],
"links": {
"previousPage": "/v1/${object_type}?id_gt=200",
"nextPage": "/v1/${object_type}?id_lt=100"
}
}