PATCH /rest/v1.0/prime_contracts/{prime_contract_id}/payment_application_line_items/{id}
Update a Payment Application (Owner Invoice) Line Item on a specified Prime Contract Payment Application (Owner Invoice)
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
Integer | Yes |
Payment Application (Owner Invoice) Line item ID |
prime_contract_id |
Integer | Yes |
Prime Contract 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 |
|---|---|---|---|
project_id |
Integer | Yes |
Unique identifier for the project. |
payment_application_line_item |
Object | Yes |
Payment Application (Owner Invoice) Line Item |
payment_application_line_item.materials_stored_retainage_retained_this_period |
String | No |
Materials stored retainage amount retained this period (materials_presently_stored should be non-zero to hold a retainage) |
payment_application_line_item.work_completed_retainage_released_this_period |
String | No |
The amount of work completed retainage released this period |
payment_application_line_item.work_completed_this_period |
String | No |
The amount of work completed this period (only for lines that use amount accounting or are calculated manually) |
payment_application_line_item.materials_presently_stored |
String | No |
The amount of materials presently stored (only for lines that use amount accounting) |
payment_application_line_item.work_completed_this_period_quantity |
String | No |
Work completed this period quantity (only for lines that use unit accounting and are not calculated manually) |
payment_application_line_item.work_completed_retainage_retained_this_period |
String | No |
Work completed retainage amount retained this period (work_completed_this_period should be non-zero to hold a retainage) |
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.