Invoice Line

The InvoiceLine resource represents a single fee line on a Halaxy invoice, detailing an individual service, product or charge billed to the patient or organization.

Use this API to list all invoice lines or retrieve a specific invoice line to access information such as item descriptions, quantities, pricing and associated invoice IDs.

Endpoints

Endpoint	Operation	Description
`GET` `/main/InvoiceLine`	List InvoiceLines	Retrieve a list or collection of invoice lines
`GET` `/main/InvoiceLine/{id}`	Get InvoiceLine	Retrieve an individual invoice line

Schema

Property	Description
id	`string` The identifier for this invoice line
resource	The fee (service or product) charged on this invoice line description `string` The fee name definitionCanonical `Reference(ChargeItemDefinition)` The fee charged on this invoice line in URL reference format e.g. `"/main/ChargeItemDefinition/1234567"` See also: ChargeItemDefinition
status	`enum` The status of the invoice line `"voided"` `"unassigned"` `"write-off"` `"locked"` `"null"`
code	`string` The fee item number
subject	`Reference(Patient)` The patient who is receiving the fee item `"reference": "/main/Patient/12345678"` `"type": "Patient"` See also: Patient
context	`Reference(Appointment)` The appointment linked to the invoice line `"reference": "/main/Appointment/123456789"` `"type": "Appointment"` See also: Appointment
enteredDate	`date-time` The date the invoice line was created
performer	`Reference(Practitioner)` The practitioner who performed or provided the item on the invoice line `"reference": "/main/Practitioner/PR-1234567"` `"type": "Practitioner"` See also: Practitioner
invoice	`Reference(Invoice)` The invoice that contains this invoice line `"reference": "/main/Invoice/123456789"` `"type": "Invoice"` See also: Invoice
quantity	`number` The quantity of the product or service on the invoice line
unitPriceComponent	`array of objects` The pricing details of the invoice line type `enum` Indicating the kind of price component `"base"` `"surcharge"` `"deduction"` `"discount"` `"tax"` `"informational"` amount value: The value amount for the price component
invoice-line-funder	`HALAXY API EXTENSION` `Reference(Organization)` The funder that the invoice line fee is linked to `"reference": "/main/Organization/FD-123456"` `"type": "Organization"` See also: Organization