Generate forecast

POST/api/v1/budgets/forecast

Generate a financial forecast based on historical data.

Operation ID: generate_forecast_api_v1_budgets_forecast_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: GenerateForecastRequest

methodForecastMethodEnumForecastMethodEnum: Forecasting method.
lookback_monthsinteger: Historical months to analyze.
forecast_monthsinteger: Months to forecast.
growth_rate_percentinteger: Growth rate adjustment.
use_seasonalityboolean: Apply seasonal adjustments.
include_cash_flowboolean: Include cash flow projections.

Responses

201Successful Response

Schema: SuccessEnvelope_ForecastResponse_

successboolean
messagestring
codestring
dataForecastResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

POST/api/v1/budgets/forecast

bash

curl -X POST 'https://api.ondayzero.com/api/v1/budgets/forecast' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "method": "string",
  "lookback_months": 0,
  "forecast_months": 0,
  "growth_rate_percent": 0,
  "use_seasonality": false,
  "include_cash_flow": false
}'