Sales Transactions
Event data structure
Sales transaction event
Sales transaction events contain complete point-of-sale transaction data including items sold, payments, taxes, and customer information.
Transaction properties
BusinessDate
datetime
Trading date for the transaction (not necessarily the current date)
ChangeGiven
decimal
Amount of change provided to the customer
ClosedByClerkId
integer
Clerk/staff member ID who finalised the transaction
CompanyCode
string
Unique company identifier
Covers
integer
Number of guests/covers for the transaction
DateTimeClosed
datetime
When the transaction was completed
DateTimeOpened
datetime
When the transaction was initiated
Duration
timespan
Total transaction time (opened to closed)
Id
string (GUID)
Unique transaction identifier
LocationId
string
Location/site identifier where transaction occurred
ParentTransactionId
string
Reference to parent transaction (for split bills or transfers)
SeatingArea
string
Seating area or service zone identifier
TerminalId
integer
POS terminal identifier
Tips
decimal
Gratuity amount
TotalDiscount
decimal
Total discount amount applied
TotalGrossItemCost
decimal
Total gross value before discounts
TotalNetItemCost
decimal
Net value excluding tax
TotalPayments
decimal
Total amount paid by customer
TotalServiceCharge
decimal
Service charge amount
TotalTax
decimal
Total tax/VAT amount
TotalToPayAmount
decimal
Final amount to be paid
TotalWastageCost
decimal
Value of wasted items
Sold items array
Each transaction contains a SoldItems array with detailed item information:
AddedByClerkId
integer
Clerk ID who added the item
DateTimeSold
datetime
When the item was added to the transaction
Id
string
PLU (Price Look-Up) identifier
IndividualGrossPrice
decimal
Single item price including tax
IndividualNetPrice
decimal
Single item price excluding tax
Name
string
Item description
Quantity
integer
Number of items sold
SalesGroup
string
Reporting category identifier
TotalDiscount
decimal
Total discount applied to this item
TotalNetPrice
decimal
Total net price for quantity sold
TotalGrossPrice
decimal
Total gross price for quantity sold
TotalServiceCharge
decimal
Service charge for this item
TotalTax
decimal
Total tax for this item
IsRefunded
boolean
Whether item has been refunded
IsRefundedBackToStock
boolean
Whether refund included stock return
Tax information
Tax details are nested within items in a Taxes array:
Id
string
Tax rate identifier
Description
string
Tax rate description (e.g., "20% VAT Sales")
Amount
decimal
Tax amount for this item
Payment information
The Payments array contains all payment methods used:
Amount
decimal
Payment amount
Method
string
Payment method name (Cash, Card, etc.)
PaymentDateTime
datetime
When payment was taken
Discount information
Transaction-level and item-level discounts appear in Discounts arrays:
Amount
decimal
Discount value
Description
string
Discount reason or promotion name
Type
string
Discount type identifier
Example transaction
Lookup values
Several fields contain identifiers that reference configuration data. These values must be retrieved through the Access EPOS Orders API for complete information:
ClosedByClerkId
integer
User/clerk lookup
Identify staff member
LocationId
string (numeric)
Location configuration
Map to physical site details
SeatingArea
string (numeric)
Seating area configuration
Identify service zones
Id (in SoldItems)
string (numeric)
PLU lookup
Get complete product details
SalesGroup
string (numeric)
Sales group configuration
Reporting category details
Id (in Taxes)
string (numeric)
Tax rate configuration
Tax rate details
Last updated
Was this helpful?