Required
salesTransactionPaymentID :
string (GUID)
The Unique identifier for this record
Required
revision :
number (int)
This represents the revision of the configuration data that was being used when this record was generated
Required
zReportID :
string (GUID)
This is the unique ID of the Z Report that this payment has been included in. This is required for all payments.
Related Fields: ZReportCounter, TradingDate
Required
zReportCounter :
number (int)
This is the Z Counter from the Z Report that this payment has been included in. This is required for all payments.
Related Fields: ZReportID, TradingDate
Required
MaxLength(32)
cashier_UserName :
string
The name of the POS User / person who created the record.
Example: John
Required
MaxLength(32)
paymentTypeName :
string
The name of the Payment Type that was used to create this payment
Example: CASH or Visa or Mastercard
Required
MaxLength(64)
created_TerminalName :
string
The name of the terminal (typically the POS terminal) that created the record.
Example: "POS 1" or "Bar POS" or "Online Orders"
Required
MaxLength(4)
created_TerminalDisplayID :
string
A short ID for the terminal that created the record, typically matching the ID from the POS_Terminals (configuration) record.
Example: P1 or TRM1 or INTG
Required
MaxLength(32)
serviceModeName :
string
The name of the Service Mode the payment was added in.
Example: Table
Required
MaxLength(8)
serviceModeEntityID :
string
This is the reference ID relating to the Service Mode assigned to this payment. If you had a service mode called "Table", a ServiceModeEntityID might be "10", indicating table number 10.
Example: 10
Required
MaxLength(64)
outletName :
string
The name of the outlet that created the record.
Nullable
salesTransactionID :
string (GUID)
Reference to the parent SalesTransactionID that owns this entity.
This will need to be manually wired if instantiated from a regular SalesTransactionItem
Nullable
tradingDate :
string (ISO 8601 DateTime)
This is the Trading Date of the Z Report that this payment has been included in. This is required for all payments.
This should be just the trading date itself, with no time component. eg 2020-01-01 00:00:00
Related Fields: ZReportID, ZReportCounter
Nullable
dateTimePaid :
string (ISO 8601 DateTime)
The date and time the payment was created in outlet local time
Nullable
splitBillID :
number (int)
When split billing is used, this indicates which bill number the payment was applied to, otherwise this value will always be 0.
Nullable
decimal(18, 2)
amountPaid :
number (decimal)
This is the total purchase amount for the payment, ie the value of all items that are being paid. It does not include tips or cashout.
This value is in the outlet's local currency
Example: 30.00
Nullable
decimal(18, 2)
amountChange :
number (decimal)
This is the amount of change that was returned as part of the payment when the tendered amount exceeds the required amount.
AmountChange = AmountTendered - (AmountPaid + AmountCashOut + AmountTip + AmountServiceCharge + AmountSurcharge)
This value is in the outlet's local currency
Example: 3.00
Nullable
decimal(18, 2)
amountCashOut :
number (decimal)
This is the amount of cash out supplied with this payment. Typically this only applies to credit card / eftpos transactions that support the cash out facility. This is in addition to the purchase amount (ie AmountPaid)
This value is in the outlet's local currency
Example: 10.00
Nullable
decimal(18, 2)
amountTip :
number (decimal)
This is the tip amount that was included as part of the payment. This is in addition to the purchase amount (ie Amount Paid)
This value is in the outlet's local currency
Example: 7.00
Nullable
decimal(18, 2)
amountServiceCharge :
number (decimal)
This is the service charge amount that was included as part of the payment. This is in addition to the purchase amount (ie Amount Paid)
This value is in the outlet's local currency
Example: 2.50
Nullable
decimal(18, 2)
amountSurcharge :
number (decimal)
This is the payment surcharge amount that was included as part of the payment. This is in addition to the purchase amount (ie Amount Paid)
This value is in the outlet's local currency
Example: 2.50
Nullable
decimal(18, 2)
amountRounded :
number (decimal)
This is the amount that was required to round the purchase amount (AmountPaid) 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.
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
decimal(18, 2)
amountTendered :
number (decimal)
This is the raw payment amount that was given to the cashier at the time of payment by the customer. This will usually only be more than the required amount when cash is used and the customer pays using a denomination that exceeds the required amount.
This value is in the outlet's local currency
Example: 50.00
Nullable
statusFlags :
number (int)
The status flags applicable to this payment as per the POSCorePublic.Enums.Sales.PaymentStatusFlags enum.
affectsCID : bool
Does this payment affect the CID (cash in draw). Typically this is only ever true for the CASH payment type.
isPaymentReversal : bool
Is this payment a reversal of another payment?
isPaymentCancelled : bool
Is this a cancelled payment?
isPaymentCashOut : bool
Is this payment the CASH OUT component of another payment?
isPaymentChanged : bool
Has the payment been changed since it was originally created?
wasReversed : bool
Has this payment been reversed (ie is there another payment which IsPaymentReversal of this payment)
Nullable
decimal(18, 7)
foreignCurrencyRate :
number (decimal)
Defines the exchange rate for the foreign currency used at the time of this payment (if applicable)
Nullable
decimal(18, 2)
foreignCurrencyTendered :
number (decimal)
The amount tendered in the foreign currency (if applicable)
Nullable
decimal(18, 2)
foreignCurrencyChange :
number (decimal)
The change amount given in the foreign currency (if applicable)
Nullable
MaxLength(4)
foreign_CurrencyCode :
string
An ISO 4217 currency code indicating the currency that the "ForeignCurrency" values in this record represent. This MUST be a valid currency code or blank (empty string) if no foreign currency is used.
Example: "GBP" or "AUD" or "USD" or "EUR"
Nullable
MaxLength(8)
foreign_CurrencySymbol :
string
The currency symbol displayed for the "ForeignCurrency" values in this record
Example: "$" or "£" or "€"
Nullable
MaxLength(64)
foreign_CurrencyName :
string
The name of the currency that all "ForeignCurrency" values in this record represent.
Example: "Euro" or "Pound Stirling" or "Australian Dollar" or "US Dollar"
Nullable
decimal(18, 2)
loyaltyPointsAccrued :
number (decimal)
The number of loyalty (membership) points accumulated due to this payment
Set this to 0 if no loyalty integration exists.
Nullable
decimal(18, 2)
loyaltyPointsRedeemed :
number (decimal)
The number of loyalty (membership) points that were redeemed to create this payment
Set this to 0 if no loyalty integration exists.
Nullable
cashier_EmployeeID :
string (GUID)
The unique employee record ID of the employee / staff member who created the record.
Nullable
cashier_UserID :
string (GUID)
This unique UserID from the POS_Users (configuration) table representing the POS user that created the record.
Nullable
paymentTypeID :
string (GUID)
This unique PaymentTypeID from the POS_PaymentTypes (configuration) table representing the Payment Type this record was created from.
Nullable
MaxLength(40)
creditCardMerchantID :
string
The MerchantID being used by the Credit Card integration that processed this payment (if applicable)
Null values will be converted to an empty string internally
Nullable
MaxLength(40)
creditCardTerminalID :
string
The TerminalID being used by the Credit Card integration that processed this payment (if applicable).
This is the Terminal ID of the physical credit card machine.
Null values will be converted to an empty string internally
Nullable
decimal(18, 2)
serviceChargableSales :
number (decimal)
This is the service chargable sales amount that the service charge amount chosen was paid against.
This value is in the outlet's local currency
Example: 2.50
Nullable
MaxLength(32)
serviceChargeName :
string
The name of the Service Charge that was included with this payment
Example: Optional Service Charge
Nullable
created_TerminalID :
string (GUID)
This is the unique TerminalID of a record from the POS_Terminals (configuration) table representing the Terminal which created the record.
Nullable
serviceModeID :
string (GUID)
The unique ID of the POS_ServiceModes (configuration) record matching the Service Mode the payment was added in.
Nullable
remarkGroupID :
string (GUID)
The unique ID of the POS_RemarkGroups (configuration) record matching the Remark Group the remark was added from (if applicable)
Nullable
MaxLength(64)
remarkGroupName :
string
The name of the Remark Group the remark (if applicable) belongs to. Leave blank (empty string) if no remark is associated with this payment.
Example: "Payment Remarks"
Nullable
remarkID :
string (GUID)
The unique ID of the POS_Remarks (configuration) record matching the Remark configuration record that the remark was added from (if applicable)
Nullable
MaxLength(256)
remarkName :
string
The name of the Remark (if applicable) that was applied. Leave blank (empty string) if no remark is associated with this payment.
Example: "Personal Cheque"
Example
{
"salesTransactionPaymentID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"revision": 321,
"zReportID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"zReportCounter": 321,
"cashier_UserName": "string value",
"paymentTypeName": "string value",
"created_TerminalName": "string value",
"created_TerminalDisplayID": "string value",
"serviceModeName": "string value",
"serviceModeEntityID": "string value",
"outletName": "string value",
"salesTransactionID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"tradingDate": "2012-04-03T09:40:59.736Z",
"dateTimePaid": "2012-04-03T09:40:59.736Z",
"splitBillID": 321,
"amountPaid": 1.23,
"amountChange": 1.23,
"amountCashOut": 1.23,
"amountTip": 1.23,
"amountServiceCharge": 1.23,
"amountSurcharge": 1.23,
"amountRounded": 1.23,
"amountTendered": 1.23,
"statusFlags": 321,
"affectsCID": true,
"isPaymentReversal": true,
"isPaymentCancelled": true,
"isPaymentCashOut": true,
"isPaymentChanged": true,
"wasReversed": true,
"foreignCurrencyRate": 1.23,
"foreignCurrencyTendered": 1.23,
"foreignCurrencyChange": 1.23,
"foreign_CurrencyCode": "string value",
"foreign_CurrencySymbol": "string value",
"foreign_CurrencyName": "string value",
"loyaltyPointsAccrued": 1.23,
"loyaltyPointsRedeemed": 1.23,
"cashier_EmployeeID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"cashier_UserID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"paymentTypeID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"creditCardMerchantID": "string value",
"creditCardTerminalID": "string value",
"serviceChargableSales": 1.23,
"serviceChargeName": "string value",
"created_TerminalID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"serviceModeID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"remarkGroupID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"remarkGroupName": "string value",
"remarkID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"remarkName": "string value"
}