List Budget Details
list_budget_detailsRetrieve budget detail rows for a project budget view. Apply filters to narrow results by cost code, vendor, or type.
Instructions
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. Pass the record's fields as top-level arguments — they are nested under "filters" in the request payload for you. budget_view_id must identify an existing parent record — resolve it with the matching list tool first. Acts on the budget detail and returns Procore's response for the operation. Failures come back as an error payload carrying the HTTP status — commonly 401 when the token has expired, 403 without tool permission, and 404 when an id does not resolve. Required parameters: budget_view_id, project_id. Procore API: Construction Financials > Budget. Endpoint: POST /rest/v1.0/budget_views/{budget_view_id}/budget_details
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| biller | No | JSON request body field — sub Job Filter, can pass Sub Job or Project | |
| vendor | No | JSON request body field — vendor Filter | |
| cost_code | No | JSON request body field — cost Code Filter | |
| cost_type | No | JSON request body field — cost Type Filter | |
| project_id | Yes | Query string parameter — unique identifier for the project. | |
| detail_type | No | JSON request body field — detail Type Filter | |
| budget_view_id | Yes | URL path parameter — unique identifier of the budget view | |
| root_cost_code | No | JSON request body field — division Filter |