List Invoices

get

https://au-api.halaxy.com/main/Invoice

Retrieves a collection of invoices in a practice group

Query Params

page

integer

Defaults to 1

The collection page number

_count

integer

≥ 0

Defaults to 30

The number of items per page

pagination

boolean

Enable or disable pagination

_id

string

ID of the invoice

_lastUpdated

string

Date the invoice was last updated.

created

string

Date the invoice was created.

recipient

string

The Recipient of the invoice, can be patient or organization

practitioner

string

Reference to the practitioner or practitioner role for the invoice

practitioner-role

string

Reference to the practitioner role for the invoice

organization

string

Filter the clinic to where the invoice was created

status

string

Reference to the coverage for the invoice

totalPaid

string

The total paid amount of the invoice

totalBalance

string

The balance amount of the invoice

_include

string

enum

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.

Allowed:

Headers

string

enum

Defaults to application/fhir+json

Generated from available response content types

Allowed:

Responses

403

Forbidden

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/fhir+json

application/json

200Invoice collection