Post a payout data request organized by sales date for a specific time range

Creates a payout reporting data organized by sales date request for a specific time range.

Specify the time range with the timeRange path parameter.

Specify whether to include data from inactive restaurants using the onlyInactiveRestaurants query parameter.

Specify the startDate and endDate for the payout data in the message body.

Include information about which restaurants to include or exclude with the restaurantIds and excludedRestaurantIds properties.

Securityoauth2
Request
path Parameters
timeRange
required
string

The specific time range that you are requesting reporting data for.

Valid values:

  • day - The request covers a one day time range.

  • week - The request covers a time range of seven days or fewer.

  • month - The request covers a time range of 31 days or fewer.

Enum: "day" "week" "month"
query Parameters
onlyInactiveRestaurants
boolean

Specifies whether the data is for inactive restaurants only. Active restaurant data is returned by default.

Valid values:

  • true - The data retrieved is for inactive restaurants only.

  • false - The data retrieved is for active restaurants only.

Request Body schema: application/json

A JSON object containing the starting and ending dates for the reporting data request and included or excluded restaurants.

endDate
required
number <integer>

The ending date of the time range for the reporting data. Specify the date in the format YYYYMMDD. For example, 20220824.

excludedRestaurantIds
required
Array of strings <UUID>

The restaurantGuid values of specific restaurants in the management group to exclude from the reporting data. If used, the data for listed restaurants in the management group that are identified by restaurantGuid is excluded. If left blank, all restaurants are included by default.

restaurantIds
required
Array of strings <uuid>

The restaurantGuid values of specific restaurants in the management group to include in the reporting data. If used, only the data for listed restaurants in the management group that are identified by restaurantGuid is included. If left blank, all restaurants are included by default.

startDate
required
number <integer>

The starting date of the time range for the reporting data. Specify the date in the format YYYYMMDD. For example, 20220824.

Responses
200

The reportRequestGuid used to retrieve the reporting data.

400

The request contains invalid information.

500

An unexpected internal error occurred. The requestId attached to this error can be referenced by the Toast support team.

post/payout/sales-date/{timeRange}
Request samples
application/json
{
  • "startDate": 0,
  • "endDate": 0,
  • "restaurantIds": [
    ],
  • "excludedRestaurantIds": [
    ]
}
Response samples
application/json
"string"