Required
salesTransactionID :
string (GUID)
The globally unique identifier for the overall Transaction
Required
revision :
number (int)
This represents the revision of the configuration data that was being used when this transaction was generated
Required
MaxLength(36)
orderNumberOpened :
string
This is a user friendly visual reference number for an order. This is not required to be sequential and is not required to be unique, although it should be unique for a reasonable period of time.
In PowerEPOS, this is an 8 digit string consisting of a simple Terminal Display Identifier followed by an incrementing numeric sequence. eg For Terminal P1 it would be P1000001, P1000002, P1000003 etc
In PowerEPOS, this value is generated and allocated when the transaction is first started. If the transaction is aborted, this number sequence is still considered used, even through the transaction no longer exists.
Once the numeric part of the sequence reaches the maximum, it simply loops around. eg P1999999 loops around to P1000001. It is common to see gaps in this number in the sales history due to things like aborted transactions
or merged transactions.
Required
MaxLength(36)
orderNumberClosed :
string
This is a user friendly final reference number for an order. This is should be sequential but is not required to be unique, although it should be unique for a reasonable period of time.
In PowerEPOS, this is an 8 digit string consisting of a simple Terminal Display Identifier followed by an incrementing numeric sequence. eg For Terminal P1 it would be P1000001, P1000002, P1000003 etc
In PowerEPOS, this value is generated and allocated when the transaction is finalised and closed. This means that there should be a complete sequence of numbers in the sales history with no gaps, as once
a transaction has been finalised, it can no longer be changed/aborted directly. This number is used for taxation purposes in countries that require sequential order numbers for all historical transactions.
Required
MaxLength(32)
createdBy_UserName :
string
The name of the POS User / person who created the order.
Example: John
Required
MaxLength(32)
ownedBy_UserName :
string
The name of the POS User / person who is considered the owner / staff member responsible for overseeing the order (used for tip ownership in US)
Example: John
Required
MaxLength(32)
serviceModeName :
string
The name of the Service Mode the transaction was created in.
Example: Table
Required
MaxLength(8)
serviceModeEntityID :
string
This is the reference ID relating to the Service Mode assigned to this transaction. If you had a service mode called "Table", a ServiceModeEntityID might be "10", indicating table number 10.
Example: 10
Required
MaxLength(32)
tax1Name :
string
The name of the tax method used for Tax 1 calculations.
Example: VAT or GST
Leave blank if this tax level is not used.
Required
decimal(18, 3)
tax1Rate :
number (decimal)
The tax percentage(%) used to calculate tax for Tax 1
Leave as 0 if this tax level is not used, or you are indicating a Tax Free tax level
Required
MaxLength(32)
tax2Name :
string
The name of the tax method used for Tax 2 calculations.
Example: VAT or GST
Leave blank if this tax level is not used.
Required
decimal(18, 3)
tax2Rate :
number (decimal)
The tax percentage(%) used to calculate tax for Tax 2
Leave as 0 if this tax level is not used, or you are indicating a Tax Free tax level
Required
MaxLength(32)
tax3Name :
string
The name of the tax method used for Tax 3 calculations.
Example: VAT or GST
Leave blank if this tax level is not used.
Required
decimal(18, 3)
tax3Rate :
number (decimal)
The tax percentage(%) used to calculate tax for Tax 3
Leave as 0 if this tax level is not used, or you are indicating a Tax Free tax level
Required
MaxLength(32)
tax4Name :
string
The name of the tax method used for Tax 4 calculations.
Example: VAT or GST
Leave blank if this tax level is not used.
Required
decimal(18, 3)
tax4Rate :
number (decimal)
The tax percentage(%) used to calculate tax for Tax 4
Leave as 0 if this tax level is not used, or you are indicating a Tax Free tax level
Required
outletID :
string (GUID)
The unique OutletID for the outlet the transaction belongs to based on the POS_Outlets (configuration) table.
Required
MaxLength(64)
outletGroupName :
string
The name of the Outlet group (at the time of sale) that this transaction belongs to.
Example: Australian Outlets
Required
MaxLength(64)
outletName :
string
The name of the Outlet that this transaction belongs to.
Example: Little Johns Pizza
Required
MaxLength(64)
created_TerminalName :
string
The name of the terminal (typically the POS terminal) that created the transaction.
Example: "POS 1" or "Bar POS" or "Online Orders"
Required
MaxLength(4)
created_TerminalDisplayID :
string
A short ID for the terminal that created the transaction, typically matching the ID from the POS_Terminals (configuration) record.
Example: P1 or TRM1 or INTG
Required
MaxLength(4)
currencyCode :
string
An ISO 4217 currency code indicating the currency that all values in this transaction represent. This MUST be a valid currency code.
Example: "GBP" or "AUD" or "USD" or "EUR"
Required
MaxLength(8)
currencySymbol :
string
The currency symbol displayed for values in this currency
Example: "$" or "£" or "€"
Required
MaxLength(64)
currencyName :
string
The name of the currency that all values in this transaction represent.
Example: "Euro" or "Pound Stirling" or "Australian Dollar" or "US Dollar"
Nullable
dbGen :
number (int)
This represents an identifier for a unique database operation that last updated/created this entity. The value is not unique as it can be shared across multiple entities if they were all inserted/updated
from within a single operation. These values are always incrementing so all entities with DBGen > X can be assumed that they were edited/inserted since the operation X occured.
Expect a 64 bit integer.
This is a readonly property. Setting it will have no effect. It will be assigned internally and made visible when querying for this model
Nullable
zReportID :
string (GUID)
This is the unique ID of the Z Report that this transaction's sales figures have been included in. This should be set for finalised (fully paid) transactions where Z integration is occuring.
NULL means the transaction is open (unfinalised) or not linked to any actual Z Report.
Related Fields: ZReportCounter, TradingDate
Nullable
zReportCounter :
number (int)
This is the Z Counter from the Z Report that this transaction's sales figures have been included in. This should be set for finalised (fully paid) transactions where Z integration is occuring.
NULL means the transaction is open (unfinalised) or not linked to any actual Z Report.
Related Fields: ZReportID, TradingDate
Nullable
tradingDate :
string (ISO 8601 DateTime)
This is the Trading Date of the Z Report that this transaction's sales figures have been included in. This should be set for finalised (fully paid) transactions where Z integration is occuring.
NULL means the transaction is open (unfinalised) or not linked to any actual Z Report.
When populated, this should be just the trading date itself, with no time component. eg 2020-01-01 00:00:00
Related Fields: ZReportID, ZReportCounter
isTransactionReversal : bool
Is this the reversed version of a source transaction
isTransactionRefund : bool
Is this the refund version of a source transaction
isTransactionReopen : bool
Is this the reopened version of a source transaction
wasReversed : bool
Is this a transaction that has been reversed (ie the source transaction)
wasRefunded : bool
Is this a transaction that has been refunded (ie the source transaction)
wasReopened : bool
Is this a transaction that has been reopened (ie the source transaction)
Nullable
dateTimeOpened :
string (ISO 8601 DateTime)
This is the Date and Time that the transaction was started in the outlet's local time.
Nullable
dateTimeClosed :
string (ISO 8601 DateTime)
This is the Date and Time that the transaction was finalised (fully paid and closed) in the outlet's local time.
Set this to NULL if the transaction is still in an open (unfinalised/unpaid) state.
Nullable
covers :
number (int)
This represents the number of Covers/Guests associated with the order. For example a table with 4 people sitting at it should have a Covers count of 4.
Some order types may use a default of 1 covers, or possibly even 0. This often depends on how the customer using the software would like to report average spend and guest counts for different types of orders.
Nullable
billNumber :
number (int)
[Deprecated] Set as 0
Nullable
statusFlags :
number (int)
This is the numeric representation of the POSCorePublic.Enums.Sales.TransactionStatusFlags applicable to this transaction.
Nullable
tableStatusMask :
number (int)
This is the table status scheme rule's bit mask that has been applied to the transaction (for things like advancing order state, entrees away, mains away etc)
Nullable
decimal(18, 2)
amount :
number (decimal)
This is the total sale value of the order (ie the sum of the Amount field from all SalesTransactionItems records within the transaction)
This value must include any Inclusive Tax amounts and exclude any Exclusive (addon) tax amounts.
Note: This value does NOT include the RecommendedRemainingServiceCharge amount.
Nullable
decimal(18, 2)
cost :
number (decimal)
This is the total cost associated with the order (ie the sum of the Cost field from all SalesTransactionItems records within the transaction)
This can be set to zero if cost is not known or you want cost to be automatically populated via the Stock Control integration once it has been submitted (where applicable)
Nullable
decimal(18, 2)
taxSales1 :
number (decimal)
This is the total value of all sale items that are considered taxable for the purpose of Tax 1 calculations.
Nullable
decimal(18, 2)
taxSales2 :
number (decimal)
This is the total value of all sale items that are considered taxable for the purpose of Tax 2 calculations.
Nullable
decimal(18, 2)
taxSales3 :
number (decimal)
This is the total value of all sale items that are considered taxable for the purpose of Tax 3 calculations.
Nullable
decimal(18, 2)
taxSales4 :
number (decimal)
This is the total value of all sale items that are considered taxable for the purpose of Tax 4 calculations.
Nullable
decimal(18, 7)
incTax1 :
number (decimal)
This is the total amount of Inclusive Tax (rounded to 2 decimal places) calculated for Tax 1 from all sale items.
This is the Tax 1 amount that may be presented to the customer and the business would notmally be liable for.
IMPORTANT: This value should be the sum of all high precision IncTax1 fields in the linked SalesTransactionItems, which is then rounded (once all summed together) to 2 decimal places.
Nullable
decimal(18, 7)
incTax2 :
number (decimal)
This is the total amount of Inclusive Tax (rounded to 2 decimal places) calculated for Tax 2 from all sale items.
This is the Tax 2 amount that may be presented to the customer and the business would notmally be liable for.
IMPORTANT: This value should be the sum of all high precision IncTax2 fields in the linked SalesTransactionItems, which is then rounded (once all summed together) to 2 decimal places.
Nullable
decimal(18, 7)
incTax3 :
number (decimal)
This is the total amount of Inclusive Tax (rounded to 2 decimal places) calculated for Tax 3 from all sale items.
This is the Tax 3 amount that may be presented to the customer and the business would notmally be liable for.
IMPORTANT: This value should be the sum of all high precision IncTax3 fields in the linked SalesTransactionItems, which is then rounded (once all summed together) to 2 decimal places.
Nullable
decimal(18, 7)
incTax4 :
number (decimal)
This is the total amount of Inclusive Tax (rounded to 2 decimal places) calculated for Tax 4 from all sale items.
This is the Tax 4 amount that may be presented to the customer and the business would notmally be liable for.
IMPORTANT: This value should be the sum of all high precision IncTax4 fields in the linked SalesTransactionItems, which is then rounded (once all summed together) to 2 decimal places.
Nullable
decimal(18, 7)
exTax1 :
number (decimal)
This is the total amount of Exclusive (Addon) Tax (rounded to 2 decimal places) calculated for Tax 1 from all sale items.
This is the Tax 1 amount that may be presented to the customer and the business would notmally be liable for.
IMPORTANT: This value should be the sum of all high precision ExTax1 fields in the linked SalesTransactionItems, which is then rounded (once all summed together) to 2 decimal places.
Nullable
decimal(18, 7)
exTax2 :
number (decimal)
This is the total amount of Exclusive (Addon) Tax (rounded to 2 decimal places) calculated for Tax 2 from all sale items.
This is the Tax 2 amount that may be presented to the customer and the business would notmally be liable for.
IMPORTANT: This value should be the sum of all high precision ExTax2 fields in the linked SalesTransactionItems, which is then rounded (once all summed together) to 2 decimal places.
Nullable
decimal(18, 7)
exTax3 :
number (decimal)
This is the total amount of Exclusive (Addon) Tax (rounded to 2 decimal places) calculated for Tax 3 from all sale items.
This is the Tax 3 amount that may be presented to the customer and the business would notmally be liable for.
IMPORTANT: This value should be the sum of all high precision ExTax3 fields in the linked SalesTransactionItems, which is then rounded (once all summed together) to 2 decimal places.
Nullable
decimal(18, 7)
exTax4 :
number (decimal)
This is the total amount of Exclusive (Addon) Tax (rounded to 2 decimal places) calculated for Tax 4 from all sale items.
This is the Tax 4 amount that may be presented to the customer and the business would notmally be liable for.
IMPORTANT: This value should be the sum of all high precision ExTax4 fields in the linked SalesTransactionItems, which is then rounded (once all summed together) to 2 decimal places.
Nullable
createdBy_EmployeeID :
string (GUID)
The unique employee record ID of the employee / staff member who created the order.
Nullable
createdBy_UserID :
string (GUID)
This unique UserID from the POS_Users (configuration) table representing the POS user that created the order.
Nullable
ownedBy_EmployeeID :
string (GUID)
The unique employee record ID of the employee / staff member who is considered the owner / staff member responsible for overseeing the order (used for tip ownership in US)
Nullable
ownedBy_UserID :
string (GUID)
This unique UserID from the POS_Users (configuration) table representing the POS user who is considered the owner / staff member responsible for overseeing the order (used for tip ownership in US)
Nullable
closedBy_EmployeeID :
string (GUID)
The unique employee record ID of the employee / staff member who finalised/closed the order.
Nullable
closedBy_UserID :
string (GUID)
This unique UserID from the POS_Users (configuration) table representing the POS user who finalised/closed the order.
Nullable
MaxLength(32)
closedBy_UserName :
string
The name of the POS User / person who finalised/closed the order.
Example: John
Nullable
serviceModeID :
string (GUID)
The unique ID of the POS_ServiceModes (configuration) record matching the Service Mode the transaction was created in.
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 transaction.
Nullable
closed_TerminalID :
string (GUID)
This is the unique TerminalID of a record from the POS_Terminals (configuration) table representing the Terminal which finalised/closed the transaction.
Nullable
MaxLength(64)
closed_TerminalName :
string
The name of the terminal (typically the POS terminal) that finalised/closed the transaction.
Example: "POS 1" or "Bar POS" or "Online Orders"
Nullable
MaxLength(4)
closed_TerminalDisplayID :
string
A short ID for the terminal that finalised/closed the transaction, typically matching the ID from the POS_Terminals (configuration) record.
Example: P1 or TRM1 or INTG
Nullable
eventID :
string (GUID)
This is the unique EventID of a record from the POS_Events (configuration) table representing the Event this transaction is considered part of.
Nullable
MaxLength(64)
eventName :
string
The name of the event that this transaction is considered part of, or blank if no Event is related to this transaction.
Example: "" (ie blank) or "Xmas Day" or "Wedding" or "Grand Final"
Example
{
"salesTransactionID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"revision": 321,
"orderNumberOpened": "string value",
"orderNumberClosed": "string value",
"createdBy_UserName": "string value",
"ownedBy_UserName": "string value",
"serviceModeName": "string value",
"serviceModeEntityID": "string value",
"tax1Name": "string value",
"tax1Rate": 1.23,
"tax2Name": "string value",
"tax2Rate": 1.23,
"tax3Name": "string value",
"tax3Rate": 1.23,
"tax4Name": "string value",
"tax4Rate": 1.23,
"outletID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"outletGroupName": "string value",
"outletName": "string value",
"created_TerminalName": "string value",
"created_TerminalDisplayID": "string value",
"currencyCode": "string value",
"currencySymbol": "string value",
"currencyName": "string value",
"dbGen": 321,
"zReportID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"zReportCounter": 321,
"tradingDate": "2012-04-03T09:40:59.736Z",
"isTransactionReversal": true,
"isTransactionRefund": true,
"isTransactionReopen": true,
"wasReversed": true,
"wasRefunded": true,
"wasReopened": true,
"dateTimeOpened": "2012-04-03T09:40:59.736Z",
"dateTimeClosed": "2012-04-03T09:40:59.736Z",
"covers": 321,
"billNumber": 321,
"statusFlags": 321,
"tableStatusMask": 321,
"amount": 1.23,
"cost": 1.23,
"taxSales1": 1.23,
"taxSales2": 1.23,
"taxSales3": 1.23,
"taxSales4": 1.23,
"incTax1": 1.23,
"incTax2": 1.23,
"incTax3": 1.23,
"incTax4": 1.23,
"exTax1": 1.23,
"exTax2": 1.23,
"exTax3": 1.23,
"exTax4": 1.23,
"createdBy_EmployeeID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"createdBy_UserID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"ownedBy_EmployeeID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"ownedBy_UserID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"closedBy_EmployeeID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"closedBy_UserID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"closedBy_UserName": "string value",
"serviceModeID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"created_TerminalID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"closed_TerminalID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"closed_TerminalName": "string value",
"closed_TerminalDisplayID": "string value",
"eventID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"eventName": "string value"
}