Procore.Api.ConstructionFinancialsCommitmentsContractPayments (procore_sdk v0.3.0)

API calls for all endpoints tagged ConstructionFinancialsCommitmentsContractPayments.

Summary

Functions

rest_v10_contract_payments_get(connection, procore_company_id, project_id, contract_id, opts \\ [])

List Contract Payments Return a list of Contract Payments.

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

Delete Contract Payment Deletes a specified Contract Payment.

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

Show Contract Payment Return detailed information on the specified Contract Payment.

rest_v10_contract_payments_id_patch(connection, procore_company_id, id, body112, opts \\ [])

Update Contract Payment Update a Contract Payment. All attributes other than 'attachments', 'origin_id', and 'origin_data' will be locked if the contract payment is synced with an ERP system.

rest_v10_contract_payments_post(connection, procore_company_id, body112, opts \\ [])

Create Contract Payment Create a new Contract Payment.

Functions

Link to this function

rest_v10_contract_payments_get(connection, procore_company_id, project_id, contract_id, opts \\ [])

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

List Contract Payments Return a list of Contract Payments.

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()): ID of the Contract
  • opts (keyword): Optional parameters
    • :page (integer()): Page
    • :per_page (integer()): Elements per page

Returns

  • {:ok, [%RestV10ContractPaymentsGet200ResponseInner{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

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

Delete Contract Payment Deletes a specified Contract Payment.

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()): ID of the Contract
  • opts (keyword): Optional parameters

Returns

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

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

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

Show Contract Payment Return detailed information on the specified Contract Payment.

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()): ID of the Contract
  • opts (keyword): Optional parameters

Returns

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

rest_v10_contract_payments_id_patch(connection, procore_company_id, id, body112, opts \\ [])

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

Update Contract Payment Update a Contract Payment. All attributes other than 'attachments', 'origin_id', and 'origin_data' will be locked if the contract payment is synced with an ERP system.

Parameters

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

Returns

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

rest_v10_contract_payments_post(connection, procore_company_id, body112, opts \\ [])

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

Create Contract Payment Create a new Contract Payment.

Parameters

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

Returns

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