Get started
API Reference
- Patient
- Contact
- Service
- Location
- Practitioner
- Appointment
- Support activity
- Support item
- Invoice
- Payment method
- Waitlist
- Screener
- Patient form
- Case
- Availability
- Payment
- Custom field
Invoice
Get a single invoice
Get invoice data by id
Copy
curl --request GET \
--url https://api.splose.com/v1/invoices/{id} \
--header 'Authorization: Bearer <token>'
Copy
{
"id": 1,
"invoiceNumber": "INV-0001",
"issueDate": "2023-07-30T09:00:00.000Z",
"dueDate": "2023-07-30T09:00:00.000Z",
"patientId": 1,
"contactId": 1,
"locationId": 1,
"practitionerId": 1,
"extraBillingInfo": "Some extra info",
"subtotal": 193.99,
"taxStatus": "excluding",
"tax": 0,
"total": 193.99,
"paidAmount": 193.99,
"status": "Paid",
"invoiceItems": [
{
"id": 1,
"type": "appointment",
"typeId": 1,
"code": 1234567,
"description": "Wed 30 Aug 2023, 09:00am - Initial Assessment",
"unitPrice": 193.99,
"quantity": 0.5,
"discount": "$20.00",
"taxType": "STANDARD",
"taxRate": 10
}
],
"paymentIds": [
1
],
"referenceNumbers": [
"Medicare: 12345678"
],
"isArchived": false,
"reference": "Some references",
"description": "Some description",
"createdAt": "2023-07-30T09:00:00.000Z",
"updatedAt": "2023-07-30T09:00:00.000Z"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Required range:
x > 0
Example:
1
Response
200 - application/json
Object with invoice data.
The response is of type object
.
Copy
curl --request GET \
--url https://api.splose.com/v1/invoices/{id} \
--header 'Authorization: Bearer <token>'
Copy
{
"id": 1,
"invoiceNumber": "INV-0001",
"issueDate": "2023-07-30T09:00:00.000Z",
"dueDate": "2023-07-30T09:00:00.000Z",
"patientId": 1,
"contactId": 1,
"locationId": 1,
"practitionerId": 1,
"extraBillingInfo": "Some extra info",
"subtotal": 193.99,
"taxStatus": "excluding",
"tax": 0,
"total": 193.99,
"paidAmount": 193.99,
"status": "Paid",
"invoiceItems": [
{
"id": 1,
"type": "appointment",
"typeId": 1,
"code": 1234567,
"description": "Wed 30 Aug 2023, 09:00am - Initial Assessment",
"unitPrice": 193.99,
"quantity": 0.5,
"discount": "$20.00",
"taxType": "STANDARD",
"taxRate": 10
}
],
"paymentIds": [
1
],
"referenceNumbers": [
"Medicare: 12345678"
],
"isArchived": false,
"reference": "Some references",
"description": "Some description",
"createdAt": "2023-07-30T09:00:00.000Z",
"updatedAt": "2023-07-30T09:00:00.000Z"
}
Assistant
Responses are generated using AI and may contain mistakes.