POST /rest/v1.0/budget_view_snapshots
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.
Servers
- https://api.procore.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Procore-Company-Id |
Integer | Yes |
Unique company identifier associated with the Procore User Account. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
budget_view_id |
Integer | No |
The budget view identifier (replaces budget_template_id) |
project_id |
Integer | Yes |
The project identifier |
only_actuals_with_dates |
Boolean | No |
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. |
name |
String | Yes |
Title of the budget view snapshot |
snapshot_type |
String | No |
Snapshot Type. Only available when Project Status Snapshots feature is enabled. Valid values:
|
description |
String | No |
Description of the budget snapshot |
date_range_for_actuals[] |
Array | No |
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. |
status_id |
Integer | No |
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 status configured for the company. |
budget_template_id |
Integer | Yes |
The budget template identifier (deprecated, use budget_view_id instead) |
approval_status |
String | No |
Approval Status. Valid values:
|
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.