Procore.Api.ConstructionFinancialsPrimeContractsPrimeContracts (procore_sdk v0.3.0)

API calls for all endpoints tagged ConstructionFinancialsPrimeContractsPrimeContracts.

Summary

Functions

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

Show First Prime Contract Returns the first Prime Contract created for the specified Project. Use the /prime_contracts endpoint if you need to return more than one Prime Contract.

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

Delete Prime Contract Delete the specified Prime Contract.

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

Show Prime Contract Show the details of a Project's Prime Contract.

rest_v10_prime_contract_id_patch(connection, procore_company_id, id, body45, opts \\ [])

Update Prime Contract Update the specified Prime Contract.

rest_v10_prime_contract_post(connection, procore_company_id, body45, opts \\ [])

Create Prime Contract Create a new Prime Contract.

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

List all Prime Contracts Returns all Prime Contracts for the specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

Functions

Link to this function

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

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

Show First Prime Contract Returns the first Prime Contract created for the specified Project. Use the /prime_contracts endpoint if you need to return more than one Prime Contract.

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

Returns

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

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

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

Delete Prime Contract Delete the specified Prime Contract.

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 Contract
  • 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_prime_contract_id_get(connection, procore_company_id, id, project_id, opts \\ [])

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

Show Prime Contract Show the details of a Project's Prime Contract.

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

Returns

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

rest_v10_prime_contract_id_patch(connection, procore_company_id, id, body45, opts \\ [])

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

Update Prime Contract Update the specified Prime Contract.

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

Returns

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

rest_v10_prime_contract_post(connection, procore_company_id, body45, opts \\ [])

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

Create Prime Contract Create a new Prime Contract.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • body45 (Body45):
  • opts (keyword): Optional parameters
    • :run_configurable_validations (boolean()): If true, validations are run for the corresponding Configurable Field Set.

Returns

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

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

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

List all Prime Contracts Returns all Prime Contracts for the specified Project. 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
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[id]" ([integer()]): Return item(s) with the specified IDs.
    • :"filters[updated_at]" (Date.t): Return item(s) last updated 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

Returns

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