GET /api/agent/cash-position
Reconciled cash across all active accounts, with the per-account breakdown and any plain-language notes the insight engine surfaced.
Auth
- Required scope:
READ_FORECAST - Header:
Authorization: Bearer cr_live_<prefix>_<secret>
Responses
200 — Cash position snapshot
Body: CashPositionResponse
| Field | Type | Required | Notes |
|---|---|---|---|
asOfDate | string (date) | yes | |
startingCash | string | yes | Effective opening cash (post-override, post-auto-adjust). Equal to effectiveStartingCash today; surfaced under both names for clarity. |
source | string · one of manual xero_reconciled | yes | |
xeroReconciledTotal | string | yes | Bare sum of Xero-reconciled bank balances across the org's RECONCILED accounts. This is the honest ledger total — no operator override or auto-detected unreconciled-transaction adjustment applied. Compare against effectiveStartingCash to detect drift driven by overrides or pending Xero categorisation. |
effectiveStartingCash | string | yes | Post-override and post-auto-adjust opening cash, used by the forecast engine. Diverges from xeroReconciledTotal when an operator override or auto-detected unreconciled-transaction adjustment is in play. |
currency | string | no | |
accounts | array of object | yes | |
redactedItemCount | integer | yes | Number of accounts rows whose name was rewritten to "Sensitive account" for this caller. Always 0 when the key carries the READ_SENSITIVE scope. Lets agentic consumers know they're operating on a masked view without inspecting every name. |
notesForAgent | array of AgentNote | no | |
billingAlert | BillingAlert | no | |
xeroAlert | XeroAlert | no |
401 — Unauthorized
Body: ErrorResponse
| Field | Type | Required | Notes |
|---|---|---|---|
error | string | yes |
429 — Rate-limited or quota-exhausted
Body: ErrorResponse
| Field | Type | Required | Notes |
|---|---|---|---|
error | string | yes |
Response headers
Every successful response carries X-CashRunway-Subscription, X-CashRunway-Plan, X-CashRunway-Quota-Remaining, and X-CashRunway-Quota-Reset. Trialing subscriptions also include X-CashRunway-Trial-Days-Remaining. See the overview for details.