cash-drawer-shift.md

Cash Drawer Shift

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.

Structure

CashDrawerShift

Fields

Name	Type	Tags	Description
id	string | undefined	Optional	The shift unique ID.
state	string | undefined	Optional	The current state of a cash drawer shift.
openedAt	string | undefined	Optional	The time when the shift began, in ISO 8601 format.
endedAt	string | undefined	Optional	The time when the shift ended, in ISO 8601 format.
closedAt	string | undefined	Optional	The time when the shift was closed, in ISO 8601 format.
employeeIds	string[] | undefined	Optional	The IDs of all employees that were logged into Square Point of Sale at any point while the cash drawer shift was open.
openingEmployeeId	string | undefined	Optional	The ID of the employee that started the cash drawer shift.
endingEmployeeId	string | undefined	Optional	The ID of the employee that ended the cash drawer shift.
closingEmployeeId	string | undefined	Optional	The ID of the employee that closed the cash drawer shift by auditing the cash drawer contents.
description	string | undefined	Optional	The free-form text description of a cash drawer by an employee.
openedCashMoney	Money | undefined	Optional	Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.
cashPaymentMoney	Money | undefined	Optional	Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.
cashRefundsMoney	Money | undefined	Optional	Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.
cashPaidInMoney	Money | undefined	Optional	Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.
cashPaidOutMoney	Money | undefined	Optional	Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.
expectedCashMoney	Money | undefined	Optional	Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.
closedCashMoney	Money | undefined	Optional	Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.
device	CashDrawerDevice | undefined	Optional	-

Example (as JSON)

{
  "id": null,
  "state": null,
  "opened_at": null,
  "ended_at": null,
  "closed_at": null,
  "employee_ids": null,
  "opening_employee_id": null,
  "ending_employee_id": null,
  "closing_employee_id": null,
  "description": null,
  "opened_cash_money": null,
  "cash_payment_money": null,
  "cash_refunds_money": null,
  "cash_paid_in_money": null,
  "cash_paid_out_money": null,
  "expected_cash_money": null,
  "closed_cash_money": null,
  "device": null
}