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.

Request
query Parameters
businessDate
required
string <calendar-date>

The business date the deposits 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 Deposit objects.

default

An unexpected error.

get/deposits
Request samples
curl -i -X GET \
  'https://toast-api-server/cashmgmt/v1/deposits?businessDate=string' \
  -H 'Toast-Restaurant-External-ID: string'
Response samples
application/json
[
  • {
    }
]