Invoice

object

archived_at

string or null <date-time>

object

closed_at

string or null <date-time>

created_at

string <date-time>

deleted_at

string or null <date-time>

discounted_amount

string or null <decimal>

string <int64>

object

invoice_to

string or null

issue_date

string <date>

object

net_amount

string or null <decimal>

notes

string or null

number

integer

online_payment_url

string or null <uri>

object

patient_extra_information

string or null

object

status

integer or null

Enum Value	Description
10	Open
20	Paid
30	Closed
40	Open credit

Enum: 10 20 30 40

status_description

string or null

Enum: "Open" "Paid" "Closed" "Open credit"

tax_amount

string or null <decimal>

total_amount

string or null <decimal>

updated_at

string <date-time>

{"appointment": {"links": {"self": "https://api.au1.cliniko.com/v1/appointments/1"
}
},
"archived_at": "2019-08-24T14:15:22Z",
"business": {"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"closed_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"discounted_amount": "string",
"id": "string",
"invoice_items": {"links": {"self": "https://api.au1.cliniko.com/v1/invoices/1/invoice_items"
}
},
"invoice_to": "string",
"issue_date": "2019-08-24",
"links": {"self": "https://api.au1.cliniko.com/v1/invoices/1"
},
"net_amount": "string",
"notes": "string",
"number": 0,
"online_payment_url": "http://example.com",
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"patient_extra_information": "string",
"practitioner": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"status": 10,
"status_description": "Open",
"tax_amount": "string",
"total_amount": "string",
"updated_at": "2019-08-24T14:15:22Z"
}

List invoices

get/invoices

SecuritybasicAuth

Request

query Parameters

order

string

Deprecated

Enum: "asc" "desc"

page

integer

per_page

integer [ 1 .. 100 ]

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
appointment_id	int64
archived_at	date-time
business_id	int64
created_at	date-time
deleted_at	date-time
id	int64
issue_date	date
number	integer
patient_id	int64
practitioner_id	int64
status	integer
updated_at	date-time

sort

Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc

Responses

200

successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"invoices": [{"appointment": {"links": {"self": "https://api.au1.cliniko.com/v1/appointments/1"
}
},
"archived_at": "2019-08-24T14:15:22Z",
"business": {"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"closed_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"discounted_amount": "string",
"id": "string",
"invoice_items": {"links": {"self": "https://api.au1.cliniko.com/v1/invoices/1/invoice_items"
}
},
"invoice_to": "string",
"issue_date": "2019-08-24",
"links": {"self": "https://api.au1.cliniko.com/v1/invoices/1"
},
"net_amount": "string",
"notes": "string",
"number": 0,
"online_payment_url": "http://example.com",
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"patient_extra_information": "string",
"practitioner": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"status": 10,
"status_description": "Open",
"tax_amount": "string",
"total_amount": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/invoices?page=2",
"previous": "https://api.au1.cliniko.com/v1/invoices?page=1",
"next": "https://api.au1.cliniko.com/v1/invoices?page=3"
}
}

Get invoice

get/invoices/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

query Parameters

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
archived_at	date-time
deleted_at	date-time

Responses

200

Successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"appointment": {"links": {"self": "https://api.au1.cliniko.com/v1/appointments/1"
}
},
"archived_at": "2019-08-24T14:15:22Z",
"business": {"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"closed_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"discounted_amount": "string",
"id": "string",
"invoice_items": {"links": {"self": "https://api.au1.cliniko.com/v1/invoices/1/invoice_items"
}
},
"invoice_to": "string",
"issue_date": "2019-08-24",
"links": {"self": "https://api.au1.cliniko.com/v1/invoices/1"
},
"net_amount": "string",
"notes": "string",
"number": 0,
"online_payment_url": "http://example.com",
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"patient_extra_information": "string",
"practitioner": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"status": 10,
"status_description": "Open",
"tax_amount": "string",
"total_amount": "string",
"updated_at": "2019-08-24T14:15:22Z"
}

List invoices for appointment

get/appointments/{appointment_id}/invoices

SecuritybasicAuth

Request

path Parameters

appointment_id

required

string <int64>

query Parameters

order

string

Deprecated

Enum: "asc" "desc"

page

integer

per_page

integer [ 1 .. 100 ]

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
archived_at	date-time
business_id	int64
created_at	date-time
deleted_at	date-time
id	int64
issue_date	date
number	integer
patient_id	int64
practitioner_id	int64
status	integer
updated_at	date-time

sort

Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc

Responses

200

successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"invoices": [{"appointment": {"links": {"self": "https://api.au1.cliniko.com/v1/appointments/1"
}
},
"archived_at": "2019-08-24T14:15:22Z",
"business": {"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"closed_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"discounted_amount": "string",
"id": "string",
"invoice_items": {"links": {"self": "https://api.au1.cliniko.com/v1/invoices/1/invoice_items"
}
},
"invoice_to": "string",
"issue_date": "2019-08-24",
"links": {"self": "https://api.au1.cliniko.com/v1/invoices/1"
},
"net_amount": "string",
"notes": "string",
"number": 0,
"online_payment_url": "http://example.com",
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"patient_extra_information": "string",
"practitioner": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"status": 10,
"status_description": "Open",
"tax_amount": "string",
"total_amount": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"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"
}
}

List invoices for attendee

get/attendees/{attendee_id}/invoices

SecuritybasicAuth

Request

path Parameters

attendee_id

required

string <int64>

query Parameters

order

string

Deprecated

Enum: "asc" "desc"

page

integer

per_page

integer [ 1 .. 100 ]

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
appointment_id	int64
archived_at	date-time
business_id	int64
created_at	date-time
deleted_at	date-time
id	int64
issue_date	date
number	integer
patient_id	int64
practitioner_id	int64
status	integer
updated_at	date-time

sort

Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc

Responses

200

successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"invoices": [{"appointment": {"links": {"self": "https://api.au1.cliniko.com/v1/appointments/1"
}
},
"archived_at": "2019-08-24T14:15:22Z",
"business": {"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"closed_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"discounted_amount": "string",
"id": "string",
"invoice_items": {"links": {"self": "https://api.au1.cliniko.com/v1/invoices/1/invoice_items"
}
},
"invoice_to": "string",
"issue_date": "2019-08-24",
"links": {"self": "https://api.au1.cliniko.com/v1/invoices/1"
},
"net_amount": "string",
"notes": "string",
"number": 0,
"online_payment_url": "http://example.com",
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"patient_extra_information": "string",
"practitioner": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"status": 10,
"status_description": "Open",
"tax_amount": "string",
"total_amount": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/attendees/1/invoices?page=2",
"previous": "https://api.au1.cliniko.com/v1/attendees/1/invoices?page=1",
"next": "https://api.au1.cliniko.com/v1/attendees/1/invoices?page=3"
}
}

List invoices for patient case

get/patient_cases/{patient_case_id}/invoices

SecuritybasicAuth

Request

path Parameters

patient_case_id

required

string <int64>

query Parameters

order

string

Deprecated

Enum: "asc" "desc"

page

integer

per_page

integer [ 1 .. 100 ]

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
appointment_id	int64
archived_at	date-time
business_id	int64
created_at	date-time
deleted_at	date-time
id	int64
issue_date	date
number	integer
patient_id	int64
practitioner_id	int64
status	integer
updated_at	date-time

sort

Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc

Responses

200

successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"invoices": [{"appointment": {"links": {"self": "https://api.au1.cliniko.com/v1/appointments/1"
}
},
"archived_at": "2019-08-24T14:15:22Z",
"business": {"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"closed_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"discounted_amount": "string",
"id": "string",
"invoice_items": {"links": {"self": "https://api.au1.cliniko.com/v1/invoices/1/invoice_items"
}
},
"invoice_to": "string",
"issue_date": "2019-08-24",
"links": {"self": "https://api.au1.cliniko.com/v1/invoices/1"
},
"net_amount": "string",
"notes": "string",
"number": 0,
"online_payment_url": "http://example.com",
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"patient_extra_information": "string",
"practitioner": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"status": 10,
"status_description": "Open",
"tax_amount": "string",
"total_amount": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/patient_cases/1/invoices?page=2",
"previous": "https://api.au1.cliniko.com/v1/patient_cases/1/invoices?page=1",
"next": "https://api.au1.cliniko.com/v1/patient_cases/1/invoices?page=3"
}
}

List invoices for patient

get/patients/{patient_id}/invoices

SecuritybasicAuth

Request

path Parameters

patient_id

required

string <int64>

query Parameters

order

string

Deprecated

Enum: "asc" "desc"

page

integer

per_page

integer [ 1 .. 100 ]

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
appointment_id	int64
archived_at	date-time
business_id	int64
created_at	date-time
deleted_at	date-time
id	int64
issue_date	date
number	integer
practitioner_id	int64
status	integer
updated_at	date-time

sort

Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc

Responses

200

successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"invoices": [{"appointment": {"links": {"self": "https://api.au1.cliniko.com/v1/appointments/1"
}
},
"archived_at": "2019-08-24T14:15:22Z",
"business": {"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"closed_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"discounted_amount": "string",
"id": "string",
"invoice_items": {"links": {"self": "https://api.au1.cliniko.com/v1/invoices/1/invoice_items"
}
},
"invoice_to": "string",
"issue_date": "2019-08-24",
"links": {"self": "https://api.au1.cliniko.com/v1/invoices/1"
},
"net_amount": "string",
"notes": "string",
"number": 0,
"online_payment_url": "http://example.com",
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"patient_extra_information": "string",
"practitioner": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"status": 10,
"status_description": "Open",
"tax_amount": "string",
"total_amount": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/patients/1/invoices?page=2",
"previous": "https://api.au1.cliniko.com/v1/patients/1/invoices?page=1",
"next": "https://api.au1.cliniko.com/v1/patients/1/invoices?page=3"
}
}

List invoices for practitioner

get/practitioners/{practitioner_id}/invoices

SecuritybasicAuth

Request

path Parameters

practitioner_id

required

string <int64>

query Parameters

order

string

Deprecated

Enum: "asc" "desc"

page

integer

per_page

integer [ 1 .. 100 ]

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
appointment_id	int64
archived_at	date-time
business_id	int64
created_at	date-time
deleted_at	date-time
id	int64
issue_date	date
number	integer
patient_id	int64
status	integer
updated_at	date-time

sort

Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc

Responses

200

successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"invoices": [{"appointment": {"links": {"self": "https://api.au1.cliniko.com/v1/appointments/1"
}
},
"archived_at": "2019-08-24T14:15:22Z",
"business": {"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"closed_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z",
"discounted_amount": "string",
"id": "string",
"invoice_items": {"links": {"self": "https://api.au1.cliniko.com/v1/invoices/1/invoice_items"
}
},
"invoice_to": "string",
"issue_date": "2019-08-24",
"links": {"self": "https://api.au1.cliniko.com/v1/invoices/1"
},
"net_amount": "string",
"notes": "string",
"number": 0,
"online_payment_url": "http://example.com",
"patient": {"links": {"self": "https://api.au1.cliniko.com/v1/patients/1"
}
},
"patient_extra_information": "string",
"practitioner": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"status": 10,
"status_description": "Open",
"tax_amount": "string",
"total_amount": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/invoices?page=2",
"previous": "https://api.au1.cliniko.com/v1/practitioners/1/invoices?page=1",
"next": "https://api.au1.cliniko.com/v1/practitioners/1/invoices?page=3"
}
}