This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

This section provides reference information about the endpoints and data types of the Toast cash management API. For more information about using the cash management API and code examples, see Cash Management. For general information about working with Toast APIs, see API overview.

Cash Management API

Base URL: /cashmgmt/v1, Version: 1.1.0

Provides information about cash operations that add cash to or remove cash from a restaurant cash drawer, separately from cash transaction payments (customer payments for individual checks). Cash entries are different than cash transactions, and affect the overall amount of cash that the Toast POS accounts for in a restaurant.

Default request content-types: application/json
Default response content-types: application/json
Schemes: https

Summary

Path Operation Description
/deposits GET

Get deposits

/entries GET

Get cash entries

Paths

Get deposits

GET /deposits

Returns an array of Deposit objects containing information about cash removed from a restaurant to be deposited in a bank or other financial institution during one business day.

Toast-Restaurant-External-ID

The GUID of the restaurant that is the context of the request.

header string (string)
businessDate

The business date the deposits were created, in the format yyyymmdd. For example, 20180228.

query string (calendar-date)

application/json

200 OK

Returns an array of Deposit objects.

default

An unexpected error.

Get cash entries

GET /entries

Returns information about cash added to or removed from a cash drawer or other cash storage device. Returns an array of CashEntry objects.

Toast-Restaurant-External-ID

The GUID of the restaurant that is the context of the request.

header string (string)
yyyymmdd

Deprecated. Use the businessDate parameter. The business date the cash entries were created, in the format yyyymmdd. For example, 20180228.

query string (calendar-date)
businessDate

The business date the cash entries were created, in the format yyyymmdd. For example, 20180228.

query string (calendar-date)

application/json

200 OK

Returns an array of CashEntry objects.

default

Unexpected error

Schema definitions

CashEntry:

Information about an event in which a restaurant employee puts cash into a cash drawer or removes cash from a cash drawer.

amount: 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.

reason: string

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

date: string (date-time)

The date and time that the cash entry occurred.

type: string , x ∈ { 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 }

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.
cashDrawer: ToastReference

The Toast GUID or external reference of the cash drawer for the cash entry.

payoutReason: ToastReference

The Toast GUID or external reference of the pre-configured restaurant expense that the cash removed from the cash drawer is used for. This value only applies to PAY_OUT cash entries. For other cash entry types this value is null.

noSaleReason: ToastReference

The Toast GUID or external reference of the pre-configured reason of a no sale operation done on a cash drawer. This value only applies to NO_SALE cash entries. For other cash entry types this value is null.

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.

employee1: ExternalReference

The Toast GUID or external reference of the employee who initiated the cash entry transaction or performed a shift review that created the cash entry.

For the following cash entry types, the employee1 value indicates the employee who initiated the cash entry transaction:

  • CASH_IN
  • CASH_OUT
  • CLOSE_OUT_EXACT
  • CLOSE_OUT_OVERAGE
  • CLOSE_OUT_SHORTAGE
  • NO_SALE
  • PAY_OUT
  • UNDO_PAY_OUT

For the following cash entry types, the employee1 value indicates the employee who performed the shift review that created the cash entry:

  • CASH_COLLECTED
  • DRIVER_REIMBURSEMENT
  • TIP_OUT
employee2: ExternalReference

The Toast GUID or external reference of the employee who approved the cash entry transaction or who is the subject of the shift review that created the cash entry.

For the following cash entry types, the employee2 value indicates the employee who approved the cash entry transaction:

  • CASH_IN
  • CASH_OUT
  • PAY_OUT
  • UNDO_PAY_OUT

For the following cash entry types, the employee2 value indicates the employee who is the subject of the shift review that created the cash entry:

  • CASH_COLLECTED
  • DRIVER_REIMBURSEMENT
  • TIP_OUT

For the following cash entry types, the employee2 value is always null:

  • CLOSE_OUT_EXACT
  • CLOSE_OUT_OVERAGE
  • CLOSE_OUT_SHORTAGE
  • NO_SALE
creatorOrShiftReviewSubject: ToastReference

An alternative identifier for the employee represented by employee1. This value is reserved for future use.

approverOrShiftReviewSubject: ToastReference

An alternative identifier for the employee represented by employee2. This value is reserved for future use.

Deposit:

Information about an event in which a restaurant employee removes cash from a restaurant and deposits it in a bank or other financial institution.

amount: number (double)

The currency amount of the deposit. Because a deposit must have some amount of cash, this is always a positive value.

date: string (date-time)

The date that the deposit was registered in the POS and the deposit slip was printed.

undoes: string (string)

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

employee: ExternalReference

The identifier of the employee who created the deposit.

creator: ToastReference

An alternative identifier of the employee who created the deposit.

Error: object

status: integer (int32)

An HTTP status code.

message: string

A message that describes the error.

ExternalReference:

A wrapper object with fields that allow reference to a Toast entity by Toast GUID or a partner's identifier.

externalId: string

External identifier string that is prefixed by the naming authority.

ToastReference: object

Identifying information about a Toast POS entity.

guid: string

The GUID assigned to the entity by the Toast POS.

entityType: string

The category of the Toast POS object.