Update a Project Budget Change
put
/api/restapi/budgetChange
Send a request to this endpoint to update a project budget change. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : ApiEntityBudgetChangeInput
Type:
object
Title:
ApiEntityBudgetChangeInput
This entity represents a BudgetChange object, a unique BudgetChange object can be identified by the following combinations of the fields.
Show Source
- budgetChangeId
- budgetChangeCode,projectId
- budgetChangeCode,projectCode,workspaceCode
- budgetChangeCode,projectBudgetId
-
approveByUserId: integer(int64)Read Only:true
Deprecated. As of 23.11.The username of the user that approved the item. -
approveByUserName: stringRead Only:true
Maximum Length:255
Deprecated. As of 23.11.The name of the user who approved a project budget change. -
approveDate: string(date-time)Read Only:true
Deprecated. As of 23.11.Date the item was approved. -
budgetChangeCode: string
Minimum Length:
0
Maximum Length:60
The unique identifier of the project budget change request. -
budgetChangeCost:budgetChangeCostRead Only:true
Deprecated. As of 23.11.An object containing the cost fields associated with the budget change. -
budgetChangeId: integer
(int64)
The system-generated identifier of a budget change.
-
budgetTransactions: array
budgetTransactions
List of all budget transactions for the project budget change.
-
configuredFields: array
configuredFields
The list of configured fields for a budget change.
-
description: string
Minimum Length:
0
Maximum Length:4000
Details supporting the change request. -
lastModifiedById: integer(int64)Read Only:true
Deprecated. As of 23.11.The username of the user who last made changes to the item. -
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
projectBudgetId: integer
(int64)
The system-generated identifier of a project budget.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for a project set by the user who created the project. -
projectId(required): integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
rejectByUserId: integer(int64)Read Only:true
Deprecated. As of 23.11.The username of the user that rejected the item. -
rejectByUserName: stringRead Only:true
Maximum Length:255
Deprecated. As of 23.11.The name of the user who rejected a project budget change. -
rejectDate: string(date-time)Read Only:true
Deprecated. As of 23.11.Date the item was rejected. -
status: string
Allowed Values:
[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]
The state of the project budget change request. Pending: The change request is awaiting a decision. Approved: The change request was approved. Rejected: The change request was not approved. -
submitByUserId: integer(int64)Read Only:true
Deprecated. As of 23.11.The username of the user that submitted the item. -
submitByUserName: stringRead Only:true
Maximum Length:255
Deprecated. As of 23.11.The name of the user who submitted a project budget change. -
submitDate: string(date-time)Deprecated. As of 23.11.Date the item was submitted. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated. -
withdrawApprovalByUserId: integer(int64)Read Only:true
Deprecated. As of 23.11.The username of the user that with withdrew approval of the item. -
withdrawApprovalByUserName: stringRead Only:true
Maximum Length:255
Deprecated. As of 23.11.The name of the user who withdrew a project budget change. -
withdrawApprovalDate: string(date-time)Read Only:true
Deprecated. As of 23.11.Date the item was withdrawn. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace.
Nested Schema : budgetChangeCost
Read Only:
true
Deprecated. As of 23.11.An object containing the cost fields associated with the budget change.
Match All
Show Source
-
object
ApiEntityBudgetChangeCost
Title:
ApiEntityBudgetChangeCost
Read Only:true
Nested Schema : budgetTransactions
Type:
array
List of all budget transactions for the project budget change.
Show Source
-
Array of:
object ApiEntityBudgetChangeTransactionInput
Title:
ApiEntityBudgetChangeTransactionInput
This entity represents a BudgetChangeTransaction object, a unique BudgetChangeTransaction object can be identified by the following combinations of the fields.- budgetTransactionId
Nested Schema : configuredFields
Type:
array
The list of configured fields for a budget change.
Show Source
-
Array of:
object ApiEntityBudgetChangeConfiguredFieldValueInput
Title:
ApiEntityBudgetChangeConfiguredFieldValueInput
This entity represents a BudgetChangeConfiguredFieldValue object, a unique BudgetChangeConfiguredFieldValue object can be identified by the following combinations of the fields.- budgetChangeConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
Nested Schema : ApiEntityBudgetChangeCost
Type:
object
Title:
ApiEntityBudgetChangeCost
Read Only:
Show Source
true
-
budgetChangeId: integer
(int64)
The system-generated identifier of a budget change.
-
link: string
(url)
Read Only:
true
The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
totalCost: number
(double)
The cost to be added or subtracted from the project budget. This value is based on the base currency.
-
totalCostProject: number
(double)
The cost to be added or subtracted from the project budget. This value is based on the project currency.
-
totalCostWorkspace1: number
(double)
The cost to be added or subtracted from the project budget. This value is based on the workspace1 currency.
-
totalCostWorkspace2: number
(double)
The cost to be added or subtracted from the project budget. This value is based on the workspace2 currency.
-
totalCostWorkspace3: number
(double)
The cost to be added or subtracted from the project budget. This value is based on the workspace3 currency.
-
updateDate: string
(date-time)
Read Only:
true
Date when the record was last updated.
Nested Schema : ApiEntityBudgetChangeTransactionInput
Type:
object
Title:
ApiEntityBudgetChangeTransactionInput
This entity represents a BudgetChangeTransaction object, a unique BudgetChangeTransaction object can be identified by the following combinations of the fields.
Show Source
- budgetTransactionId
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
approveDate: string(date-time)Read Only:true
Deprecated. As of 23.11.The date the transaction was approved. -
budgetCbsSheetCodeId: integer
(int64)
The name of the CBS Code associated with the budget line item.
-
budgetChangeId: integer
(int64)
This is an intermediary field that the system uses to calculate other values. It does not correspond to any field users can see in the user interface.
-
budgetCostCategoryId: integer
(int64)
The cost category ID of the budget line item.
-
budgetHours: number(double)Read Only:true
Deprecated. As of 23.11.The number of hours needed to complete the budget details line item. Calculated as Production Rate multiplied by Quantity. -
budgetItemId: integer
(int64)
A unique identifier for the budget item (Change Budget Line).
-
budgetItemName: string
Maximum Length:
255
The name of the budget item. -
budgetTransactionCost:
budgetTransactionCost
The cost of a budget transaction.
-
budgetTransactionId: integer
(int64)
The system-generated identifier of a budget transaction.
-
changeMode: stringRead Only:true
Allowed Values:[ "AUTO", "MANUAL", "CHANGE" ]
Deprecated. As of 23.11.The detailed budget change line item. -
configuredFields: array
configuredFields
The list of configured fields for a budget change transaction.
-
desiredCode: string
Minimum Length:
0
Maximum Length:60
A unique identifier for the budget item (Add Budget Line). -
itemCode: string
Maximum Length:
60
The unique identifier for the budget line item. -
itemCodeSuffix: integer(int64)Read Only:true
Deprecated. As of 23.11.The suffix of a budget transaction code. -
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
productionRate: number
(double)
Minimum Value:
0.000010
The number of hours per unit of measure needed to complete the budget line item. -
quantity: number
(double)
The number of each budget line item needed to complete the work.
-
status: string
Allowed Values:
[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ]
The status of the transaction. Indicates whether the transaction is approved, pending, draft, or rejected. -
transactionType: stringRead Only:true
Allowed Values:[ "ORIGINAL", "CHANGE", "TRANSFER" ]
Deprecated. As of 23.11.Specifies whether the budget row is an original, change, or transfer value. -
unitOfMeasureId: integer
(int64)
The Unit of Measure used for the budget line item detail.
-
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Nested Schema : budgetTransactionCost
The cost of a budget transaction.
Match All
Show Source
-
object
ApiEntityBudgetTransactionCostInput
Title:
ApiEntityBudgetTransactionCostInput
This entity represents a BudgetTransactionCost object, a unique BudgetTransactionCost object can be identified by the following combinations of the fields.- budgetTransactionId
Nested Schema : configuredFields
Type:
array
The list of configured fields for a budget change transaction.
Show Source
-
Array of:
object ApiEntityBudgetTransactionConfiguredFieldValueInput
Title:
ApiEntityBudgetTransactionConfiguredFieldValueInput
This entity represents a BudgetTransactionConfiguredFieldValue object, a unique BudgetTransactionConfiguredFieldValue object can be identified by the following combinations of the fields.- budgetTransactionConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
Nested Schema : ApiEntityBudgetTransactionCostInput
Type:
object
Title:
ApiEntityBudgetTransactionCostInput
This entity represents a BudgetTransactionCost object, a unique BudgetTransactionCost object can be identified by the following combinations of the fields.
Show Source
- budgetTransactionId
-
amountCost: number(double)Read Only:true
Deprecated. As of 23.11.The amount that the budget row has changed as the result of transactions. This value is based on the base currency. -
amountCostProject: number
(double)
The amount that the budget row has changed as the result of transactions. This value is based on the project currency.
-
amountCostWorkspace1: number(double)Read Only:true
Deprecated. As of 23.11.The amount that the budget row has changed as the result of transactions. This value is based on the workspace1 currency. -
amountCostWorkspace2: number(double)Read Only:true
Deprecated. As of 23.11.The amount that the budget row has changed as the result of transactions. This value is based on the workspace2 currency. -
amountCostWorkspace3: number(double)Read Only:true
Deprecated. As of 23.11.The amount that the budget row has changed as the result of transactions. This value is based on the workspace3 currency. -
budgetTransactionId: integer
(int64)
The system-generated identifier of a budget transaction.
-
currentCost: number(double)Read Only:true
Deprecated. As of 23.11.The current cost of the associated budget line item. This value is based on the base currency. -
currentCostProject: number(double)Read Only:true
Deprecated. As of 23.11.The current cost of the associated budget line item. This value is based on the project currency. -
currentCostWorkspace1: number(double)Read Only:true
Deprecated. As of 23.11.The current cost of the associated budget line item. This value is based on the workspace1 currency. -
currentCostWorkspace2: number(double)Read Only:true
Deprecated. As of 23.11.The current cost of the associated budget line item. This value is based on the workspace2 currency. -
currentCostWorkspace3: number(double)Read Only:true
Deprecated. As of 23.11.The current cost of the associated budget line item. This value is based on the workspace3 currency. -
laborRate: number(double)Read Only:true
Deprecated. As of 23.11.The cost per labor hour of the budget line item detail. This value is based on the base currency. -
laborRateProject: number
(double)
The cost per labor hour of the budget line item detail. This value is based on the project currency.
-
laborRateWorkspace1: number(double)Read Only:true
Deprecated. As of 23.11.The cost per labor hour of the budget line item detail. This value is based on the workspace1 currency. -
laborRateWorkspace2: number(double)Read Only:true
Deprecated. As of 23.11.The cost per labor hour of the budget line item detail. This value is based on the workspace2 currency. -
laborRateWorkspace3: number(double)Read Only:true
Deprecated. As of 23.11.The cost per labor hour of the budget line item detail. This value is based on the workspace3 currency. -
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
unitRate: number(double)Read Only:true
Deprecated. As of 23.11.The cost per Unit of Measure for the budget line item detail. This value is based on the base currency. -
unitRateProject: number
(double)
The cost per Unit of Measure for the budget line item detail. This value is based on the project currency.
-
unitRateWorkspace1: number(double)Read Only:true
Deprecated. As of 23.11.The cost per Unit of Measure for the budget line item detail. This value is based on the workspace1 currency. -
unitRateWorkspace2: number(double)Read Only:true
Deprecated. As of 23.11.The cost per Unit of Measure for the budget line item detail. This value is based on the workspace2 currency. -
unitRateWorkspace3: number(double)Read Only:true
Deprecated. As of 23.11.The cost per Unit of Measure for the budget line item detail. This value is based on the workspace3 currency. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Nested Schema : ApiEntityBudgetTransactionConfiguredFieldValueInput
Type:
object
Title:
ApiEntityBudgetTransactionConfiguredFieldValueInput
This entity represents a BudgetTransactionConfiguredFieldValue object, a unique BudgetTransactionConfiguredFieldValue object can be identified by the following combinations of the fields.
Show Source
- budgetTransactionConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
budgetTransactionConfiguredFieldValueId: integer
(int64)
The unique identifier for the Transaction Configured Field.
-
budgetTransactionId: integer(int64)Read Only:true
Deprecated. As of 23.11.The system-generated identifier for a transaction. -
columnDefinitionId: integer
(int64)
Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
-
columnLabel: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column label. -
columnName: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column name. -
costValue: numberRead Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record. -
costValueWorkspace1: number(double)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace1 currency conversion. -
costValueWorkspace2: number(double)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace2 currency conversion. -
costValueWorkspace3: number(double)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace3 currency conversion. -
dateValue: string
(date-time)
This holds values for Date type configured fields.
-
exceptionMessage: stringRead Only:true
Maximum Length:4000
Deprecated. As of 23.10.Provides the error message for why the formula calculation resulted in an error. -
hasException: booleanRead Only:true
Deprecated. As of 23.10.Determines if formula calculation hit an error calculating a value for this field. -
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
numberValue: number
This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
-
textValue: string
Maximum Length:
4000
This holds values for Boolean, List and Text type configured fields. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Nested Schema : ApiEntityBudgetChangeConfiguredFieldValueInput
Type:
object
Title:
ApiEntityBudgetChangeConfiguredFieldValueInput
This entity represents a BudgetChangeConfiguredFieldValue object, a unique BudgetChangeConfiguredFieldValue object can be identified by the following combinations of the fields.
Show Source
- budgetChangeConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
budgetChangeConfiguredFieldValueId: integer
(int64)
The unique identifier for the Budget Change Configured Field.
-
budgetChangeId: integer
(int64)
-
columnDefinitionId: integer
(int64)
Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
-
columnLabel: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column label. -
columnName: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column name. -
costValue: numberRead Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record. -
costValueWorkspace1: number(double)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace1 currency conversion. -
costValueWorkspace2: number(double)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace2 currency conversion. -
costValueWorkspace3: number(double)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace3 currency conversion. -
dateValue: string
(date-time)
This holds values for Date type configured fields.
-
exceptionMessage: stringRead Only:true
Maximum Length:4000
Deprecated. As of 23.10.Provides the error message for why the formula calculation resulted in an error. -
hasException: booleanRead Only:true
Deprecated. As of 23.10.Determines if formula calculation hit an error calculating a value for this field. -
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
numberValue: number
This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
-
textValue: string
Maximum Length:
4000
This holds values for Boolean, List and Text type configured fields. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Examples
Back to Top
Response
204 Response
Successful operation with no content.
400 Response
Invalid input for the Project Budget Change service. Verify the request contains valid data, then resubmit the request.