Updates A Receipt Header.
updates_a_receipt_headerUpdate Procore receipt headers: status, signature, received by, shipment reference, delivery location, dynamic properties, and trigger invoice creation on finalization of commitment-based receipts.
Instructions
This endpoint allows updating various receipt header properties including status, signature, received by name, received at timestamp, shipment reference, delivery location, and related document associations. It also supports adding, updating, and removing dynamic properties. When transitioning a receipt to Final status for a PO that originates from a commitment (order_type_id == 2), an invoice (requisition) will be created in Procore for the received quantities. Send only the fields you intend to change; omitted fields keep their current values. company_id and project_id default to the values set by procore_set_config when omitted, and id must identify an existing parent record — resolve it with the matching list tool first. Returns the modified receipt header on success. 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: id, company_id, project_id. Procore API (v2.0): Resource Management > Materials Management. Endpoint: PATCH /rest/v2.0/companies/{company_id}/projects/{project_id}/materials_mgmt/receipts/{id}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | URL path parameter — the unique identifier of the receipt to update. | |
| name | No | JSON request body field — name of the document header. | |
| notes | No | JSON request body field — notes associated with the document header. | |
| state | No | JSON request body field — the state for this Materials Management operation | |
| status | No | JSON request body field — the status for this Materials Management operation | |
| order_id | No | JSON request body field — the related order ID associated with the receipt. | |
| signature | No | JSON request body field — the signature to update on the receipt. | |
| company_id | Yes | URL path parameter — the company identifier | |
| project_id | Yes | URL path parameter — the project identifier | |
| description | No | JSON request body field — description of the document header. | |
| received_at | No | JSON request body field — the timestamp when the receipt was received. | |
| shipment_id | No | JSON request body field — the related shipment ID associated with the receipt. | |
| received_by_id | No | JSON request body field — the id of the user who received the receipt. Clears field if value is empty string or "-1". | |
| delivery_location | No | JSON request body field — the location ID of the delivery location. Clears field if value is empty string or -1. | |
| properties_to_add | No | JSON request body field — collection of resource parameters to add to the document header. | |
| shipment_reference | No | JSON request body field — the reference metadata for the shipment. | |
| properties_to_delete | No | JSON request body field — collection of resource parameters to delete from the document header. | |
| properties_to_update | No | JSON request body field — collection of resource parameters to update in the document header. |