V1CashDrawerShift

July 10, 2019 ยท View on GitHub

Description

Contains details for a single cash drawer shift.

Properties

NameTypeDescriptionNotes
idStringThe shift's unique ID.[optional]
eventTypeStringThe shift's current state. See V1CashDrawerShiftEventType for possible values[optional]
openedAtStringThe time when the shift began, in ISO 8601 format.[optional]
endedAtStringThe time when the shift ended, in ISO 8601 format.[optional]
closedAtStringThe time when the shift was closed, in ISO 8601 format.[optional]
employeeIdsList<String>The IDs of all employees that were logged into Square Register at some point during the cash drawer shift.[optional]
openingEmployeeIdStringThe ID of the employee that started the cash drawer shift.[optional]
endingEmployeeIdStringThe ID of the employee that ended the cash drawer shift.[optional]
closingEmployeeIdStringThe ID of the employee that closed the cash drawer shift by auditing the cash drawer's contents.[optional]
descriptionStringA description of the cash drawer shift.[optional]
startingCashMoneyV1MoneyThe amount of money in the cash drawer at the start of the shift.[optional]
cashPaymentMoneyV1MoneyThe amount of money added to the cash drawer from cash payments.[optional]
cashRefundsMoneyV1MoneyThe amount of money removed from the cash drawer from cash refunds. This value is always negative or zero.[optional]
cashPaidInMoneyV1MoneyThe amount of money added to the cash drawer for reasons other than cash payments.[optional]
cashPaidOutMoneyV1MoneyThe amount of money removed from the cash drawer for reasons other than cash refunds.[optional]
expectedCashMoneyV1MoneyThe amount of money that should be in the cash drawer at the end of the shift, based on the shift's other money amounts.[optional]
closedCashMoneyV1MoneyThe amount of money found in the cash drawer at the end of the shift by an auditing employee.[optional]
deviceDeviceThe device running Square Register that was connected to the cash drawer.[optional]
eventsList<V1CashDrawerEvent>All of the events (payments, refunds, and so on) that involved the cash drawer during the shift.[optional]