Name Type Description Additional information
CMReasonID integer

Reason for Discount. See Get Reason Types.

Name string

Discount name. This will show on the Transaction and Reports.

Amount decimal number

Discount Amount.

PromptText string

IsDiscountByPercentage boolean

True: Amount is Percentage. False: Amount is whole number.

IsManagerOverride boolean

Used to set if Manager permissions are required.

IsApplyToOptions boolean

Used to set if Discount should apply to Options or only full Items.

IsMustHaveItemsSelected boolean

Used to set if items must be selected before discount is applied. If not; All items on the Transaction are discounted.

IsPromptForReason boolean

Used to set if Reason prompt should show on every trigger of the discount.

IncludedProducts string

Used to specify which Products discount can be applied to. CSV List.

MaxCovers integer

Used to set if Discount should apply if Transaction exceeds cover count.

TriggerBarcode string

Used to set barcode value to trigger the Discount through a barcode scan.

StartDate date

Start Date from which Discount can be applied.

EndDate date

End Date at which Discount can no longer be applied.

PriceGroupIDs string

Price Group IDs for which Discount can apply to. If none set, applies to all Price Groups.

ApplyIfBestDiscount boolean

Used to set priority if more than one Discount is being applied.

MaxValue decimal number

Used to set Maximum Discount value which applying Discount will not exceed.

StockCode string

Stock Code used for Reporting and Stock.

ShortName string

Short name used on bills and receipts.

Quantity integer

Used to set how many of the discount should be applied.

DiscountSchedule Collection of PostDiscountSchedule

List of schedules (day of the week) when Promotion should trigger.