Re-apply a saved version's config to the live forecast

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

Load a saved version into the user's working scope.

Pushes the version's budget exclusion list to business settings and replays its overrides into the working scope so the live forecast recomputes against the saved configuration. The caller should invalidate the cash-forecast query and use budget_id from the response to sync any local budget-selector state.

Operation ID: cfo_portal_apply_version_api_v1_businesses__business_id__cfo_portal_cash_forecast_versions__version_id__apply_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_id string required
version_id string required

Responses

201 Successful Response

Schema: CashForecastVersionApplyResponse

version_id string required
budget_id string
excluded_budget_ledger_ids array · string
applied_override_count integer required

400 Bad Request - Invalid input

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

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

bash

curl -X POST 'https://api.ondayzero.com/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/versions/{version_id}/apply' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/versions/{version_id}/apply', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.post("https://api.ondayzero.com/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/versions/{version_id}/apply", headers=headers)
data = response.json()