Start free trial

Save the current cash forecast configuration as a named version

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

Snapshot the current cash forecast configuration + output.

The version captures the chosen budget, excluded ledgers, and embedded one-time items, along with the full computed forecast JSON. The snapshot is what stays stable as live data drifts; the config is what's replayed against live data on load.

Operation ID: cfo_portal_create_version_api_v1_businesses__business_id__cfo_portal_cash_forecast_versions_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: CashForecastVersionCreate

namestringrequired
descriptionstring
configCashForecastVersionConfigCashForecastVersionConfig
4 fields
budget_idstring
excluded_budget_ledger_idsarray · string
weeksinteger
one_time_items_snapshotarray · CashForecastOneTimeItemBaseCashForecastOneTimeItemBase

Snapshot of the one-time items as they existed when the version was saved. Replays against live data don't re-load from the live cash_forecast_one_time_items table.

Responses

201Successful Response

Schema: SuccessEnvelope_CashForecastVersionDetail_

successboolean
messagestring
codestring
dataCashForecastVersionDetail

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