Surcharge
- idType: integer | stringFormat: int32required
Unique Id of this Surcharge
- nameType: null | stringrequired
Name of this Surcharge
- amountType: number | stringFormat: double
Amount of this Surcharge
- automaticallyType: boolean
Apply True if this Surcharge is automatically applied, False if not
- daysType: integer | stringFormat: int32
Returns an int describing the days this Surcharge applies:
- endType: stringFormat: date-time
Date Applies if EnforceDateRanges is true: End date for when this Surcharge is enforced
- endType: stringFormat: date-time
Time Applies if EnforceTimeRanges is true: End time for when this Surcharge is enforced
- enforceType: boolean
Date Ranges True if this Surcharge is enforced within a specified date range, False if not
- enforceType: boolean
Days True if this Surcharge is enforced on specific days, False if not
- enforceType: boolean
Party Size True if this Surcharge is enforced within a specified date range, False if not
- enforceType: boolean
Time Ranges True if this Surcharge is enforced within a specified time range, False if not
- limitType: boolean
Destinations True if this Surcharge is limited to ValidDestinationIds, False if not
- limitType: boolean
Sections True if this Surcharge is limited to ValidSectionIds, False if not
- maximumType: integer | stringFormat: int32
Party Size Applies if EnforcePartySize is true: Maximum party size for which this Surcharge is enforced, 0 if null
- methodType: integer | stringFormat: int32
Returns one of the following: 0 = Fixed Per Order 1 = Percentage Per Order 2 = Fixed Per Item 3 = Percentage Per Item
- minimumType: integer | stringFormat: int32
Party Size Applies if EnforcePartySize is true: Minimum party size for which this Surcharge is enforced, 0 if null
- promptType: boolean
True if this Surcharge is prompted, False if not
- startType: stringFormat: date-time
Date Applies if EnforceDateRanges is true: Start date for when this Surcharge is enforced
- startType: stringFormat: date-time
Time Applies if EnforceTimeRanges is true: Start time for when this Surcharge is enforced
- taxType: null | array of integer | stringFormat: int32
Ids Maps to the Id(s) of the Tax(es) associated with this Surcharge
- terminalType: integer | stringFormat: int32
Types Returns a byte describing the terminal the values this Surcharge applies to: 0 = None 1 = Register 2 = Web Ordering 8 = Web Mobile Ordering 16 = Web-Service 32 = Mobile App
- typeType: integer | stringFormat: int32
Returns one of the following: 0 = ServiceCharge 1 = Gratuity 2 = NonCashAdjustment
- validType: null | array of integer | stringFormat: int32
Destination Ids Applies if LimitDestinations is true: Maps to the Id(s) of the Destination(s) this Surcharge is limited to
- validType: null | array of integer | stringFormat: int32
Section Ids Applies if LimitDestinations is true: Maps to the Id(s) of the Section(s) this Surcharge is limited to
