POST /rest/v1.0/prime_contract
Create a new Prime 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 |
Prime Contract attachments.
To upload attachments you must upload the entire payload as |
prime_contract |
Object | Yes |
Prime Contract object |
prime_contract.executed |
Boolean | No |
Executed |
prime_contract.description |
String | No |
Description |
prime_contract.currency_iso_code |
String | No |
Currency ISO code; It'll be accepted only when multicurrency phase two feature flag is enabled. |
prime_contract.contract_estimated_completion_date |
String | No |
Contract Estimated Completion Date |
prime_contract.contractor_id |
Integer | No |
Contractor ID |
prime_contract.origin_data |
String | No |
Prime Contract third party data |
prime_contract.drawing_revision_ids[] |
Array | No |
Drawing Revisions to attach to the response |
prime_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. |
|
prime_contract.retainage_percent |
String | No |
Retainage Percent |
prime_contract.actual_completion_date |
String | No |
Actual Completion Date |
prime_contract.architect_id |
Integer | No |
Architect ID |
prime_contract.origin_id |
String | No |
Prime Contract third party ID |
prime_contract.title |
String | No |
Title of the Prime Contract |
prime_contract.approval_letter_date |
String | No |
Approval letter date |
prime_contract.contract_start_date |
String | No |
Contract Start Date |
prime_contract.contract_date |
String | No |
Contract date |
prime_contract.signed_contract_received_date |
String | No |
Signed Contract Received Date |
prime_contract.file_version_ids[] |
Array | No |
File Versions to attach to the response |
prime_contract.vendor_id |
Integer | No |
Vendor ID |
prime_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. |
prime_contract.image_ids[] |
Array | No |
Images to attach to the response |
prime_contract.inclusions |
String | No |
Inclusions |
prime_contract.number |
String | No |
Number of the Prime Contract |
prime_contract.letter_of_intent_date |
String | No |
Letter of intent date |
prime_contract.upload_ids[] |
Array | No |
Uploads to attach to the response |
prime_contract.status |
String | No |
Status Possible values:
|
prime_contract.returned_date |
String | No |
Returned date |
prime_contract.issued_on_date |
String | No |
Issued on date |
prime_contract.form_ids[] |
Array | No |
Forms to attach to the response |
prime_contract.exclusions |
String | No |
Exclusions |
prime_contract.accounting_method |
String | No |
Accounting method Possible values:
|
prime_contract.execution_date |
String | No |
Execution 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.