Create Prime Change Order Batch
create_prime_change_order_batchCreate a new Prime Change Order Batch in Procore, specifying project and contract IDs, with optional fields like description, due date, status, and attachments. Returns the created batch on success.
Instructions
Create a new Prime Change Order Batch. 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: project_id, contract_id. Procore API: Construction Financials > Prime Contracts. Endpoint: POST /rest/v1.0/projects/{project_id}/prime_change_order_batches
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | URL path parameter — unique identifier for the project. | |
| run_configurable_validations | No | Query string parameter — if true, validations are run for the corresponding Configurable Field Set. | |
| 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 | |
| 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 Batch is executed | |
| invoiced_date | No | JSON request body field — the invoiced date in YYYY-MM-DD format | |
| number | No | JSON request body field — number of the Change Order Batch | |
| paid_date | No | JSON request body field — the paid date in YYYY-MM-DD format | |
| private | No | JSON request body field — whether or not the Change Order Batch is private | |
| revised_substantial_completion_date | No | JSON request body field — revised substantial completion date | |
| revision | No | JSON request body field — revision Number | |
| schedule_impact_amount | No | JSON request body field — schedule impact in days | |
| signature_required | No | JSON request body field — whether a signature will be required for this Change Order Batch | |
| signed_change_order_received_date | No | JSON request body field — signed Change Order Batch Received Date | |
| status | No | JSON request body field — the status for this Prime Contracts operation | |
| title | No | JSON request body field — title of the Change Order Batch | |
| 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. | |
| change_order_ids | No | JSON request body field — array of Change Order (PCO) IDs to link to this batch. This field is only supported for two-tier projects. | |
| legacy_request_ids | No | JSON request body field — array of Change Order Request IDs to link to this batch. This field is only supported for three-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 ... | |
| 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 | |
| file_version_ids | No | JSON request body field — file Versions to attach to the response | |
| form_ids | No | JSON request body field — forms to attach to the response | |
| image_ids | No | JSON request body field — images to attach to the response | |
| upload_ids | No | JSON request body field — uploads to attach to the response |