List Budget View Snapshot Detail Rows
list_budget_view_snapshot_detail_rowsRetrieve paginated budget view snapshot detail rows for project status and ad hoc types. Filter by biller, cost code, category, or budget line item.
Instructions
Returns a list of all budget view snapshots detail rows for project status and ad hoc types. 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. Use this to enumerate Budget records when you need a paginated overview, to find IDs, or to filter by query parameters. Returns a paginated JSON array of Budget records. Use page and per_page to control pagination; the response includes pagination metadata. Required parameters: budget_view_snapshot_id, project_id. Procore API: Construction Financials > Budget. Endpoint: GET /rest/v1.0/budget_view_snapshots/{budget_view_snapshot_id}/detail_rows
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| budget_view_snapshot_id | Yes | URL path parameter — budget View Snapshot ID | |
| project_id | Yes | Query string parameter — unique identifier for the project. | |
| page | No | Query string parameter — page number for paginated results (default: 1) | |
| per_page | No | Query string parameter — number of items per page (default: 100, max: 100) | |
| biller__ | No | Query string parameter — return item(s) within a specific biller. Format is biller[]=id=1,type=SubJob or biller[]=id=1,type=Project | |
| cost_code_id__ | No | Query string parameter — return item(s) within a specific Cost Code id or range of Cost Code IDs | |
| cost_code_name__ | No | Query string parameter — return item(s) within a specific Cost Code name or range of Cost Code names | |
| root_cost_code_id__ | No | Query string parameter — return item(s) within a specific Root Cost Code id or range of Root Cost Code IDs | |
| root_cost_code_name__ | No | Query string parameter — return item(s) within a specific Root Cost Code name or range of Root Cost Code names | |
| category_id__ | No | Query string parameter — return item(s) within a specific category id (line item type id) or range of category IDs | |
| budget_line_item_id__ | No | Query string parameter — return item(s) within a specific budget line item id or range of budget line item IDs | |
| sort | No | Query string parameter — return item(s) with the specified sort. Default is biller_type,biller,root_cost_code,cost_code,category_id | |
| budget_row_type | No | Query string parameter — 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... |