v1

latestOpenAPI 3.0.1Apache 2.02026-07-2473111182.6 KB
Client Course

Retrieve a client course

Get a client course for the specified business id and client course id

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

Path parameters

businessIdstring required
clientCourseIdstring required

Response

Specified client course retrieved

clientCourseIdstring
archivedboolean
purchaseDatestring
expiryDatestring date
clientIdstring
purchasingBranchIdstring
courseIdstring
courseNamestring
grossPricenumber
netPricenumber

Example response

{
  "clientCourseId": "ab123",
  "purchaseDate": "2018-01-01",
  "expiryDate": "2018-01-01",
  "clientId": "ab123",
  "purchasingBranchId": "ab123",
  "courseId": "ab123",
  "courseName": "10 x Massage",
  "grossPrice": 100,
  "netPrice": 80,
  "clientCourseItems": [
    {
      "clientCourseItemId": "ab123",
      "courseItemId": "ab123",
      "serviceId": "ab123",
      "initialUnits": 10,
      "remainingUnits": 5,
      "grossPrice": 100,
      "netPrice": 80
    }
  ]
}