Procore.Api.ConstructionFinancialsInvoicesPaymentReadinessManualHolds (procore_sdk v0.3.0)

API calls for all endpoints tagged ConstructionFinancialsInvoicesPaymentReadinessManualHolds.

Summary

Functions

rest_v10_projects_project_id_payment_readiness_manual_holds_get(connection, procore_company_id, project_id, invoice_id, opts \\ [])

List manual holds for a given invoice Return a list of all manual holds for a given invoice

rest_v10_projects_project_id_payment_readiness_manual_holds_id_patch(connection, procore_company_id, id, project_id, invoice_id, opts \\ [])

Update a manual hold Update a manual hold with the ID specified in the URL

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

Create a manual hold for a given invoice Create a manual hold for an invoice or vendor.

Functions

Link to this function

rest_v10_projects_project_id_payment_readiness_manual_holds_get(connection, procore_company_id, project_id, invoice_id, opts \\ [])

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

List manual holds for a given invoice Return a list of all manual holds for a given invoice

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.
  • invoice_id (integer()): Unique identifier of the invoice to retrieve manual holds
  • opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_payment_readiness_manual_holds_id_patch(connection, procore_company_id, id, project_id, invoice_id, opts \\ [])

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

Update a manual hold Update a manual hold with the ID specified in the URL

Parameters

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

Returns

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

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

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

Create a manual hold for a given invoice Create a manual hold for an invoice or vendor.

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
    • :invoice_id (integer()): Unique identifier of the invoice. This is required if the hold_type is invoice

Returns

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