Object Index / Definition

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

Beta

This model gives the details of a cash drawer shift

The cashpaymentmoney, cashrefundmoney, cashpaidinmoney, and cashpaidoutmoney fields are all computed by summing their respective event types.

Properties

Name Description
id
string

The shift unique ID.

cash_paid_in_money
Money

The amount of money added to the cash drawer for reasons other than cash payments. It is computed by summing the events of type PAID_IN. The amount is always greater than or equal to zero.

cash_paid_out_money
Money

The amount of money removed from the cash drawer for reasons other than cash refunds. It is computed by summing the events of type PAID_OUT. The amount is always greater than or equal to zero.

cash_payment_money
Money

The amount of money added to the cash drawer from cash payments. This is computed by summing all events with the types CASHTENDERPAYMENT and CASHTENDERCANCELED_PAYMENT. The amount is always greater than or equal to zero.

cash_refunds_money
Money

The amount of money removed from the cash drawer from cash refunds. It is computed by summing the events of type CASHTENDERREFUND. The amount is always greater than or equal to zero.

closed_at
string

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

closed_cash_money
Money

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

closing_employee_id
string

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

description
string

The free-form text description of a cash drawer by an employee.

device
Cash​Drawer​Device

The device running Square Point of Sale that was connected to the cash drawer.

employee_ids
string [ ]

The IDs of all employees that were logged into Square Point of Sale at any point while the cash drawer shift was open.

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.

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. This can be negative if employees have not correctly recorded all the events on the cash drawer. cashpaidoutmoney is a summation of amounts from cashpaymentmoney (zero or positive), cashrefundsmoney (zero or negative), cashpaidinmoney (zero or positive), and cashpaidout_money (zero or negative) event types.

opened_at
string

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

opened_cash_money
Money

The amount of money in the cash drawer at the start of the shift. The amount must be greater than or equal to zero.

opening_employee_id
string

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

state
string

The shift current state.

Share Feedback

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