A rule defines the fee that is applied when specific conditions (also defined by the rule) are met. You can use a rule to apply a service fee to a restaurant order.
Rule ID.
ID of the restaurant’s location.
Rule name.
Date and time the rule was created.
Date and time the rule was updated.
Percentage value to apply as a custom tax rate. For example, 5
respresents a 5% fee applied to the order's total.
Min: '0'.
Max: 100
.
Specifies the type of condition.
Specifies the type of condition.
Whether the rule is enabled. If true
, the rule is evaluated when service fees are calculated. If false
, the rule will not be evaluated when service fees are calculated.
Revision number. Increments by 1 each time the rule is updated.
To prevent conflicting changes, the existing revision
must be used when updating a rule.
DEPRECATED. Defines the app that the rule is connected to.
Defines the app that the rule is connected to.
Rounding strategy to apply to fee and tax calculation.
HALF_UP
rounds up any number exactly halfway between two integers. For example, 2.5
rounds to 3
, and 3.5
and rounds to 4
.HALF_EVEN
rounds such numbers to the nearest even integer. For example, 2.5
rounds to 2
, but 3.5
rounds to 4
.Fixed fee. Must hold a positive value.
Percentage fee. For example, 5
respresents a 5% fee applied to the order's total.
Fixed fee. Must hold a positive value.
Percentage fee. For example, 5
respresents a 5% fee applied to the order's total.
Single condition that must be met for the rule to be applied to an order.
Binary tree of conditions. Use the operator to indicate whether only one or both conditions must be met in order for a service fee rule to be applied to an order.
Single condition that must be met for the rule to be applied to an order.
Binary tree of conditions. Use the operator to indicate whether only one or both conditions must be met in order for a service fee rule to be applied to an order.
Percentage value to apply as a custom tax rate. Range: [0-100].
Tax group ID. Internal only.