CashEntry

Identifying information about a Toast POS entity.

amount
required
number <double>

The currency amount of the cash that an employee adds to or removes from a cash drawer. This value is positive when an employee adds cash and negative when an employee removes cash.

object (ToastReference)

Identifying information about a Toast POS entity.

object (ToastReference)

Identifying information about a Toast POS entity.

object (ToastReference)

Identifying information about a Toast POS entity.

date
required
string <date-time>

The date and time that the cash entry occurred.

object (ExternalReference)

Identifying information about a Toast POS entity.

object (ExternalReference)

Identifying information about a Toast POS entity.

entityType
required
string

The category of the Toast POS object.

guid
required
string

The GUID assigned to the entity by the Toast POS.

object (ToastReference)

Identifying information about a Toast POS entity.

object (ToastReference)

Identifying information about a Toast POS entity.

reason
required
string

A short description of why this cash entry was created, written by the restaurant employee.

type
required
string

The type of the cash entry.

  • CASH_IN - cash added to a cash drawer.
  • CASH_COLLECTED - cash added to a cash drawer at the end of an employee shift.
  • CASH_OUT - cash removed from a cash drawer and stored in a different restaurant location. The Toast POS does track cash after it is removed by a CASH_OUT entry.
  • NO_SALE - cash drawer opened with no change to the cash balance. For example, a restaurant employee might perform a no sale transaction to make change for a customer.
  • PAY_OUT - cash removed from a cash drawer to pay for a pre-configured restaurant expense.
  • TIP_OUT - cash removed from a cash drawer to distribute tips or gratuities to restaurant employees.
  • UNDO_PAY_OUT - cash added to a cash drawer to undo a previous PAY_OUT cash entry.
  • DRIVER_REIMBURSEMENT - cash removed from a cash drawer to repay delivery drivers for delivery driving expenses.
  • CLOSE_OUT_EXACT - an employee closes a cash drawer and the closing balance is equal to the expected balance.
  • CLOSE_OUT_OVERAGE - an employee closes a cash drawer and the closing balance is greater than the expected balance.
  • CLOSE_OUT_SHORTAGE - an employee closes a cash drawer and the closing balance is less than the expected balance.
Enum: "CASH_IN" "CASH_COLLECTED" "CASH_OUT" "PAY_OUT" "UNDO_PAY_OUT" "TIP_OUT" "NO_SALE" "DRIVER_REIMBURSEMENT" "CLOSE_OUT_EXACT" "CLOSE_OUT_OVERAGE" "CLOSE_OUT_SHORTAGE"
undoes
string

The Toast GUID of the cash entry that is being undone. This value is null if the cash entry does not undo a previous entry.

{
  • "guid": "string",
  • "entityType": "string",
  • "amount": 0,
  • "reason": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "type": "CASH_IN",
  • "cashDrawer": {
    },
  • "payoutReason": {
    },
  • "noSaleReason": {
    },
  • "undoes": "string",
  • "employee1": {
    },
  • "employee2": {
    },
  • "creatorOrShiftReviewSubject": {
    },
  • "approverOrShiftReviewSubject": {
    }
}