Cash
Requires access scope.
Tracks the balance in a cash drawer for a point of sale device over the course of a shift.
Anchor to FieldsFields
- adjustments (CashTrackingAdjustmentConnection!)
- cashTrackingEnabled (Boolean!)
- cashTransactions (OrderTransactionConnection!)
- closingBalance (MoneyV2)
- closingNote (String)
- closingStaffMember (StaffMember)
- closingTime (DateTime)
- expectedBalance (MoneyV2!)
- expectedClosingBalance (MoneyV2)
- expectedOpeningBalance (MoneyV2)
- id (ID!)
- location (Location)
- netCashSales (MoneyV2!)
- openingBalance (MoneyV2!)
- openingNote (String)
- openingStaffMember (StaffMember)
- openingTime (DateTime!)
- registerName (String!)
- totalAdjustments (MoneyV2)
- totalCashRefunds (MoneyV2!)
- totalCashSales (MoneyV2!)
- totalDiscrepancy (MoneyV2)
- Anchor to adjustmentsadjustments•Cash
Tracking Adjustment Connection! non-null The adjustments made to the cash drawer during this session.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Adjustments
Key Sort Keys Default:TIME Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
Arguments
- Anchor to cashTrackingEnabledcash•Boolean!
Tracking Enabled non-null Whether this session is tracking cash payments.
- Anchor to cashTransactionscash•Order
Transactions Transaction Connection! non-null The cash transactions made during this session.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Cash
Key Tracking Session Transactions Sort Keys Default:PROCESSED_AT Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.
Arguments
- Anchor to closingBalanceclosing•Money
Balance V2 The counted cash balance when the session was closed.
- Anchor to closingNoteclosing•String
Note The note entered when the session was closed.
- Anchor to closingStaffMemberclosing•Staff
Staff Member Member The user who closed the session.
- Anchor to closingTimeclosing•Date
Time Time When the session was closed.
- Anchor to expectedBalanceexpected•Money
Balance V2! non-null The expected balance at the end of the session or the expected current balance for sessions that are still open.
- Anchor to expectedClosingBalanceexpected•Money
Closing Balance V2 The amount that was expected to be in the cash drawer at the end of the session, calculated after the session was closed.
- Anchor to expectedOpeningBalanceexpected•Money
Opening Balance V2 The amount expected to be in the cash drawer based on the previous session.
- •ID!non-null
A globally-unique ID.
- Anchor to locationlocation•Location
The location of the point of sale device during this session.
- Anchor to netCashSalesnet•Money
Cash Sales V2! non-null The net cash sales made for the duration of this cash tracking session.
- Anchor to openingBalanceopening•Money
Balance V2! non-null The counted cash balance when the session was opened.
- Anchor to openingNoteopening•String
Note The note entered when the session was opened.
- Anchor to openingStaffMemberopening•Staff
Staff Member Member The user who opened the session.
- Anchor to openingTimeopening•Date
Time Time! non-null When the session was opened.
- Anchor to registerNameregister•String!
Name non-null The register name for the point of sale device that this session is tracking cash for.
- Anchor to totalAdjustmentstotal•Money
Adjustments V2 The sum of all adjustments made during the session, excluding the final adjustment.
- Anchor to totalCashRefundstotal•Money
Cash Refunds V2! non-null The sum of all cash refunds for the duration of this cash tracking session.
- Anchor to totalCashSalestotal•Money
Cash Sales V2! non-null The sum of all cash sales for the duration of this cash tracking session.
- Anchor to totalDiscrepancytotal•Money
Discrepancy V2 The total discrepancy for the session including starting and ending.
Anchor to QueriesQueries
- cashTrackingSession (CashTrackingSession)
- cashTrackingSessions (CashTrackingSessionConnection!)
- •query
Returns a
resource by ID.- •ID!required
The ID of the
to return.
Arguments
- •ID!
- •query
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.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Cash
Key Tracking Sessions Sort Keys Default:ID Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.
Arguments