Create scenario

POST/api/v1/cfo-projection/scenarios

Create a new projection scenario. Drivers are auto-seeded from trailing actuals when omitted.

Operation ID: create_scenario_api_v1_cfo_projection_scenarios_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.

Request body

Schema: ScenarioCreateRequest

namestring
base_monthstring · date: Last month of actuals; defaults to most recent closed month
projection_monthsinteger
revenue_driversobject
cost_classificationsobject
variable_driversobject
fixed_driversobject
monthly_overridesobject: Manual monthly overrides keyed by ledger_id then month index
tax_ratenumber
interest_income_monthlyinteger
interest_expense_monthlyinteger

Responses

201Successful Response

Schema: SuccessEnvelope_ScenarioResponse_

successboolean
messagestring
codestring
dataScenarioResponse

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

Code samples

POST/api/v1/cfo-projection/scenarios

bash

curl -X POST 'https://api.ondayzero.com/api/v1/cfo-projection/scenarios' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "base_month": "2026-01-01",
  "projection_months": 0,
  "revenue_drivers": {},
  "cost_classifications": {},
  "variable_drivers": {}
}'