Required
salesTransactionItemCorrectionID :
string (GUID)
The Unique identifier for this record
Required
salesTransactionItemID_Original :
string (GUID)
The unique ID of the POS_SalesTransactionItem record of the original line item that this record is associated with. Ie the item that was affected by the correction.
Required
salesTransactionItemID_Corrected :
string (GUID)
The unique ID of the POS_SalesTransactionItem record of the corrected version of the line item that this record is associated with. Ie the item that has results from the correction.
Note: For inline corrections (where source item is modified directly), this will be the same item as SalesTransactionItemID_Original.
For non-inline corrections (where the source item is duplicated and the reversed), this will be a different item that the SalesTransactionItemID_Original
Required
revision :
number (int)
This represents the revision of the configuration data that was being used when this record was generated
Required
dateTimeCorrected :
string (ISO 8601 DateTime)
The date and time the correction was applied in outlet local time.
Required
correctionTypeBaseType :
number (int)
The base type of the correction. This must be a value from the POSCorePublic.Enums.Configuration.CorrectionBaseTypes enum
Required
MaxLength(32)
correctionTypeName :
string
The name of the Correction Type that was applied to the item.
Example: "Error Correct" or "Refund" or "Cancel Item" or "Void"
Required
MaxLength(32)
correctedBy_UserName :
string
The name of the POS User / person who created the record.
Example: John
Required
MaxLength(64)
correctedBy_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)
correctedBy_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
decimal(13, 2)
saleQtyBefore :
number (decimal)
The SaleQty value of the original item record BEFORE the correction was applied
Nullable
decimal(18, 7)
stockQtyBefore :
number (decimal)
The StockQty value of the original item record BEFORE the correction was applied
Nullable
decimal(18, 2)
priceBefore :
number (decimal)
The Price value of the original item record BEFORE the correction was applied
Nullable
decimal(18, 2)
amountBefore :
number (decimal)
The Amount value of the original item record BEFORE the correction was applied
Nullable
decimal(13, 2)
saleQtyAfter :
number (decimal)
The SaleQty value of the item record AFTER the correction was applied
Nullable
decimal(18, 7)
stockQtyAfter :
number (decimal)
The StockQty value of the item record AFTER the correction was applied
Nullable
decimal(18, 2)
priceAfter :
number (decimal)
The Price value of the item record AFTER the correction was applied
Nullable
decimal(18, 2)
amountAfter :
number (decimal)
The Amount value of the item record AFTER the correction was applied
Nullable
correctionTypeID :
string (GUID)
This is the unique ID of a record from the POS_CorrectionTypes (configuration) table representing the Correction Type that was used to create this record
Nullable
correctedBy_EmployeeID :
string (GUID)
The unique employee record ID of the employee / staff member who created the record.
Nullable
correctedBy_UserID :
string (GUID)
This unique UserID from the POS_Users (configuration) table representing the POS user that created the record.
Nullable
manager_EmployeeID :
string (GUID)
The unique employee record ID of the employee / manager who approved the action that created this record (if applicable).
Typically this value will be NULL as manager authorisation is usually only required occasionally.
Nullable
manager_UserID :
string (GUID)
This unique UserID from the POS_Users (configuration) table representing the POS User who approved the action that created this record (if applicable).
Typically this value will be NULL as manager authorisation is usually only required occasionally.
Nullable
MaxLength(32)
manager_UserName :
string
The name of the POS User / person who approved the action that created this record (if applicable).
Typically this value will be NULL as manager authorisation is usually only required occasionally.
Example: Mary
Nullable
correctedBy_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
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 correction.
Example: "Error Correct Reasons"
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 correction.
Example: "Food was cold"
Example
{
"salesTransactionItemCorrectionID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"salesTransactionItemID_Original": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"salesTransactionItemID_Corrected": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"revision": 321,
"dateTimeCorrected": "2012-04-03T09:40:59.736Z",
"correctionTypeBaseType": 321,
"correctionTypeName": "string value",
"correctedBy_UserName": "string value",
"correctedBy_TerminalName": "string value",
"correctedBy_TerminalDisplayID": "string value",
"outletName": "string value",
"salesTransactionID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"saleQtyBefore": 1.23,
"stockQtyBefore": 1.23,
"priceBefore": 1.23,
"amountBefore": 1.23,
"saleQtyAfter": 1.23,
"stockQtyAfter": 1.23,
"priceAfter": 1.23,
"amountAfter": 1.23,
"correctionTypeID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"correctedBy_EmployeeID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"correctedBy_UserID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"manager_EmployeeID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"manager_UserID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"manager_UserName": "string value",
"correctedBy_TerminalID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"remarkGroupID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"remarkGroupName": "string value",
"remarkID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"remarkName": "string value"
}