Procore.Api.ConstructionFinancialsChangeOrdersPotentialChangeOrders (procore_sdk v0.3.0)

API calls for all endpoints tagged ConstructionFinancialsChangeOrdersPotentialChangeOrders.

Summary

Functions

List Potential Change Orders Return a list of all Potential Change Orders (PCO). See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

Show Potential Change Orders Return detailed information about a Potential Change Order (PCO).

Update Potential Change Order Update information about a specific Potential Change Order (PCO).

List Potential Change Order Line Items Return a list of all Potential Change Order Line Items. Change Event Line Item information is only returned if a line item is associated to a change event line item and user can view change events. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

Show Potential Change Order Line Item Return a Potential Change Order Line Item. Change Event Line Item information is only returned if a line item is associated to a change event line item and user can view change events.

Update Potential Change Order Line Item Update a Potential Change Order Line Item. Note: A budget line item will automatically be created for Non-budgeted line items for all new projects and for projects enabled with Non-Budgeted line item beta functionality

Create Potential Change Order Line Item Create a Potential Change Order Line Item. Note: A budget line item will automatically be created for Non-budgeted line items for all new projects and for projects enabled with Non-Budgeted line item beta functionality

Sync Potential Change Order Line Items This endpoint creates or updates a batch of Potential Change Order Line Items. See Using Sync Actions for additional information.

Sync Potential Change Orders This endpoint creates or updates a batch of Potential Change Orders (PCO). See Using Sync Actions for additional information.

Functions

Link to this function

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

List Potential Change Orders Return a list of all Potential Change Orders (PCO). See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

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
    • :"filters[id]" ([integer()]): Return item(s) with the specified IDs.
    • :"filters[origin_id]" (String.t): Origin ID. Returns item(s) with the specified Origin ID.
    • :"filters[created_at]" (Date.t): Return item(s) created within the specified ISO 8601 datetime range. Formats: YYYY-MM-DD...YYYY-MM-DD - Date YYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ - DateTime with UTC Offset YYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[updated_at]"(Date.t): Return item(s) last updated within the specified ISO 8601 datetime range. Formats:YYYY-MM-DD...YYYY-MM-DD- DateYYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ- DateTime with UTC OffsetYYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[due_date]"(String.t): Returns item(s) due within the specified ISO 8601 datetime range. -:"filters[contract_id]"(integer()): Contract ID. Returns item(s) with the specified Contract ID. -:"filters[include_deleted]"(String.t): Use 'only' for only deleted resources. Use 'with' for deleted and undeleted resources. -:"filters[invoiced_date]"(String.t): Returns item(s) invoiced within the specified ISO 8601 datetime range. -:"filters[paid_date]"(String.t): Returns item(s) paid within the specified ISO 8601 datetime range. -:"filters[reviewed_at]"(String.t): Returns item(s) reviewed within the specified ISO 8601 datetime range. -:page(integer()): Page -:per_page(integer()): Elements per page ### Returns -, ...]}on success -` on failure
Link to this function

rest_v10_potential_change_orders_id_get(connection, procore_company_id, id, project_id, contract_id, opts \\ [])

Show Potential Change Orders Return detailed information about a Potential Change Order (PCO).

Parameters

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

Returns

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

rest_v10_potential_change_orders_id_patch(connection, procore_company_id, id, rest_v10_potential_change_orders_id_patch_request, opts \\ [])

Update Potential Change Order Update information about a specific Potential Change Order (PCO).

Parameters

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

Returns

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

rest_v10_potential_change_orders_post(connection, procore_company_id, rest_v10_potential_change_orders_post_request, opts \\ [])

Create Potential Change Order Create a new Potential Change Order (PCO).

Parameters

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

Returns

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

rest_v10_potential_change_orders_potential_change_order_id_line_items_get(connection, procore_company_id, potential_change_order_id, project_id, opts \\ [])

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

List Potential Change Order Line Items Return a list of all Potential Change Order Line Items. Change Event Line Item information is only returned if a line item is associated to a change event line item and user can view change events. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • potential_change_order_id (integer()): Potential Change Order ID
  • project_id (integer()): Unique identifier for the project.
  • opts (keyword): Optional parameters
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[id]" ([integer()]): Return item(s) with the specified IDs.
    • :"filters[created_at]" (Date.t): Return item(s) created within the specified ISO 8601 datetime range. Formats: YYYY-MM-DD...YYYY-MM-DD - Date YYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ - DateTime with UTC Offset YYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[updated_at]"(Date.t): Return item(s) last updated within the specified ISO 8601 datetime range. Formats:YYYY-MM-DD...YYYY-MM-DD- DateYYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ- DateTime with UTC OffsetYYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00- Datetime with Custom Offset -:"filters[cost_code_id]"(String.t): Cost Code ID. Returns item(s) with the specified Cost Code ID or within the specified range of Cost Code IDs. -:"filters[line_item_type_id]"(integer()): Line Item Type ID. Returns item(s) with the specified Line Item Type ID or range of Line Item Type IDs. ### Returns -, ...]}on success -` on failure
Link to this function

rest_v10_potential_change_orders_potential_change_order_id_line_items_id_delete(connection, procore_company_id, potential_change_order_id, id, project_id, opts \\ [])

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

Delete Potential Change Order Line Item Delete a Potential Change Order Line Item.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • potential_change_order_id (integer()): Potential Change Order ID
  • id (integer()): ID
  • 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_potential_change_orders_potential_change_order_id_line_items_id_get(connection, procore_company_id, potential_change_order_id, id, project_id, opts \\ [])

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

Show Potential Change Order Line Item Return a Potential Change Order Line Item. Change Event Line Item information is only returned if a line item is associated to a change event line item and user can view change events.

Parameters

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

Returns

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

rest_v10_potential_change_orders_potential_change_order_id_line_items_id_patch(connection, procore_company_id, potential_change_order_id, id, body3, opts \\ [])

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

Update Potential Change Order Line Item Update a Potential Change Order Line Item. Note: A budget line item will automatically be created for Non-budgeted line items for all new projects and for projects enabled with Non-Budgeted line item beta functionality

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • potential_change_order_id (integer()): Potential Change Order ID
  • id (integer()): ID
  • body3 (Body3):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_potential_change_orders_potential_change_order_id_line_items_post(connection, procore_company_id, potential_change_order_id, body3, opts \\ [])

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

Create Potential Change Order Line Item Create a Potential Change Order Line Item. Note: A budget line item will automatically be created for Non-budgeted line items for all new projects and for projects enabled with Non-Budgeted line item beta functionality

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • potential_change_order_id (integer()): Potential Change Order ID
  • body3 (Body3):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_potential_change_orders_potential_change_order_id_line_items_sync_patch(connection, procore_company_id, project_id, potential_change_order_id, line_item_sync_body, opts \\ [])

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

Sync Potential Change Order Line Items This endpoint creates or updates a batch of Potential Change Order Line Items. See Using Sync Actions for additional information.

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.
  • potential_change_order_id (integer()): Potential Change Order ID
  • line_item_sync_body (LineItemSyncBody):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_potential_change_orders_sync_patch(connection, procore_company_id, project_id, contract_id, potential_change_order_body, opts \\ [])

Sync Potential Change Orders This endpoint creates or updates a batch of Potential Change Orders (PCO). See Using Sync Actions for additional information.

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.
  • contract_id (integer()): Contract ID
  • potential_change_order_body (PotentialChangeOrderBody):
  • opts (keyword): Optional parameters

Returns

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