Version 1.10.2

POST /api/business/{businessId}/creditaccounttransaction

Create a client credit account transaction

Return Type:

Changed response : 400 Bad Request

Client credit account transaction data is invalid, unable to create client credit account transaction

Changed response : 201 Created

Client credit account transaction created successfully

POST /api/business/{businessId}/branch/{branchId}/client/{clientId}/checkin

Check in appointments

Return Type:

Changed response : 200 OK

Appointments checked in successfully

Changed response : 404 Not Found

Business, branch or client with the specified ids don't exist

POST /api/business/{businessId}/branch/{branchId}/booking/{bookingId}/appendnote

Return Type:

Changed response : 200 OK

Booking note created successfully

GET /api/business/{businessId}/voucher/{voucherId}

Retrieve a voucher

Return Type:

Changed response : 404 Not Found

Business or voucher with the specified ids don't exist

Changed response : 200 OK

Specified voucher retrieved

PUT /api/business/{businessId}/voucher/{voucherId}

Update a voucher

Return Type:

Changed response : 404 Not Found

Business or voucher with the specified ids don't exist

Changed response : 200 OK

Voucher updated successfully

GET /api/business/{businessId}/clientcourse/{clientCourseId}

Retrieve a client course

Return Type:

Changed response : 404 Not Found

Business or client course with the specified ids don't exist

Changed response : 200 OK

Specified client course retrieved

PUT /api/business/{businessId}/clientcourse/{clientCourseId}

Update a client course

Return Type:

Changed response : 404 Not Found

Business or client course with the specified ids don't exist

Changed response : 409 Conflict

Client course has been updated since it was read

Changed response : 200 OK

Client course updated successfully

GET /api/business/{businessId}/client/{clientId}

GET /api/business/{businessId}/voucher

List vouchers

Parameters:

Changed: includeUsed in query

include used vouchers in the list

Changed: size in query

number of voucher records to return, max is 100

Return Type:

Changed response : 404 Not Found

Business with the specified id doesn't exist

Changed response : 200 OK

Vouchers listed

POST /api/business/{businessId}/voucher

Create a voucher

Return Type:

Changed response : 412 Precondition Failed

Voucher with the specified serial number already exists

Changed response : 404 Not Found

Business with the specified id doesn't exist

Changed response : 201 Created

Voucher created successfully

POST /api/business/{businessId}/branch/{branchId}/stock/adjustment

Adjust stock quantity

Return Type:

Changed response : 204 No Content

Stock quantity adjusted successfully

Changed response : 404 Not Found

Business or branch with the specified ids don't exist

POST /api/business/{businessId}/branch/{branchId}/csvexportjob

Create a CSV export job

Return Type:

Changed response : 404 Not Found

Business or branch with the specified ids don't exist

Changed response : 201 Created

CSV export job created successfully

GET /api/business/{businessId}/paymenttype

List payment types

Parameters:

Changed: size in query

number of payment type records to return, max is 100

Return Type:

Changed response : 404 Not Found

Business with the specified id doesn't exist

Changed response : 200 OK

Payment types listed

GET /api/business/{businessId}/paymenttype/{paymentTypeId}

Retrieve a payment type

Return Type:

Changed response : 404 Not Found

Business or payment type with the specified ids don't exist

Changed response : 200 OK

Specified payment type retrieved

GET /api/business/{businessId}/category/client

List client categories

Parameters:

Deleted: includeArchived in query

Changed: name in query

client category name to filter by

Changed: archivedOnly in query

include archived client categories in the list

Changed: size in query

number of client category records to return, max is 100

Return Type:

Changed response : 404 Not Found

Business with the specified id doesn't exist

Changed response : 200 OK

Client categories listed

GET /api/business/{businessId}/category/client/{categoryId}

Retrieve a client category

Return Type:

Changed response : 404 Not Found

Business or client category with the specified ids don't exist

Changed response : 200 OK

Specified client category retrieved

GET /api/business/{businessId}/branch/{branchId}/taxrate

List tax rates

Parameters:

Changed: size in query

number of tax rate records to return, max is 100

Return Type:

Changed response : 404 Not Found

Business or branch with the specified ids don't exist

Changed response : 200 OK

Tax rates listed

GET /api/business/{businessId}/branch/{branchId}/taxrate/{taxId}

Retrieve a tax rate

Return Type:

Changed response : 404 Not Found

Business, branch or tax rate with the specified ids don't exist

Changed response : 200 OK

Specified tax rate retrieved

GET /api/business/{businessId}/branch/{branchId}/staff

List staffs

Parameters:

Changed: fetch_archived in query

include archived staffs in the list

Return Type:

Changed response : 404 Not Found

Business or branch with the specified ids don't exist

Changed response : 200 OK

Staffs listed

GET /api/business/{businessId}/branch/{branchId}/staff/{staffId}

Retrieve a staff

Return Type:

Changed response : 404 Not Found

Business, branch or staff with the specified id don't exist

Changed response : 200 OK

Specified staff retrieved

GET /api/business/{businessId}/branch/{branchId}/staff-batch

Retrieve a batch of staffs

Return Type:

Changed response : 404 Not Found

Business or branch with the specified ids don't exist

Changed response : 200 OK

Batch of staffs retrieved

GET /api/business/{businessId}/branch/{branchId}/service-category

List service categories

Return Type:

Changed response : 404 Not Found

Business or branch with the specified ids don't exist

Changed response : 200 OK

Service categories listed

GET /api/business/{businessId}/branch/{branchId}/room

Parameters:

Changed: include_archived in query

include archived rooms in the list

GET /api/business/{businessId}/branch/{branchId}/review

List reviews

Parameters:

Changed: clientId in query

Client id to filter by

Changed: clientName in query

Client first name or surname to filter by

Changed: staffName in query

Staff member first name or surname to filter by

Changed: reviewDate in query

Date of review to filter by. yyyy-MM-dd

Return Type:

Changed response : 404 Not Found

Business or branch with the specified ids don't exist

Changed response : 200 OK

Reviews listed

GET /api/business/{businessId}/branch/{branchId}/review/{reviewId}

Retrieve a review

Return Type:

Changed response : 404 Not Found

Business, branch or review with the specified ids don't exist

Changed response : 200 OK

Specified review retrieved

GET /api/business/{businessId}/branch/{branchId}/product

List products

Parameters:

Changed: searchQuery in query

query to search for a product by name or barcode

Changed: outOfStock in query

list only out of stock products

Changed: archivedOnly in query

list only archived products

Changed: includeArchived in query

include archived products in the list

Changed: lowStock in query

list only low in stock products

Return Type:

Changed response : 404 Not Found

Business or branch with the specified ids don't exist

Changed response : 200 OK

Products listed

GET /api/business/{businessId}/branch/{branchId}/machine

Parameters:

Changed: include_archived in query

include archived machines in the list

GET /api/business/{businessId}/branch/{branchId}/csvexportjob/{jobId}

Retrieve a CSV export job

Return Type:

Changed response : 404 Not Found

Business, branch or job with the specified ids don't exist

Changed response : 200 OK

Specified CSV export job retrieved

GET /api/business/{businessId}/client

Parameters:

Changed: includeArchived in query

include archived clients in the list

Changed: includeDeleted in query

include deleted clients in the list

GET /api/business/{businessId}/clientcourse

List client courses

Parameters:

Changed: branch_id in query

branch id to filter by

Changed: includeArchived in query

include archived client courses in the list

Changed: client_id in query

client id to filter by

Return Type:

Changed response : 404 Not Found

Business with the specified id doesn't exist

Changed response : 200 OK

Client courses listed

GET /api/business/{businessId}/branch/{branchId}/service/{serviceId}

Retrieve a branch service

Parameters:

Changed: fetch_online_category in query

include online categories of branch services

Return Type:

Changed response : 404 Not Found

Branch service with the specified id doesn't exist

Changed response : 200 OK

Specified branch service retrieved

GET /api/business/{businessId}/branch/{branchId}/course

List courses

Parameters:

Changed: includeArchived in query

include archived courses in the list

Changed: size in query

number of course records to return, max is 100

Return Type:

Changed response : 404 Not Found

Business or branch with the specified ids don't exist

Changed response : 200 OK

Courses listed

POST /api/business/{businessId}/branch/{branchId}/purchase

Create a purchase

Return Type:

Changed response : 404 Not Found

Business or branch with the specified ids don't exist

Changed response : 201 Created

Purchase created successfully

POST /api/business/{businessId}/branch/{branchId}/appointments/availability

List appointment availabilities

Request:

Changed content type : application/json

• Added property isOnlineAvailability (boolean)

  Fetch staff available online

Return Type:

Changed response : 400 Bad Request

Availability request data is invalid, unable to list appointment availabilities

Changed response : 404 Not Found

Business or branch with the specified ids don't exist

Changed response : 200 OK

Appointment availabilities listed

GET /api/business/{businessId}/branch/{branchId}/service

List branch services

Parameters:

Changed: category_id in query

service category id to filter by

Changed: includeArchived in query

include archived branch services in the list

Changed: fetch_online_category in query

include online categories of branch services

Changed: size in query

number of branch service records to return, max is 100

Return Type:

Changed response : 200 OK

Branch services listed

GET /api/business/{businessId}/branch/{branchId}/worktimetable

Retrieve a branch timetable

Return Type:

Changed response : 404 Not Found

Business or branch with the specified ids don't exist

Changed response : 200 OK

Specified timetable retrieved

GET /api/business/{businessId}/branch/{branchId}/appointment

Parameters:

Changed: fetch_canceled in query

include canceled appointments in the list

Changed: fetch_deleted in query

include deleted appointments in the list

Changed: fetch_archived in query

include archived appointments in the list

Changed: fetch_online_category in query

include online categories of appointments

Changed: fetch_notes in query

include notes of appointments

GET /api/business/{businessId}/branch/{branchId}/staff/worktimetable

List staff timetables

Parameters:

Changed: size in query

number of staff timetables to return, max is 100

Return Type:

Changed response : 404 Not Found

Business or branch with the specified ids don't exist

Changed response : 200 OK

Staff timetables listed

GET /api/business/{businessId}/branch/{branchId}/service-special-offer

List service special offers

Parameters:

Changed: category_id in query

service category id to filter by

Return Type:

Changed response : 404 Not Found

Business or branch with the specified ids don't exist

Changed response : 200 OK

Service special offers listed

GET /api/business/{businessId}/branch/{branchId}/package

List service packages

Parameters:

Changed: category_id in query

service category id to filter by

Return Type:

Changed response : 404 Not Found

Business or branch with the specified ids don't exist

Changed response : 200 OK

Service packages listed