Skip to content

Cash

The Cash module is nested under /cash with sub-routes:

RouteTab labelPage component
/cash(redirect)Redirects to /cash/balances.
/cash/balancesBalancesCashBalancesPage
/cash/ocpOCPOpenCurrencyPositionPage
/cash/paymentsPaymentsPaymentOrdersPage
/cash/analyticsAnalyticsCashAnalyticsPage

Path: /cash/balances

The balances view shows CashBalanceGrid rows keyed by book / entity with functional currency rollups. Toolbar filters:

  • Entity dropdown (options from API entity list or inferred from loaded balances).
  • Currency multi-select (USD, EUR, GBP, …).

Summary chips typically include total functional amount and total margin (initial + variation).

When the WebSocket client is not connected (and not idle), a yellow banner warns “Live feed offline — showing last known data” — the store may still show the last snapshot.

Row drill-in opens book balance detail; you can spawn a new payment order drawer pre-linked to a book.


Path: /cash/ocp

Open currency position aggregates net exposure by entity and currency with:

  • OCP risk alert banner when limits are breached.
  • Summary bar and toggle between waterfall chart mode and heatmap mode.
  • OCP position grid with export to CSV.
  • Same WebSocket offline banner pattern as balances when the feed drops.

Use breach filter and chart mode toggles to focus problem currencies.


Path: /cash/payments

Lists payment orders via usePaymentOrders with optional state filtering:

Filter tabState
AllNo filter
Pending ApprovalPENDING_APPROVAL
Pending SettlementPENDING_SETTLEMENT
SettledSETTLED
RejectedREJECTED

PaymentOrderGrid drives the main sheet; selecting a row opens PaymentOrderDetail. Admins can authorize or reject through dialogs; New payment order opens a drawer to draft instructions.

WebSocket updates invalidate payment-orders queries when the server broadcasts (see WebSocket).


Path: /cash/analytics

Cash analytics combines a toolbar (preset range, from / to, interval) with four chart cards:

  • Cashflow history (CashflowHistoryChart)
  • Exposure drift (ExposureDriftChart)
  • Funding utilisation (FundingUtilChart)
  • Snapshot trend (SnapshotTrendChart)

Charts load from historical queries (useCashflowHistory, useOcpHistory, useFundingUtilisation, useSnapshotTrend) and share the same date preset plumbing (1M, custom range, EOD interval).

Empty states render when the API returns no rows for the window.


Related: WebSocket integration, REST API.