Routes
Budgets

Update Budget

This request updates an existing Budget.

ParameterTypeRequiredDescription
nameStringOptionalThe title of this budget.
awaitingAllowPOEditBooleanOptionalWhen POs belonging to this budget are in the "ready to receive" state, will they be editable?
awaitingEmailSendBooleanOptionalWhen POs belonging to this budget enter the "ready to receive" state, should the assignee(s) be emailed?
awaitingAssignmentTypeEnumOptionalWhat type ('user' or 'team') should we interpret the awaitingAssignment value as? Required when awaitingAssignment is provided.
awaitingAssignmentInt or Array of IntsOptionalWhen POs belonging to this budget enter the "ready to receive" state, who will they be assigned to? If awaitingAssignmentType is 'team' then this cannot be an array, and may only be one number. Required when awaitingAssignmentType is provided.
prEmailSendBooleanOptionalWhen PO items are received on POs that belong to this budget in the "ready to receive" or "partially received" states, should we send email notification(s)?
prAssignmentTypeEnumOptionalWhat type ('user' or 'team') should we interpret the prAssignment value as? Required when prAssignment is provided.
prAssignmentInt or Array of IntsOptionalWhen bills are generated for PO items on POs that belong to this budget, who should the bills be assigned to? If prAssignmentType is 'team' then this cannot be an array, and may only be one number. Required when prAssignmentType is provided.
defaultBudgetObjectOptionalAn object containing Boolean flags for global, purchaseRequests, and minPartQtyPOs. Setting any of these flags to true will set the same value for any other budgets at this location to false (we cannot have two default budgets). All properties of this object are required when the object is provided. global: Should this be the default budget for this location? purchaseRequests: When purchase requests are created from tasks, should this be the default budget? minPartQtyPOs: When a PO is automatically created due to part quantity threshold, should this be the default budget?
patch/v2/budgets/{budgetID}

Request

Request body

namestring
awaitingAllowPOEditboolean
awaitingEmailSendboolean
awaitingAssignmentTypestring
awaitingAssignmentinteger
prEmailSendboolean
prAssignmentTypestring
prAssignmentinteger[]

Response

The operation completed successfully. The response body is empty.

Changes

No recorded changes to this operation across all 4 revisions of this API.