PATCH /rest/v1.0/projects/{project_id}/budget_changes/{id}
Update information of a Budget Change
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
Integer | Yes |
Unique identifier of budget change |
project_id |
Integer | Yes |
Unique identifier for the project. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Procore-Company-Id |
Integer | Yes |
Unique company identifier associated with the Procore User Account. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
Integer | No |
Unique identifier of this budget change |
prostore_file_ids[] |
Array | No |
The desired prostore file identifiers that will replace the current collection of attachments associated with the budget change |
description |
String | No |
Description of budget change in HTML format |
number |
Number | No |
Number field of budget change |
title |
String | No |
Title of budget change |
production_quantities[] |
Array | No |
List of budget change production quantities |
production_quantities[].id |
Integer | No |
ID of this Production Quantity |
production_quantities[].comment |
String | No |
Comment of the adjustment |
production_quantities[].change_event_production_quantity_id |
Number | No |
ID of the Change Event Production Quantity that is to be associated with the Budget Change Production Quantity |
production_quantities[].description |
String | No |
Description of the Production Quantity |
production_quantities[].quantity |
Number | Yes |
Estimated cost quantity |
production_quantities[].ref |
String | No |
Identifier used to map production quantities in the request to their respective objects or errors in the response |
production_quantities[].uom |
String | Yes |
Unit of measure used |
production_quantities[]._delete |
Boolean | No |
Whether this production quantity should be deleted |
production_quantities[].cost_code_id |
Integer | Yes |
Cost Code ID |
status |
String | No |
Status of budget change Possible values:
|
adjustment_line_items[] |
Array | No |
List of budget change adjustments |
adjustment_line_items[].description |
String | No |
Description of the adjustment |
adjustment_line_items[].quantity |
Number | No |
Estimated cost quantity |
adjustment_line_items[].ref |
String | No |
Identifier used to map line items in the request to their respective objects or errors in the response |
adjustment_line_items[].uom |
String | No |
Unit of measure used |
adjustment_line_items[]._delete |
Boolean | No |
Whether this adjustment should be deleted |
adjustment_line_items[].adjustment_number |
Integer | No |
Number of this adjustment |
adjustment_line_items[].unit_cost |
Number | No |
Estimated unit cost |
adjustment_line_items[].id |
Integer | No |
ID of this adjustment |
adjustment_line_items[].calculation_strategy |
String | No |
Cost calculation strategy Possible values:
|
adjustment_line_items[].comment |
String | No |
Comment of the adjustment |
adjustment_line_items[].wbs_code_id |
Integer | No |
Work Breakdown Structure Code ID |
adjustment_line_items[].amount |
Number | No |
Estimated cost amount |
adjustment_line_items[].change_event_line_item_id |
Integer | No |
ID for the change event line item associated with the adjustment |
adjustment_line_items[].type |
String | No |
Used to identify type of line item. id uniqueness is guaranteed per type NOTE: To update an Adjustment Line Item with the type budget_change for an adjustment_number, an Adjustment Line item with the type change_event must exist for the same adjustment_number. Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.