POST /rest/v1.0/work_order_contracts
Create a Work Order Contract.
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 |
|---|---|---|---|
run_configurable_validations |
Boolean | No |
If true, validations are run for the corresponding Configurable Field Set. Default value: false |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
project_id |
Integer | Yes |
Unique identifier for the project. |
attachments[] |
Array | No |
Work Order Contract attachments. To upload attachments you must upload the entire payload as |
work_order_contract |
Object | Yes |
Work Order Contract object |
work_order_contract.executed |
Boolean | No |
Executed (or not) Default value: false |
work_order_contract.description |
String | No |
Description |
work_order_contract.invoice_contact_user_ids[] |
Array | No |
IDs of users in the project directory (see the Project Users endpoint). The users with these IDs will be added as invoice contacts if they belong to the same vendor as the contract vendor. Invoice contacts are the points of contact for subcontractor invoices. |
work_order_contract.currency_iso_code |
String | No |
Currency ISO code; It'll be accepted only when multicurrency phase two feature flag is enabled. |
work_order_contract.contract_estimated_completion_date |
String | No |
Estimated completion date |
work_order_contract.origin_data |
String | No |
Origin Data |
work_order_contract.drawing_revision_ids[] |
Array | No |
Drawing Revisions to attach to the response |
work_order_contract.origin_code |
String | No |
Origin code |
work_order_contract.custom_field_%{custom_field_definition_id} |
No |
Value of the custom field. The data type of the value passed in corresponds with the data_type of the Custom Field Definition. For a lov_entry data_type the value passed in should be the ID of one of the Custom Field Definition's LOV Entries. For a lov_entries data_type the value passed in should be an array of IDs of the Custom Field Definition's LOV Entries. |
|
work_order_contract.retainage_percent |
String | No |
Retainage percent |
work_order_contract.actual_completion_date |
String | No |
Actual completion date |
work_order_contract.origin_id |
String | No |
Origin ID |
work_order_contract.title |
String | No |
Title |
work_order_contract.approval_letter_date |
String | No |
Approval letter date |
work_order_contract.contract_start_date |
String | No |
Start date |
work_order_contract.contract_date |
String | No |
Contract date |
work_order_contract.signed_contract_received_date |
String | No |
Signed contract received date |
work_order_contract.file_version_ids[] |
Array | No |
File Versions to attach to the response |
work_order_contract.vendor_id |
Integer | No |
Vendor ID |
work_order_contract.currency_exchange_rate |
Number | No |
Exchange rate from contract currency to project currency; It'll be accepted only when multicurrency phase two feature flag is enabled and user has the granular permission to edit the contract exchange rate. |
work_order_contract.image_ids[] |
Array | No |
Images to attach to the response |
work_order_contract.inclusions |
String | No |
Inclusions |
work_order_contract.number |
String | No |
Number |
work_order_contract.letter_of_intent_date |
String | No |
Letter of intent date |
work_order_contract.upload_ids[] |
Array | No |
Uploads to attach to the response |
work_order_contract.status |
String | No |
Status Possible values:
|
work_order_contract.returned_date |
String | No |
Returned date |
work_order_contract.issued_on_date |
String | No |
Issued on date |
work_order_contract.form_ids[] |
Array | No |
Forms to attach to the response |
work_order_contract.exclusions |
String | No |
Exclusions |
work_order_contract.accounting_method |
String | No |
Accounting method. If not provided on create action, defaults to Project Configuration. Possible values:
|
work_order_contract.execution_date |
String | No |
Execution date |
work_order_contract.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.