PATCH /rest/v1.0/potential_change_orders/sync
This endpoint creates or updates a batch of Potential Change Orders (PCO). See Using Sync Actions for additional information.
Servers
- https://api.procore.com
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. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
project_id |
Integer | Yes |
Unique identifier for the project. |
contract_id |
Integer | Yes |
Contract ID |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
updates[] |
Array | Yes | |
updates[].prime_change_event_id |
Integer | No |
Prime Contract Change Event ID |
updates[].currency_exchange_rate |
String | No |
Exchange rate from change order currency to project currency; It'll be accepted only when multicurrency phase two feature flag is enabled. |
updates[].description |
String | No |
Description |
updates[].commitment_change_event_id |
Integer | No |
Commitment Change Event ID |
updates[].number |
String | No |
Number |
updates[].paid_date |
String | No |
Paid date |
updates[].status |
String | No |
Status. This PCO attribute is ignored on projects when the tool is configured for single tier COs. Possible values:
|
updates[].origin_data |
String | No |
Origin data |
updates[].invoiced_date |
String | No |
Invoiced date |
updates[].change_order_request |
Object | No | |
updates[].change_order_request.change_order_package_id |
Integer | No |
Change Order Package (2 Tier Contract Config) |
updates[].origin_id |
String | No |
Origin ID |
updates[].title |
String | No |
Title |
updates[].schedule_impact_amount |
Integer | No |
Schedule impact in days |
updates[].change_order_request_id |
Integer | No |
Change Order Request ID |
updates[].due_date |
String | No |
Due date |
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.