Appointment Type Billable Item

AppointmentTypeBillableItem

	object
	object
created_at	string <date-time>
discount_percentage	number or null [ 0 .. 100 ]
discounted_amount	string or null <decimal>
id	string <int64>
is_monetary_discount	boolean or null
	object
quantity	integer
updated_at	string <date-time>

{"appointment_type": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1"
}
},
"billable_item": {"links": {"self": "https://api.au1.cliniko.com/v1/billable_items/1"
}
},
"created_at": "2019-08-24T14:15:22Z",
"discount_percentage": 100,
"discounted_amount": "string",
"id": "string",
"is_monetary_discount": true,
"links": {"self": "https://api.au1.cliniko.com/v1/appointment_type_billable_items/1"
},
"quantity": 0,
"updated_at": "2019-08-24T14:15:22Z"
}

List appointment type billable items

get/appointment_type_billable_items

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_type_id	int64
billable_item_id	int64
created_at	date-time
id	int64
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

{"appointment_type_billable_items": [{"appointment_type": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1"
}
},
"billable_item": {"links": {"self": "https://api.au1.cliniko.com/v1/billable_items/1"
}
},
"created_at": "2019-08-24T14:15:22Z",
"discount_percentage": 100,
"discounted_amount": "string",
"id": "string",
"is_monetary_discount": true,
"links": {"self": "https://api.au1.cliniko.com/v1/appointment_type_billable_items/1"
},
"quantity": 0,
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/appointment_type_billable_items?page=2",
"previous": "https://api.au1.cliniko.com/v1/appointment_type_billable_items?page=1",
"next": "https://api.au1.cliniko.com/v1/appointment_type_billable_items?page=3"
}
}

Create appointment type billable item

post/appointment_type_billable_items

SecuritybasicAuth

Request

Request Body schema: application/json

appointment_type_id	string <int64> appointment type id
billable_item_id	string <int64> billable item id
discount_percentage	number or null [ 0 .. 100 ]
discounted_amount	string or null <decimal>
quantity	integer

Responses

201

Resource was created

422

Resource could not be saved due to validation errors

Request samples

Payload
curl
JavaScript
Python
Ruby

application/json

{"appointment_type_id": "1",
"billable_item_id": "1",
"discount_percentage": 100,
"discounted_amount": "string",
"quantity": 0
}

Response samples

application/json

{"appointment_type": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1"
}
},
"billable_item": {"links": {"self": "https://api.au1.cliniko.com/v1/billable_items/1"
}
},
"created_at": "2019-08-24T14:15:22Z",
"discount_percentage": 100,
"discounted_amount": "string",
"id": "string",
"is_monetary_discount": true,
"links": {"self": "https://api.au1.cliniko.com/v1/appointment_type_billable_items/1"
},
"quantity": 0,
"updated_at": "2019-08-24T14:15:22Z"
}

Get appointment type billable item

get/appointment_type_billable_items/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Responses

200

Successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"appointment_type": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1"
}
},
"billable_item": {"links": {"self": "https://api.au1.cliniko.com/v1/billable_items/1"
}
},
"created_at": "2019-08-24T14:15:22Z",
"discount_percentage": 100,
"discounted_amount": "string",
"id": "string",
"is_monetary_discount": true,
"links": {"self": "https://api.au1.cliniko.com/v1/appointment_type_billable_items/1"
},
"quantity": 0,
"updated_at": "2019-08-24T14:15:22Z"
}

Update appointment type billable item

patch/appointment_type_billable_items/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Request Body schema: application/json

billable_item_id	string <int64> billable item id
discount_percentage	number or null [ 0 .. 100 ]
discounted_amount	string or null <decimal>
quantity	integer

Responses

200

Resource was updated

422

Resource could not be saved due to validation errors

Request samples

Payload
curl
JavaScript
Python
Ruby

application/json

{"billable_item_id": "1",
"discount_percentage": 100,
"discounted_amount": "string",
"quantity": 0
}

Response samples

application/json

{"appointment_type": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1"
}
},
"billable_item": {"links": {"self": "https://api.au1.cliniko.com/v1/billable_items/1"
}
},
"created_at": "2019-08-24T14:15:22Z",
"discount_percentage": 100,
"discounted_amount": "string",
"id": "string",
"is_monetary_discount": true,
"links": {"self": "https://api.au1.cliniko.com/v1/appointment_type_billable_items/1"
},
"quantity": 0,
"updated_at": "2019-08-24T14:15:22Z"
}

Delete appointment type billable item

delete/appointment_type_billable_items/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Responses

204

Resource was deleted successfully

Request samples

curl
JavaScript
Python
Ruby