Create Prime Contract
create_prime_contract_projectCreate a new Prime Contract for a project in Procore. Requires company and project IDs to establish the contract.
Instructions
Creates a new Prime Contract for a given project. Use this to create a new Prime Contracts in Procore. Creates a new Prime Contracts and returns the created object on success (HTTP 201). Required parameters: company_id, project_id. Procore API (v2.0): Construction Financials > Prime Contracts. Endpoint: POST /rest/v2.0/companies/{company_id}/projects/{project_id}/prime_contracts
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | Yes | URL path parameter — unique identifier for the company. | |
| project_id | Yes | URL path parameter — unique identifier for the project. | |
| view | No | Query string parameter — 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 | JSON request body field — the Prime Contract number. Defaults to the project numbering sequence for the respective contract type. | |
| status | No | JSON request body field — the Prime Contract status. | |
| title | No | JSON request body field — the Prime Contract title. | |
| description | No | JSON request body field — the Prime Contract description. | |
| executed | No | JSON request body field — the Prime Contract executed status. | |
| vendor_id | No | JSON request body field — 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 | JSON request body field — the ID of the architect for the contract. | |
| contractor_id | No | JSON request body field — the ID of the contractor for the contract. | |
| inclusions | No | JSON request body field — only applicable to Work Order Contracts. The inclusions of the Prime Contract. | |
| exclusions | No | JSON request body field — only applicable to Work Order Contracts. The exclusions of the Prime Contract. | |
| accounting_method | No | JSON request body field — the accounting method for the contract. Default is driven by a project setting. | |
| allow_comments | No | JSON request body field — 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 | JSON request body field — 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 | JSON request body field — 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 | JSON request body field — the level of details for showing change orders on invoices attached to this contract. | |
| enable_ssov | No | JSON request body field — 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 | JSON request body field — if true, invoices are allowed on the Prime Contract; otherwise invoices are not allowed. Default is driven by a project setting. | |
| allow_payments | No | JSON request body field — 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 | JSON request body field — 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 | JSON request body field — 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 | JSON request body field — 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 | JSON request body field — 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 | JSON request body field — 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 | JSON request body field — only applicable to private contracts. If true, line items are visible to non-admins; otherwise visible to admins only. | |
| actual_completion_date | No | JSON request body field — only applicable to Work Order Contracts. | |
| approval_letter_date | No | JSON request body field — approval_letter_date | |
| contract_date | No | JSON request body field — the contract date in YYYY-MM-DD format | |
| contract_estimated_completion_date | No | JSON request body field — only applicable to Work Order Contracts. | |
| contract_start_date | No | JSON request body field — only applicable to Work Order Contracts. |