Get cash position forecast
well_get_cash_forecastGet the workspace's cash-position forecast — trailing actual month-end balances plus a worst-case projection forward — the exact same series the Well app's "Cash Position Forecast" chart draws. Use this instead of projecting cash forward yourself from a cash figure and a burn rate.
Returns entries, one per month, oldest first, each { month, actuals, projection } where month is YYYY-MM:
actualsis the settled cash position at that month's end, and is null for future months.projectionis the worst-case value at that month's end, and is null for past months.
So the series has exactly one turn: actuals up to the present, projection after it. Do not fill the nulls in or treat a null as a zero.
anchor names what the projection counts forward from: { month, amount, basis }, where the first projection point is amount minus one month of trailing burn. Name the anchor whenever you present that point — without it a reader cannot tell a projection falling from a base that is weeks old from cash that is actually dropping, and the two produce the same number. anchor is absent when nothing is projected.
Read basis before describing the anchor, because the two values are different readings and only one is a month-end:
closed_month_end—amountis the settled balance at the end ofmonth. Whenmonthis not the month just gone, say so: the projection for a month already under way was computed without anything that happened in it.current_position—amountis today's consolidated cash, which DOES include the month under way. Heremonthis only where the projection starts on the chart's grid, not the date the amount was read, so do not present it as a closing balance.
The projection is explicitly WORST CASE — it assumes NO revenue and declines at the trailing average burn until it reaches zero, where it stays clamped. Say so whenever you present it. It is a floor, not a forecast of what will happen, and a workspace that expects income will not follow it.
Takes no period. A worst-case projection has no coherent meaning for a month whose real outcome is already known, so this always returns the live forecast — unlike well_get_cash_position and well_get_cost_structure, which do accept year/month.
If hints are present (a short actuals window, excluded accounts, or a burn-coverage gap), disclose them rather than presenting the series as unconditionally complete.
This tool renders its own chart card in the host. Do not re-plot the series with a charting or visualisation tool — that draws a second, unbranded copy of a chart the reader is already looking at, from the same numbers. Read the series to answer in words; leave the drawing to the card.
For the single months-of-cash-left figure call well_get_runway; for the burn rate driving the decline call well_get_burn.
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 |
|---|---|---|---|
| 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 |
|---|---|---|---|
| error | No | ||
| hints | No | ||
| anchor | No | ||
| entries | Yes | ||
| success | Yes | ||
| currency | No | ||
| connectors_url | No | ||
| resolved_workspace | No | The workspace that answered, when the caller named none and the token authorizes several. |