You are viewing an old version of the API
Retrieve cash drawer shift
V1

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.

Required permissions TIMECARDS_READ

Path Parameters

Name Description
location_id
string

Required

The ID of the location to list cash drawer shifts for.

shift_id
string

Required

The shift's ID.

Response Fields

Name Description
id
string

The shift's unique ID.

event_type
string

The shift's current state. See V1CashDrawerShiftEventType for possible values

opened_at
string

The time when the shift began, in ISO 8601 format.

ended_at
string

The time when the shift ended, in ISO 8601 format.

closed_at
string

The time when the shift was closed, in ISO 8601 format.

employee_ids
string [ ]

The IDs of all employees that were logged into Square Register at some point during the cash drawer shift.

opening_employee_id
string

The ID of the employee that started the cash drawer shift.

ending_employee_id
string

The ID of the employee that ended the cash drawer shift.

closing_employee_id
string

The ID of the employee that closed the cash drawer shift by auditing the cash drawer's contents.

description
string

A description of the cash drawer shift.

starting_cash_money
Money

The amount of money in the cash drawer at the start of the shift.

cash_payment_money
Money

The amount of money added to the cash drawer from cash payments.

cash_refunds_money
Money

The amount of money removed from the cash drawer from cash refunds. This value is always negative or zero.

cash_paid_in_money
Money

The amount of money added to the cash drawer for reasons other than cash payments.

cash_paid_out_money
Money

The amount of money removed from the cash drawer for reasons other than cash refunds.

expected_cash_money
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.

closed_cash_money
Money

The amount of money found in the cash drawer at the end of the shift by an auditing employee.

device
Device

The device running Square Register that was connected to the cash drawer.

events
CashDrawerEvent [ ]

All of the events (payments, refunds, and so on) that involved the cash drawer during the shift.

Examples

You are viewing an old version of the API
GET /v1/{location_id}/cash-drawer-shifts/{shift_id}
cURL
  • cURL
curl https://connect.squareup.com/v1/{location_id}/cash-drawer-shifts/{shift_id} \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?