Get a payout reason

Returns a PayoutReason object containing information about a recurring restaurant expense that is paid in cash. Payout reasons are pre-configured for a restaurant.

Securityoauth2

Request

path Parameters

• guid required:
  string

  The Toast POS GUID of the payout reason.

header Parameters

• Toast-Restaurant-External-ID required:
  string

  The Toast POS GUID of the restaurant that the configuration applies to.

Responses

200

Returns a PayoutReason object.

get /payoutReasons/{guid}

Request samples

curl -i -X GET \
  'https://toast-api-server/config/v2/payoutReasons/{guid}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Toast-Restaurant-External-ID: string'

Response samples

application/json

{
  "guid": "string",
  "entityType": "string",
  "name": "string"
}