PATCH /rest/v2.0/companies/{company_id}/projects/{project_id}/prime_contracts/{prime_contract_id}

Updates a Prime Contract for a given project.

Servers

https://api.procore.com

Path parameters

Name	Type	Required	Description
`project_id`	String	Yes	Unique identifier for the project.
`company_id`	String	Yes	Unique identifier for the company.
`prime_contract_id`	String	Yes	Unique identifier for the Prime Contract.

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

Name	Type	Required	Description
`view`	String	No	Specifies which view (which attributes) of the resource is going to be present in the response. The extended view includes architect name, contractor name, vendor name and custom fields data, while the default view does not. Valid values: `"extended"` `"default"`

view

String

Specifies which view (which attributes) of the resource is going to be present in the response. The extended view includes architect name, contractor name, vendor name and custom fields data, while the default view does not.

Valid values:

"extended"
"default"

Request body fields

Name	Type	Required	Description
`display_work_retainage`	Boolean	No	If true, work retainage is displayed on the Prime Contract; otherwise work retainage is not displayed. Default is driven by a project setting.
`executed`	Boolean	No	The Prime Contract executed status. Default value: false
`change_event_attachment_ids[]`	Array	No	List of attachment IDs to attach. These must presently be associated with Change Events.
`description`	String	No	The Prime Contract description.
`auto_approve_prefilled_requisitions_on_payapp`	Boolean	No	If true, prefilled requisitions are auto-approved on payment applications; otherwise prefilled requisitions are not auto-approved. Default is driven by a project setting.
`allow_payments`	Boolean	No	If true, payments are allowed on the Prime Contract; otherwise payments are not allowed. Default is driven by a project setting.
`currency_iso_code`	String	No	Currency ISO code; It'll be accepted only when multicurrency phase two feature flag is enabled.
`contract_estimated_completion_date`	String	No	Only applicable to Work Order Contracts.
`contractor_id`	String	No	The ID of the contractor for the contract.
`change_order_level_of_detail`	String	No	The level of details for showing change orders on invoices attached to this contract. Valid values: `"change_order_request"` `"potential_change_order"` `"line_item"` `"change_order_package"`
`show_line_items_to_non_admins`	Boolean	No	Only applicable to private contracts. If true, line items are visible to non-admins; otherwise visible to admins only. Default value: false
`drawing_revision_ids[]`	Array	No	Drawing Revisions to attach to the response
`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.
`allow_comments`	Boolean	No	If true, comments are allowed on the Prime Contract; otherwise comments are not allowed. Default is driven by a project setting.
`architect_id`	String	No	The ID of the architect for the contract.
`actual_completion_date`	String	No	Only applicable to Work Order Contracts.
`title`	String	No	The Prime Contract title.
`allow_markups`	Boolean	No	If true, markups are allowed on the Prime Contract; otherwise markups are not allowed. Default is driven by a project setting.
`approval_letter_date`	String	No
`contract_start_date`	String	No	Only applicable to Work Order Contracts.
`contract_date`	String	No
`signed_contract_received_date`	String	No
`request_for_quote_attachment_ids[]`	Array	No	List of attachment IDs to attach. These must presently be associated with Request For Quotes (or their Quotes / Responses).
`file_version_ids[]`	Array	No	File Versions to attach to the response
`display_materials_retainage`	Boolean	No	If true, materials retainage is displayed on the Prime Contract; otherwise materials retainage is not displayed. Default is driven by a project setting.
`vendor_id`	String	No	The ID of the vendor for the contract. The selected invoice contacts must all belong to this vendor. When the vendor is changed, the invoice contacts are reset.
`currency_exchange_rate`	String	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.
`allow_payment_applications`	Boolean	No	If true, invoices are allowed on the Prime Contract; otherwise invoices are not allowed. Default is driven by a project setting.
`image_ids[]`	Array	No	Images to attach to the response
`inclusions`	String	No	Only applicable to Work Order Contracts. The inclusions of the Prime Contract.
`number`	String	No	The Prime Contract number. Defaults to the project numbering sequence for the respective contract type.
`letter_of_intent_date`	String	No
`upload_ids[]`	Array	No	Uploads to attach to the response
`status`	String	No	The Prime Contract status.
`returned_date`	String	No
`enable_ssov`	Boolean	No	If true, the subcontractor schedule of values (SSOV) is enabled for the Prime Contract; otherwise the SSOV is not enabled. Default is driven by a project setting.
`accessor_ids[]`	Array	No	Only applicable to private contracts. IDs of users in the project directory (see the Project Users endpoint). These users will be able to view the commitment contract.
`attachment_ids[]`	Array	No	The current attachments to the item. Values should be omitted to remove attachments. New files cannot be attached via this param. If the key is omitted, the existing attachments will remain unchanged.
`show_cost_code_on_pdf`	Boolean	No	If true, cost codes are displayed on the Prime Contract PDF; otherwise cost codes are not displayed. Default is driven by a project setting.
`issued_on_date`	String	No
`form_ids[]`	Array	No	Forms to attach to the response
`substantial_completion_date`	String	No	Only applicable to Work Order Contracts.
`exclusions`	String	No	Only applicable to Work Order Contracts. The exclusions of the Prime Contract.
`accounting_method`	String	No	The accounting method for the contract. Default is driven by a project setting. Valid values: `"unit"` `"amount"`
`private`	Boolean	No	If true, visible to admins and accessors only; otherwise visible to those with access to the Primes tool. Default based on project level setting. Default value: true
`execution_date`	String	No

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.