Procore.Api.CoreProjectDirectoryProjectVendors (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreProjectDirectoryProjectVendors.

Summary

Functions

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

List project vendors Return a list of Vendors associated with a specified Project.

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

Add to project Add a specified vendor to a Project from the Company Directory.

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

Delete from project Remove a specified Vendor from a Project.

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

Show project vendor Show detail on a specified Project Vendor.

rest_v10_projects_project_id_vendors_id_patch(connection, procore_company_id, project_id, id, project_vendor_body1, opts \\ [])

Update project vendor Update a specified Project Vendor. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

rest_v10_projects_project_id_vendors_post(connection, procore_company_id, project_id, project_vendor_body, opts \\ [])

Create project vendor Create a new Project Vendor. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

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

List project vendors Return a list of Vendors associated with a specified Project.

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

Add to project Add a specified vendor to a Project from the Company Directory.

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

Delete from project Remove a specified Vendor from a Project.

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

Show project vendor Show detail on a specified Project Vendor.

rest_v11_projects_project_id_vendors_id_patch(connection, procore_company_id, project_id, id, project_vendor_body1, opts \\ [])

Update project vendor Update a specified Project Vendor. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

rest_v11_projects_project_id_vendors_post(connection, procore_company_id, project_id, project_vendor_body, opts \\ [])

Create project vendor Create a new Project Vendor. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

Functions

Link to this function

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

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

List project vendors Return a list of Vendors associated with a specified Project.

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
    • :view (String.t): The normal view provides what is shown below. The extended view is the same as the normal view but includes children_count, legal_name, parent, and bidding. The default view is normal.
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[search]" (String.t): Return vendors where the search string matches the vendor name, keywords, origin_code, or ABN/EIN number
    • :"filters[standard_cost_code_id][]" ([integer()]): Returns vendors associated with the specified standard cost code id(s)
    • :"filters[trade_id][]" ([integer()]): Returns vendors associated with the specified trade id(s)
    • :"filters[id][]" ([integer()]): Returns vendors with the specified id(s)
    • :"filters[parent_id][]" ([integer()]): Returns vendors with the specified parent id(s)
    • :"filters[abbreviated_name][]" ([String.t]): Return vendors(s) matching any of the specified abbreviated names in the abbreviated_name filter.
    • :sort (String.t): Return items with the specified sort.

Returns

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

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

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

Add to project Add a specified vendor to a Project from the Company Directory.

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.
  • id (integer()): ID of the vendor
  • opts (keyword): Optional parameters
    • :view (String.t): The normal view provides what is shown below. The extended view is the same as the normal view but includes children_count, legal_name, parent, and bidding. The name view is a minimal view only including the name and id. The default view is normal.

Returns

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

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

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

Delete from project Remove a specified Vendor from a Project.

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.
  • id (integer()): ID of the vendor
  • opts (keyword): Optional parameters

Returns

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

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

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

Show project vendor Show detail on a specified Project 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.
  • id (integer()): ID of the vendor
  • opts (keyword): Optional parameters
    • :view (String.t): The normal view provides what is shown below. The extended view is the same as the normal view but includes children_count, legal_name, parent, and bidding. The default view is normal.

Returns

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

rest_v10_projects_project_id_vendors_id_patch(connection, procore_company_id, project_id, id, project_vendor_body1, opts \\ [])

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

Update project vendor Update a specified Project Vendor. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes 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.
  • id (integer()): ID of the vendor
  • project_vendor_body1 (ProjectVendorBody1):
  • opts (keyword): Optional parameters
    • :view (String.t): The normal view provides what is shown below. The extended view is the same as the normal view but includes children_count, legal_name, parent, and bidding. The default view is normal.
    • :run_configurable_validations (boolean()): If true, validations are run for the corresponding Configurable Field Set.

Returns

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

rest_v10_projects_project_id_vendors_post(connection, procore_company_id, project_id, project_vendor_body, opts \\ [])

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

Create project vendor Create a new Project Vendor. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes 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.
  • project_vendor_body (ProjectVendorBody):
  • opts (keyword): Optional parameters
    • :view (String.t): The normal view provides what is shown below. The extended view is the same as the normal view but includes children_count, legal_name, parent, and bidding. The default view is normal.
    • :run_configurable_validations (boolean()): If true, validations are run for the corresponding Configurable Field Set.

Returns

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

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

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

List project vendors Return a list of Vendors associated with a specified Project.

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
    • :view (String.t): Specifies which view of the resource to return (which attributes should be present in the response). Users without read permissions to Directory are limited to ids_only, name, and minimal views. If a valid view is not provided, it will return the default view: minimal for users without read permissions and normal otherwise.
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[search]" (String.t): Return vendors where the search string matches the vendor name, keywords, origin_code, or ABN/EIN number
    • :"filters[standard_cost_code_id][]" ([integer()]): Returns vendors associated with the specified standard cost code id(s)
    • :"filters[trade_id][]" ([integer()]): Returns vendors associated with the specified trade id(s)
    • :"filters[id][]" ([integer()]): Returns vendors with the specified id(s)
    • :"filters[parent_id][]" ([integer()]): Returns vendors with the specified parent id(s)
    • :sort (String.t): Return items with the specified sort.

Returns

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

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

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

Add to project Add a specified vendor to a Project from the Company Directory.

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.
  • id (integer()): ID of the vendor
  • opts (keyword): Optional parameters
    • :view (String.t): The normal view provides what is shown below. The extended view is the same as the normal view but includes children_count, legal_name, parent, and bidding. The default view is normal.

Returns

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

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

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

Delete from project Remove a specified Vendor from a Project.

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.
  • id (integer()): ID of the vendor
  • opts (keyword): Optional parameters

Returns

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

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

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

Show project vendor Show detail on a specified Project 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.
  • id (integer()): ID of the vendor
  • opts (keyword): Optional parameters
    • :view (String.t): The normal view provides what is shown below. The extended view is the same as the normal view but includes children_count, legal_name, parent, and bidding. The default view is normal.

Returns

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

rest_v11_projects_project_id_vendors_id_patch(connection, procore_company_id, project_id, id, project_vendor_body1, opts \\ [])

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

Update project vendor Update a specified Project Vendor. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes 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.
  • id (integer()): ID of the vendor
  • project_vendor_body1 (ProjectVendorBody1):
  • opts (keyword): Optional parameters
    • :view (String.t): The normal view provides what is shown below. The extended view is the same as the normal view but includes children_count, legal_name, parent, and bidding. The default view is normal.
    • :run_configurable_validations (boolean()): If true, validations are run for the corresponding Configurable Field Set.

Returns

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

rest_v11_projects_project_id_vendors_post(connection, procore_company_id, project_id, project_vendor_body, opts \\ [])

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

Create project vendor Create a new Project Vendor. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes 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.
  • project_vendor_body (ProjectVendorBody):
  • opts (keyword): Optional parameters
    • :view (String.t): Specifies which view of the resource to return (which attributes should be present in the response). The default view is normal.
    • :run_configurable_validations (boolean()): If true, validations are run for the corresponding Configurable Field Set.

Returns

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