Procore.Api.ConstructionFinancialsCommitmentsCommitmentChangeOrderBatches (procore_sdk v0.3.0)

API calls for all endpoints tagged ConstructionFinancialsCommitmentsCommitmentChangeOrderBatches.

Summary

Functions

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

Show All Commitment Change Order Batches Returns all Commitment Change Order Batches for the specified Project.

rest_v10_projects_project_id_commitment_change_order_batches_id_delete(connection, procore_company_id, id, project_id, opts \\ [])

Delete Commitment Change Order Batch Delete the specified Commitment Change Order Batch.

rest_v10_projects_project_id_commitment_change_order_batches_id_get(connection, procore_company_id, id, project_id, opts \\ [])

Show Commitment Change Order Batch Show the details of the Commitment Change Order Batch.

rest_v10_projects_project_id_commitment_change_order_batches_id_patch(connection, procore_company_id, id, project_id, body49, opts \\ [])

Update Commitment Change Order Batch Update the specified Commitment Change Order Batch.

rest_v10_projects_project_id_commitment_change_order_batches_post(connection, procore_company_id, project_id, body48, opts \\ [])

Create Commitment Change Order Batch Create a new Commitment Change Order Batch.

Functions

Link to this function

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

@spec rest_v10_projects_project_id_commitment_change_order_batches_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok, Procore.Model.RestV10ProjectsGetDefaultResponse.t()}
  | {:ok,
     Procore.Model.RestV10ProjectsProjectIdCommitmentChangeOrderBatchesGet200Response.t()}
  | {:error, Tesla.Env.t()}

Show All Commitment Change Order Batches Returns all Commitment Change Order Batches for the specified 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
    • :sort (String.t): Direction (asc/desc) can be controlled by the presence or absence of '-' before the sort parameter.
    • :"filters[id]" (integer()): Filter results by Change Order Batch ID
    • :"filters[change_order_id]" (integer()): Filter results by Change Order ID
    • :"filters[contract_id]" (integer()): Filter results by Contract ID
    • :"filters[updated_at]" (String.t): Return item(s) within a specific updated at iso8601 datetime range

Returns

  • {:ok, Procore.Model.RestV10ProjectsProjectIdCommitmentChangeOrderBatchesGet200Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_projects_project_id_commitment_change_order_batches_id_delete(connection, procore_company_id, id, project_id, opts \\ [])

@spec rest_v10_projects_project_id_commitment_change_order_batches_id_delete(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok, nil}
  | {:ok, Procore.Model.RestV10ProjectsGetDefaultResponse.t()}
  | {:error, Tesla.Env.t()}

Delete Commitment Change Order Batch Delete the specified Commitment Change Order Batch.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): ID of the Commitment Change Order Batch
  • project_id (integer()): Unique identifier for the project.
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_projects_project_id_commitment_change_order_batches_id_get(connection, procore_company_id, id, project_id, opts \\ [])

@spec rest_v10_projects_project_id_commitment_change_order_batches_id_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10ProjectsProjectIdCommitmentChangeOrderBatchesPost201Response.t()}
  | {:ok, Procore.Model.RestV10ProjectsGetDefaultResponse.t()}
  | {:error, Tesla.Env.t()}

Show Commitment Change Order Batch Show the details of the Commitment Change Order Batch.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): ID of the Commitment Change Order Batch
  • project_id (integer()): Unique identifier for the project.
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.RestV10ProjectsProjectIdCommitmentChangeOrderBatchesPost201Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_projects_project_id_commitment_change_order_batches_id_patch(connection, procore_company_id, id, project_id, body49, opts \\ [])

@spec rest_v10_projects_project_id_commitment_change_order_batches_id_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  Procore.Model.Body49.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10ProjectsProjectIdCommitmentChangeOrderBatchesPost201Response.t()}
  | {:ok, Procore.Model.RestV10ProjectsGetDefaultResponse.t()}
  | {:error, Tesla.Env.t()}

Update Commitment Change Order Batch Update the specified Commitment Change Order Batch.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): ID of the Commitment Change Order Batch
  • project_id (integer()): Unique identifier for the project.
  • body49 (Body49):
  • opts (keyword): Optional parameters
    • :run_configurable_validations (boolean()): If true, validations are run for the corresponding Configurable Field Set.

Returns

  • {:ok, Procore.Model.RestV10ProjectsProjectIdCommitmentChangeOrderBatchesPost201Response.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_projects_project_id_commitment_change_order_batches_post(connection, procore_company_id, project_id, body48, opts \\ [])

@spec rest_v10_projects_project_id_commitment_change_order_batches_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  Procore.Model.Body48.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10ProjectsProjectIdCommitmentChangeOrderBatchesPost201Response.t()}
  | {:ok, Procore.Model.RestV10ProjectsGetDefaultResponse.t()}
  | {:error, Tesla.Env.t()}

Create Commitment Change Order Batch Create a new Commitment Change Order Batch.

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.
  • body48 (Body48):
  • opts (keyword): Optional parameters
    • :run_configurable_validations (boolean()): If true, validations are run for the corresponding Configurable Field Set.

Returns

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