SalesTransactionItemAdjustmentLink Model

This record defines the adjustment (ie discount/surcharge) effects on the Amount and Taxes of a PLU sale line item.

Required
SalesTransactionItemAdjustmentLinkID : string (GUID)

The Unique identifier for this record

Required
SalesTransactionItemID_Adjustment : string (GUID)

The unique ID of the POS_SalesTransactionItem record of the adjustment (ie discount/surcharge) line item that this record is associated with.

Required
SalesTransactionItemID_Product : string (GUID)

The unique ID of the POS_SalesTransactionItem record of the product (ie PLU sale) line item that this record is associated with.

Required MaxLength(64) Truncates
AdjustmentRevenue_CostCenterCommonName : string

The name of the cost center allocated to this adjustment for revenue tracking purposes (if applicable), otherwise blank (ie empty string)
Note: This should be in the organisations "Common Language", ie their overall default neutral language (typically English).
3rd Party integrations can make up their own revenue center names if required, or they can base them on the existing configuration records if available.
Example: "Restaurant" or "Outlet" or "Front Bar"

Required MaxLength(64) Truncates
AdjustmentRevenue_CostCenterLocalizedName : string

The localised name of the cost center allocated to this adjustment for revenue tracking purposes (if applicable), otherwise blank (ie empty string)
Note: This should be in the outlets "Local Language", ie the language used by the POS system on site. This may or may not be the same as the common language.
3rd Party integrations can make up their own revenue center names if required, or they can base them on the existing configuration records if available.
Example: "Restaurant" or "Outlet" or "Front Bar"

Nullable decimal(18, 2)
Amount : number (decimal)

The amount that the adjustment (ie discount/surcharge) applies to the linked SalesTransactionItemID_Product line item
Example: -1.00 (would be a $1.00 discount to the referenced product line item)
Example: 0.50 (would be a $0.50 surcharge to the referenced product line item)

Nullable decimal(18, 7)
IncTax1 : number (decimal)

The amount that the adjustment (ie discount/surcharge) affects the IncTax1 field of the linked SalesTransactionItemID_Product line item
Set this to 0 if tax is not affected by the adjustment, or if this tax level is not used.
Example: -0.15 (would be a reduction of $0.15 to the Inclusive Tax 1 field of the sale item)

Nullable decimal(18, 7)
IncTax2 : number (decimal)

The amount that the adjustment (ie discount/surcharge) affects the IncTax2 field of the linked SalesTransactionItemID_Product line item
Set this to 0 if tax is not affected by the adjustment, or if this tax level is not used.
Example: -0.15 (would be a reduction of $0.15 to the Inclusive Tax 2 field of the sale item)

Nullable decimal(18, 7)
IncTax3 : number (decimal)

The amount that the adjustment (ie discount/surcharge) affects the IncTax3 field of the linked SalesTransactionItemID_Product line item
Set this to 0 if tax is not affected by the adjustment, or if this tax level is not used.
Example: -0.15 (would be a reduction of $0.15 to the Inclusive Tax 3 field of the sale item)

Nullable decimal(18, 7)
IncTax4 : number (decimal)

The amount that the adjustment (ie discount/surcharge) affects the IncTax4 field of the linked SalesTransactionItemID_Product line item
Set this to 0 if tax is not affected by the adjustment, or if this tax level is not used.
Example: -0.15 (would be a reduction of $0.15 to the Inclusive Tax 4 field of the sale item)

Nullable decimal(18, 7)
ExTax1 : number (decimal)

The amount that the adjustment (ie discount/surcharge) affects the ExTax1 field of the linked SalesTransactionItemID_Product line item
Set this to 0 if tax is not affected by the adjustment, or if this tax level is not used.
Example: -0.15 (would be a reduction of $0.15 to the Exclusive Tax 1 field of the sale item)

Nullable decimal(18, 7)
ExTax2 : number (decimal)

The amount that the adjustment (ie discount/surcharge) affects the ExTax2 field of the linked SalesTransactionItemID_Product line item
Set this to 0 if tax is not affected by the adjustment, or if this tax level is not used.
Example: -0.15 (would be a reduction of $0.15 to the Exclusive Tax 2 field of the sale item)

Nullable decimal(18, 7)
ExTax3 : number (decimal)

The amount that the adjustment (ie discount/surcharge) affects the ExTax3 field of the linked SalesTransactionItemID_Product line item
Set this to 0 if tax is not affected by the adjustment, or if this tax level is not used.
Example: -0.15 (would be a reduction of $0.15 to the Exclusive Tax 3 field of the sale item)

Nullable decimal(18, 7)
ExTax4 : number (decimal)

The amount that the adjustment (ie discount/surcharge) affects the ExTax4 field of the linked SalesTransactionItemID_Product line item
Set this to 0 if tax is not affected by the adjustment, or if this tax level is not used.
Example: -0.15 (would be a reduction of $0.15 to the Exclusive Tax 4 field of the sale item)

Nullable
Type : number (int)

The type of adjustment effect type this record represents. This must be a value from the POSCorePublic.Enums.Sales.ItemAdjustmentLinkType

Nullable
Flags : number (int)

The flags relating to how this record is applied. This must be a value from the POSCorePublic.Enums.Sales.ItemAdjustmentLinkFlags
Example: ItemAdjustmentLinkFlags.AffectsTax1 indicates that Tax level 1 is affected by the adjustment.

Nullable
SplitBillID : number (int)

Indicates if the adjustment is specific to a certain split bill. Only applicable to "All Items" type adjustments.
3rd Party integrations should set this to 0.

Nullable
AdjustmentRevenue_CostCenterID : string (GUID)

This is the unique ID of a record from the POS_CostCenters (configuration) table representing the cost center allocated to this adjustment for revenue tracking purposes
3rd Party integrations would normally set this to be NULL

Example
{
  "SalesTransactionItemAdjustmentLinkID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "SalesTransactionItemID_Adjustment": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "SalesTransactionItemID_Product": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "AdjustmentRevenue_CostCenterCommonName": "string value",
  "AdjustmentRevenue_CostCenterLocalizedName": "string value",
  "Amount": 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,
  "Type": 321,
  "Flags": 321,
  "SplitBillID": 321,
  "AdjustmentRevenue_CostCenterID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512"
}