Update budget

PATCH /api/v1/budgets/{budget_id}

Update a draft budget's metadata.

Operation ID: update_budget_api_v1_budgets__budget_id__patch · 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

budget_id string required

Request body

Schema: BudgetUpdateRequest

name string: Budget name.
description string: Budget description.
notes string: Additional notes.
start_date string · date: Budget period start date.
end_date string · date: Budget period end date.

Responses

200 Successful Response

Schema: BudgetResponse

id string required: Budget UUID.
name string required: Budget name.
fiscal_year integer required: Fiscal year.
start_date string · date required: Budget period start date.
end_date string · date required: Budget period end date.
status BudgetStatusEnum requiredBudgetStatusEnum: Budget status: draft, active, or closed.
period_type BudgetPeriodTypeEnum requiredBudgetPeriodTypeEnum: Period granularity.
description string: Budget description.
notes string: Additional notes.
line_count integer: Number of budget lines.
total_budgeted_revenue integer: Total budgeted revenue in cents.
total_budgeted_expenses integer: Total budgeted expenses in cents.
budgeted_net_income integer: Budgeted net income (revenue - expenses) in cents.
source_scenario_id string: CFO projection scenario UUID that generated this budget.
business_id string required: Business UUID.
created_at string · date-time required: Creation timestamp.
updated_at string · date-time required: Last update timestamp.

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

PATCH /api/v1/budgets/{budget_id}

bash

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

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/budgets/{budget_id}', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "name": "string",
  "description": "string",
  "notes": "string",
  "start_date": "2026-01-01",
  "end_date": "2026-01-01"
}),
});
const data = await response.json();

python

import httpx

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

payload = {
  "name": "string",
  "description": "string",
  "notes": "string",
  "start_date": "2026-01-01",
  "end_date": "2026-01-01"
}

response = httpx.patch("https://api.ondayzero.com/api/v1/budgets/{budget_id}", headers=headers, json=payload)
data = response.json()