Update Prime Change Order
update_prime_change_orderUpdate an existing prime change order in Procore by modifying only the specified fields. Supports projects with 1 or 2 tier change order configurations.
Instructions
Update the specified Prime Change Order. This endpoint currently only supports projects using 1 and 2 tier change order configurations. Use this to update an existing Prime Contracts (only the supplied fields are changed). Updates the specified Prime Contracts and returns the modified object on success. Required parameters: project_id, id. Procore API: Construction Financials > Prime Contracts. Endpoint: PATCH /rest/v1.0/projects/{project_id}/prime_change_orders/{id}
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | URL path parameter — unique identifier for the project. | |
| id | Yes | URL path parameter — iD of the Prime Change Order | |
| run_configurable_validations | No | Query string parameter — if true, validations are run for the corresponding Configurable Field Set. | |
| 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 change events data, while the default view does not. | |
| contract_id | No | JSON request body field — unique identifier for the contract. | |
| batch_id | No | JSON request body field — unique identifier for a change order batch. | |
| change_order_change_reason_id | No | JSON request body field — unique identifier for the change reason. | |
| location_id | No | JSON request body field — unique identifier for the location. | |
| designated_reviewer_id | No | JSON request body field — unique identifier for the designated reviewer. This field is only supported for single-tier projects. Behavior is undefined in multi-tier projects. | |
| received_from_id | No | JSON request body field — unique identifier for the received from entity. | |
| description | No | JSON request body field — the description for this Prime Contracts operation | |
| due_date | No | JSON request body field — due date in YYYY-MM-DD format | |
| paid_date | No | JSON request body field — the paid date in YYYY-MM-DD format | |
| invoiced_date | No | JSON request body field — the invoiced date in YYYY-MM-DD format | |
| title | No | JSON request body field — title of the Contract | |
| status | No | JSON request body field — the status for this Prime Contracts operation | |
| reference | No | JSON request body field — the reference for this Prime Contracts operation | |
| number | No | JSON request body field — number of the Change Order | |
| revision | No | JSON request body field — revision Number | |
| field_change | No | JSON request body field — the field change for this Prime Contracts operation | |
| signature_required | No | JSON request body field — whether a signature will be required for this Change Order | |
| signed_change_order_received_date | No | JSON request body field — signed Change Order Received Date | |
| schedule_impact_amount | No | JSON request body field — schedule impact in days | |
| executed | No | JSON request body field — whether or not the Change Order is executed | |
| private | No | JSON request body field — whether or not the Commitment Change Order is private | |
| paid | No | JSON request body field — whether or not the Commitment Change Order is paid | |
| reason | No | JSON request body field — reason for the change order | |
| custom_field_%{custom_field_definition_id} | No | JSON request body field — 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 ... | |
| enable_ssov | No | JSON request body field — whether to enable SSOV on this Change Order. Only applicable to Commitment Change Orders. | |
| change_event_attachment_ids | No | JSON request body field — list of attachment IDs to attach. These must presently be associated with Change Events. | |
| attachment_ids | No | JSON request body field — existing attachments to preserve on the response | |
| drawing_revision_ids | No | JSON request body field — drawing Revisions to attach to the response |