Create a budget change

Create a budget change via API. The budget must have final approval. Budget change category and reason are optional. Project site IDs are required. The API respects the governance setting: Prevent Negative Budget Values. If the budget change would cause a cost code to become negative and the setting is enabled, an error will be returned.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Budget ID

items
array of objects
required

Budget change items

items*
project_site_ids
array of strings
required

Project site IDs (required)

project_site_ids*
string | null
Defaults to null

Description of the budget change

string | null
enum
Defaults to null

Budget change category (optional)

Allowed:
string | null
enum
Defaults to null

Reason for change (optional)

document_ids
array of strings
Defaults to []

Document IDs to attach

document_ids
string | null
enum
Defaults to null

Status is optional and defaults to "draft". Statuses "approved" and "internally-rejected" are not allowed when approval workflows are configured for budget changes

Allowed:
Responses
201

Budget change created successfully

400

Bad Request

401

Unauthorized

403

Access Forbidden

409

Budget does not have final approval or validation failed

422

Validation error or budget change would result in negative budget values

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!