Versions Compared

Key

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

...

PropertyTypeRequiredDefaultDescription
memberIdIntegerY The Club OS unique id for the member who made the payment.
salespersonIdIntegerN The Club OS unique id for the salesperson who was responsible for the payment.
localPaymentIdtransactionIdStringY Your systems unique id for the paymentA reference to the transactionId for this payment / invoice.
lineItemIdStringN A reference to the line item Id within the transaction.
clubServiceIdIntegerN The Club OS unique id for the club service that is being paid for. Use the /clubservices to get this id. Not required.
nameStringN The descriptive name of the product or service, i.e. 'Group Training', '30 Min Sessions', 'Multi-Vitamin'. Only required if no clubServiceId is used.
qtyDecimalY The qty purchased.
unitPriceDecimalY The unit price (cost of 1 item) of the product or service.
upcStringN The UPC for the product or service that was purchased.
taxesDecimalN The amount of taxes on the payment.
saleDateDate (M-d-YYYY)Y The date of the sale.
expireDateDate (M-d-YYYY)N The expiration date if one exists.

...

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

This method works identical to the above method, but the request body needs to be an array of payments, rather than a single payment, and a clubLocationId value must be specified for each payment.  Use this when there are multiple payments within a single orderto submit multiple transactions at once.

Note, if any payments in the batch fail, the entire batch will fail.  Validation errors will be returned for the first invalid payment.

...