ExternalReference

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

amount
number <double>

The subtotal amount due on this check in USD, after discounts but before tax.

Array of objects (AppliedDiscount) >= 0 items

The discounts applied to this check. In a POST request, only one appliedDiscount is allowed per check.

object (AppliedLoyaltyInfo)

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

Array of objects (AppliedServiceCharge)

Any restaurant-configured service charges that applied to this check.

closedDate
string <date-time>

The most recent date and time when this check's payment status was set to CLOSED.

object (Device)

The Device ID value that the Toast POS system assigns to a specific Toast POS device. The id value is a unique identifier for a device. To find the ID for a Toast POS device, do the following. From the overflow menu (⋮) select Device Status and then select the Device tab.

object (Customer)

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

deleted
boolean

True if this check has been deleted.

deletedDate
string <date-time>

The date and time when this check was deleted. deletedDate is only applicable when deleted is true. If the check is not deleted, defaults to 1970-01-01T00:00:00.000+0000.

displayNumber
string

Generally starts at 1 each day and counts up. Toast will supply a displayNumber if one is not specified when POSTing. The displayNumber is not a unique identifier.

entityType
required
string

The type of object this is.

externalId
string

External identifier string that is prefixed by the naming authority.

guid
required
string

The GUID maintained by Toast.

modifiedDate
string <date-time>

The most recent date and time when this check was modified.

openedDate
string <date-time>

The date and time when this check was opened. If not specified, set to the current system time.

paidDate
string <date-time>

The most recent date and time when this check received payment. If not specified when POSTing, set to the current system time.

Array of objects (Payment) >= 0 items

Payments made on this check.

required
Array of objects (Selection)
tabName
string

The name taken by a restaurant employee to identify the order. This name appears on the KDS (Kitchen Display System) for pending orders. The tabName can be up to 255 characters in length.

taxAmount
number <double>

The computed tax amount in USD. Includes service charge and item-level taxes.

taxExempt
boolean
Default: false

True if this check is tax exempt. Tax exempt number is not yet supported.

totalAmount
number <double>

The total amount due on this check in USD, including discounts and taxes.

voidBusinessDate
integer

The business date (yyyymmdd) on which this check was voided.

voidDate
string <date-time>

The date and time when this check was voided.

voided
boolean

True if this check has been voided.

{
  • "guid": "string",
  • "entityType": "Check",
  • "externalId": "string",
  • "openedDate": "2019-08-24T14:15:22Z",
  • "closedDate": "2019-08-24T14:15:22Z",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "deletedDate": "2019-08-24T14:15:22Z",
  • "deleted": true,
  • "createdDevice": {
    },
  • "selections": [
    ],
  • "customer": {
    },
  • "appliedLoyaltyInfo": {
    },
  • "taxExempt": false,
  • "displayNumber": "string",
  • "appliedServiceCharges": [
    ],
  • "amount": 0,
  • "taxAmount": 0,
  • "totalAmount": 0,
  • "payments": [
    ],
  • "tabName": "string",
  • "appliedDiscounts": [
    ],
  • "voided": true,
  • "voidDate": "2019-08-24T14:15:22Z",
  • "voidBusinessDate": 0,
  • "paidDate": "2019-08-24T14:15:22Z"
}