Update Commitment Contract
update_commitment_contractUpdates an existing commitment contract by modifying only the supplied fields for a project in Procore.
Instructions
Updates a Commitment Contract for a given project. Use this to update an existing Commitments (only the supplied fields are changed). Updates the specified Commitments and returns the modified object on success. Required parameters: company_id, project_id, commitment_contract_id. Procore API (v2.0): Construction Financials > Commitments. Endpoint: PATCH /rest/v2.0/companies/{company_id}/projects/{project_id}/commitment_contracts/{commitment_contract_id}
Input 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. | |
| commitment_contract_id | Yes | URL path parameter — unique identifier for the Commitment Contract. | |
| 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 vendor name and custom fields data, while the default view does not. | |
| number | No | JSON request body field — the Commitment Contract number. Defaults to the project numbering sequence for the respective contract type. | |
| status | No | JSON request body field — the Commitment Contract status. | |
| title | No | JSON request body field — the Commitment Contract title. | |
| description | No | JSON request body field — the Commitment Contract description. | |
| executed | No | JSON request body field — the Commitment 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. | |
| assignee_id | No | JSON request body field — 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 | JSON request body field — if true, a signature is required to execute the contract; otherwise no signature is required. | |
| billing_schedule_of_values_status | No | JSON request body field — the subcontractor schedule of values (SSOV) status. Only applicable to contracts which use an SSOV. | |
| inclusions | No | JSON request body field — only applicable to Work Order Contracts. The inclusions of the Commitment Contract. | |
| exclusions | No | JSON request body field — only applicable to Work Order Contracts. The exclusions of the Commitment Contract. | |
| bill_to_address | No | JSON request body field — 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 | JSON request body field — 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 | JSON request body field — only applicable to Purchase Order Contracts. The shipping method for the Commitment Contract. | |
| payment_terms | No | JSON request body field — only applicable to Purchase Order Contracts. The payment terms for the Commitment Contract. | |
| retainage_percent | No | JSON request body field — 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 | 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 Commitment Contract; otherwise comments are not allowed. Default is driven by a project setting. | |
| allow_markups | No | JSON request body field — 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 | 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 Commitment Contract; otherwise the SSOV is not enabled. Default is driven by a project setting. | |
| allow_change_orders_ssov | No | JSON request body field — 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 | JSON request body field — if true, invoices are allowed on the Commitment 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 Commitment 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 Commitment 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 Commitment 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 Commitment Contract PDF; otherwise cost codes are not displayed. Default is driven by a project setting. | |
| ssr_enabled | No | JSON request body field — if true, the sliding scale retention is enabled for the Commitment Contract. Default is driven by a project setting. | |
| bill_recipient_ids | No | JSON request body field — 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... |