TipWithholding

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

enabled
boolean

Indicates whether a restaurant location withholds a percent of employees' credit card tips.

  • true - the location keeps a percent of employees' credit card tips.

  • false - the location does not keep a percent of employees' credit card tips.

entityType
required
string

The type of object this is.

guid
required
string

The GUID maintained by the Toast POS.

percentage
number

The decimal percentage of credit card tips withheld. If tip withholding is not enabled, tips will not be withheld in the Toast platform regardless of this value.

{
  • "guid": "string",
  • "entityType": "string",
  • "enabled": true,
  • "percentage": 0
}