Retrieving the check reporting data

Send a GET request to the /era/v1/check/{reportRequestGuid} endpoint to retrieve check reporting data. The rate limit for this endpoint and method type is five requests per second and 30 requests per minute. For information about API rate limits for the analytics API, see Analytics API rate limits.

To request the check reporting data, you must include the check reporting data request GUID, or reportRequestGuid, as a path variable.

Optionally, you can choose to include a fetchRestaurantNames query parameter. If the fetchRestaurantNames query parameter is set to true, it adds the restaurant name to the check reporting data. If the fetchRestaurantNames query parameter is set to false or not included, it does not add the restaurant name.

Request to retrieve check reporting data

The following example curl command sends a GET request to the /era/v1/check/{reportRequestGuid} endpoint. 

curl -X GET \ 'https://[toast-api-hostname]/era/v1/check/1
83c93717-02ba-4b7c-9891-dfe090274d2d/2
&fetchRestaurantNames=true’ \3
  -H 'Authorization: Bearer [token]'4

1

Send a GET request to the /era/v1/check endpoint of the analytics API.

2

The GUID for the check reporting data request, also called the reportRequestGuid. For more information about the analytics API process, see Understanding the analytics API process.

3

Set the fetchRestaurantNames query parameter to true to include the restaurant name in the response.

4

Include an authentication token. For more information, see Authentication and restaurant access.

Response to the retrieval request for check reporting data

The following example shows the response from the /era/v1/check/{reportRequestGuid} endpoint. 

[
  {
    "restaurantGuid": "95a96d7b-dbf5-46d3-98c5-c65c8ad18021",
    "orderNumber": "5018",
    "orderGuid": "f8e4ae5e-ccbd-49e5-81e8-947d673c30ad",
    "checkNumber": "5018",
    "checkGuid": "98bca966-4969-4314-9a8a-8486340164d2",
    "orderOpenedDate": "20230201",
    "checkPaidDateTime": "2023-02-02T00:37:20.089Z",
    "checkModifiedDateTime": "2023-02-02T19:04:46.340Z",
    "checkStatus": "CLOSED",
    "checkVoidedStatus": false,
    "diningOption": "Dine In",
    "revenueCenter": "Dining Room",
    "serverName": "Lydia Bennet",
    "checkTotalAmount": 35.59,
    "checkDiscountAmount": 0.0,
    "checkTaxAmount": 2.06,
    "checkTipAmount": 5.59,
    "checkGratuityAmount": 0.0,
    "checkRefundAmount": 0.0,
    "restaurantName": "Grove Place Cafe"1
  },
  [content omitted]
  {
    "restaurantGuid": "95a96d7b-dbf5-46d3-98c5-c65c8ad18021",
    "orderNumber": "5010",
    "orderGuid": "98bca966-4969-4314-9a8a-8486340164d2",
    "checkNumber": "5010",
    "checkGuid": "e3dd31e1-78bb-47e4-a1a3-7c14c9f8c8ff",
    "orderOpenedDate": "20230201",
    "checkPaidDateTime": "2023-02-01T23:48:56.896Z",
    "checkModifiedDateTime": "2023-02-02T19:04:39.186Z",
    "checkStatus": "CLOSED",
    "checkVoidedStatus": false,
    "diningOption": "Take Out",
    "revenueCenter": "Dining Room",
    "serverName": "Lydia Bennet",
    "checkTotalAmount": 23.24,
    "checkDiscountAmount": 0.0,
    "checkTaxAmount": 1.32,
    "checkTipAmount": 3.95,
    "checkGratuityAmount": 0.0,
    "checkRefundAmount": 0.0,
    "restaurantName": "Grove Place Cafe"
  }
]

1

The restaurantName value appears because the fetchRestaurantName query parameter was set to true in the request.

For more information about the values in the response, see Understanding the check reporting data.