PartnerSalesTransactionAdjustment Model

This model defines the adjustment (ie discount/surcharge) effects on Transactions and PLU sale line items within a Partner Sales Transaction.

Required MaxLength(50)
adjustmentName : string

The name for the adjustment to be displayed in the sales data.
Example: "10% Discount"
Note: When BucketID is used, this value must be the same for all PartnerSalesTransactionAdjustment with the same BucketID

Nullable MaxLength(64)
bucketID : string

(Optional) Use this ID when you have a subset of the PartnerSalesTransactionItem records that are included in the same adjustment (discount/surcharge).
Default: null (no bucket)
Note: Only applicable to PartnerSalesTransactionItem.ItemAdjustments, this field is ignored for PartnerSalesTransaction.OrderAdjustments.
Important: When used, all PartnerSalesTransactionItem.ItemAdjustments with the same BucketID must have the same AdjustmentName and AdjustmentRevenue_CostCenterName value or the transaction will be rejected.
Important: When used, each PartnerSalesTransactionItem.ItemAdjustments record's values are expected to be the already prorated portions of the adjustment to apply to this item. The system will sum up the PartnerSalesTransactionAdjustment records for the batch to determine the overall adjustment amount.

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

The amount that the adjustment (ie discount/surcharge) affects the value of the sale line item. This should include any INCLUSIVE taxes effects, but exclude any EXCLUSIVE/ADDON tax effects.
Example: -1.00 (would be a $1.00 discount to the related plu sale item)
Example: 0.50 (would be a $0.50 surcharge to the related plu line item)
OrderAdjustments - The total adjustment amount that will be automatically prorated over all items on the order.
ItemAdjustments - The portion of the adjustment amount specific to the item that this record is attached to. Ie the already prorated value

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

(Optional) The amount that the adjustment (ie discount/surcharge) affects IncTax1
Default: 0
Set this to 0 if tax is not affected by the adjustment, or NULL 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)
OrderAdjustments - The total adjustment's IncTax1 value that will be automatically prorated over all items on the order.
ItemAdjustments - The portion of the adjustment's IncTax1 value specific to the item that this record is attached to. Ie the already prorated value

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

(Optional) The amount that the adjustment (ie discount/surcharge) affects IncTax2
Default: 0
Set this to 0 if tax is not affected by the adjustment, or NULL 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)
OrderAdjustments - The total adjustment's IncTax2 value that will be automatically prorated over all items on the order.
ItemAdjustments - The portion of the adjustment's IncTax2 value specific to the item that this record is attached to. Ie the already prorated value

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

(Optional) The amount that the adjustment (ie discount/surcharge) affects IncTax3
Default: 0
Set this to 0 if tax is not affected by the adjustment, or NULL 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)
OrderAdjustments - The total adjustment's IncTax3 value that will be automatically prorated over all items on the order.
ItemAdjustments - The portion of the adjustment's IncTax3 value specific to the item that this record is attached to. Ie the already prorated value

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

(Optional) The amount that the adjustment (ie discount/surcharge) affects IncTax4
Default: 0
Set this to 0 if tax is not affected by the adjustment, or NULL 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)
OrderAdjustments - The total adjustment's IncTax4 value that will be automatically prorated over all items on the order.
ItemAdjustments - The portion of the adjustment's IncTax4 value specific to the item that this record is attached to. Ie the already prorated value

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

(Optional) The amount that the adjustment (ie discount/surcharge) affects ExTax1
Default: 0
Set this to 0 if tax is not affected by the adjustment, or NULL 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)
OrderAdjustments - The total adjustment's ExTax1 value that will be automatically prorated over all items on the order.
ItemAdjustments - The portion of the adjustment's ExTax1 value specific to the item that this record is attached to. Ie the already prorated value

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

(Optional) The amount that the adjustment (ie discount/surcharge) affects ExTax2
Default: 0
Set this to 0 if tax is not affected by the adjustment, or NULL 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)
OrderAdjustments - The total adjustment's ExTax2 value that will be automatically prorated over all items on the order.
ItemAdjustments - The portion of the adjustment's ExTax2 value specific to the item that this record is attached to. Ie the already prorated value

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

(Optional) The amount that the adjustment (ie discount/surcharge) affects ExTax3
Default: 0
Set this to 0 if tax is not affected by the adjustment, or NULL 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)
OrderAdjustments - The total adjustment's ExTax3 value that will be automatically prorated over all items on the order.
ItemAdjustments - The portion of the adjustment's ExTax3 value specific to the item that this record is attached to. Ie the already prorated value

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

(Optional) The amount that the adjustment (ie discount/surcharge) affects ExTax4
Default: 0
Set this to 0 if tax is not affected by the adjustment, or NULL 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)
OrderAdjustments - The total adjustment's ExTax4 value that will be automatically prorated over all items on the order.
ItemAdjustments - The portion of the adjustment's ExTax4 value specific to the item that this record is attached to. Ie the already prorated value

Nullable MaxLength(64)
adjustmentRevenue_CostCenterName : string

(Optional) The name of the cost center allocated to this adjustment for revenue tracking purposes (if applicable)
Default: "" (ie blank string)
3rd Party integrations can use their own cost center names if required, or they can base them on the existing configuration records if available.
Example: "Restaurant" or "Outlet" or "Front Bar"
Note: When BucketID is used, this value must be the same for all PartnerSalesTransactionAdjustment with the same BucketID

Example
{
  "adjustmentName": "string value",
  "bucketID": "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,
  "adjustmentRevenue_CostCenterName": "string value"
}