Cash Management API (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.

Get cash entries

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

Request

query Parameters

• businessDate required:
  string <calendar-date>

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

• yyyymmdd:
  string <calendar-date>

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

header Parameters

• Toast-Restaurant-External-ID required:
  string <string>

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

Responses

200

Returns an array of CashEntry objects.

default

Unexpected error

get /entries

Request samples

curl -i -X GET \
  'https://toast-api-server/cashmgmt/v1/entries?businessDate=string&yyyymmdd=string' \
  -H 'Toast-Restaurant-External-ID: string'

Response samples

application/json

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