Get cash position
well_get_cash_positionGet the workspace's current cash position: total cash on hand right now, converted to the workspace base currency, plus a per-account breakdown — the exact same computation and numbers the Well app's canvas KPI card shows. Use this instead of summing account balances yourself.
Returns amount/currency (the converted total), accounts (per-account contributions: native amount/currency, converted amount, the FX rate applied), as_of (the FX-rate anchor date this snapshot is valid for), and balance_history when the workspace has one.
balance_history is the trailing closed month-ends plus today, oldest first. Month-end is the only historical granularity that exists, so describe movement between months, never within one, and never as a daily series. A null amount is a month no connected account covered — not a zero balance. The field is absent when there is no reconstructed history, so make a trend claim only when it is present.
unavailable: true means amount is a placeholder, not a real measurement (e.g. no accounts connected yet) — say so plainly rather than presenting it as a real €0 balance. partial: true means one or more accounts were excluded from an otherwise real total (e.g. missing FX rate) — mention the exclusion count and any hints rather than presenting the number as unconditionally complete.
Everything here is backward-looking — no burn rate or runway is implied. Call well_get_runway instead for a forward-looking figure.
Pass year + month to read the balance as of the end of a past month instead of today. Note that balance_history (the trailing sparkline series) is returned ONLY for the live reading: a historical month has no live final point to anchor a trailing series on, so asking for a period returns the point-in-time balance without the series.
When the token authorizes one workspace, call this directly — no other tool call is needed first. When it authorizes several, this read will not guess which one you mean: pass workspace_id on the call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| year | No | Calendar year of the reporting period, e.g. 2026. Must be given together with `month`. | |
| month | No | Calendar month of the reporting period, 1 = January … 12 = December. Must be given together with `year`. Omit both to read the live/current figure. | |
| workspace_id | No | Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several: this read reports one workspace's own figures and will not choose which. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| as_of | No | ||
| error | No | ||
| hints | No | ||
| amount | Yes | ||
| partial | No | ||
| success | Yes | ||
| accounts | Yes | ||
| currency | No | ||
| excluded | No | ||
| unavailable | Yes | ||
| connectors_url | No | ||
| balance_history | No | ||
| resolved_workspace | No | The workspace that answered, when the caller named none and the token authorizes several. |