Retrieve cash drawer shift
Note We recommend using the Square API (V2) for all new development when possible.
Provides the details for a single cash drawer shift, including all events that occurred during the shift
Path Parameters
Name | Description |
---|---|
location_id
Required
|
The ID of the location to list cash drawer shifts for. |
shift_id
Required
|
The shift's ID. |
Response Fields
Name | Description |
---|---|
id
|
The shift's unique ID. |
cash_paid_in_money
|
The amount of money added to the cash drawer for reasons other than cash payments. |
cash_paid_out_money
|
The amount of money removed from the cash drawer for reasons other than cash refunds. |
cash_payment_money
|
The amount of money added to the cash drawer from cash payments. |
cash_refunds_money
|
The amount of money removed from the cash drawer from cash refunds. This value is always negative or zero. |
closed_at
|
The time when the shift was closed, in ISO 8601 format. |
closed_cash_money
|
The amount of money found in the cash drawer at the end of the shift by an auditing employee. |
closing_employee_id
|
The ID of the employee that closed the cash drawer shift by auditing the cash drawer's contents. |
description
|
A description of the cash drawer shift. |
device
|
The device running Square Register that was connected to the cash drawer. |
employee_ids
|
The IDs of all employees that were logged into Square Register at some point during the cash drawer shift. |
ended_at
|
The time when the shift ended, in ISO 8601 format. |
ending_employee_id
|
The ID of the employee that ended the cash drawer shift. |
event_type
|
The shift's current state. |
events
|
All of the events (payments, refunds, and so on) that involved the cash drawer during the shift. |
expected_cash_money
|
The amount of money that should be in the cash drawer at the end of the shift, based on the shift's other money amounts. |
opened_at
|
The time when the shift began, in ISO 8601 format. |
opening_employee_id
|
The ID of the employee that started the cash drawer shift. |
starting_cash_money
|
The amount of money in the cash drawer at the start of the shift. |
Examples
- cURL
curl https://connect.squareup.com/v1/{location_id}/cash-drawer-shifts/{shift_id} \
-H 'Authorization: Bearer ACCESS_TOKEN'