Get payout reasons

Returns an array of PayoutReason objects containing information about recurring cash expenses configured for a restaurant. For example, payment for services such as window washing might be payout reasons. If a lastModified date is specified, returns all objects that were created or modified after that date.

Request
query Parameters
pageToken
string

A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the pageToken parameter from the Toast-Next-Page-Token header field value of a previous request to the endpoint. For more information, see Paginating response data.

pageSize
integer

The number of objects to return in the array.

Deprecated. For more information, see Paginating response data.

page
integer

The sequence number of the first object to return in the array.

Deprecated. For more information, see Paginating response data.

lastModified
string <date>

Limits the return data to objects created or modified after a specific date and time. For example: 2015-12-01T00:00:00.000+0000.

header Parameters
Toast-Restaurant-External-ID
required
string

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

Responses
200

Returns an array of PayoutReason objects.

get/payoutReasons
Request samples
curl -i -X GET \
  'https://toast-api-server/config/v2/payoutReasons?pageToken=string&pageSize=0&page=0&lastModified=2019-08-24' \
  -H 'Toast-Restaurant-External-ID: string'
Response samples
application/json
[
  • {
    }
]