<- Object

Object

All versions ->

CashDrawerShift

This model gives the details of a cash drawer shift.

The cash_payment_money, cash_refund_money, cash_paid_in_money, and cash_paid_out_money fields are all computed by summing their respective event types.

Link to section

Properties

Link to section

id

string

The shift unique ID.

Link to section

state

string

The shift current state.

Link to section

opened_at

string

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

Link to section

ended_at

string

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

Link to section

closed_at

string

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

Link to section

description

string

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

Link to section

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

Link to section

cash_payment_money

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

Link to section

cash_refunds_money

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

Link to section

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

Link to section

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

Link to section

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

Link to section

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

Link to section

device

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

Link to section

created_at

string

Read only The shift start time in RFC 3339 format.

Link to section

updated_at

string

Read only The shift updated at time in RFC 3339 format.

Link to section

location_id

string

Read only The ID of the location the cash drawer shift belongs to.

Link to section

team_member_ids

string [ ]

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

Link to section

opening_team_member_id

string

Read only The ID of the team member that started the cash drawer shift.

Link to section

ending_team_member_id

string

Read only The ID of the team member that ended the cash drawer shift.

Link to section

closing_team_member_id

string

Read only The ID of the team member that closed the cash drawer shift by auditing the cash drawer contents.