Procore.Api.ConstructionFinancialsPrimeContractsPrimeChangeOrders (procore_sdk v0.3.0)

API calls for all endpoints tagged ConstructionFinancialsPrimeContractsPrimeChangeOrders.

Summary

Functions

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

Show All Prime Change Orders Returns all Prime Change Orders for the specified Project. This endpoint currently only supports projects using 1 and 2 tier change order configurations.

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

Delete Prime Change Order Delete the specified Prime Change Order. This endpoint currently only supports projects using 1 and 2 tier change order configurations.

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

Show Prime Change Order Show the details of the Prime Change Order. This endpoint currently only supports projects using 1 and 2 tier change order configurations.

rest_v10_projects_project_id_prime_change_orders_id_patch(connection, procore_company_id, id, project_id, body47, opts \\ [])

Update Prime Change Order Update the specified Prime Change Order. This endpoint currently only supports projects using 1 and 2 tier change order configurations.

rest_v10_projects_project_id_prime_change_orders_post(connection, procore_company_id, project_id, body46, opts \\ [])

Create Prime Change Order Create a new Prime Change Order. This endpoint currently only supports projects using 1 and 2 tier change order configurations.

Functions

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

@spec rest_v10_projects_project_id_prime_change_orders_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10ProjectsProjectIdPrimeChangeOrdersGet200Response.t()}
  | {:error, Tesla.Env.t()}

Show All Prime Change Orders Returns all Prime Change Orders for the specified Project. This endpoint currently only supports projects using 1 and 2 tier change order configurations.

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
- :view (String.t): Specifies Which view (which attributes) of the resource is going to be present in the response. the extended view includes change events data, while the default view does not.
- :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 ID
- :"filters[batch_id]" (integer()): Filter results by Change Order Batch ID
- :"filters[legacy_package_id]" (integer()): Filter results by legacy Change Order Package 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.RestV10ProjectsProjectIdPrimeChangeOrdersGet200Response.t} on success
{:error, Tesla.Env.t} on failure

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

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

Delete Prime Change Order Delete the specified Prime Change Order. This endpoint currently only supports projects using 1 and 2 tier change order configurations.

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 Prime Change Order
project_id (integer()): Unique identifier for the project.
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

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

@spec rest_v10_projects_project_id_prime_change_orders_id_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10ProjectsProjectIdPrimeChangeOrdersPost201Response.t()}
  | {:error, Tesla.Env.t()}

Show Prime Change Order Show the details of the Prime Change Order. This endpoint currently only supports projects using 1 and 2 tier change order configurations.

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 Prime Change Order
project_id (integer()): Unique identifier for the project.
opts (keyword): Optional parameters
- :view (String.t): Specifies Which view (which attributes) of the resource is going to be present in the response. the extended view includes change events data, while the default view does not.

Returns

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

rest_v10_projects_project_id_prime_change_orders_id_patch(connection, procore_company_id, id, project_id, body47, opts \\ [])

@spec rest_v10_projects_project_id_prime_change_orders_id_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  Procore.Model.Body47.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10ProjectsProjectIdPrimeChangeOrdersPost201Response.t()}
  | {:error, Tesla.Env.t()}

Update Prime Change Order Update the specified Prime Change Order. This endpoint currently only supports projects using 1 and 2 tier change order configurations.

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 Prime Change Order
project_id (integer()): Unique identifier for the project.
body47 (Body47):
opts (keyword): Optional parameters
- :run_configurable_validations (boolean()): If true, validations are run for the corresponding Configurable Field Set.
- :view (String.t): Specifies Which view (which attributes) of the resource is going to be present in the response. the extended view includes change events data, while the default view does not.

Returns

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

rest_v10_projects_project_id_prime_change_orders_post(connection, procore_company_id, project_id, body46, opts \\ [])

@spec rest_v10_projects_project_id_prime_change_orders_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  Procore.Model.Body46.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok,
     Procore.Model.RestV10ProjectsProjectIdPrimeChangeOrdersPost201Response.t()}
  | {:error, Tesla.Env.t()}

Create Prime Change Order Create a new Prime Change Order. This endpoint currently only supports projects using 1 and 2 tier change order configurations.

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

Returns

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