Choose a version:

cashManagementShopSummary

query

Requires read_cash_tracking access scope. Also: User must have view_payment_tracking_sessions_pos_channel or payments_cash_session_history retail role permission.

Summary of cash management data across all locations with a POS Pro subscription for a shop, filtered by currency.

Anchor to Arguments

Arguments

Anchor to currencyCodecurrencyCode

•CurrencyCode!

required

The currency code to filter by.

Anchor to endDateendDate

•Date!

required

The end date to summarize to.

Anchor to startDatestartDate

•Date!

required

The start date to summarize from.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to CashManagementSummaryCashManagementSummary

•CashManagementSummary!

A summary of cash management data.

Anchor to cashBalanceAtEndcashBalanceAtEnd •MoneyV2! non-null: The cumulative cash balance of all cash drawers at the provided end date.
Anchor to cashBalanceAtStartcashBalanceAtStart •MoneyV2! non-null: The cumulative cash balance of all cash drawers at the provided start date.
Anchor to netCashnetCash •MoneyV2! non-null: The net cash flow during the specified period (start date to end date). Calculated as net sales plus adjustments.
Anchor to sessionsClosedsessionsClosed •Int! non-null: The number of sessions that were closed during the specified period (start date to end date).
Anchor to sessionsOpenedsessionsOpened •Int! non-null: The number of sessions that were opened during the specified period (start date to end date).
Anchor to totalDiscrepanciestotalDiscrepancies •MoneyV2! non-null: The total cash discrepancies during the specified period (start date to end date).

Was this section helpful?