avatax 20.7.1 → 21.3.1

data/lib/avatax/client/companies.rb

@@ -101,6 +101,29 @@ module AvaTax
       def create_companies(model)        path = "/api/v2/companies"
         post(path, model)      end
 
+      # Add parameters to a company.
+      #
+      # Add parameters to a company.
+      #
+      # Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters".
+      #
+      # A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company.
+      #
+      # A company location parameter specified on a transaction line will override a company parameter if they share the same parameter name.
+      #
+      # To see available parameters for this company, call `/api/v2/definitions/parameters?$filter=attributeType eq Company`
+      #
+      # Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter "$showSubscribed=true" to the parameter definition call above.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The ID of the company that owns this company parameter.
+      # @param model [CompanyParameterDetailModel[]] The company parameters you wish to create.
+      # @return [CompanyParameterDetailModel[]]
+      def create_company_parameters(companyId, model)        path = "/api/v2/companies/#{companyId}/parameters"
+        post(path, model)      end
+
       # Request managed returns funding setup for a company
       #
       # This API is available by invitation only.
@@ -116,7 +139,7 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
+      # * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param id [Integer] The unique identifier of the company
       # @param model [Object] The funding initialization request
@@ -136,6 +159,24 @@ module AvaTax
       def delete_company(id)        path = "/api/v2/companies/#{id}"
         delete(path)      end
 
+      # Delete a single company parameter
+      #
+      # Delete a parameter of a company.
+      # Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters".
+      #
+      # A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company.
+      #
+      # A company location parameter specified on a transaction line will override a company parameter if they share the same parameter name.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The company id
+      # @param id [Integer] The parameter id
+      # @return [ErrorDetail[]]
+      def delete_company_parameter(companyId, id)        path = "/api/v2/companies/#{companyId}/parameters/#{id}"
+        delete(path)      end
+
       # Check the funding configuration of a company
       #
       # This API is available by invitation only.
@@ -146,7 +187,7 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
+      # * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
       # @param companyId [Integer] The unique identifier of the company
       # @return [Object]
       def funding_configuration_by_company(companyId)        path = "/api/v2/companies/#{companyId}/funding/configuration"
@@ -162,7 +203,7 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
+      # * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
       # @param companyId [Integer] The unique identifier of the company
       # @param currency [String] The currency of the funding. USD and CAD are the only valid currencies
       # @return [FundingConfigurationModel[]]
@@ -217,6 +258,25 @@ module AvaTax
       def get_company_configuration(id)        path = "/api/v2/companies/#{id}/configuration"
         get(path)      end
 
+      # Retrieve a single company parameter
+      #
+      # Retrieves a single parameter of a company.
+      #
+      # Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters".
+      #
+      # A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company.
+      #
+      # A company location parameter specified on a transaction line will override a company parameter if they share the same parameter name.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # @param companyId [Integer] 
+      # @param id [Integer] 
+      # @return [Object]
+      def get_company_parameter_detail(companyId, id)        path = "/api/v2/companies/#{companyId}/parameters/#{id}"
+        get(path)      end
+
       # Get this company's filing status
       #
       # Retrieve the current filing status of this company.
@@ -232,6 +292,7 @@ module AvaTax
       # * `FilingRequested` - The company has requested to begin filing tax returns, but Avalara's compliance team has not yet begun filing.
       # * `FirstFiling` - The company has recently filing tax returns and is in a new status.
       # * `Active` - The company is currently active and is filing tax returns via Avalara Managed Returns.
+      # * `Inactive` - The company is currently inactive.
       #
       # ### Security Policies
       #
@@ -241,6 +302,31 @@ module AvaTax
       def get_filing_status(id)        path = "/api/v2/companies/#{id}/filingstatus"
         get(path)      end
 
+      # Retrieve parameters for a company
+      #
+      # Retrieve all parameters of a company.
+      #
+      # Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters".
+      #
+      # A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company.
+      #
+      # A company location parameter specified on a transaction line will override a company parameter if they share the same parameter name.
+      #
+      # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
+      # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # @param companyId [Integer] The company id
+      # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* name, unit
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
+      # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
+      # @return [FetchResult]
+      def list_company_parameter_details(companyId, options={})        path = "/api/v2/companies/#{companyId}/parameters"
+        get(path, options)      end
+
       # Check managed returns funding status for a company
       #
       # This API is available by invitation only.
@@ -250,7 +336,7 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
+      # * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param id [Integer] The unique identifier of the company
       # @return [FundingStatusModel[]]
@@ -294,7 +380,7 @@ module AvaTax
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param include [String] A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.
-      # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters
+      # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters, supplierandcustomers
       # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -348,6 +434,26 @@ module AvaTax
       # @return [Object]
       def update_company(id, model)        path = "/api/v2/companies/#{id}"
         put(path, model)      end
+
+      # Update a company parameter
+      #
+      # Update a parameter of a company.
+      #
+      # Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters".
+      #
+      # A parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company.
+      #
+      # A company location parameter specified on a transaction line will override a company parameter if they share the same parameter name.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The company id.
+      # @param id [Integer] The company parameter id
+      # @param model [Object] The company parameter object you wish to update.
+      # @return [Object]
+      def update_company_parameter_detail(companyId, id, model)        path = "/api/v2/companies/#{companyId}/parameters/#{id}"
+        put(path, model)      end
     end
   end
 end

data/lib/avatax/client/customers.rb

@@ -16,15 +16,15 @@ module AvaTax
       # A nested object such as CustomFields could be specified and created along with the customer object. To fetch the
       # nested object, please call 'GetCustomer' API with appropriate $include parameters.
       #
-      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
-      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
-      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
-      # storage for this company, call `RequestCertificateSetup`.
+      # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
+      # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
+      # certificate storage for this company, call `RequestCertificateSetup`.
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
       # @param model [CustomerModel[]] The list of customer objects to be created
       # @return [CustomerModel[]]
@@ -41,15 +41,15 @@ module AvaTax
       # identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
       # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
       #
-      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
-      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
-      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
-      # storage for this company, call `RequestCertificateSetup`.
+      # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
+      # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
+      # certificate storage for this company, call `RequestCertificateSetup`.
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
       # @param customerCode [String] The unique code representing this customer
       # @return [Object]
@@ -72,15 +72,15 @@ module AvaTax
       # * CustomFields - Fetch a list of custom fields associated to this customer.
       # * attributes - Retrieves all attributes applied to the customer.
       #
-      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
-      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
-      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
-      # storage for this company, call `RequestCertificateSetup`.
+      # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
+      # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
+      # certificate storage for this company, call `RequestCertificateSetup`.
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
       # @param customerCode [String] The unique code representing this customer
       # @param include [String] Specify optional additional objects to include in this fetch request
@@ -101,15 +101,15 @@ module AvaTax
       # identify any certificates linked to this customer object. If any certificate applies to the transaction,
       # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
       #
-      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
-      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
-      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
-      # storage for this company, call `RequestCertificateSetup`.
+      # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
+      # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
+      # certificate storage for this company, call `RequestCertificateSetup`.
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param companyId [Integer] The unique ID number of the company that recorded the provided customer
       # @param customerCode [String] The unique code representing the current customer
       # @param model [CustomerAttributeModel[]] The list of attributes to link to the customer.
@@ -127,15 +127,15 @@ module AvaTax
       # identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
       # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
       #
-      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
-      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
-      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
-      # storage for this company, call `RequestCertificateSetup`.
+      # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
+      # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
+      # certificate storage for this company, call `RequestCertificateSetup`.
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
       # @param customerCode [String] The unique code representing this customer
       # @param model [Object] The list of certificates to link to this customer
@@ -162,7 +162,7 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param companyId [Integer] The unique ID number of the company defining customers.
       # @param code [String] The code of the bill-to customer to link.
       # @param model [Object] A list of information about ship-to customers to link to this bill-to customer.
@@ -183,15 +183,15 @@ module AvaTax
       # identify any certificates linked to this customer object. If any certificate applies to the transaction,
       # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
       #
-      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
-      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
-      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
-      # storage for this company, call `RequestCertificateSetup`.
+      # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
+      # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
+      # certificate storage for this company, call `RequestCertificateSetup`.
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param companyId [Integer] The unique ID number of the company that recorded the provided customer
       # @param customerCode [String] The unique code representing the current customer
       # @return [FetchResult]
@@ -208,15 +208,15 @@ module AvaTax
       # identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
       # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
       #
-      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
-      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
-      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
-      # storage for this company, call `RequestCertificateSetup`.
+      # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
+      # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
+      # certificate storage for this company, call `RequestCertificateSetup`.
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
       # @param customerCode [String] The unique code representing this customer
       # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:      * customers - Retrieves the list of customers linked to the certificate.   * po_numbers - Retrieves all PO numbers tied to the certificate.   * attributes - Retrieves all attributes applied to the certificate.
@@ -241,15 +241,15 @@ module AvaTax
       # a CertExpress invitation link so that the customer can upload proof of their exemption certificate. Please
       # see the `CreateCertExpressInvitation` API to create an invitation link for this customer.
       #
-      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
-      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
-      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
-      # storage for this company, call `RequestCertificateSetup`.
+      # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
+      # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
+      # certificate storage for this company, call `RequestCertificateSetup`.
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
       # @param customerCode [String] The unique code representing this customer
       # @param country [String] Search for certificates matching this country. Uses the ISO 3166 two character country code.
@@ -273,15 +273,15 @@ module AvaTax
       # * Certificates - Fetch a list of certificates linked to this customer.
       # * attributes - Retrieves all attributes applied to the customer.
       #
-      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
-      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
-      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
-      # storage for this company, call `RequestCertificateSetup`.
+      # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
+      # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
+      # certificate storage for this company, call `RequestCertificateSetup`.
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
       # @param include [String] OPTIONAL - You can specify the value `certificates` to fetch information about certificates linked to the customer.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* shipTos
@@ -305,15 +305,15 @@ module AvaTax
       # identify any certificates linked to this customer object. If any certificate applies to the transaction,
       # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
       #
-      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
-      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
-      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
-      # storage for this company, call `RequestCertificateSetup`.
+      # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
+      # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
+      # certificate storage for this company, call `RequestCertificateSetup`.
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param companyId [Integer] The unique ID number of the company that recorded the customer
       # @param customerCode [String] The unique code representing the current customer
       # @param model [CustomerAttributeModel[]] The list of attributes to unlink from the customer.
@@ -331,15 +331,15 @@ module AvaTax
       # identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
       # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
       #
-      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
-      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
-      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
-      # storage for this company, call `RequestCertificateSetup`.
+      # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
+      # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
+      # certificate storage for this company, call `RequestCertificateSetup`.
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
       # @param customerCode [String] The unique code representing this customer
       # @param model [Object] The list of certificates to link to this customer
@@ -357,15 +357,15 @@ module AvaTax
       # identify any certificates linked to this `customer` object. If any certificate applies to the transaction,
       # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
       #
-      # Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
-      # Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
-      # certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
-      # storage for this company, call `RequestCertificateSetup`.
+      # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
+      # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
+      # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
+      # certificate storage for this company, call `RequestCertificateSetup`.
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
       # @param customerCode [String] The unique code representing this customer
       # @param model [Object] The new customer model that will replace the existing record at this URL

data/lib/avatax/client/datasources.rb

@@ -10,7 +10,7 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # @param companyId [Integer] The id of the company you which to create the datasources
       # @param model [DataSourceModel[]] 
       # @return [DataSourceModel[]]
@@ -24,7 +24,7 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # @param companyId [Integer] The id of the company the datasource belongs to.
       # @param id [Integer] The id of the datasource you wish to delete.
       # @return [ErrorDetail[]]
@@ -38,7 +38,7 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # @param companyId [Integer] 
       # @param id [Integer] data source id
       # @return [Object]
@@ -52,7 +52,7 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # @param companyId [Integer] The id of the company you wish to retrieve the datasources.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* isEnabled, isSynced, isAuthorized, name, externalState
       # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
@@ -72,7 +72,7 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* isEnabled, isSynced, isAuthorized, name, externalState
       # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
@@ -88,7 +88,7 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # @param companyId [Integer] The id of the company the datasource belongs to.
       # @param id [Integer] The id of the datasource you wish to delete.
       # @param model [Object]