PATCH /rest/v1.0/work_order_contracts/sync
This endpoint creates or updates a batch of Work Order Contracts. 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. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
project_id |
Integer | Yes |
Unique identifier for the project. |
updates[] |
Array | Yes |
Updated Work order contracts |
updates[].executed |
Boolean | No |
Executed (or not) Default value: false |
updates[].description |
String | No |
Description |
updates[].contract_estimated_completion_date |
String | No |
Estimated completion date |
updates[].origin_data |
String | No |
Origin Data |
updates[].origin_code |
String | No |
Origin code |
updates[].id |
Integer | No |
ID |
updates[].retainage_percent |
String | No |
Retainage percent |
updates[].actual_completion_date |
String | No |
Actual completion date |
updates[].origin_id |
String | No |
Origin ID |
updates[].title |
String | No |
Title |
updates[].approval_letter_date |
String | No |
Approval letter date |
updates[].contract_start_date |
String | No |
Start Date |
updates[].contract_date |
String | No |
Contract date |
updates[].signed_contract_received_date |
String | No |
Signed contract received date |
updates[].vendor_id |
Integer | No |
Vendor ID |
updates[].inclusions |
String | No |
Inclusions |
updates[].number |
String | No |
Number |
updates[].letter_of_intent_date |
String | No |
Letter of intent date |
updates[].status |
String | No |
Status Possible values:
|
updates[].returned_date |
String | No |
Returned date |
updates[].issued_on_date |
String | No |
Issued on date |
updates[].exclusions |
String | No |
Exclusions |
updates[].accounting_method |
String | No |
Accounting method Possible values:
|
updates[].execution_date |
String | No |
Execution date |
updates[].private |
Boolean | No |
If true, visible to admins and whitelisted accessors; otherwise visible to those with read only access. |
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.