Create Prime Change Order
create_prime_change_orderCreate a prime change order in Procore for a specified project and contract. Returns the newly created change order with its ID.
Instructions
Create a new Prime Change Order. This endpoint currently only supports projects using 1 and 2 tier change order configurations. Pass the record's fields as top-level arguments — they are nested under "change_order" in the request payload for you. project_id defaults to the value set by procore_set_config when omitted. Creates the prime change order and returns it with its new id (HTTP 201); calling it again creates another record. Failures come back as an error payload carrying the HTTP status — commonly 401 when the token has expired, 403 without tool permission, and 404 when an id does not resolve. Required parameters: project_id, contract_id. Procore API: Construction Financials > Prime Contracts. Endpoint: POST /rest/v1.0/projects/{project_id}/prime_change_orders
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| paid | No | JSON request body field — whether or not the Commitment Change Order is paid | |
| title | No | JSON request body field — title of the Contract | |
| number | No | JSON request body field — number of the Change Order | |
| reason | No | JSON request body field — reason for the change order | |
| status | No | JSON request body field — the status for this Prime Contracts operation | |
| private | No | JSON request body field — whether or not the Commitment Change Order is private | |
| batch_id | No | JSON request body field — unique identifier for a change order batch. | |
| due_date | No | JSON request body field — due date in YYYY-MM-DD format | |
| executed | No | JSON request body field — whether or not the Change Order is executed | |
| revision | No | JSON request body field — revision Number | |
| paid_date | No | JSON request body field — the paid date in YYYY-MM-DD format | |
| reference | No | JSON request body field — the reference for this Prime Contracts operation | |
| project_id | Yes | URL path parameter — unique identifier for the project. | |
| contract_id | Yes | JSON request body field — unique identifier for the contract. | |
| description | No | JSON request body field — the description for this Prime Contracts operation | |
| enable_ssov | No | JSON request body field — whether to enable SSOV on this Change Order. Only applicable to Commitment Change Orders. | |
| location_id | No | JSON request body field — unique identifier for the location. | |
| field_change | No | JSON request body field — the field change for this Prime Contracts operation | |
| invoiced_date | No | JSON request body field — the invoiced date in YYYY-MM-DD format | |
| attachment_ids | No | JSON request body field — existing attachments to preserve on the response | |
| received_from_id | No | JSON request body field — unique identifier for the received from entity. | |
| signature_required | No | JSON request body field — whether a signature will be required for this Change Order | |
| 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. | |
| schedule_impact_amount | No | JSON request body field — schedule impact in days | |
| change_event_attachment_ids | No | JSON request body field — list of attachment IDs to attach. These must presently be associated with Change Events. | |
| run_configurable_validations | No | Query string parameter — if true, validations are run for the corresponding Configurable Field Set. | |
| change_order_change_reason_id | No | JSON request body field — unique identifier for the change reason. | |
| request_for_quote_attachment_ids | No | JSON request body field — list of attachment IDs to attach. These must presently be associated with Request For Quotes (or their Quotes / Responses). | |
| signed_change_order_received_date | No | JSON request body field — signed Change Order Received Date | |
| revised_substantial_completion_date | No | JSON request body field — revised substantial completion date, only supported for Prime Change Orders on single-tier projects. | |
| 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 ... |