Get the check reporting data

Returns the check reporting data for the specified report request GUID.

Specify the reportRequestGuid for the data.

Specify whether to include the guest-facing restaurant names.

Securityoauth2
Request
path Parameters
reportRequestGuid
required
string

The Toast platform identifier for the data request.

query Parameters
fetchRestaurantNames
boolean

Specifies whether the data includes the guest-facing restaurant name. The guest-facing restaurant name is not returned by default.

Valid values:

  • true - The guest-facing restaurant name is returned with the data.

  • false - The guest-facing restaurant name is not returned with the data.

Responses
200

The check reporting data.

202

The Toast platform is in the process of gathering the reporting data. Try the request again at a later time.

404

An unexpected error occurred. Refer to the message attached to this error for more information.

409

The Toast platform was unable to process the request. Request a new reportRequestGuid and try again.

500

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

504

The Toast platform was unable to process the request because internal services took too long to process, resulting in a timeout.

get/check/{reportRequestGuid}
Request samples
curl -i -X GET \
  'https://toast-api-server/era/v1/check/{reportRequestGuid}?fetchRestaurantNames=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "restaurantGuid": "string",
  • "orderNumber": 0,
  • "orderGuid": "string",
  • "checkNumber": 0,
  • "checkGuid": "string",
  • "orderOpenDate": "string",
  • "checkPaidDateTime": "2019-08-24T14:15:22Z",
  • "checkModifiedDateTime": "2019-08-24T14:15:22Z",
  • "checkStatus": "string",
  • "checkVoidedStatus": true,
  • "diningOption": "string",
  • "revenueCenter": "string",
  • "serverName": "string",
  • "checkTotalAmount": 0,
  • "checkDiscountAmount": 0,
  • "checkTaxAmount": 0,
  • "checkTipAmount": 0,
  • "checkGratuityAmount": 0,
  • "checkRefundAmount": 0,
  • "restaurantName": "string"
}