AppliedServiceCharge

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

Array of objects (AppliedTaxRate)

Derived from serviceCharge - the taxes applied to the service

chargeAmount
number <double>

The final applied amount excluding tax. This is required if amountType is OPEN.

chargeType
string

Derived from serviceCharge. An OPEN service charge can either be a dollar amount or a percentage.

Enum: "FIXED" "PERCENT" "OPEN"
delivery
boolean

Derived from serviceCharge - whether this service charge is a delivery charge.

entityType
required
string

The type of object this is.

externalId
string

External identifier string that is prefixed by the naming authority.

gratuity
boolean

Derived from serviceCharge - whether this service charge is a gratuity. Can be used to derive required tip amount on the check.

guid
required
string

The GUID maintained by Toast.

name
string

Derived from serviceCharge - the configured human readable label for the service charge.

required
object (ExternalReference)

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

taxable
boolean

Derived from serviceCharge - whether this service charge is taxable.

{
  • "guid": "string",
  • "entityType": "string",
  • "externalId": "string",
  • "chargeAmount": 0,
  • "serviceCharge": {
    },
  • "chargeType": "FIXED",
  • "name": "string",
  • "delivery": true,
  • "gratuity": true,
  • "taxable": true,
  • "appliedTaxes": [
    ]
}