Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

PropertyTypeRequiredDefaultDescription
localServiceIdStringY Your systems unique id for the club service.
memberIdIntegerY The Club OS unique id for the member who bought the club service.
salespersonIdIntegerY The Club OS unique id for the salesperson who was responsible for selling the club service.
nameStringY The descriptive name of the service, i.e. 'Group Training' or '30 Min Sessions'.
startDateDate (M-d-YYYY)Y The effective start date of the club service.
endDateDate (M-d-YYYY)N The end date of the club service if one exists.
saleDateDate (M-d-YYYY)Y The date of the sale.
qtyDecimalY The qty of sessions purchased.
unitPriceDecimalY The unit price (cost of 1 item) of the service.
taxesDecimalN The amount of taxes on the payment.
autoRenewBooleanY false

true - the club service auto-renews.

false - the club service does not auto-renew.

statusBooleanYtrue

true - the club service is active and in good standing.

false - the club service is inactive and not in good standing.

paidOnSaleDecimalY The amount paid on the saleDate, or the date the club service was purchased.
recurTypeStringNmonthlyOne of 'monthly' or 'weekly'.

...

PropertyTypeRequiredDefaultDescription
localServiceIdStringY Your systems unique id for the club service. Used to lookup the club service to update.
salespersonIdIntegerN The Club OS unique id for the salesperson who was responsible for selling the club service.
startDateDate (M-d-YYYY)N The effective start date of the club service.
endDateDate (M-d-YYYY)N The end date of the club service if one exists.
saleDateDate (M-d-YYYY)N The date of the sale.
nameStringN The descriptive name of the service - as of now, 'Personal Training' is the only option, i.e. 'Group Training' or '30 Min Sessions'.
qtyDecimalN The qty of sessions purchased.
unitPriceDecimalN The unit price (cost of 1 item) of the service.
taxesDecimalN The amount of taxes on the payment.
autoRenewBooleanN 

true - the club service auto-renews.

false - the club service does not auto-renew.

statusBooleanN 

true - the club service is active and in good standing.

false - the club service is inactive and not in good standing.

paidOnSaleDecimalN The amount paid on the saleDate, or the date the club service was purchased.
recurTypeStringNmonthlyOne of 'monthly' or 'weekly'.
deletedBooleanN 

true - soft deletes the club service from the system (can be undone).

false - undeletes a club service.

...