PATCH /rest/v1.0/contract_payments/{id}
Update a Contract Payment. All attributes other than 'attachments', 'origin_id', and 'origin_data' will be locked if the contract payment is synced with an ERP system.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
Integer | Yes |
ID |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Procore-Company-Id |
Integer | Yes |
Unique company identifier associated with the Procore User Account. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
contract_payment |
Object | No |
Contract Payment object |
contract_payment.payment_number |
Integer | No |
Payment number |
contract_payment.prostore_file_ids[] |
Array | No |
Any prostore files to actualize contract payment's attachments. Mutually exclusive with the |
contract_payment.draw_request_number |
Integer | No |
Draw Request number |
contract_payment.check_number |
String | No |
Check number |
contract_payment.payment_method |
String | No |
Payment method Possible values:
|
contract_payment.date |
String | No |
Payment date |
contract_payment.origin_data |
String | No |
Contract payment third party data |
contract_payment.notes |
String | No |
Associated notes |
contract_payment.invoice_number |
String | No |
Invoice number |
contract_payment.amount |
String | No |
Payment amount |
contract_payment.origin_id |
String | No |
Contract payment third party ID |
contract_payment.invoice_date |
String | No |
Invoice date |
contract_payment.requisition_id |
Integer | No |
Subcontractor requisition ID |
project_id |
Integer | Yes |
Unique identifier for the project. |
contract_id |
Integer | Yes |
Contract ID |
attachments[] |
Array | No |
Contract payment attachments.
To upload attachments you must upload the entire payload as |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.