Required
salesTransactionID :
string (GUID)
The POS's unique ID for the order (transaction).
Required
MaxLength(8)
serviceModePrefix :
string
The short name for the service mode (eg TBL)
Required
MaxLength(8)
serviceModeEntityID :
string
The service mode entity's ID (eg table number)
Required
MaxLength(8)
orderNumberOpened :
string
The OrderNumberOpened value assigned to this order
Required
MaxLength(3)
currencyCode :
string
The currency for the order
Required
decimal(13, 2)
amount :
number (decimal)
The total sale amount of the order (excluding any existing payments and exluding any remaining service charges)
Required
decimal(13, 2)
amountOwing :
number (decimal)
The total amount owing on the order (This is calculated as Amount subtract all Payments, plus any RemainingServiceChargeAmount)
Required
isClosed :
bool
Is this order finalised (closed)?
Required
decimal(13, 2)
remainingServiceChargeAmount :
number (decimal)
The total UNPAID remaining service charge amount calculated for the order
Required
covers :
number (int)
The number of covers on the order
Required
products :
OrderNPayProduct
[]
A list of products for the order
Required
taxes :
OrderNPayTax
[]
A list of taxes calculated for the order
Nullable
ownedBy_UserID :
string (GUID)
The ID of the POS User who created the order
Nullable
MaxLength(20)
ownedBy_UserName :
string
The name of the POS User who created the order
Nullable
payments :
OrderNPayPayment
[]
A list of payments for the order
Nullable
adjustments :
OrderNPayAdjustment
[]
A list of adjustments for the order
Nullable
notes :
OrderNPayNote
[]
A list of order tags for the order
Example
{
"salesTransactionID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"serviceModePrefix": "string value",
"serviceModeEntityID": "string value",
"orderNumberOpened": "string value",
"currencyCode": "string value",
"amount": 1.23,
"amountOwing": 1.23,
"isClosed": true,
"remainingServiceChargeAmount": 1.23,
"covers": 321,
"products": [],
"taxes": [],
"ownedBy_UserID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"ownedBy_UserName": "string value",
"payments": [],
"adjustments": [],
"notes": []
}