ServiceCharge

Any charge applied to a check for something other than menu item. Typical examples include gratuity and delivery fees.

amount
number <double>

Amount in USD to be applied for FIXED type service charges.

amountType
string

The type of service charge.

Enum: "FIXED" "PERCENT" "OPEN"
Array of objects (TaxRate)

A reference to the taxes applied to the service charge, if the service charge is taxable.

object (ServiceChargeCriteria)

Describes thresholds for when a service charge should be applied to a check.

destination
string

Final recipient of the funds from this service charge.

  • RESTAURANT - The business owner of the restaurant receives the service charge funds.
  • SERVER - Restaurant employees receive the service charge funds e.g. gratuity.
  • TOAST - Toast receives the service charge funds.
  • THIRD_PARTY - A third party receives the service charge funds e.g. fundraising funds go to charity.
Enum: "RESTAURANT" "SERVER" "TOAST" "THIRD_PARTY"
entityType
required
string

The type of object this is.

externalId
string

External identifier string, prefixed by the naming authority.

gratuity
boolean

True if the service charge is a gratuity and is assigned to the owner of the check.

guid
required
string

The GUID maintained by the Toast POS.

name
string

The name of this service charge.

percent
number <double>

Percent fee to be applied for PERCENT type service charges, based on pre-discount check amount. Must be a number between 0 and 100.

serviceChargeCalculation
string

Defines whether or not the service charge is applied before (PRE) or after (POST) discounts. This field is null for non-percent service charges.

Enum: "PRE_DISCOUNT" "POST_DISCOUNT"
taxable
boolean

True if tax should be applied to the service charge.

{
  • "guid": "string",
  • "entityType": "string",
  • "externalId": "string",
  • "name": "string",
  • "amountType": "FIXED",
  • "amount": 0,
  • "percent": 0,
  • "criteria": {
    },
  • "gratuity": true,
  • "taxable": true,
  • "applicableTaxes": [
    ],
  • "serviceChargeCalculation": "PRE_DISCOUNT",
  • "destination": "RESTAURANT"
}