Discount
- activeType: boolean
True if this Discount is active, False if inactive
- allowType: boolean
Later Discounts True if this Discount can be applied to orders that have already been sent, False if not
- allowType: boolean
Prior Discounts True if this Discount can be applied before items are populated on the order, False if not
- amountType: number | stringFormat: double
New amount for the item this Discount is applied to
- approvalType: boolean
Needed - discountedType: boolean
Items Eligible True if already discounted items will be eligible for this Discount, False if not
- eligibleType: null | array of integer | stringFormat: int32
Item Group Ids Maps to the Id(s) of the Item Group(s) eligible for this Discount
- eligibleType: integer | stringFormat: int32
Item Id Maps to the Id of the Item eligible for this Discount, 0 if null
- endType: stringFormat: date-time
Date End date after which this Discount will be discontinued
- endType: stringFormat: date-time
Time End time after which this Discount will be discontinued
- enforceType: boolean
Maximum Amount True if this Discount amount will not be able to exceed MaximumAmount value, False if not enforced
- enforceType: boolean
Maximum Items True if this Discount will not be applied to items exceeding MaximumItems value, False if not enforced
- enforceType: boolean
Maximum Per Order True if this Discount per order will not be able to exceed MaximumPerOrder value, False if not enforced
- excludeType: boolean
Items From Product Mix True if items will be excluded from product mix, False if not
- externalType: null | string
Id Stores the external identifier of a loyalty reward created via a loyalty provider outside the Brink System
- fridayType: boolean
True if this Discount can be applied on Fridays, False if not
- granularityType:
Returns one of the following: Order Items
Possible values:
Order= 0Items= 1
- idType: integer | stringFormat: int32
Unique Id of this Discount
- isType: boolean
Employee Discount True if this Discount is an employee discount, False if not
- isType: boolean
Loyalty Discount True if this discount can only be applied via the redemption of a loyalty reward, False if not
- maximumType: number | stringFormat: double
Amount Maximum amount allowed for this Discount, 0 if null
- maximumType: integer | stringFormat: int32
Items Maximum number of items Discount can be applied to, 0 if null
- maximumType: integer | stringFormat: int32
Per Order Maximum amount per order this Discount can be applied for, 0 if null
- mondayType: boolean
True if this Discount can be applied on Mondays, False if not
- mustType: boolean
Enter Amount True if entering an amount for this Discount is required, False if not
- mustType: boolean
Enter Name True if entering a name for this Discount is required, False if not
- mustType: boolean
Enter Percent True if entering a percentage for this Discount is required, False if not
- nameType: null | string
Name of this Discount
- openType: boolean
Drawer If True, drawer will open, False if not
- printedType: null | string
Name Name of Discount printed on receipt
- printType: boolean
Order True if the order will be printed, False if not
- rateType: number | stringFormat: double
Percentage of the Discount to be applied
- saturdayType: boolean
True if this Discount can be applied on Saturdays, False if not
- startType: stringFormat: date-time
Date Start date of when this Discount can be applied
- startType: stringFormat: date-time
Time Start time of when this Discount can be applied
- sundayType: boolean
If True, Discount can be applied on Sundays, False if not
- thursdayType: boolean
True if this Discount can be applied on Thursdays, False if not
- tuesdayType: boolean
True if this Discount can be applied on Tuesdays, False if not
- typeType:
Returns one of the following: None Comp New Price Max
Possible values:
None= 0Comp= 1NewPrice= 2Max= 3
- useType: boolean
Date Range Filter True if this Discount can only be applied between StartDate and EndDate, False if not enforced
- useType: boolean
Day Filter True if this Discount can only be applied on specific days, False if not enforced
- useType: boolean
Item Filter True if this Discount can only be applied on designated item with EligibleItemId, False if not enforced
- useType: boolean
Item Group Filter True if this Discount can only be applied on designated items within EligibleItemGroupIds, False if not enforced
- useType: boolean
Time Range Filter True if this Discount can only be applied between StartTime and EndTime, False if not enforced
- wednesdayType: boolean
True if this Discount can be applied on Wednesdays, False if not
