...
Any of the fields below may be included in the body of the HTTP request as a valid JSON string. Only fields included in the request will be updated. For example, if you only want to update the name and qty, the JSON should be { localServiceId: "theLocalServiceId", name: "newName", qty: "10"}
Property | Type | Required | Default | Description |
---|---|---|---|---|
localServiceId | String | Y | Your systems unique id for the club service. Used to lookup the club service to update. | |
salespersonId | Integer | N | The Club OS unique id for the salesperson who was responsible for selling the club service. | |
startDate | Date (M-d-YYYY) | N | The effective start date of the club service. | |
endDate | Date (M-d-YYYY) | N | The end date of the club service if one exists. | |
saleDate | Date (M-d-YYYY) | N | The date of the sale. | |
name | String | N | The name of the service - as of now, 'Personal Training' is the only option. | |
qty | Decimal | N | The qty of sessions purchased. | |
unitPrice | Decimal | N | The unit price (cost of 1 item) of the service. | |
taxes | Decimal | N | The amount of taxes on the payment. | |
autoRenew | Boolean | N | true - the club service auto-renews. false - the club service does not auto-renew. | |
status | Boolean | N | true - the club service is active and in good standing. false - the club service is inactive and not in good standing. | |
paidOnSale | Decimal | N | The amount paid on the saleDate, or the date the club service was purchased. | |
recurType | String | N | monthly | One of 'monthly' or 'weekly'. |
deleted | Boolean | N | true - soft deletes the club service from the system (can be undone). false - undeletes a club service. |
...