Create budget

POST/api/v1/budgets

Create a new budget for the business.

Operation ID: create_budget_api_v1_budgets_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: BudgetCreateRequest

namestringrequired: Budget name (e.g., '2026 Annual Budget').
fiscal_yearintegerrequired: Fiscal year for the budget.
start_datestring · daterequired: Budget period start date.
end_datestring · daterequired: Budget period end date.
period_typeBudgetPeriodTypeEnumBudgetPeriodTypeEnum: Period granularity: monthly, quarterly, or annual.
descriptionstring: Budget description.
notesstring: Additional notes.
source_scenario_idstring: CFO projection scenario that generated this budget.

Responses

201Successful Response

Schema: SuccessEnvelope_BudgetResponse_

successboolean
messagestring
codestring
dataBudgetResponse

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

bash

curl -X POST 'https://api.ondayzero.com/api/v1/budgets' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "fiscal_year": 0,
  "start_date": "2026-01-01",
  "end_date": "2026-01-01"
}'