List Budget View Snapshot Summary Rows
list_budget_view_snapshot_summary_rowsRetrieve paginated summary rows from budget view snapshots to enumerate budget records, find IDs, and filter by biller, cost code, or category. Use for project budget overview.
Instructions
Returns a list of all budget view snapshots summary rows for project status and ad hoc types. The type of row returned is dependent on the value used in the group_by query param. Note: In addition to all the fields outlined in the response, there will be an additional key for each visible standard, source, and formula column created for the particular budget view. 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}/summary_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 | |
| group_by | No | Query string parameter — groups the data. Value can be a comma separated string. Default is biller,root_cost_code | |
| 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 subtotals may change depending on the pr... |