...
GET https://api.club-os.com/clubservices?clubLocationId=[clubLocationId]&serviceIdclubServiceId=[serviceIdclubServiceId]
Variable | Type | Description |
---|---|---|
clubLocationId | Integer | The Club OS unique id for the club location you wish to access. Club OS will provide these to you. |
serviceIdclubServiceId | Integer | The Club OS unique id for the club service you are requesting. |
...
One of the following messages will be returned when the request succeeds.
Message | Value | Description |
clubservice created | the newly created clubServiceId | Club Service successfully created. |
clubservice exists | the existing clubServiceId | Club Service already exists, nothing was done. |
...
Property | Type | Required | Default | Description |
---|---|---|---|---|
localServiceIdclubServiceId | StringInteger | Y | Your systems The Club OS unique id for the club service . Used to lookup the club service to updateyou are updating. | |
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 descriptive name of the service, i.e. 'Group Training' or '30 Min Sessions'. | |
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. |
...