Procore.Api.ConstructionFinancialsTaxTaxTypes (procore_sdk v0.3.0)

API calls for all endpoints tagged ConstructionFinancialsTaxTaxTypes.

Summary

Functions

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

List Tax Types Return a list of all Tax Types for a given Company A Tax Type represents a "value added tax" or "goods and services tax" which needs to be accounted for on a commitment or an invoice generated by Procore. In many places there will just be a single tax to deal with, for example in Australia it will be GST, in the UK it will be VAT. Other countries may require that multiple taxes are displayed, for example in Canada an invoice may be required to include both GST and PST. Procore currently only supports the definition of one tax type per company. Tax support can be enabled at the company level by an admin user though the web interface. Once enabled at the company level, tax support can also be enabled or disabled at the project level. When tax support is enabled at the company level, it is disabled for existing projects, but by default will be enabled for new projects. An admin user can change these settings through the web interface.

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

Delete Tax Type Delete a Tax Type

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

Show Tax Type Show detailed information for a specific Tax Type

rest_v10_tax_types_id_patch(connection, procore_company_id, id, company_id, rest_v10_tax_types_id_patch_request, opts \\ [])

Update Tax Type Update a Tax Type's attributes

rest_v10_tax_types_post(connection, procore_company_id, company_id, rest_v10_tax_types_post_request, opts \\ [])

Create Tax Type Creates a Tax Type on a given Company

rest_v10_tax_types_sync_patch(connection, procore_company_id, body12, opts \\ [])

Sync Tax Types This endpoint creates or updates a batch of Tax Types

Functions

Link to this function

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

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

List Tax Types Return a list of all Tax Types for a given Company A Tax Type represents a "value added tax" or "goods and services tax" which needs to be accounted for on a commitment or an invoice generated by Procore. In many places there will just be a single tax to deal with, for example in Australia it will be GST, in the UK it will be VAT. Other countries may require that multiple taxes are displayed, for example in Canada an invoice may be required to include both GST and PST. Procore currently only supports the definition of one tax type per company. Tax support can be enabled at the company level by an admin user though the web interface. Once enabled at the company level, tax support can also be enabled or disabled at the project level. When tax support is enabled at the company level, it is disabled for existing projects, but by default will be enabled for new projects. An admin user can change these settings through the web interface.

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, [%RestV10TaxTypesGet200ResponseInner{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

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

Delete Tax Type Delete a Tax Type

Parameters

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

Returns

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

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

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

Show Tax Type Show detailed information for a specific Tax Type

Parameters

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

Returns

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

rest_v10_tax_types_id_patch(connection, procore_company_id, id, company_id, rest_v10_tax_types_id_patch_request, opts \\ [])

@spec rest_v10_tax_types_id_patch(
  Tesla.Env.client(),
  integer(),
  String.t(),
  integer(),
  Procore.Model.RestV10TaxTypesIdPatchRequest.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.RestV10TaxTypesPost400Response.t()}
  | {:ok, Procore.Model.RestV10TaxTypesGet200ResponseInner.t()}
  | {:error, Tesla.Env.t()}

Update Tax Type Update a Tax Type's attributes

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (String.t): The Tax Type ID
  • company_id (integer()): Unique identifier for the company.
  • rest_v10_tax_types_id_patch_request (RestV10TaxTypesIdPatchRequest):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_tax_types_post(connection, procore_company_id, company_id, rest_v10_tax_types_post_request, opts \\ [])

@spec rest_v10_tax_types_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  Procore.Model.RestV10TaxTypesPostRequest.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.RestV10TaxTypesPost400Response.t()}
  | {:ok, Procore.Model.RestV10TaxTypesGet200ResponseInner.t()}
  | {:error, Tesla.Env.t()}

Create Tax Type Creates a Tax Type on a given Company

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.
  • rest_v10_tax_types_post_request (RestV10TaxTypesPostRequest):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_tax_types_sync_patch(connection, procore_company_id, body12, opts \\ [])

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

Sync Tax Types This endpoint creates or updates a batch of Tax Types

Parameters

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

Returns

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