update_commitment_contract_v2_0
Modify commitment contract details in Procore to update project financials, including status, vendor information, payment terms, and contract specifications.
Instructions
Update Commitment Contract. [Construction Financials/Commitments] PATCH /rest/v2.0/companies/{company_id}/projects/{project_id}/commitment_contracts/{commitment_contract_id}
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | Yes | Unique identifier for the company. | |
| project_id | Yes | Unique identifier for the project. | |
| commitment_contract_id | Yes | Unique identifier for the Commitment Contract. | |
| view | No | Specifies which view (which attributes) of the resource is going to be present in the response. The extended view includes vendor name and custom fields data, while the default view does not. | |
| number | No | The Commitment Contract number. Defaults to the project numbering sequence for the respective contract type. | |
| status | No | The Commitment Contract status. | |
| title | No | The Commitment Contract title. | |
| description | No | The Commitment Contract description. | |
| executed | No | The Commitment 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. | |
| assignee_id | No | Only applicable to Purchase Order Contracts. The ID of the user assigned to the Commitment Contract. The user must belong to the project directory (see the Project Users endpoint). | |
| signature_required | No | If true, a signature is required to execute the contract; otherwise no signature is required. | |
| billing_schedule_of_values_status | No | The subcontractor schedule of values (SSOV) status. Only applicable to contracts which use an SSOV. | |
| inclusions | No | Only applicable to Work Order Contracts. The inclusions of the Commitment Contract. | |
| exclusions | No | Only applicable to Work Order Contracts. The exclusions of the Commitment Contract. | |
| bill_to_address | No | Only applicable to Purchase Order Contracts. The address to which invoices are sent. The default will be the bill to address of the most recently created purchase order. | |
| ship_to_address | No | Only applicable to Purchase Order Contracts. The address to which materials are shipped. The default will be the ship to address of the most recently created purchase order. | |
| ship_via | No | Only applicable to Purchase Order Contracts. The shipping method for the Commitment Contract. | |
| payment_terms | No | Only applicable to Purchase Order Contracts. The payment terms for the Commitment Contract. | |
| retainage_percent | No | An "unformatted" decimal number. Specifically a number with a period as the decimal separator, without a thousands separator, and with an optional sign. It should be assumed that this number includ... | |
| 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 Commitment Contract; otherwise comments are not allowed. Default is driven by a project setting. | |
| allow_markups | No | If true, markups are allowed on the Commitment 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 Commitment Contract; otherwise the SSOV is not enabled. Default is driven by a project setting. | |
| allow_change_orders_ssov | No | If true, the subcontractor schedule of values (SSOV) can be enabled on change orders for this Commitment Contract. When enabled, Change Order SSOV toggles become available. Default is false. | |
| allow_payment_applications | No | If true, invoices are allowed on the Commitment Contract; otherwise invoices are not allowed. Default is driven by a project setting. | |
| allow_payments | No | If true, payments are allowed on the Commitment 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 Commitment 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 Commitment 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 Commitment Contract PDF; otherwise cost codes are not displayed. Default is driven by a project setting. | |
| ssr_enabled | No | If true, the sliding scale retention is enabled for the Commitment Contract. Default is driven by a project setting. | |
| bill_recipient_ids | No | IDs of users in the project directory (see the Project Users endpoint). These users must belong to the selected vendor and are the invoice contacts for submitting subcontractor invoices. To grant a... |