Create A Budget View Snapshot.
create_a_budget_view_snapshotCreate a project budget view snapshot for project status or ad hoc reporting, preserving budget data with a new snapshot ID.
Instructions
Create a project-level snapshot for either project status or ad hoc type. This is rate limited to one request per hour for each project and budget view, regardless of snapshot type. Creates the budget view snapshot and returns it with its new id (HTTP 201); calling it again creates another record. 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: project_id, budget_template_id, name. Procore API: Construction Financials > Budget. Endpoint: POST /rest/v1.0/budget_view_snapshots
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | JSON request body field — title of the budget view snapshot | |
| status_id | No | JSON request body field — the ID of a custom status. Only available when the Custom Statuses feature is enabled. When enabled, use this parameter instead of approval_status. The status_id must reference an available custom ... | |
| project_id | Yes | JSON request body field — the project identifier | |
| description | No | JSON request body field — description of the budget snapshot | |
| snapshot_type | No | JSON request body field — snapshot Type. Only available when Project Status Snapshots feature is enabled. | |
| budget_view_id | No | JSON request body field — the budget view identifier (replaces budget_template_id) | |
| approval_status | No | JSON request body field — approval Status. | |
| budget_template_id | Yes | JSON request body field — the budget template identifier (deprecated, use budget_view_id instead) | |
| financial_period_id | No | JSON request body field — the ID of the Financial Period to associate with this snapshot. Only available when the Financial Periods feature is enabled. | |
| date_range_for_actuals | No | JSON request body field — filters actuals data to a specific date range when generating the snapshot. Provide exactly two dates in ISO 8601 format representing the start and end of the range. | |
| only_actuals_with_dates | No | JSON request body field — when true, only actuals records with a date within date_range_for_actuals are included. When false (default), actuals records with no date are also included alongside date-ranged results. | |
| reassign_financial_period | No | JSON request body field — only applies when snapshot_type is project_status_snapshot and financial_period_id is provided. When true, if the requested financial_period_id is already assigned to another snapshot in the same p... |