This model defines payment information within a Partner Sales Transaction.
Nullable
salesTransactionPaymentID :
string (GUID)
(Optional) A Unique identifier for this payment record.
Default: A new unique ID will be generated automatically if it is not supplied.
3rd Party integrations that have a suitable unique identifier for payments can set this to allow them to have a way to match items to their original source records.
Nullable
dateTimePaid :
string (ISO 8601 DateTime)
(Optional) The date and time the payment was created/ordered in outlet local time.
Default: PartnerSalesTransaction.DateTimeClosed value
Nullable
decimal(18, 2)
amountPurchase :
number (decimal)
This is the rounded total purchase amount for the payment, ie the value of all items that are being paid. It does not include tips.
This value is in the outlet's local currency
Example: 30.00
Nullable
decimal(18, 2)
amountTip :
number (decimal)
(Optional) This is the tip amount that was included as part of the payment. This is in addition to the purchase amount (ie AmountPurchase)
Default: 0
This value is in the outlet's local currency
Example: 7.00
Nullable
decimal(18, 2)
amountRounded :
number (decimal)
(Optional) This is the amount that was required to round the purchase amount (AmountPurchase) to complete the payment. This is only applicable in countries like Australia which round cash payments to the nearest 5 cents as 5 cents in the smallest cash denomination.
Default: 0
This value is in the outlet's local currency
Example: 0.01 (eg if transaction amount was 29.99, if paid in cash in Australia, the purchase amount is rounded to 30.00)
Nullable
affectsCID :
bool
(Optional) Does this payment affect the CID (cash in draw) of the terminal. Typically this is only ever true for the CASH payment type.
Default: false
Nullable
MaxLength(32)
paymentTypeName :
string
The name of the Payment Type that was used to create this payment
3rd Party integrations can use their own names, or they can base them on the existing PaymentType configuration if available.
Example: CASH or Visa or Mastercard
Nullable
MaxLength(64)
revenue_CostCenterName :
string
(Optional) The name of the cost center allocated to this payment for revenue tracking purposes (if applicable), otherwise blank (ie empty string)
Default: "" (ie blank string)
3rd Party integrations can use their own revenue center names if required, or they can base them on the existing configuration records if available.
Example: "Restaurant" or "Outlet" or "Front Bar"
Nullable
MaxLength(256)
remark :
string
(Optional) The remark text (if applicable). Leave blank (empty string) if no remark/note is associated with this payment.
Default: "" (ie empty string)
Example: "Personal Cheque"
Example
{
"salesTransactionPaymentID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"dateTimePaid": "2012-04-03T09:40:59.736Z",
"amountPurchase": 1.23,
"amountTip": 1.23,
"amountRounded": 1.23,
"affectsCID": true,
"paymentTypeName": "string value",
"revenue_CostCenterName": "string value",
"remark": "string value"
}