Object Index / Definition

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

Beta

The summary of a closed cash drawer shift

This model contains only the money counted to start a cash drawer shift, counted at the end of the shift, and the amount that should be in the drawer at shift end based on summing all cash drawer shift events.

Properties

Name Description
id
string

The shift unique ID.

closed_at
string

The shift close time 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 must be greater than or equal to zero.

description
string

An employee free-text description of a cash drawer shift.

ended_at
string

The shift end time in ISO 8601 format.

expected_cash_money
Money

The amount of money that should be in the cash drawer at the end of the shift, based on the cash drawer events on the shift. The amount is correct if all shift employees accurately recorded their cash drawer shift events. Unrecorded events and events with the wrong amount result in an incorrect expectedcashmoney amount that can be negative.

opened_at
string

The shift start time in ISO 8601 format.

opened_cash_money
Money

The amount of money in the cash drawer at the start of the shift. This must be a positive amount.

state
string

The shift current state.

Share Feedback

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