Check reporting data contains a constant set of values. These values appear for every check and are organized by active restaurant. Optionally, you can choose to include the restaurant name in the check reporting data. For more information, see Retrieving the check reporting data. For more information about inactive restaurant data, see Viewing inactive restaurant data.
The restaurants included in the check reporting data can be limited by adding the GUIDs of restaurants to either include only or exclude only. For more information about choosing specific restaurants, see Creating a request for check reporting data.
The following table specifies the set of values returned in the check reporting data. The values are listed in the order that they appear.
Value name |
Definition |
---|---|
|
The unique identifier assigned to the restaurant by the Toast platform. |
|
The number of the order. |
|
The unique identifier assigned to the order by the Toast platform. |
|
The number of the check. |
|
The unique identifier assigned to the check by the Toast platform. |
|
The business date for when the order is initially expected to be fulfilled. This date determines whether a check is within the requested time range or not. |
|
The most recent date the check received payment. |
|
The most recent date that the check was modified. |
|
The payment state of the check. The state can be one of the following values:
|
|
Indicates whether the check was voided or not. A
|
|
The dining option for the check data. |
|
The revenue center for the check data. |
|
The first and last name of the employee who created the order. |
|
The total amount of the check. |
|
The total discounted amount of the check. |
|
The total tax amount of the check. |
|
The total tip amount of the check. |
|
The total gratuity amount of the check. |
|
The total refund amount of the check. |
|
The restaurant’s name. This is included when you
set the |