Skip to content

Latest commit

 

History

History
42 lines (33 loc) · 2.77 KB

cash-drawer-shift-summary.md

File metadata and controls

42 lines (33 loc) · 2.77 KB

Cash Drawer Shift Summary

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.

Structure

CashDrawerShiftSummary

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 shift start time in ISO 8601 format.
endedAt string | undefined Optional The shift end time in ISO 8601 format.
closedAt string | undefined Optional The shift close time in ISO 8601 format.
description string | undefined Optional An employee free-text description of a cash drawer shift.
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.
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.

Example (as JSON)

{
  "id": null,
  "state": null,
  "opened_at": null,
  "ended_at": null,
  "closed_at": null,
  "description": null,
  "opened_cash_money": null,
  "expected_cash_money": null,
  "closed_cash_money": null
}