Create a budget

Finance module

POST/budgetsbudgets.create

A project budget, structured as a chart of accounts by department and discipline. Creates a budget. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability finance.budget.write.
OAuth scopes: finance.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: BudgetCreate

budgets.create: BudgetCreate
Field	Type	Required	Description
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	No	Whether this is the gate 3 baseline the final cost report compares against.

{
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "name": "Gate 3 Budget",
  "currency_code": "USD",
  "is_baseline": false
}

Response 201: Budget

budgets.create: 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 POST "$XOS_BASE_URL/budgets" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","name":"Gate 3 Budget","currency_code":"USD","is_baseline":false}'

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

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

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