The check reporting data.
checkDiscountAmount | number <double> The total discount amount applied to the check or to associated items on the check. |
checkGratuityAmount | number <double> The gratuity amount applied to the check. |
checkGuid | string <UUID> The identifier assigned by the Toast platform used to identify a check. |
checkModifiedDateTime | string <date-time> The business date and time that the check was modified. |
checkNumber | number <long> The number of the check. |
checkPaidDateTime | string <date-time> The business date and time that the check was paid. |
checkRefundAmount | number <double> The refund amount applied to the check. |
checkStatus | string <text> The state of the check. Valid values:
|
checkTaxAmount | number <double> The calculated tax amount applied to the check. This includes any service charge and item-level taxes. |
checkTipAmount | number <double> The tip amount applied to the check. |
checkTotalAmount | number <double> The sum of the cost of each item applied to a check, taking into account the item quantity. This includes taxes, services charges, tip, and refunds applied to the check. |
checkVoidedStatus | boolean <boolean> Indicates whether the check is void or not. Valid values:
|
diningOption | string The dining option for the data. |
orderGuid | string <UUID> The identifier assigned by the Toast platform used to identify an order. |
orderNumber | number <long> The number of the order. |
orderOpenDate | string <integer> The business date for when the order is initially expected to be fulfilled. The business
date uses the YYYYMMDD format. For example, |
restaurantGuid | string <UUID> The identifier assigned by the Toast platform used to identify a restaurant location. |
restaurantName | string <string> The restaurant's name. This property is only included when
the |
revenueCenter | string The revenue center for the data. |
serverName | string The first and last name of the employee who initially created the order associated with the check. |
{- "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"
}