v2
latestOpenAPI 3.0.32026-08-07222102695.9 KBInvoice
List invoices for appointment
get/appointments/{appointment_id}/invoices
Path parameters
appointment_idstring int64 required
Query parameters
pageinteger
per_pageinteger
sortstring[]
Comma separated search fields. See: Ordering
[ "created_at:desc" ]
order'asc' | 'desc'
q[]string[]
Filter result by one or more fields.
See Filtering Results
Available filters:
| Value | Format |
|---|---|
| archived_at | date-time |
| attendee_id | int64 |
| business_id | int64 |
| closed_at | date-time |
| created_at | date-time |
| deleted_at | date-time |
| id | int64 |
| issue_date | date |
| number | integer |
| original_invoice_id | int64 |
| patient_id | int64 |
| practitioner_id | int64 |
| status | integer |
| updated_at | date-time |
Response
successful operation
Example response
{
"invoices": [
{
"appointment": {
"links": {
"self": "https://api.au1.cliniko.com/v1/appointments/1"
}
},
"attendee": {
"links": {
"self": "https://api.au1.cliniko.com/v1/attendees/1"
}
},
"business": {
"links": {
"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"invoice_items": {
"links": {
"self": "https://api.au1.cliniko.com/v1/invoices/1/invoice_items"
}
},
"links": {
"self": "https://api.au1.cliniko.com/v1/invoices/1"
},
"original_invoice": {
"links": {
"self": "https://api.au1.cliniko.com/v1/invoices/1"
}
},
"patient": {
"links": {
"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"practitioner": {
"links": {
"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"reversed_invoices": {
"links": {
"self": "https://api.au1.cliniko.com/v1/invoices?q%5B%5D=invoice_id%3A%3D1"
}
},
"signature": {
"links": {
"self": "https://api.au1.cliniko.com/v1/signatures/1"
}
}
}
],
"total_entries": 1,
"links": {
"self": "https://api.au1.cliniko.com/v1/appointments/1/invoices?page=2",
"previous": "https://api.au1.cliniko.com/v1/appointments/1/invoices?page=1",
"next": "https://api.au1.cliniko.com/v1/appointments/1/invoices?page=3"
}
}