Invoice

The Invoice resource represents Halaxy invoices, a financial document issued by a healthcare provider to a patient or organization indicating the goods and services provided with their quantities and prices

Through this resource API, you can list all invoices or retrieve a specific invoice to access billing information, service details, outstanding balances and more.

Endpoints

Endpoint	Operation	Description
`GET` `/main/Invoice`	List Invoices	Retrieves a list or collection of invoices in a practice group
`GET` `/main/Invoice/{id}`	Get Invoice	Retrieves an individual invoice

Schema

Property	Description
id	`string` The invoice number
recipient	`array of objects` The individual or organization billed on this invoice (patient or organization) If patient `"recipient": "/main/Patient/12345678"` `"type": "Patient"` If organization `"recipient": "/main/Organization/123456789"` `"type": "Organization"` See also: Patient, Organization
status	`string` defaults to active e.g. `"active"` `"issued"` `"write-off"`
date	`date` The invoice issue date
payorType	`string` Type of payor - `"patient"` or `"organization"`
title	`string` The patient's name as the invoice title
type	`string` The kind of invoice document - e.g. `"invoice"` `"quote"`
practitioner	`array of objects` The identifier for both the practitioner and clinic location this invoice is assigned to (i.e. PractitionerRole) `"reference": "/main/PractitionerRole/PR-1234567"` `"type": "PractitionerRole"`
note	Additional comments in the Notes section of the invoice (may contain html elements) `"text": "<p>Please transfer payment within 7 days of appointment.</p>"`
totalNet	The total amount on the invoices without taxes
totalGross	The total amount on the invoice with taxes
totalBalance	The total unpaid amount on the invoice
totalTax	The total tax amount on the invoice
totalPaid	The total paid amount on the invoice