POST /rest/v1.0/budget_views/{budget_view_id}/budget_details
Return a list of all rows from the Budget Detail Report for a Project and Budget View.
Note: In addition to all the fields outlined in the response example, there will be an additional key for each visible, non-formula, non-qualitative column (Ex: Original Budget Amount, Budget Modifications, Forecast to Complete, and Source Columns).
The integer keys returned represent the IDs of the budget columns which are returned by the Budget Detail Columns API.
As well, valid filter values can be found through the Budget Detail Filter Options API.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
budget_view_id |
Integer | Yes |
Budget View 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. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
project_id |
Integer | Yes |
Unique identifier for the project. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
filters |
Object | No |
Budget Detail Filters Object |
filters.vendor[] |
Array | No |
Vendor Filter |
filters.detail_type[] |
Array | No |
Detail Type Filter |
filters.cost_code[] |
Array | No |
Cost Code Filter |
filters.cost_type[] |
Array | No |
Cost Type Filter |
filters.root_cost_code[] |
Array | No |
Division Filter |
filters.biller[] |
Array | No |
Sub Job Filter, can pass Sub Job or Project |
filters.biller[].name |
String | No |
Name of Project or Sub Job |
filters.biller[].type |
String | No |
Type of Biller Possible values:
|
filters.biller[].value[] |
Array | No |
ID of Project or Sub Job |
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.