GET /rest/v1.0/budget_view_snapshots/{budget_view_snapshot_id}/detail_rows
Return a list of all Budget View Snapshot Detail Rows for a project and budget view snapshot.
Note: In addition to all the fields outlined in the response, there will be an additional key for each visible source and formula column created for the particular budget view. As well, when using a Forecasting View ID, additional keys will be visible that give calculated forecasts for each month, as defined by the Advanced Forecasting Tool.
Servers
- https://api.procore.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
budget_view_snapshot_id |
Integer | Yes |
Budget View Snapshot ID |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Procore-Company-Id |
Integer | Yes |
Unique company identifier associated with the Procore User Account. |
Query parameters
Name | Type | Required | Description |
---|---|---|---|
page |
Integer | No |
Page |
project_id |
Integer | Yes |
Unique identifier for the project. |
cost_code_name[] |
Array | No |
Return item(s) within a specific Cost Code name or range of Cost Code names |
per_page |
Integer | No |
Elements per page |
sort |
String | No |
Return item(s) with the specified sort. Default is biller_type,biller,root_cost_code,cost_code,category_id Possible values:
|
root_cost_code_id[] |
Array | No |
Return item(s) within a specific Root Cost Code id or range of Root Cost Code IDs |
budget_row_type |
String | No |
Return budgeted, unbudgeted or all item(s) from all budget rows for a project. Default is all. Note that when the unbudgeted or all values are supplied, the id field will be null for rows that have budgeted false Possible values:
|
category_id[] |
Array | No |
Return item(s) within a specific category id (line item type id) or range of category IDs |
budget_line_item_id[] |
Array | No |
Return item(s) within a specific budget line item id or range of budget line item IDs |
biller[] |
Array | No |
Return item(s) within a specific biller. Format is biller[]=id=1,type=SubJob or biller[]=id=1,type=Project |
root_cost_code_name[] |
Array | No |
Return item(s) within a specific Root Cost Code name or range of Root Cost Code names |
cost_code_id[] |
Array | No |
Return item(s) within a specific Cost Code id or range of Cost Code IDs |
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.