Object Index / Definition

You are viewing an old version of the API
Cash​Drawer​Shift
V1

Note We recommend using the Square API (V2) for all new development when possible.

Contains details for a single cash drawer shift

Properties

Name Description
id
string

The shift's unique ID.

cash_paid_in_money
V1​Money

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

cash_paid_out_money
V1​Money

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

cash_payment_money
V1​Money

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

cash_refunds_money
V1​Money

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

closed_at
string

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

closed_cash_money
V1​Money

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

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.

device
Device

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

employee_ids
string [ ]

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

ended_at
string

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

ending_employee_id
string

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

event_type
string

The shift's current state.

events
V1​Cash​Drawer​Event [ ]

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

expected_cash_money
V1​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
string

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

opening_employee_id
string

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

starting_cash_money
V1​Money

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

Share Feedback

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