Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
POST /checkins

Add a checkin to the system.

POST https://api.club-os.com/clubservicescheckins?clubLocationId=[clubLocationId]

...

PropertyTypeRequiredDefaultDescription
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.
localServiceIdlocalCheckinIdStringY Your systems unique id for the club service.
nameStringY The name of the service - as of now, 'Personal Training' is the only option.
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-renewcheckin.
startDateDate (M-d-YYYY hh:mm:ss)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.
paidOnSaleDecimalY The amount paid on the saleDate, or the date the club service was purchased.
recurTypeStringNmonthlyOne of 'monthly' or 'weekly'.and time of the checkin
Response Messages

One of the following messages will be returned when the request succeeds.

MessageDescription
Club Service Check-in CreatedClub Service Checkin successfully created.Club Service Updated
Club Service successfully updatedCheck-in FoundCheckin already exists in the system with the given localCheckinId.