Update a Budget Item
put
/primeapi/restapi/budgetItem
Send a request to this endpoint to update a budget item. 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
Supported Media Types
- application/json
A budget item object.
Root Schema : ApiEntityBudgetItem
Type:
Show Source
object
-
budgetChangeId(optional):
integer(int64)
Indicates whether the budget item originated in a budget change.
-
budgetHours(optional):
object Hour
-
budgetItemConfiguredFields(optional):
object ApiEntityBudgetItemConfiguredFields
-
budgetItemCost(optional):
object ApiEntityBudgetItemCost
-
budgetItemId(optional):
integer(int64)
The system-generated identifier of a budget item. This value should not be provided in create operation request data, however, it is required for update requests.
-
costCategoryId(optional):
integer(int64)
The type of cost associated with the budget item.
-
costSheetItemId:
integer(int64)
The unique identifier of the CBS Code.
-
itemCode(optional):
string
The unique identifier of the project budget item.
-
itemName:
string
The name of the budget item.
-
itemSuffix(optional):
integer(int64)
The suffix of a budget item code.
-
link(optional):
string(url)
Read Only:
true
-
productionRate(optional):
object Hour
-
projectBudgetId:
integer(int64)
The system-generated identifier of a project budget.
-
quantity(optional):
number(double)
The number of each budget item needed to complete the work.
-
sourceId(optional):
string
The unique identifier of budget item data in an external source.
-
unitsOfMeasureId(optional):
integer(int64)
The Unit of Measure used for the budget item.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityBudgetItemConfiguredFields
Type:
Show Source
object
-
budgetItemId(optional):
integer(int64)
The system-generated identifier of a budget item.
-
costFlexMap(optional):
object costFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing cost fields in the form of key-value pairs.
-
link(optional):
string(url)
Read Only:
true
-
otherFlexMap(optional):
object otherFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing non-cost, non-text fields in the form of key-value pairs.
-
textFlexMap(optional):
object textFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing text fields in the form of key-value pairs.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityBudgetItemCost
Type:
Show Source
object
-
budgetItemId(optional):
integer(int64)
The system-generated identifier of a budget item. This value should not be provided in create operation request data, however, it is required for update requests.
-
currentCost(optional):
object Cost
-
currentCostProject(optional):
object Cost
-
currentCostWorkspace1(optional):
object Cost
-
currentCostWorkspace2(optional):
object Cost
-
currentCostWorkspace3(optional):
object Cost
-
laborRate(optional):
object Cost
-
laborRateProject(optional):
object Cost
-
laborRateWorkspace1(optional):
object Cost
-
laborRateWorkspace2(optional):
object Cost
-
laborRateWorkspace3(optional):
object Cost
-
link(optional):
string(url)
Read Only:
true
-
originalCost:
object Cost
-
originalCostProject(optional):
object Cost
-
originalCostWorkspace1(optional):
object Cost
-
originalCostWorkspace2(optional):
object Cost
-
originalCostWorkspace3(optional):
object Cost
-
unitRate(optional):
object Cost
-
unitRateProject(optional):
object Cost
-
unitRateWorkspace1(optional):
object Cost
-
unitRateWorkspace2(optional):
object Cost
-
unitRateWorkspace3(optional):
object Cost
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing cost fields in the form of key-value pairs.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing non-cost, non-text fields in the form of key-value pairs.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing text fields in the form of key-value pairs.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : Cost
Type:
object
Response
Supported Media Types
- application/json
204 Response
Successful operation with no content.
400 Response
Invalid input for the Budget Item service. Verify the request contains valid data, then resubmit the request.