Billing (3.0.0)

Invoice

Data for accessing and managing Invoices

Retrieve invoice contents

Retrieve all invoice contents

query Parameters

required	object (Pageable) Pageable parameters
patient-uuid	string <uuid> Example: patient-uuid=C668A5B0-0471-4AD5-B222-71B38A94F4C2
appointment-uuid	string <uuid> Example: appointment-uuid=C668A5B0-0471-4AD5-B222-71B38A94F4C2
billable-uuid	string <uuid> Example: billable-uuid=C668A5B0-0471-4AD5-B222-71B38A94F4C2
item-date-start	string <date-time> Example: item-date-start=2021-07-02T00:00:00.00Z
item-date-end	string <date-time> Example: item-date-end=2021-07-03T00:00:00.00Z
modified-date-start	string <date-time> Example: modified-date-start=2021-07-02T00:00:00.00Z
modified-date-end	string <date-time> Example: modified-date-end=2021-07-03T00:00:00.00Z
location-uuid	string <uuid> Example: location-uuid=E47195E2-23E4-4FF5-B82D-17BB6103F6B6
insurance-claim-ref	integer <int64> Example: insurance-claim-ref=11 When set only items with a matching insurance claim will be returned, -1 for pending, 0 is invalid

Responses

Response Schema: application/json

Array of objects (InvoiceContent)

Array

billable-uuid	string <uuid>
patient-uuid	string <uuid>
billing-uuid	string <uuid>
contact-practitioner-uuid	string <uuid>
practitioner	string
description	string
value-net	number
value-net-4dp	number
value-dispensing-fee-net	number
value-tax	number
value-tax-4dp	number
value-total	number
markup	number
tax-uuid	string <uuid>
quantity	number
item-date	string <date-time>
formulary-uuid	string <uuid>
insurance-claim-ref	integer <int64>
location-uuid	string <uuid>
modified-date	string <date-time>
appointment-uuid	string <uuid>
booked-date	string <date-time>
healthplan-part-of	boolean
healthplan-core-item	boolean
healthplan-subscription-uuid	string <uuid>
healthplan-allowance-usage-uuid	Array of strings <uuid> [ items <uuid > ]
net-discount	number
netnet-discount	number
clinical-history-uuid	Array of strings <uuid> [ items <uuid > ]
invoice-uuid	string <uuid>

Response samples

200
400
500

Content type

application/json

{"results": [{"billable-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"patient-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"billing-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"contact-practitioner-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"practitioner": "E A Gardiner",
"description": "Use in each ear twice a day, before medication",
"value-net": 11.11,
"value-net-4dp": 11.11,
"value-dispensing-fee-net": 11.11,
"value-tax": 11.11,
"value-tax-4dp": 11.11,
"value-total": 11.11,
"markup": 11,
"tax-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"quantity": 11,
"item-date": "2022-01-14T11:32:50Z",
"formulary-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"insurance-claim-ref": 11,
"location-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"modified-date": "2022-01-14T11:32:50Z",
"appointment-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"booked-date": "2022-01-14T11:32:50Z",
"healthplan-part-of": true,
"healthplan-core-item": true,
"healthplan-subscription-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"healthplan-allowance-usage-uuid": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"net-discount": 11.11,
"netnet-discount": 11.11,
"clinical-history-uuid": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"invoice-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF"
}
]
}

Retrieve deleted invoice contents

Retrieve all deleted invoice contents

query Parameters

patient-uuid	string <uuid> Example: patient-uuid=C668A5B0-0471-4AD5-B222-71B38A94F4C2
billable-uuid	string <uuid> Example: billable-uuid=C668A5B0-0471-4AD5-B222-71B38A94F4C2
item-date-start	string <date-time> Example: item-date-start=2021-07-02T00:00:00.00Z
item-date-end	string <date-time> Example: item-date-end=2021-07-03T00:00:00.00Z
deleted-start	string <date-time> Example: deleted-start=2021-07-02T00:00:00.00Z
deleted-end	string <date-time> Example: deleted-end=2021-07-03T00:00:00.00Z
location-uuid	string <uuid> Example: location-uuid=44587DBC-ED46-479B-B87B-07D809C20FFF
required	object (Pageable) Pageable parameters

Responses

Response Schema: application/json

Array of objects (InvoiceContent)

Array

billable-uuid	string <uuid>
patient-uuid	string <uuid>
billing-uuid	string <uuid>
contact-practitioner-uuid	string <uuid>
practitioner	string
description	string
value-net	number
value-net-4dp	number
value-dispensing-fee-net	number
value-tax	number
value-tax-4dp	number
value-total	number
markup	number
tax-uuid	string <uuid>
quantity	number
item-date	string <date-time>
formulary-uuid	string <uuid>
insurance-claim-ref	integer <int64>
location-uuid	string <uuid>
modified-date	string <date-time>
appointment-uuid	string <uuid>
booked-date	string <date-time>
healthplan-part-of	boolean
healthplan-core-item	boolean
healthplan-subscription-uuid	string <uuid>
healthplan-allowance-usage-uuid	Array of strings <uuid> [ items <uuid > ]
net-discount	number
netnet-discount	number
clinical-history-uuid	Array of strings <uuid> [ items <uuid > ]
invoice-uuid	string <uuid>

Response samples

200
400
500

Content type

application/json

{"results": [{"billable-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"patient-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"billing-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"contact-practitioner-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"practitioner": "E A Gardiner",
"description": "Use in each ear twice a day, before medication",
"value-net": 11.11,
"value-net-4dp": 11.11,
"value-dispensing-fee-net": 11.11,
"value-tax": 11.11,
"value-tax-4dp": 11.11,
"value-total": 11.11,
"markup": 11,
"tax-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"quantity": 11,
"item-date": "2022-01-14T11:32:50Z",
"formulary-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"insurance-claim-ref": 11,
"location-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"modified-date": "2022-01-14T11:32:50Z",
"appointment-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"booked-date": "2022-01-14T11:32:50Z",
"healthplan-part-of": true,
"healthplan-core-item": true,
"healthplan-subscription-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"healthplan-allowance-usage-uuid": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"net-discount": 11.11,
"netnet-discount": 11.11,
"clinical-history-uuid": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"invoice-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF"
}
]
}

Retrieve single invoice contents

Retrieve all invoice contents by invoice-uuid

path Parameters

uuid

required

string <uuid>

Example: 018D012A-E5CE-4391-8D42-8396EF19CE83

query Parameters

required	object (Pageable) Pageable parameters
patient-uuid	string <uuid> Example: patient-uuid=C668A5B0-0471-4AD5-B222-71B38A94F4C2
appointment-uuid	string <uuid> Example: appointment-uuid=C668A5B0-0471-4AD5-B222-71B38A94F4C2

Responses

Response Schema: application/json

Array of objects (InvoiceContent)

Array

billable-uuid	string <uuid>
patient-uuid	string <uuid>
billing-uuid	string <uuid>
contact-practitioner-uuid	string <uuid>
practitioner	string
description	string
value-net	number
value-net-4dp	number
value-dispensing-fee-net	number
value-tax	number
value-tax-4dp	number
value-total	number
markup	number
tax-uuid	string <uuid>
quantity	number
item-date	string <date-time>
formulary-uuid	string <uuid>
insurance-claim-ref	integer <int64>
location-uuid	string <uuid>
modified-date	string <date-time>
appointment-uuid	string <uuid>
booked-date	string <date-time>
healthplan-part-of	boolean
healthplan-core-item	boolean
healthplan-subscription-uuid	string <uuid>
healthplan-allowance-usage-uuid	Array of strings <uuid> [ items <uuid > ]
net-discount	number
netnet-discount	number
clinical-history-uuid	Array of strings <uuid> [ items <uuid > ]
invoice-uuid	string <uuid>

Response samples

200
400
500

Content type

application/json

{"results": [{"billable-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"patient-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"billing-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"contact-practitioner-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"practitioner": "E A Gardiner",
"description": "Use in each ear twice a day, before medication",
"value-net": 11.11,
"value-net-4dp": 11.11,
"value-dispensing-fee-net": 11.11,
"value-tax": 11.11,
"value-tax-4dp": 11.11,
"value-total": 11.11,
"markup": 11,
"tax-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"quantity": 11,
"item-date": "2022-01-14T11:32:50Z",
"formulary-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"insurance-claim-ref": 11,
"location-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"modified-date": "2022-01-14T11:32:50Z",
"appointment-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"booked-date": "2022-01-14T11:32:50Z",
"healthplan-part-of": true,
"healthplan-core-item": true,
"healthplan-subscription-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"healthplan-allowance-usage-uuid": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"net-discount": 11.11,
"netnet-discount": 11.11,
"clinical-history-uuid": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"invoice-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF"
}
]
}

Retrieve invoices

Retrieve list of invoices

query Parameters

required	object (Pageable) Pageable parameters
billing-uuid	string <uuid> Example: billing-uuid=4887D81B-F472-4959-94A6-BAD5E54F11F4
invoice-date-start	string <date-time> Example: invoice-date-start=2021-07-02T00:00:00.00Z
invoice-date-end	string <date-time> Example: invoice-date-end=2021-07-03T00:00:00.00Z
booked-date-start	string <date-time> Example: booked-date-start=2021-07-02T00:00:00.00Z
booked-date-end	string <date-time> Example: booked-date-end=2021-07-03T00:00:00.00Z

Responses

Response Schema: application/json

Array of objects (Invoice)

Array

invoice-uuid	string <uuid>
invoice-number	string
invoice-date	string <date-time>
billing-uuid	string <uuid>
modified-date	string <date-time>
booked-date	string <date-time>
gross-total	number
net-total	number
tax-total	number
paid-total	number
gross-insured	number
net-insured	number
tax-insured	number

Response samples

200
400
500

Content type

application/json

{"results": [{"invoice-uuid": "018D012A-E5CE-4391-8D42-8396EF19CE83",
"invoice-number": "90",
"invoice-date": "2022-01-14T11:32:50Z",
"billing-uuid": "018D012A-E5CE-4391-8D42-8396EF19CE83",
"modified-date": "2022-02-14T11:32:50Z",
"booked-date": "2022-01-14T11:32:50Z",
"gross-total": 0,
"net-total": 0,
"tax-total": 0,
"paid-total": 0,
"gross-insured": 0,
"net-insured": 0,
"tax-insured": 0
}
]
}

Create an invoice

Request Body schema: application/json
required

billing-uuid required	string <uuid>
invoice-date	string <date-time> Defaults to the current date if left blank
location-uuid required	string <uuid>
billable-uuids required	Array of strings <uuid> [ items <uuid > ]

Responses

Response Schema: application/json

invoice-uuid

string <uuid>

Request samples

Content type

application/json

{"billing-uuid": "D9A21292-606A-4AE2-9655-BD0B6AA51940",
"invoice-date": "2021-01-07T15:50:00.00Z",
"location-uuid": "D9A21292-606A-4AE2-9655-BD0B6AA51940",
"billable-uuids": ["D9A21292-606A-4AE2-9655-BD0B6AA51940"
]
}

Response samples

201
422
500

Content type

application/json

{"invoice-uuid": "D9A21292-606A-4AE2-9655-BD0B6AA51940"
}

Retrieve invoices for a billing uuid

Retrieve list of invoices for a billing uuid

path Parameters

billing-uuid

required

string <uuid>

Example: 4887D81B-F472-4959-94A6-BAD5E54F11F4

query Parameters

required	object (Pageable) Pageable parameters
invoice-date-start	string <date-time> Example: invoice-date-start=2021-07-02T00:00:00.00Z
invoice-date-end	string <date-time> Example: invoice-date-end=2021-07-03T00:00:00.00Z
booked-date-start	string <date-time> Example: booked-date-start=2021-07-02T00:00:00.00Z
booked-date-end	string <date-time> Example: booked-date-end=2021-07-03T00:00:00.00Z
unpaid-only	boolean Default: false Example: unpaid-only=true

Responses

Response Schema: application/json

Array of objects (Invoice)

Array

invoice-uuid	string <uuid>
invoice-number	string
invoice-date	string <date-time>
billing-uuid	string <uuid>
modified-date	string <date-time>
booked-date	string <date-time>
gross-total	number
net-total	number
tax-total	number
paid-total	number
gross-insured	number
net-insured	number
tax-insured	number

Response samples

200
400
500

Content type

application/json

{"results": [{"invoice-uuid": "018D012A-E5CE-4391-8D42-8396EF19CE83",
"invoice-number": "90",
"invoice-date": "2022-01-14T11:32:50Z",
"billing-uuid": "018D012A-E5CE-4391-8D42-8396EF19CE83",
"modified-date": "2022-02-14T11:32:50Z",
"booked-date": "2022-01-14T11:32:50Z",
"gross-total": 0,
"net-total": 0,
"tax-total": 0,
"paid-total": 0,
"gross-insured": 0,
"net-insured": 0,
"tax-insured": 0
}
]
}

Retrieve Invoice

Retrieve a single invoice

path Parameters

invoice-uuid

required

string <uuid>

Example: C668A5B0-0471-4AD5-B222-71B38A94F4C2

Responses

Response Schema: application/json

invoice-uuid	string <uuid>
invoice-number	string
invoice-date	string <date-time>
billing-uuid	string <uuid>
modified-date	string <date-time>
booked-date	string <date-time>
gross-total	number
net-total	number
tax-total	number
paid-total	number
gross-insured	number
net-insured	number
tax-insured	number

Response samples

200
400
500

Content type

application/json

{"invoice-uuid": "018D012A-E5CE-4391-8D42-8396EF19CE83",
"invoice-number": "90",
"invoice-date": "2022-01-14T11:32:50Z",
"billing-uuid": "018D012A-E5CE-4391-8D42-8396EF19CE83",
"modified-date": "2022-02-14T11:32:50Z",
"booked-date": "2022-01-14T11:32:50Z",
"gross-total": 0,
"net-total": 0,
"tax-total": 0,
"paid-total": 0,
"gross-insured": 0,
"net-insured": 0,
"tax-insured": 0
}

Payment

Data for accessing and managing Payments

Retrieve payment methods

Retrieve a list of payment method objects

query Parameters

required	object (Pageable) Pageable parameters
show-hidden	boolean Default: false Example: show-hidden=true

Responses

Response Schema: application/json

Array of objects (PaymentMethod)

Array

payment-method-uuid	string <uuid>
name	string
description	string
takings-document-required	boolean
reason-value	number
iref-required	boolean
hidden	boolean
system-defined	boolean

Response samples

200
400
500

Content type

application/json

{"results": [{"payment-method-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"name": "CreditCard",
"description": "Credit Card",
"takings-document-required": false,
"reason-value": 5,
"iref-required": true,
"hidden": false,
"system-defined": true
}
]
}

Create a payment method

Request Body schema: application/json
required

name required	string [ 1 .. 100 ] characters
description required	string [ 1 .. 200 ] characters
image	string [ 1 .. 200 ] characters
takings-document-required	boolean
reason-value	number [ 1 .. 999999 ]
iref-required	boolean
hidden	boolean

Responses

Response Schema: application/json

payment-method-uuid

string <uuid>

Request samples

Content type

application/json

{"name": "Payment Link",
"description": "Payment link description",
"image": "path of the image",
"takings-document-required": false,
"reason-value": 1,
"iref-required": false,
"hidden": false
}

Response samples

201
400
422
500

Content type

application/json

{"payment-method-uuid": "D9A21292-606A-4AE2-9655-BD0B6AA51940"
}

Retrieve a payment method

Retrieve a payment method object from its id

path Parameters

payment-method-uuid

required

string <uuid>

Example: C668A5B0-0471-4AD5-B222-71B38A94F4C2

Responses

Response Schema: application/json

payment-method-uuid	string <uuid>
name	string
description	string
takings-document-required	boolean
reason-value	number
iref-required	boolean
hidden	boolean
system-defined	boolean

Response samples

200
400
404
500

Content type

application/json

{"payment-method-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"name": "CreditCard",
"description": "Credit Card",
"takings-document-required": false,
"reason-value": 5,
"iref-required": true,
"hidden": false,
"system-defined": true
}

Return a summary total of payments between specified dates.

Retrieve a payment summary object

query Parameters

embed-payment-totals	boolean Default: false Example: embed-payment-totals=true
embed-donation-totals	boolean Default: false Example: embed-donation-totals=true
receipt-date-start	string <date-time> Example: receipt-date-start=2021-07-02T00:00:00.00Z
receipt-date-end	string <date-time> Example: receipt-date-end=2021-07-03T00:00:00.00Z
booked-date-start	string <date-time> Example: booked-date-start=2021-07-02T00:00:00.00Z
booked-date-end	string <date-time> Example: booked-date-end=2021-07-03T00:00:00.00Z
location-uuid	string <uuid> Example: location-uuid=C668A5B0-0471-4AD5-B222-71B38A94F4C2
location-account-code	string Example: location-account-code=MP18164

Responses

Response Schema: application/json

	Array of objects (PaymentSummarySubTotal)
	Array of objects (PaymentSummaryGrandTotal)

Response samples

200
400
500

Content type

application/json

{"sub-totals": [{"payment-method-name": "Credit card",
"payment-method-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"total": 37.55
}
],
"grand-totals": [{"total-type": "Donation Total",
"total": 37.55
}
]
}

Retrieve payments

Retrieve a list of payment objects

query Parameters

required	object (Pageable) Pageable parameters
embed-allocation	boolean Default: false Example: embed-allocation=true
billing-uuid	string <uuid> Example: billing-uuid=018D012A-E5CE-4391-8D42-8396EF19CE83
payment-method-uuid	string <uuid> Example: payment-method-uuid=C668A5B0-0471-4AD5-B222-71B38A94F4C2
receipt-date-start	string <date-time> Example: receipt-date-start=2021-07-02T00:00:00.00Z
receipt-date-end	string <date-time> Example: receipt-date-end=2021-07-03T00:00:00.00Z
booked-date-start	string <date-time> Example: booked-date-start=2021-07-02T00:00:00.00Z
booked-date-end	string <date-time> Example: booked-date-end=2021-07-03T00:00:00.00Z
modified-date-start	string <date-time> Example: modified-date-start=2021-07-02T00:00:00.00Z
modified-date-end	string <date-time> Example: modified-date-end=2021-07-03T00:00:00.00Z
location-uuid	string <uuid> Example: location-uuid=95C2EBA0-73A5-4F8F-BFBF-05F47468F8EA

Responses

Response Schema: application/json

Array of objects (Payment)

Array

payment-uuid	string <uuid>
billing-uuid	string <uuid>
description	string
location-uuid	string <uuid>
receipt-date	string <date-time>
booked-date	string <date-time>
payment-method-uuid	string <uuid>
amount-paid	number
amount-returned	number
modified-date	string <date-time>
user-initials	string
legal-entity-uuid	string <uuid>
donation-type-uuid	string <uuid>
	Array of objects (PaymentInvoice)
	Array of objects (PaymentRefund)

Response samples

200
400
500

Content type

application/json

{"results": [{"payment-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"billing-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"description": "Credit Card",
"location-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"receipt-date": "2022-01-14T11:32:50Z",
"booked-date": "2022-01-14T11:32:50Z",
"payment-method-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"amount-paid": 11.11,
"amount-returned": 11.11,
"modified-date": "2022-01-14T11:32:50Z",
"user-initials": "some user initials",
"legal-entity-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"donation-type-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"invoices": [{"amount-allocated": 50.55,
"invoice-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"invoice-number": "90",
"allocated-date": "2022-01-14"
}
],
"refunds": [{"amount-allocated": 37.55,
"refund-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"refund-date": "2022-01-14"
}
]
}
]
}

Create a payment

Request Body schema: application/json
required

billing-uuid required	string <uuid>
payment-type required	string (PaymentType) Enum: "Payment" "Donation" "Deposit"
payment-method-uuid required	string <uuid>
donation-type-uuid	string <uuid>
receipt-date required	string <date-time>
value required	number
note	string
user-initials	string
location-uuid required	string <uuid>
legal-entity-uuid	string <uuid>
invoice-allocation	Array of strings <uuid> [ items <uuid > ]
operator	string <= 100 characters

Responses

Response Schema: application/json

payment-uuid

string <uuid>

Request samples

Content type

application/json

{"billing-uuid": "AFB24BB1-D9A0-46FC-9D83-D75649B8A133",
"payment-type": "Payment",
"payment-method-uuid": "b7744f6c-baed-4ca5-918d-a8e847b9dd83",
"donation-type-uuid": "30db5a4e-342e-4c26-a0e6-9b751d484baf",
"receipt-date": "2021-01-07T15:50:00.00Z",
"value": 11.11,
"note": "note",
"user-initials": "az",
"location-uuid": "D9A21292-606A-4AE2-9655-BD0B6AA51940",
"legal-entity-uuid": "b1e91845-ab0e-45e7-b0c9-2fd2a6bf1985",
"invoice-allocation": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"operator": "operator"
}

Response samples

201
400
422
500

Content type

application/json

{"payment-uuid": "3B0A1726-3D39-49EB-AA12-4207662481FB"
}

Retrieve a payment

Retrieve a payment object from its id

path Parameters

payment-uuid

required

string <uuid>

Example: C668A5B0-0471-4AD5-B222-71B38A94F4C2

query Parameters

embed-allocation

boolean

Example: embed-allocation=true

Responses

Response Schema: application/json

payment-uuid	string <uuid>
billing-uuid	string <uuid>
description	string
location-uuid	string <uuid>
receipt-date	string <date-time>
booked-date	string <date-time>
payment-method-uuid	string <uuid>
amount-paid	number
amount-returned	number
modified-date	string <date-time>
user-initials	string
legal-entity-uuid	string <uuid>
donation-type-uuid	string <uuid>
	Array of objects (PaymentInvoice)
	Array of objects (PaymentRefund)

Response samples

200
400
404
500

Content type

application/json

{"payment-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"billing-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"description": "Credit Card",
"location-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"receipt-date": "2022-01-14T11:32:50Z",
"booked-date": "2022-01-14T11:32:50Z",
"payment-method-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"amount-paid": 11.11,
"amount-returned": 11.11,
"modified-date": "2022-01-14T11:32:50Z",
"user-initials": "some user initials",
"legal-entity-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"donation-type-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"invoices": [{"amount-allocated": 50.55,
"invoice-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"invoice-number": "90",
"allocated-date": "2022-01-14"
}
],
"refunds": [{"amount-allocated": 37.55,
"refund-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"refund-date": "2022-01-14"
}
]
}

Donation

Data for accessing and managing Donations

Retrieve Donation Types

Retrieve a list of donation types

query Parameters

required

object (Pageable)

Pageable parameters

Responses

Response Schema: application/json

Array of objects (DonationType)

Array

donation-type-uuid	string <uuid>
name	string
description	string
view-order	integer <int32>

Response samples

200
400
500

Content type

application/json

{"results": [{"donation-type-uuid": "018D012A-E5CE-4391-8D42-8396EF19CE83",
"name": "some name",
"description": "some description",
"view-order": 0
}
]
}

Retrieve Donation Type

Retrieve a single Donation Type

path Parameters

donation-type-uuid

required

string <uuid>

Example: 018D012A-E5CE-4391-8D42-8396EF19CE83

Responses

Response Schema: application/json

donation-type-uuid	string <uuid>
name	string
description	string
view-order	integer <int32>

Response samples

200
400
500

Content type

application/json

{"donation-type-uuid": "018D012A-E5CE-4391-8D42-8396EF19CE83",
"name": "some name",
"description": "some description",
"view-order": 0
}

Draft invoice

Data for accessing and managing Draft invoices

Retrieve draft invoices

Retrieve a list of draft invoice objects

query Parameters

required	object (Pageable) Pageable parameters
billing-uuid	string <uuid> Example: billing-uuid=C668A5B0-0471-4AD5-B222-71B38A94F4C2
patient-uuid	string <uuid> Example: patient-uuid=C668A5B0-0471-4AD5-B222-71B38A94F4C2
appointment-uuid	string <uuid> Example: appointment-uuid=C668A5B0-0471-4AD5-B222-71B38A94F4C2
billable-uuid	string <uuid> Example: billable-uuid=C668A5B0-0471-4AD5-B222-71B38A94F4C2
item-date-start	string <date-time> Example: item-date-start=2021-07-02T00:00:00.00Z
item-date-end	string <date-time> Example: item-date-end=2021-07-03T00:00:00.00Z
booked-date-start	string <date-time> Example: booked-date-start=2021-07-02T00:00:00.00Z
booked-date-end	string <date-time> Example: booked-date-end=2021-07-03T00:00:00.00Z

Responses

Response Schema: application/json

Array of objects (DraftInvoice)

Array

billable-uuid	string <uuid>
patient-uuid	string <uuid>
billing-uuid	string <uuid>
contact-practitioner-uuid	string <uuid>
practitioner	string
description	string
value-net	number
value-net-4dp	number
value-dispensing-fee-net	number
value-tax	number
value-tax-4dp	number
value-total	number
markup	number
tax-uuid	string <uuid>
quantity	number
item-date	string <date-time>
formulary-uuid	string <uuid>
insurance-claim-ref	integer <int64>
location-uuid	string <uuid>
modified-date	string <date-time>
appointment-uuid	string <uuid>
booked-date	string <date-time>
healthplan-part-of	boolean
healthplan-core-item	boolean
healthplan-subscription-uuid	string <uuid>
healthplan-allowance-usage-uuid	Array of strings <uuid> [ items <uuid > ]
net-discount	number
netnet-discount	number
clinical-history-uuid	Array of strings <uuid> [ items <uuid > ]

Response samples

200
400
500

Content type

application/json

{"results": [{"billable-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"patient-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"billing-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"contact-practitioner-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"practitioner": "E A Gardiner",
"description": "Use in each ear twice a day, before medication",
"value-net": 11.11,
"value-net-4dp": 11.11,
"value-dispensing-fee-net": 11.11,
"value-tax": 11.11,
"value-tax-4dp": 11.11,
"value-total": 11.11,
"markup": 11,
"tax-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"quantity": 11,
"item-date": "2022-01-14T11:32:50Z",
"formulary-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"insurance-claim-ref": 11,
"location-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"modified-date": "2022-01-14T11:32:50Z",
"appointment-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"booked-date": "2022-01-14T11:32:50Z",
"healthplan-part-of": true,
"healthplan-core-item": true,
"healthplan-subscription-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"healthplan-allowance-usage-uuid": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"net-discount": 11.11,
"netnet-discount": 11.11,
"clinical-history-uuid": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
]
}

Taxes

Data for accessing and managing Taxes

Retrieve taxes

Retrieve a list of taxes objects

query Parameters

	object (Pageable) Pageable parameters
tax-point-date	string <date> Example: tax-point-date=2017-06-09

Responses

Response Schema: application/json

Array of objects (Tax)

Array

tax-uuid	string <uuid>
name	string
description	string
tax-percentage	number
tax-point-date	string <date>

Response samples

200
400
500

Content type

application/json

{"results": [{"tax-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"name": "tax name",
"description": "this is tax",
"tax-percentage": 5,
"tax-point-date": "2017-07-01"
}
]
}

Billing

Data for accessing and managing Billings

Retrieve billing identifiers

Retrieve a list of billing identifiers

query Parameters

	object (Pageable) Pageable parameters
account-uuid	string <uuid> Example: account-uuid=018D012A-E5CE-4391-8D42-8396EF19CE83

Responses

Response Schema: application/json

Array of objects (BillingIdentifiers)

Array

account-uuid	string <uuid>
billing-uuid	string <uuid>

Response samples

200
400
500

Content type

application/json

{"results": [{"account-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"billing-uuid": "AFB24BB1-D9A0-46FC-9D83-D75649B8A133"
}
]
}

Retrieve billing identifiers

Retrieve a single billing identifier

path Parameters

billing-uuid

required

string <uuid>

Example: 018D012A-E5CE-4391-8D42-8396EF19CE83

Responses

Response Schema: application/json

account-uuid	string <uuid>
billing-uuid	string <uuid>

Response samples

200
400
500

Content type

application/json

{"account-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"billing-uuid": "AFB24BB1-D9A0-46FC-9D83-D75649B8A133"
}

Retrieve balance

Retrieve the balance for the specified billing account

path Parameters

billing-uuid

required

string <uuid>

Example: FBE03E40-DA25-47E3-A939-6DE85A267F06

Responses

Response Schema: application/json

invoiced-balance	number
timestamp	string <date-time>

Response samples

200
400
404
500

Content type

application/json

{"invoiced-balance": 163.45,
"timestamp": "2022-06-14T13:45:26Z"
}

Discount

Data for accessing and managing Discounts

Retrieve discount categories

Retrieve a list of discount categories objects

query Parameters

required

object (Pageable)

Pageable parameters

Responses

Response Schema: application/json

Array of objects (DiscountCategory)

Array

discount-category-uuid	string <uuid>
name	string
description	string
eligibility-expired-discount-uuid	string <uuid>
eligibility-is-eligible	boolean

Response samples

200
400
500

Content type

application/json

{"results": [{"discount-category-uuid": "018D012A-E5CE-4391-8D42-8396EF19CE83",
"name": "Patient Discount Category",
"description": "Description of Patient Discount Category",
"eligibility-expired-discount-uuid": "018D012A-E5CE-4391-8D42-8396EF19CE83",
"eligibility-is-eligible": false
}
]
}

Retrieve a discount category

Retrieve a discount category object by its uuid

path Parameters

uuid

required

string <uuid>

Example: C668A5B0-0471-4AD5-B222-71B38A94F4C2

Responses

Response Schema: application/json

discount-category-uuid	string <uuid>
name	string
description	string
eligibility-expired-discount-uuid	string <uuid>
eligibility-is-eligible	boolean

Response samples

200
400
404
500

Content type

application/json

{"discount-category-uuid": "018D012A-E5CE-4391-8D42-8396EF19CE83",
"name": "Patient Discount Category",
"description": "Description of Patient Discount Category",
"eligibility-expired-discount-uuid": "018D012A-E5CE-4391-8D42-8396EF19CE83",
"eligibility-is-eligible": false
}

Subscription

Data for accessing and managing Subscriptions

Retrieve subscriptions

Retrieve list of subscriptions

query Parameters

required	object (Pageable) Pageable parameters
account-uuid	string <uuid> Example: account-uuid=4887D81B-F472-4959-94A6-BAD5E54F11F4
patient-uuid	string <uuid> Example: patient-uuid=4887D81B-F472-4959-94A6-BAD5E54F11F4
subscription-uuid	string <uuid> Example: subscription-uuid=4887D81B-F472-4959-94A6-BAD5E54F11F4
joined-date-start	string <date-time> Example: joined-date-start=2021-07-02T00:00:00.00Z
joined-date-end	string <date-time> Example: joined-date-end=2021-07-03T00:00:00.00Z
left-date-start	string <date-time> Example: left-date-start=2021-07-02T00:00:00.00Z
left-date-end	string <date-time> Example: left-date-end=2021-07-03T00:00:00.00Z
renewal-date-start	string <date-time> Example: renewal-date-start=2021-07-02T00:00:00.00Z
renewal-date-end	string <date-time> Example: renewal-date-end=2021-07-03T00:00:00.00Z
modified-start	string <date-time> Example: modified-start=2021-07-02T00:00:00.00Z
modified-end	string <date-time> Example: modified-end=2021-07-03T00:00:00.00Z

Responses

Response Schema: application/json

Array of objects (Subscription)

Array

patient-uuid	string <uuid>
account-uuid	string <uuid>
subscription-uuid	string <uuid>
plan-uuid	string <uuid>
date-joined-plan	string <date-time>
date-left-plan	string <date-time>
first-payment-date	string <date-time>
renewal-date	string <date-time>
status-renewal-due	boolean
status-subscription-started	boolean
status-subscription-closed	boolean
modified-date	string <date-time>

Response samples

200
400
500

Content type

application/json

{"results": [{"patient-uuid": "018D012A-E5CE-4391-8D42-8396EF19CE83",
"account-uuid": "018D012A-E5CE-4391-8D42-8396EF19CE83",
"subscription-uuid": "018D012A-E5CE-4391-8D42-8396EF19CE83",
"plan-uuid": "018D012A-E5CE-4391-8D42-8396EF19CE83",
"date-joined-plan": "2022-01-14T11:32:50Z",
"date-left-plan": "2022-01-14T11:32:50Z",
"first-payment-date": "2022-01-14T11:32:50Z",
"renewal-date": "2022-01-14T11:32:50Z",
"status-renewal-due": true,
"status-subscription-started": true,
"status-subscription-closed": true,
"modified-date": "2022-01-14T11:32:50Z"
}
]
}

Create a subscription

Request Body schema: application/json
required

patient-uuid required	string <uuid>
account-uuid required	string <uuid>
date-joined-plan required	string <date-time>
plan-uuid required	string <uuid>
location-uuid required	string <uuid>

Responses

Response Schema: application/json

subscription-uuid

string <uuid>

Request samples

Content type

application/json

{"patient-uuid": "AFB24BB1-D9A0-46FC-9D83-D75649B8A133",
"account-uuid": "b7744f6c-baed-4ca5-918d-a8e847b9dd83",
"date-joined-plan": "2023-01-07T15:50:00.00Z",
"plan-uuid": "30db5a4e-342e-4c26-a0e6-9b751d484baf",
"location-uuid": "D9A21292-606A-4AE2-9655-BD0B6AA51940"
}

Response samples

201
400
422
500

Content type

application/json

{"subscription-uuid": "D9A21292-606A-4AE2-9655-BD0B6AA51940"
}

Retrieve entitlements

Retrieve the entitlements for the specified subscription account

path Parameters

subscription-uuid

required

string <uuid>

Example: c5318732-aec6-4e1c-87fa-08ca04c5decf

Responses

Response Schema: application/json

Array of objects (SubscriptionEntitlement)

Array

entitlement-content-uuid	string <uuid>
plan-content-uuid	string <uuid>
plan-group-uuid	string <uuid>
quantity-used	number

Response samples

200
400
404
500

Content type

application/json

{"results": [{"entitlement-content-uuid": "018D012A-E5CE-4391-8D42-8396EF19CE83",
"plan-content-uuid": "018D012A-E5CE-4391-8D42-8396EF19CE83",
"plan-group-uuid": "018D012A-E5CE-4391-8D42-8396EF19CE83",
"quantity-used": 10
}
]
}

Refund

Data for accessing and managing Refunds

Create a refund for a payment

Create a refund for an existing payment

Request Body schema: application/json
required

payment-uuid required	string <uuid>
location-uuid required	string <uuid>
refund-date	string <date-time> Defaults to the current date if left blank
operator	string <= 100 characters

Responses

Request samples

Content type

application/json

{"payment-uuid": "018D012A-E5CE-4391-8D42-8396EF19CE83",
"location-uuid": "018D012A-E5CE-4391-8D42-8396EF19CE83",
"refund-date": "2025-06-13T17:35:49Z",
"operator": "user1"
}

Response samples

400
422
500

Content type

application/json

{"messages": ["string"
]
}

Create a refund for a monetary amount

Create a refund for a specified monetary amount

Request Body schema: application/json
required

billing-uuid required	string <uuid>
location-uuid required	string <uuid>
refund-date	string <date-time> Defaults to the current date if left blank
refund-payment-method-uuid required	string <uuid> The payment method of the refund
refund-amount required	number > 0
tax-uuid required	string <uuid>
description	string <= 100 characters
operator	string <= 100 characters

Responses

Request samples

Content type

application/json

{"billing-uuid": "EB8E5C2C-E27C-4450-91BD-F88972B81591",
"location-uuid": "6A447413-5437-49AE-AC7A-6F63B73850D0",
"refund-date": "2025-06-13T17:35:49Z",
"refund-payment-method-uuid": "85B03FFB-9CA9-4DB1-87E9-657E272E70D6",
"refund-amount": 65.99,
"tax-uuid": "40A4AF26-43F7-4F74-B53C-8C2875DA433E",
"description": "Refund for overpayment",
"operator": "user1"
}

Response samples

400
422
500

Content type

application/json

{"messages": ["string"
]
}

Insurance

Data for accessing and managing Insurance Claims

Retrieve insurance claims

Retrieve the insurance claims for a specified patient

path Parameters

patient-uuid

required

string <uuid>

Example: c5318732-aec6-4e1c-87fa-08ca04c5decf

query Parameters

insurance-claim-ref

integer <int64>

Example: insurance-claim-ref=3

When set only items with a matching insurance claim will be returned, -1 for pending, 0 is invalid

Responses

Response Schema: application/json

account-uuid	string <uuid>
billing-uuid	string <uuid>
patient-uuid	string <uuid>
patient-name	string
	Array of objects (InsuranceClaimItem)

Response samples

200
400
404
500

Content type

application/json

{"account-uuid": "34124BB1-D9A0-46FC-9D83-D75649B8A1FF",
"billing-uuid": "AFB24BB1-D9A0-46FC-9D83-D75649B8A133",
"patient-uuid": "83C90126-C565-11F0-860B-465D73579FA5",
"patient-name": "Fido",
"insurance-claim-items": [{"record-uuid": "4BA2580E-C55D-11F0-B6C0-465D73579FA5",
"item-date": "2022-01-14T11:32:50Z",
"transaction-date": "2023-02-14T11:32:50Z",
"invoice-uuid": "AFB24BB1-D9A0-46FC-9D83-D75649B8A133",
"description": "Anaesthetic Gas Isoflo p/min",
"quantity": 11,
"value-net": 11.11,
"value-tax": 23.6,
"value-total": 57.21,
"insurance-claim-ref": 3,
"formulary-type": "Vaccine"
}
]
}

Billing (3.0.0)

Invoice

Retrieve invoice contents

query Parameters

Responses

Response Schema: application/json

Response samples

Retrieve deleted invoice contents

query Parameters

Responses

Response Schema: application/json

Response samples

Retrieve single invoice contents

path Parameters

query Parameters

Responses

Response Schema: application/json

Response samples

Retrieve invoices

query Parameters

Responses

Response Schema: application/json

Response samples

Create an invoice

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Retrieve invoices for a billing uuid

path Parameters

query Parameters

Responses

Response Schema: application/json

Response samples

Retrieve Invoice

path Parameters

Responses

Response Schema: application/json

Response samples

Payment

Retrieve payment methods

query Parameters

Responses

Response Schema: application/json

Response samples

Create a payment method

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Retrieve a payment method

path Parameters

Responses

Response Schema: application/json

Response samples

Return a summary total of payments between specified dates.

query Parameters

Responses

Response Schema: application/json

Response samples

Retrieve payments

query Parameters

Responses

Response Schema: application/json

Response samples

Create a payment

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Retrieve a payment

path Parameters

query Parameters

Responses

Response Schema: application/json

Response samples

Donation

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required