Start free trial

Evaluate a what-if cash forecast scenario

POST/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/demand-plan

Run the canonical forecast twice (clean baseline + scenario) and return the per-week ending-cash delta.

Read-only: overrides and inline_one_time_items apply only to the scenario pass and are never persisted. Persisting a scenario is a separate call to PUT /cash-forecast/overrides.

Operation ID: cfo_portal_evaluate_demand_plan_api_v1_businesses__business_id__cfo_portal_cash_forecast_demand_plan_post·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

business_idstringrequired

Request body

Schema: DemandPlanScenarioRequest

scenario_descriptionstringrequired
overridesarray · DemandPlanScenarioOverrideDemandPlanScenarioOverride
3 fields
week_numberintegerrequired
columnstringrequired

One of: ar_in, ap_out, inventory, debt, debt_in, budget_rev, budget_exp, one_time

amount_centsintegerrequired
inline_one_time_itemsarray · DemandPlanScenarioOneTimeDemandPlanScenarioOneTime
3 fields
labelstringrequired
amount_centsintegerrequired
applies_onstring · daterequired
weeksinteger
budget_idstring
excluded_budget_ledger_idsarray · string

Responses

201Successful Response

Schema: SuccessEnvelope_DemandPlanScenarioResponse_

successboolean
messagestring
codestring
dataDemandPlanScenarioResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject