Procore.Api.CoreCostCodesSubJobsCostCodes (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreCostCodesSubJobsCostCodes.

Summary

Functions

rest_v10_cost_codes_copy_from_standard_list_post(connection, procore_company_id, body102, opts \\ [])

Copy from Standard Cost Code List Copy Cost Codes from Standard Cost Code List.

rest_v10_cost_codes_copy_subset_from_standard_list_post(connection, procore_company_id, opts \\ [])

Copy Subset from Standard Cost Code List Copy a subset of Cost Codes from Standard Cost Code List.

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

List Cost Codes Returns a list of Cost Codes.

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

Show Cost Code Returns details on a specific Cost Code.

rest_v10_cost_codes_id_patch(connection, procore_company_id, id, body101, opts \\ [])

Update Cost Code Update a specific Cost Code.

rest_v10_cost_codes_post(connection, procore_company_id, body101, opts \\ [])

Create Cost Code Create a new Cost Code.

rest_v10_cost_codes_sync_patch(connection, procore_company_id, project_id, cost_code_sync_body, opts \\ [])

Sync Cost Codes This endpoint creates or updates a batch of Cost Codes. See Using Sync Actions for additional information.

rest_v10_standard_cost_code_lists_get(connection, procore_company_id, company_id, opts \\ [])

List Standard Cost Code Lists Return a list of all Standard Cost Code Lists at the Company level. Deprecation Note: Please find the replacement endpoint in the Work Breakdown Structure documents. This endpoint will be replaced with the List Company WBS Segment Item Lists Endpoint.

rest_v10_standard_cost_code_lists_id_get(connection, procore_company_id, id, company_id, opts \\ [])

Show Standard Cost Code List Return detailed information on a Standard Cost Code List at the Company level.

rest_v10_standard_cost_code_lists_id_patch(connection, procore_company_id, id, body104, opts \\ [])

Update Standard Cost Code List Update a Standard Cost Code List at the Company level.

rest_v10_standard_cost_code_lists_post(connection, procore_company_id, body103, opts \\ [])

Create Standard Cost Code List Create a new Standard Cost Code List at the Company level.

rest_v10_standard_cost_codes_get(connection, procore_company_id, company_id, standard_cost_code_list_id, opts \\ [])

List Standard Cost Codes Return a list of all Standard Cost Codes in a specified Standard Cost Code list.

rest_v10_standard_cost_codes_id_delete(connection, procore_company_id, id, company_id, opts \\ [])

Delete Standard Cost Code Delete a Standard Cost Code for ERP integrated companies and standard cost code lists. Deprecation Note: Please find the replacement endpoint in the Work Breakdown Structure documents. This endpoint will be replaced with the Delete Company Segment Item Endpoint.

rest_v10_standard_cost_codes_id_get(connection, procore_company_id, id, company_id, standard_cost_code_list_id, opts \\ [])

Show Standard Cost Code Return information about a Standard Cost Code from a specified Standard Cost Code list.

rest_v10_standard_cost_codes_id_patch(connection, procore_company_id, id, body106, opts \\ [])

Update Standard Cost Code Update a Standard Cost Code.

rest_v10_standard_cost_codes_post(connection, procore_company_id, body105, opts \\ [])

Create Standard Cost Code Create a new Standard Cost Code.

rest_v10_standard_cost_codes_sync_patch(connection, procore_company_id, standard_cost_code_sync_body, opts \\ [])

Sync Standard Cost Codes This endpoint creates or updates a batch of Standard Cost Codes. See Using Sync Actions for additional information.

Functions

rest_v10_cost_codes_copy_from_standard_list_post(connection, procore_company_id, body102, opts \\ [])

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

Copy from Standard Cost Code List Copy Cost Codes from Standard Cost Code List.

Parameters

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

Returns

{:ok, [%RestV10ProjectsProjectIdTimesheetsScopedCostCodesGet200ResponseInner{}, ...]} on success
{:error, Tesla.Env.t} on failure

rest_v10_cost_codes_copy_subset_from_standard_list_post(connection, procore_company_id, opts \\ [])

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

Copy Subset from Standard Cost Code List Copy a subset of Cost Codes from Standard Cost Code List.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
opts (keyword): Optional parameters
- :body (RestV10CostCodesCopySubsetFromStandardListPostRequest):

Returns

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

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

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

List Cost Codes Returns a list of Cost Codes.

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
- :sub_job_id (integer()): Unique identifier for the Sub Job
- :"filters[id]" ([integer()]): return cost codes that are filtered on an array of ID's. Example: filters[id]=[1,2]
- :page (integer()): Page
- :per_page (integer()): Elements per page
- :"filters[origin_id]" (String.t): Origin ID. Returns item(s) with the specified Origin ID.
- :view (String.t): Specifies which view (which attributes) of the resource is going to be present in the response.

Returns

{:ok, [%RestV10ProjectsProjectIdTimesheetsScopedCostCodesGet200ResponseInner{}, ...]} on success
{:error, Tesla.Env.t} on failure

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

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

Show Cost Code Returns details on a specific Cost Code.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
id (integer()): Unique identifier for the Cost Code
project_id (integer()): Unique identifier for the project.
opts (keyword): Optional parameters
- :sub_job_id (integer()): Unique identifier for the Sub Job

Returns

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

rest_v10_cost_codes_id_patch(connection, procore_company_id, id, body101, opts \\ [])

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

Update Cost Code Update a specific Cost Code.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
id (integer()): Unique identifier for the Cost Code
body101 (Body101):
opts (keyword): Optional parameters

Returns

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

rest_v10_cost_codes_post(connection, procore_company_id, body101, opts \\ [])

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

Create Cost Code Create a new Cost Code.

Parameters

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

Returns

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

rest_v10_cost_codes_sync_patch(connection, procore_company_id, project_id, cost_code_sync_body, opts \\ [])

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

Sync Cost Codes This endpoint creates or updates a batch of Cost Codes. 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.
cost_code_sync_body (CostCodeSyncBody):
opts (keyword): Optional parameters
- :sub_job_id (integer()): Unique identifier for the Sub Job

Returns

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

rest_v10_standard_cost_code_lists_get(connection, procore_company_id, company_id, opts \\ [])

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

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
company_id (integer()): Unique identifier for the company.
opts (keyword): Optional parameters
- :page (integer()): Page
- :per_page (integer()): Elements per page

Returns

{:ok, [%StandardCostCodeList{}, ...]} on success
{:error, Tesla.Env.t} on failure

rest_v10_standard_cost_code_lists_id_get(connection, procore_company_id, id, company_id, opts \\ [])

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

Show Standard Cost Code List Return detailed information on a Standard Cost Code List at the Company level.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
id (integer()): Unique identifier for the Standard Cost Code
company_id (integer()): Unique identifier for the company.
opts (keyword): Optional parameters

Returns

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

rest_v10_standard_cost_code_lists_id_patch(connection, procore_company_id, id, body104, opts \\ [])

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

Update Standard Cost Code List Update a Standard Cost Code List at the Company level.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
id (integer()): Unique identifier for the Standard Cost Code
body104 (Body104):
opts (keyword): Optional parameters

Returns

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

rest_v10_standard_cost_code_lists_post(connection, procore_company_id, body103, opts \\ [])

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

Create Standard Cost Code List Create a new Standard Cost Code List at the Company level.

Parameters

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

Returns

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

rest_v10_standard_cost_codes_get(connection, procore_company_id, company_id, standard_cost_code_list_id, opts \\ [])

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

List Standard Cost Codes Return a list of all Standard Cost Codes in a specified Standard Cost Code list.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
company_id (integer()): Unique identifier for the company.
standard_cost_code_list_id (integer()): Standard Cost Code List ID
opts (keyword): Optional parameters
- :page (integer()): Page
- :per_page (integer()): Elements per page
- :"filters[origin_id]" (String.t): Origin ID. Returns item(s) with the specified Origin ID.
- :view (String.t): The 'default' view only returns id and standard_cost_code_list_id. The 'compact' view also includes origin_id. The 'extended' view includes the more complete list of attributes shown below. The 'extended' view is used when no value is passed in for this parameter.

Returns

{:ok, [%StandardCostCode{}, ...]} on success
{:error, Tesla.Env.t} on failure

rest_v10_standard_cost_codes_id_delete(connection, procore_company_id, id, company_id, opts \\ [])

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

Parameters

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

Returns

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

rest_v10_standard_cost_codes_id_get(connection, procore_company_id, id, company_id, standard_cost_code_list_id, opts \\ [])

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

Show Standard Cost Code Return information about a Standard Cost Code from a specified Standard Cost Code list.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
id (integer()): ID
company_id (integer()): Unique identifier for the company.
standard_cost_code_list_id (integer()): The ID of the Standard Cost Code List
opts (keyword): Optional parameters
- :view (String.t): The 'default' view only returns id and standard_cost_code_list_id. The 'compact' view also includes origin_id. The 'extended' view includes the more complete list of attributes shown below. The 'extended' view is used when no value is passed in for this parameter.

Returns

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

rest_v10_standard_cost_codes_id_patch(connection, procore_company_id, id, body106, opts \\ [])

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

Update Standard Cost Code Update a Standard Cost Code.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
id (integer()): ID
body106 (Body106):
opts (keyword): Optional parameters
- :view (String.t): The 'default' view only returns id and standard_cost_code_list_id. The 'compact' view also includes origin_id. The 'extended' view includes the more complete list of attributes shown below. The 'extended' view is used when no value is passed in for this parameter.

Returns

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

rest_v10_standard_cost_codes_post(connection, procore_company_id, body105, opts \\ [])

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

Create Standard Cost Code Create a new Standard Cost Code.

Parameters

connection (Procore.Connection): Connection to server
procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
body105 (Body105):
opts (keyword): Optional parameters
- :view (String.t): The 'default' view only returns id and standard_cost_code_list_id. The 'compact' view also includes origin_id. The 'extended' view includes the more complete list of attributes shown below. The 'extended' view is used when no value is passed in for this parameter.

Returns

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

rest_v10_standard_cost_codes_sync_patch(connection, procore_company_id, standard_cost_code_sync_body, opts \\ [])

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

Sync Standard Cost Codes This endpoint creates or updates a batch of Standard Cost Codes. 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.
standard_cost_code_sync_body (StandardCostCodeSyncBody):
opts (keyword): Optional parameters
- :view (String.t): The 'default' view only returns id and standard_cost_code_list_id. The 'compact' view also includes origin_id. The 'extended' view includes the more complete list of attributes shown below. The 'extended' view is used when no value is passed in for this parameter.

Returns

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