Required
salesTransactionItemID :
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
dateTimeOrdered :
string (ISO 8601 DateTime)
The date and time the item was created/ordered in outlet local time.
Required
sortID :
number (int)
The sorting identifier for the item. This defines the order in which items are displayed on the order. It is expected that each item will have a unique sort id to ensure a consistant display order,
however if multiple items have the same SortID, the sort order between them will be undefined.
Example: T-Bone Steak (SortId: 1, this is a parent item)
Medium Rare (SortId: 2, this is a child item of T-Bone Steak so should appear after)
Pepper Sauce (SortId: 3, this is a child item of T-Bone Steak so should appear after)
Required
MaxLength(32)
createdBy_UserName :
string
The name of the POS User / person who created the record.
Example: John
Required
MaxLength(32)
serviceModeName :
string
The name of the Service Mode the item was added in.
Example: Table
Required
MaxLength(8)
serviceModeEntityID :
string
This is the reference ID relating to the Service Mode assigned to this item. If you had a service mode called "Table", a ServiceModeEntityID might be "10", indicating table number 10.
Example: 10
Required
MaxLength(32)
groupName :
string
The name of the Reporting Group this item belongs to.
Only applicable for PLU sale items (ie ItemType 1-9), blank for all other line types.
Example: Entrees or Spirits
Required
MaxLength(32)
mainGroupName :
string
The name of the Main Group this item belongs to.
Only applicable for PLU sale items (ie ItemType 1-9), blank for all other line types.
Example: FOOD or BEVERAGE
Required
MaxLength(50)
itemName :
string
The name of the item record, this must always be set and should not be blank.
Example: "Garlic Bread" or "10% Discount"
Required
MaxLength(18)
plU :
string
The PLU number this item was generated from. Only applicable for PLU based ItemType's, all other ItemTypes will be blank (ie empty string).
Required
MaxLength(24)
saleModifierName :
string
The name of the Sale Modifier applied to this item record (if applicable). Applies to PLU Sale based items only.
For PLU Sale based item types, if no Sales Modifier was applied then set this to "[No Modifier]"
For all other item types, set this to blank (ie empty string)
Example: "Pint" or "Double Shot"
Required
MaxLength(8)
saleModifierPrefixName :
string
The prefix of the Sale Modifier applied to this item record (if applicable). Applies to PLU Sale based items only, prefix is optional for Sales Modifiers. Prefixes are applied to the front of the item name.
For PLU Sale based item types, if no Sales Modifier was applied then this should be blank (ie empty string).
For all other item types, set this to blank (ie empty string).
Example: "PINT" (as in 1 x PINT Carlsberg) or "DBL" (as in 1 x DBL Jack Daniels on ice)
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(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.
Nullable
dateTimeModified :
string (ISO 8601 DateTime)
The date and time the item was last modified in outlet local time.
When the item is first created, set this the same as the DateTimeOrdered value.
Nullable
seat :
number (int)
The seat number this item belongs to (where applicable).
If seat numbers are being used, typically only sale items (PLU's) are tagged with a seat number.
All other line types typically just set seat to 0.
Nullable
decimal(13, 2)
saleQty :
number (decimal)
The sale item count of this line represents for PLU Sale items (ItemType 1-9).
For non sale items (ItemType >= 10) this should be set to 0.
Example: 1 (eg if line item is for 1 x Garlic Bread)
3 (eg if the line item is for 3 x Garlic Bread)
0 (eg if the line item is for 10% Discount, as this is not a sale item)
Nullable
decimal(18, 7)
stockQty :
number (decimal)
The unit count of stock items affected by this sale. A standard product would normally be 1:1 with SaleQty, modified products quite often affect the StockQty.
Example: 1 x Garlic Bread would have a SaleQty of 1 and a StockQty of 1
1 x DBL Jacks on Ice would have a SaleQty of 1 and a StockQty of 2 (as its a double shot)
Nullable
decimal(18, 2)
price :
number (decimal)
The single unit price of the PLU sale (ItemType 1-9) item. Price should include any INCLUSIVE taxes, but exclude any EXCLUSIVE/ADDON taxes.
For all other line types (ItemType >= 10) this should be zero.
Example: 1 x Garlic Bread (SaleQty 1, Price $5.00, Amount $5.00)
Example: 3 x Garlic Bread (SaleQty 3, Price $5.00, Amount $15.00)
Nullable
decimal(18, 2)
amount :
number (decimal)
The total value of the line item. Price should include any INCLUSIVE taxes, but exclude any EXCLUSIVE/ADDON taxes.
For sale items (ItemType 1-9) this should be the same as SaleQty * Price, for all other line types it should be the line value (if applicable).
Example: 1 x Garlic Bread (SaleQty 1, Price $5.00, Amount $5.00)
Example: 3 x Garlic Bread (SaleQty 3, Price $5.00, Amount $15.00)
Example: 10% Discount (SaleQty 0, Price $0.00, Amount -$1.50)
Nullable
decimal(18, 2)
cost :
number (decimal)
The single unit cost of the item. This should be zero for all non PLU sale items (ie ItemType > 10).
If cost is not known for a PLU sale item, set it to 0.
Nullable
decimal(18, 7)
incTax1 :
number (decimal)
This is the amount of Inclusive Tax (accurate to 7 decimal places) calculated for Tax level 1 for this line item.
This value should remain high precision, ie do not round any further than 7 decimal places. Using high precision reduces the tax rounding error at the overall transaction level and this accuracy is required in some tax juristictions.
Set to zero if no tax inclusive tax is required, or this tax level is not used
Example: 10% inclusive tax on $10.00, value would be 0.9090909
Nullable
decimal(18, 7)
incTax2 :
number (decimal)
This is the amount of Inclusive Tax (accurate to 7 decimal places) calculated for Tax level 2 for this line item.
This value should remain high precision, ie do not round any further than 7 decimal places. Using high precision reduces the tax rounding error at the overall transaction level and this accuracy is required in some tax juristictions.
Set to zero if no tax inclusive tax is required, or this tax level is not used
Example: 10% inclusive tax on $10.00, value would be 0.9090909
Nullable
decimal(18, 7)
incTax3 :
number (decimal)
This is the amount of Inclusive Tax (accurate to 7 decimal places) calculated for Tax level 3 for this line item.
This value should remain high precision, ie do not round any further than 7 decimal places. Using high precision reduces the tax rounding error at the overall transaction level and this accuracy is required in some tax juristictions.
Set to zero if no tax inclusive tax is required, or this tax level is not used
Example: 10% inclusive tax on $10.00, value would be 0.9090909
Nullable
decimal(18, 7)
incTax4 :
number (decimal)
This is the amount of Inclusive Tax (accurate to 7 decimal places) calculated for Tax level 4 for this line item.
This value should remain high precision, ie do not round any further than 7 decimal places. Using high precision reduces the tax rounding error at the overall transaction level and this accuracy is required in some tax juristictions.
Set to zero if no tax inclusive tax is required, or this tax level is not used
Example: 10% inclusive tax on $10.00, value would be 0.9090909
Nullable
decimal(18, 7)
exTax1 :
number (decimal)
This is the amount of Exclusive Tax (accurate to 7 decimal places) calculated for Tax level 1 for this line item.
This value should remain high precision, ie do not round any further than 7 decimal places. Using high precision reduces the tax rounding error at the overall transaction level and this accuracy is required in some tax juristictions.
Set to zero if no tax exclusive/addon tax is required, or this tax level is not used
Example: 8.125% exclusive tax on $2.50, value would be 0.2031250
Nullable
decimal(18, 7)
exTax2 :
number (decimal)
This is the amount of Exclusive Tax (accurate to 7 decimal places) calculated for Tax level 2 for this line item.
This value should remain high precision, ie do not round any further than 7 decimal places. Using high precision reduces the tax rounding error at the overall transaction level and this accuracy is required in some tax juristictions.
Set to zero if no tax exclusive/addon tax is required, or this tax level is not used
Example: 8.125% exclusive tax on $2.50, value would be 0.2031250
Nullable
decimal(18, 7)
exTax3 :
number (decimal)
This is the amount of Exclusive Tax (accurate to 7 decimal places) calculated for Tax level 3 for this line item.
This value should remain high precision, ie do not round any further than 7 decimal places. Using high precision reduces the tax rounding error at the overall transaction level and this accuracy is required in some tax juristictions.
Set to zero if no tax exclusive/addon tax is required, or this tax level is not used
Example: 8.125% exclusive tax on $2.50, value would be 0.2031250
Nullable
decimal(18, 7)
exTax4 :
number (decimal)
This is the amount of Exclusive Tax (accurate to 7 decimal places) calculated for Tax level 4 for this line item.
This value should remain high precision, ie do not round any further than 7 decimal places. Using high precision reduces the tax rounding error at the overall transaction level and this accuracy is required in some tax juristictions.
Set to zero if no tax exclusive/addon tax is required, or this tax level is not used
Example: 8.125% exclusive tax on $2.50, value would be 0.2031250
Nullable
decimal(18, 7)
taxSales1 :
number (decimal)
This is the sale value used for any Tax 1 calculations.
Typically this would be the same as the Amount field if the full amount of the item is being taxed.
Set to 0 only if this tax level is not used. For a tax free tax level (tax rate of 0%), this value should still be set to the amount that would be used for any normal tax calculation.
Nullable
decimal(18, 7)
taxSales2 :
number (decimal)
This is the sale value used for any Tax 2 calculations.
Typically this would be the same as the Amount field if the full amount of the item is being taxed.
Set to 0 only if this tax level is not used. For a tax free tax level (tax rate of 0%), this value should still be set to the amount that would be used for any normal tax calculation.
Nullable
decimal(18, 7)
taxSales3 :
number (decimal)
This is the sale value used for any Tax 3 calculations.
Typically this would be the same as the Amount field if the full amount of the item is being taxed.
Set to 0 only if this tax level is not used. For a tax free tax level (tax rate of 0%), this value should still be set to the amount that would be used for any normal tax calculation.
Nullable
decimal(18, 7)
taxSales4 :
number (decimal)
This is the sale value used for any Tax 4 calculations.
Typically this would be the same as the Amount field if the full amount of the item is being taxed.
Set to 0 only if this tax level is not used. For a tax free tax level (tax rate of 0%), this value should still be set to the amount that would be used for any normal tax calculation.
Nullable
statusFlags1 :
number (int)
The applicable status flags for the item. These are flags from the POSCorePublic.Enums.Sales.ItemStatusFlags enum
Nullable
priceLevelID :
number (int)
This unique PriceLevelID from the POS_PriceLevels (configuration) table representing the price level associated with the record (if applicable)
This is only applicable to PLU sale items (ItemType 1-9), use NULL for all other item types.
Nullable
MaxLength(32)
priceLevelName :
string
The name of the Price Level associated to the item record.
This is only applicable to PLU sale items (ItemType 1-9), use blank (empty string) for all other item types.
Example: "Price Level 1" or "Standard Prices" or "Happy Hour"
Nullable
createdBy_EmployeeID :
string (GUID)
The unique employee record ID of the employee / staff member who created the record.
Nullable
createdBy_UserID :
string (GUID)
This unique UserID from the POS_Users (configuration) table representing the POS user that created the record.
Nullable
serviceModeID :
string (GUID)
The unique ID of the POS_ServiceModes (configuration) record matching the Service Mode the item was added in.
Nullable
groupID_Reporting :
string (GUID)
The unique ID of the POS_Groups (configuration) record matching the Reporting Group the item was added from.
Only applicable for PLU sale items (ie ItemType 1-9), NULL for all other line types.
Nullable
mainGroupID :
string (GUID)
The unique ID of the POS_MainGroups (configuration) record matching the Main Group the item was added from.
Only applicable for PLU sale items (ie ItemType 1-9), NULL for all other line types.
Nullable
itemType :
number (int)
The type of item this record represents. This must be a valid value from from the from POSCorePublic.Enums.Sales.SaleItemType enum.
Nullable
itemReferenceID :
string (GUID)
The unique ID of the configuration record matching the Item Type this record was populated from (if applicable).
Example: For PLU based ItemType's, this would be the PLUID from the POS_PLUs table
Example: For Adjustment ItemType's this would be the AdjustmentID from the POS_Adjustments table
Nullable
salesModifierID :
string (GUID)
The unique ID of the POS_SalesModifier (configuration) record matching the Sales Modifier that was added to the item (if applicable).
Only applicable for PLU sale items (ie ItemType 1-9), NULL for all other line types or where no Sales Modifier was applied.
Nullable
parentSalesTransactionItemID :
string (GUID)
[INTERNAL USE]
The unique ID of the POS_SalesTransactionItem parent record that this sale links to (child products only)
Only applicable for PLU sale child products (ie ItemType 2-5 and 7), NULL for all other line types.
Example: T-Bone Steak (SalesTransactionItemID1, this is a parent record, ParentSalesTransactionItemID will be NULL)
Medium Well (SalesTransactionItemID2, this is a child record, ParentSalesTransactionItemID would be SalesTransactionItemID1)
Pepper Sauce (SalesTransactionItemID3, this is a child record, ParentSalesTransactionItemID would be SalesTransactionItemID1)
Nullable
taxGroupID :
string (GUID)
This is the unique TaxGroupID of a record from the POS_TaxGroups (configuration) table representing the Tax Group which was used for tax calculations on this item.
Only applicable for PLU sale items (ie ItemType 1-9), NULL for all other line types.
Nullable
MaxLength(32)
taxGroupName :
string
The name of the Tax Group which was used for tax calculations on this item.
Only applicable for PLU sale items (ie ItemType 1-9), blank (empty string) for all other line types.
Example: "VAT" or "GST" or "Tax Free"
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
decimal(18, 2)
adjustmentAmount :
number (decimal)
The total amount of adjustment applied to this specific item's amount
Nullable
decimal(18, 7)
adjustmentIncTax1 :
number (decimal)
The total amount of adjustment applied to this specific item's IncTax1
Nullable
decimal(18, 7)
adjustmentIncTax2 :
number (decimal)
The total amount of adjustment applied to this specific item's IncTax2
Nullable
decimal(18, 7)
adjustmentIncTax3 :
number (decimal)
The total amount of adjustment applied to this specific item's IncTax3
Nullable
decimal(18, 7)
adjustmentIncTax4 :
number (decimal)
The total amount of adjustment applied to this specific item's IncTax4
Nullable
decimal(18, 7)
adjustmentExTax1 :
number (decimal)
The total amount of adjustment applied to this specific item's ExTax1
Nullable
decimal(18, 7)
adjustmentExTax2 :
number (decimal)
The total amount of adjustment applied to this specific item's ExTax2
Nullable
decimal(18, 7)
adjustmentExTax3 :
number (decimal)
The total amount of adjustment applied to this specific item's ExTax3
Nullable
decimal(18, 7)
adjustmentExTax4 :
number (decimal)
The total amount of adjustment applied to this specific item's ExTax4
Nullable
decimal(18, 2)
amountAdjusted :
number (decimal)
The total amount of this item after the adjustments have been applied
Nullable
decimal(18, 7)
incTax1Adjusted :
number (decimal)
The total IncTax1 of this item after the adjustments have been applied
Nullable
decimal(18, 7)
incTax2Adjusted :
number (decimal)
The total IncTax2 of this item after the adjustments have been applied
Nullable
decimal(18, 7)
incTax3Adjusted :
number (decimal)
The total IncTax3 of this item after the adjustments have been applied
Nullable
decimal(18, 7)
incTax4Adjusted :
number (decimal)
The total IncTax4 of this item after the adjustments have been applied
Nullable
decimal(18, 7)
exTax1Adjusted :
number (decimal)
The total ExTax1 of this item after the adjustments have been applied
Nullable
decimal(18, 7)
exTax2Adjusted :
number (decimal)
The total ExTax2 of this item after the adjustments have been applied
Nullable
decimal(18, 7)
exTax3Adjusted :
number (decimal)
The total ExTax3 of this item after the adjustments have been applied
Nullable
decimal(18, 7)
exTax4Adjusted :
number (decimal)
The total ExTax4 of this item after the adjustments have been applied
Example
{
"salesTransactionItemID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"revision": 321,
"dateTimeOrdered": "2012-04-03T09:40:59.736Z",
"sortID": 321,
"createdBy_UserName": "string value",
"serviceModeName": "string value",
"serviceModeEntityID": "string value",
"groupName": "string value",
"mainGroupName": "string value",
"itemName": "string value",
"plU": "string value",
"saleModifierName": "string value",
"saleModifierPrefixName": "string value",
"created_TerminalName": "string value",
"created_TerminalDisplayID": "string value",
"outletName": "string value",
"salesTransactionID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"dateTimeModified": "2012-04-03T09:40:59.736Z",
"seat": 321,
"saleQty": 1.23,
"stockQty": 1.23,
"price": 1.23,
"amount": 1.23,
"cost": 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,
"taxSales1": 1.23,
"taxSales2": 1.23,
"taxSales3": 1.23,
"taxSales4": 1.23,
"statusFlags1": 321,
"priceLevelID": 321,
"priceLevelName": "string value",
"createdBy_EmployeeID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"createdBy_UserID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"serviceModeID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"groupID_Reporting": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"mainGroupID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"itemType": 321,
"itemReferenceID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"salesModifierID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"parentSalesTransactionItemID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"taxGroupID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"taxGroupName": "string value",
"created_TerminalID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"adjustmentAmount": 1.23,
"adjustmentIncTax1": 1.23,
"adjustmentIncTax2": 1.23,
"adjustmentIncTax3": 1.23,
"adjustmentIncTax4": 1.23,
"adjustmentExTax1": 1.23,
"adjustmentExTax2": 1.23,
"adjustmentExTax3": 1.23,
"adjustmentExTax4": 1.23,
"amountAdjusted": 1.23,
"incTax1Adjusted": 1.23,
"incTax2Adjusted": 1.23,
"incTax3Adjusted": 1.23,
"incTax4Adjusted": 1.23,
"exTax1Adjusted": 1.23,
"exTax2Adjusted": 1.23,
"exTax3Adjusted": 1.23,
"exTax4Adjusted": 1.23
}