Procore.Api.ConstructionFinancialsBudgetBudgetViewSnapshots (procore_sdk v0.3.0)

API calls for all endpoints tagged ConstructionFinancialsBudgetBudgetViewSnapshots.

Summary

Functions

rest_v10_budget_view_snapshots_get(connection, procore_company_id, project_id, opts \\ [])

List Budget View Snapshots Return a list of all Budget View Snapshots for a project.

rest_v10_budget_view_snapshots_post(connection, procore_company_id, rest_v10_budget_view_snapshots_post_request, opts \\ [])

Create a Budget View Snapshot. Create a new Budget View Snapshot for the Project and Budget. This is rate limited to one request per hour for each Project and Budget View pair.

Functions

Link to this function

rest_v10_budget_view_snapshots_get(connection, procore_company_id, project_id, opts \\ [])

@spec rest_v10_budget_view_snapshots_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, [Procore.Model.RestV10BudgetViewSnapshotsGet200ResponseInner.t()]}
  | {:error, Tesla.Env.t()}

List Budget View Snapshots Return a list of all Budget View Snapshots for a project.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • project_id (integer()): Unique identifier for the project.
  • opts (keyword): Optional parameters
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[budget_template_id]" ([integer()]): Return snapshot(s) using the specified budget template id.
    • :"filters[budget_view_id]" ([integer()]): Return snapshot(s) using the specified budget view id. (This will replace budget_template_id filter)
    • :"filters[snapshot_type]" (String.t): Return snapshot(s) of the specified type.
    • :"filters[approval_status]" (String.t): Return snapshot(s) in the specified status.
    • :sort (String.t): Direction (asc/desc) can be controlled by the presence or absence of '-' before the sort parameter

Returns

  • {:ok, [%RestV10BudgetViewSnapshotsGet200ResponseInner{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_budget_view_snapshots_post(connection, procore_company_id, rest_v10_budget_view_snapshots_post_request, opts \\ [])

@spec rest_v10_budget_view_snapshots_post(
  Tesla.Env.client(),
  integer(),
  Procore.Model.RestV10BudgetViewSnapshotsPostRequest.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.RestV10BudgetViewSnapshotsPost429Response.t()}
  | {:ok, Procore.Model.RestV10BudgetViewSnapshotsPost400Response.t()}
  | {:ok, Procore.Model.RestV10BudgetViewSnapshotsPost201Response.t()}
  | {:ok, Procore.Model.RestV10BudgetViewSnapshotsPost202Response.t()}
  | {:error, Tesla.Env.t()}

Create a Budget View Snapshot. Create a new Budget View Snapshot for the Project and Budget. This is rate limited to one request per hour for each Project and Budget View pair.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • rest_v10_budget_view_snapshots_post_request (RestV10BudgetViewSnapshotsPostRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV10BudgetViewSnapshotsPost201Response.t} on success
  • {:error, Tesla.Env.t} on failure