Check

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

amount
number <double>

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

Array of objects (AppliedDiscount) >= 0 items

The discounts applied to this 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 on which this check's payment status was set to CLOSED. Use ISO 8601 date and time format for all Toast APIs.

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 on which this check was deleted. deletedDate is only applicable when deleted is true (by default the value will be set to 1970-01-01T00:00:00.000+0000). Use ISO 8601 date and time format for all Toast APIs.

displayNumber
string

Generally starts at one each day and counts up. Not guaranteed to be unique.

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.

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.

modifiedDate
string <date-time>

The most recent date on which this check was modified. Use ISO 8601 date and time format for all Toast APIs.

openedDate
string <date-time>

The date on which this check was opened. Use ISO 8601 date and time format for all Toast APIs.

paidDate
string <date-time>

The most recent date on which this check received payment. Use ISO 8601 date and time format for all Toast APIs.

Array of objects (Payment) >= 0 items

Payments made on this check

paymentStatus
string

The payment status of this check. OPEN means there is an outstanding balance. PAID means a credit card payment has been applied but the tip has not been adjusted. CLOSED means there is no remaining amount due on this check. Toast does not prevent a CLOSED check from transitioning back to OPEN or PAID.

Enum: "OPEN" "PAID" "CLOSED"
required
Array of objects (Selection)
tabName
string

The name of the tab on this check. This will show up on the KDS (Kitchen Display System) for pending orders. The length of tabName can be up to 255 characters.

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 on which this check was voided. Use ISO 8601 date and time format for all Toast APIs.

voided
boolean

True if this check has been voided.

{
  • "guid": "string",
  • "entityType": "string",
  • "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,
  • "selections": [
    ],
  • "customer": {
    },
  • "appliedLoyaltyInfo": {
    },
  • "taxExempt": false,
  • "displayNumber": "string",
  • "appliedServiceCharges": [
    ],
  • "amount": 0,
  • "taxAmount": 0,
  • "totalAmount": 0,
  • "payments": [
    ],
  • "tabName": "string",
  • "paymentStatus": "OPEN",
  • "appliedDiscounts": [
    ],
  • "voided": true,
  • "voidDate": "2019-08-24T14:15:22Z",
  • "voidBusinessDate": 0,
  • "paidDate": "2019-08-24T14:15:22Z",
  • "createdDevice": {
    },
  • "lastModifiedDevice": {
    }
}