CashTrackingSession - admin-graphql - OBJECT

Version: 2024-10

Description:

Tracks the balance in a cash drawer for a point of sale device over the course of a shift.

Access Scopes

`read_cash_tracking` access scope.

Fields

  • cashTrackingEnabled: Boolean! - Whether this session is tracking cash payments.
  • closingBalance: MoneyV2 - The counted cash balance when the session was closed.
  • closingNote: String - The note entered when the session was closed.
  • closingStaffMember: StaffMember - The user who closed the session.
  • closingTime: DateTime - When the session was closed.
  • expectedBalance: MoneyV2! - The expected balance at the end of the session or the expected current balance for sessions that are still open.
  • expectedClosingBalance: MoneyV2 - The amount that was expected to be in the cash drawer at the end of the session, calculated after the session was closed.
  • expectedOpeningBalance: MoneyV2 - The amount expected to be in the cash drawer based on the previous session.
  • id: ID! - A globally-unique ID.
  • location: Location - The location of the point of sale device during this session.
  • netCashSales: MoneyV2! - The net cash sales made for the duration of this cash tracking session.
  • openingBalance: MoneyV2! - The counted cash balance when the session was opened.
  • openingNote: String - The note entered when the session was opened.
  • openingStaffMember: StaffMember - The user who opened the session.
  • openingTime: DateTime! - When the session was opened.
  • registerName: String! - The register name for the point of sale device that this session is tracking cash for.
  • totalAdjustments: MoneyV2 - The sum of all adjustments made during the session, excluding the final adjustment.
  • totalCashRefunds: MoneyV2! - The sum of all cash refunds for the duration of this cash tracking session.
  • totalCashSales: MoneyV2! - The sum of all cash sales for the duration of this cash tracking session.
  • totalDiscrepancy: MoneyV2 - The total discrepancy for the session including starting and ending.

Connections

  • adjustments: CashTrackingAdjustmentConnection!
  • cashTransactions: OrderTransactionConnection!

Related queries

  • cashTrackingSession Lookup a cash tracking session by ID.
  • cashTrackingSessions Returns a shop's cash tracking sessions for locations with a POS Pro subscription. Tip: To query for cash tracking sessions in bulk, you can [perform a bulk operation](https://shopify.dev/docs/api/usage/bulk-operations/queries).

Related mutations

Related Unions

Examples