Sign in

v1

latestOpenAPI 3.1.02026-07-2649128242.2 KB
Invoice

List Invoices

Retrieves a collection of invoices in a practice group

get/main/Invoice

Query parameters

pageinteger

The collection page number

_countinteger

The number of items per page

paginationboolean

Enable or disable pagination

_idstring

ID of the invoice

_lastUpdatedstring datetime

Date the invoice was last updated.

createdstring datetime

Date the invoice was created.

recipientstring

The Recipient of the invoice, can be patient or organization

practitionerstring

Reference to the practitioner or practitioner role for the invoice

practitioner-rolestring

Reference to the practitioner role for the invoice

organizationstring

Filter the clinic to where the invoice was created

statusstring

Reference to the coverage for the invoice

totalPaidstring

The total paid amount of the invoice

totalBalancestring

The balance amount of the invoice

_include'Invoice:recipient' | 'Invoice:practitioner' | 'PractitionerRole:practitioner' | 'PractitionerRole:organization'

The _include parameter can be used to include related search results to reduce overall network delay of repeated retrievals of related resources.

Modifiers

  • _include:iterate = can be used to include related resources based on already included resources.

Response

Invoice collection

status'active' | 'deleted' | 'issued' | 'write-off' | 'pending-confirmation' | 'null' nullable

Status of the invoice

datestring date-time nullable

Date of the invoice

dueDatestring date-time nullable

Due date of the invoice

payorType'organisation' | 'patient' | 'null' nullable

Type of payor billed on the invoice

titlestring nullable

The patient's name as the invoice title

idstring nullable

Logical id of this artifact

resourceTypestring nullable

Resource Type