create_prime_contract_v2_0
Create a prime contract in Procore for construction projects by specifying company, project, vendor, and contract details to manage financial agreements.
Instructions
Create Prime Contract. [Construction Financials/Prime Contracts] POST /rest/v2.0/companies/{company_id}/projects/{project_id}/prime_contracts
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | Yes | Unique identifier for the company. | |
| project_id | Yes | Unique identifier for the project. | |
| view | 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, whil... | |
| number | No | The Prime Contract number. Defaults to the project numbering sequence for the respective contract type. | |
| status | No | The Prime Contract status. | |
| title | No | The Prime Contract title. | |
| description | No | The Prime Contract description. | |
| executed | No | The Prime Contract executed status. | |
| vendor_id | 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. | |
| architect_id | No | The ID of the architect for the contract. | |
| contractor_id | No | The ID of the contractor for the contract. | |
| inclusions | No | Only applicable to Work Order Contracts. The inclusions of the Prime Contract. | |
| exclusions | No | Only applicable to Work Order Contracts. The exclusions of the Prime Contract. | |
| accounting_method | No | The accounting method for the contract. Default is driven by a project setting. | |
| allow_comments | No | If true, comments are allowed on the Prime Contract; otherwise comments are not allowed. Default is driven by a project setting. | |
| auto_approve_prefilled_requisitions_on_payapp | 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_markups | No | If true, markups are allowed on the Prime Contract; otherwise markups are not allowed. Default is driven by a project setting. | |
| change_order_level_of_detail | No | The level of details for showing change orders on invoices attached to this contract. | |
| enable_ssov | 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. | |
| allow_payment_applications | No | If true, invoices are allowed on the Prime Contract; otherwise invoices are not allowed. Default is driven by a project setting. | |
| allow_payments | No | If true, payments are allowed on the Prime Contract; otherwise payments are not allowed. Default is driven by a project setting. | |
| display_materials_retainage | No | If true, materials retainage is displayed on the Prime Contract; otherwise materials retainage is not displayed. Default is driven by a project setting. | |
| display_work_retainage | No | If true, work retainage is displayed on the Prime Contract; otherwise work retainage is not displayed. Default is driven by a project setting. | |
| show_cost_code_on_pdf | 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. | |
| accessor_ids | 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. | |
| private | 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. | |
| show_line_items_to_non_admins | No | Only applicable to private contracts. If true, line items are visible to non-admins; otherwise visible to admins only. | |
| actual_completion_date | No | Only applicable to Work Order Contracts. | |
| approval_letter_date | No | approval_letter_date | |
| contract_date | No | contract_date | |
| contract_estimated_completion_date | No | Only applicable to Work Order Contracts. | |
| contract_start_date | No | Only applicable to Work Order Contracts. |