Procore.Api.ConstructionFinancialsCommitmentsWorkOrderContractLineItems (procore_sdk v0.3.0)

API calls for all endpoints tagged ConstructionFinancialsCommitmentsWorkOrderContractLineItems.

Summary

Functions

List Work Order Contract Line Items Return a list of all Line Items of a specified Work Order Contract in a specified Project. 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 Work Order Contract line item Return a specific Line Item in a specified Work Order Contract. 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 Work Order Contract line item Update a Line Item in a specific Work Order Contract. 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 Work Order Contract line item Create a new Line Item in a specified Work Order Contract. 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 Work Order Contract Line Items Sync Work Order Contract Line Items. 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

Functions

Link to this function

rest_v10_work_order_contracts_work_order_contract_id_line_items_get(connection, procore_company_id, work_order_contract_id, project_id, opts \\ [])

List Work Order Contract Line Items Return a list of all Line Items of a specified Work Order Contract in a specified Project. 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.
  • work_order_contract_id (integer()): Work Order Contract 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. -:view(String.t): Specifies which view (which attributes) of the resource is going to be present in the response. 'default' view will be rendered by default if the parameter is not provided. For the 'ssov_source_lines' view lower permissions are acceptable. It's enough to be added to invoice contacts and contract accessors even if SOV line items are hidden from non-admins. ### Returns -, ...]}on success -` on failure
Link to this function

rest_v10_work_order_contracts_work_order_contract_id_line_items_id_delete(connection, procore_company_id, work_order_contract_id, id, project_id, opts \\ [])

@spec rest_v10_work_order_contracts_work_order_contract_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 Work Order Contract line item Delete a Line Item in a specific Work Order Contract.

Parameters

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

Show Work Order Contract line item Return a specific Line Item in a specified Work Order Contract. 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.
  • work_order_contract_id (integer()): Work Order Contract ID
  • id (integer()): ID
  • 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. 'default' view will be rendered by default if the parameter is not provided. For the 'ssov_source_lines' view lower permissions are acceptable. It's enough to be added to invoice contacts and contract accessors even if SOV line items are hidden from non-admins.

Returns

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

rest_v10_work_order_contracts_work_order_contract_id_line_items_id_patch(connection, procore_company_id, work_order_contract_id, id, body3, opts \\ [])

@spec rest_v10_work_order_contracts_work_order_contract_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 Work Order Contract line item Update a Line Item in a specific Work Order Contract. 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.
  • work_order_contract_id (integer()): Work Order Contract 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_work_order_contracts_work_order_contract_id_line_items_post(connection, procore_company_id, work_order_contract_id, body3, opts \\ [])

@spec rest_v10_work_order_contracts_work_order_contract_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 Work Order Contract line item Create a new Line Item in a specified Work Order Contract. 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.
  • work_order_contract_id (integer()): Work Order Contract 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_work_order_contracts_work_order_contract_id_line_items_sync_patch(connection, procore_company_id, work_order_contract_id, project_id, line_item_sync_body, opts \\ [])

Sync Work Order Contract Line Items Sync Work Order Contract Line Items. 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.
  • work_order_contract_id (integer()): Work Order Contract ID
  • project_id (integer()): Unique identifier for the project.
  • line_item_sync_body (LineItemSyncBody):
  • opts (keyword): Optional parameters

Returns

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