Get Forecast Run Cash Plan
GET/api/forecast-runs/:run/cash-plan
The cash plan stored with a saved forecast run: the weekly strip, payables and weights at build time, and every line's rank and fit. It does not change when payables, settings or weights change later; pins re-cut it.
purchase-orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Balance inputs (cash_on_hand, credit_line_limit, credit_line_drawn, available_credit, reserve_floor, snapshot_id, reserve_periods, and each week's reserve / reserve_label) are only present for users holding the cash_buying.view_balances permission. Without it these keys are omitted entirely (not null), because capacity together with the reserve or credit figures would reveal the bank balance.
Permission: cash_buying.index. Token scope: purchase-orders:read.
Without cash_buying.view_balances each week also omits capacity, spendable and spendable_after (see Get Weekly Headroom).
sized_unit_cost (on each line): the unit cost, in the line's pricing currency (as the purchase order carries it), that the line's cash was sized at. Compare it with the product's current cost to tell a plan ranked at old costs from the current ones; null on plans saved before it was recorded.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden
Response Headers
Not Found
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.