Update a budget

Finance module

PATCH/budgets/{id}budgets.update

A project budget, structured as a chart of accounts by department and discipline. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Requires the capability finance.budget.write.
OAuth scopes: finance.
Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

budgets.update: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the budget.

Request body: BudgetUpdate

budgets.update: BudgetUpdate
Field	Type	Required	Description
name	string	No	Budget name.Constraints: length 1 to 300
currency_code	string	No	ISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$
is_baseline	boolean	No	Whether this is the gate 3 baseline the final cost report compares against.

{
  "name": "Gate 3 Budget",
  "currency_code": "USD",
  "is_baseline": false
}

Response 200: Budget

budgets.update: Budget
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the budget.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
project_id	string (uuid)	Yes	Identifier of the project.
name	string	Yes	Budget name.Constraints: length 1 to 300
currency_code	string	Yes	ISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$
is_baseline	boolean	Yes	Whether this is the gate 3 baseline the final cost report compares against.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "name": "Gate 3 Budget",
  "currency_code": "USD",
  "is_baseline": false
}

Code samples

curl -X PATCH "$XOS_BASE_URL/budgets/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"name":"Gate 3 Budget","currency_code":"USD","is_baseline":false}'

const { data, etag } = await xos.budgets.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "name": "Gate 3 Budget",
    "currency_code": "USD",
    "is_baseline": false
  }, { ifMatch: etag });

response = xos.budgets.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"name": "Gate 3 Budget", "currency_code": "USD", "is_baseline": False}, if_match=etag)

xos budgets update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"name":"Gate 3 Budget","currency_code":"USD","is_baseline":false}' --if-match auto