Check

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

amount
number <double>

The total calculated price of the check including discounts and service charges. The amount does not include gratuity or taxes. Response only.

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 on which this check's payment status was set to CLOSED.

createdDate
string <date-time>

The date and time that the Toast platform received the check.

object (Device)

The Device ID value that the Toast platform 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, 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

Set to true if this check was deleted.

deletedDate
string <date-time>

The date on which this check was deleted.

deletedDate is only applicable when deleted is true.

If deleted is false, then deletedDate is set to the UNIX epoch, 1970-01-01T00:00:00.000+0000.

displayNumber
string

Generally starts at one each day and counts up. The Toast platform fills this in if it is not specified when the order is POSTed. Not guaranteed to be unique.

duration
integer

The number of seconds between creation and payment. Response only.

entityType
required
string

The type of object this is. Response only.

externalId
string

External identifier string that is prefixed by the naming authority. You can use the orders API to set an externalId for an order and then GET the order with that externalId.

guid
required
string

The GUID maintained by the Toast platform.

object (Device)

The Device ID value that the Toast platform 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, 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.

object (ExternalReference)

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

openedDate
string <date-time>

The date on which this check was opened. If not specified, it is set to the current system time.

paidDate
string <date-time>

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

Array of objects (Payment) >= 0 items

Payments made on this check.

paymentStatus
string

The payment status of this check.

Valid values:

  • OPEN - There is an outstanding balance.

  • PAID - A credit card payment was applied, but the tip has not been adjusted.

  • CLOSED - There is no remaining amount due on this check. For credit card payments, the payment has been adjusted to reflect the tip. Toast does not prevent a CLOSED check from transitioning back to OPEN or PAID.

Response only.

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

The name of the tab on this check. This displays on the KDS (Kitchen Display System) for pending orders.

The tabName value can contain up to 255 characters.

taxAmount
number <double>

The calculated tax amount. Includes service charge and item level taxes. Response only.

taxExempt
boolean
Default: false

Set to true if this check is tax exempt.

totalAmount
number <double>

The total calculated price of this check including discounts and taxes. Not affected by refunds. Response only.

voidBusinessDate
integer

The business date (yyyyMMdd) on which this check was voided. Response only.

voidDate
string <date-time>

The date when this check was voided. Response only.

voided
boolean

True if this check is voided. Response only.

{
  • "guid": "string",
  • "entityType": "string",
  • "externalId": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "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": {
    },
  • "duration": 0,
  • "openedBy": {
    }
}