avatax 19.5.0 → 19.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2512039042d82fe246845a50c231a866722d3edaaa96d706ddb998bd29a55652
-  data.tar.gz: c547e15c054c2c1333461de86bf875355a2d702fd9e41be5026cee56a65b26bc
+  metadata.gz: 93c68605547d18e18f977de7f8e02672ea083ab7ff4cc15289b622eddc2cad37
+  data.tar.gz: d08e217a9a80f892ff0ccb01e1536769e406683ff982bfb6ac3c7b53538e720c
 SHA512:
-  metadata.gz: 30c074e4a60b2d613061113480c879b7ea24539fe49771d24928342f512c8eacaa8bc977460e851ad47a3c600fea744750c2cbe08528db1943fb54add04d2e6b
-  data.tar.gz: 6dd71355cd5af75146284ef35c6cac6f3c6b4d2877f0a243967fdae06fe9448b2c7debc42c0583877697e5de6bb2d1af06ce88867f856ff49a5b0c3f1a5ec6c0
+  metadata.gz: 4e5246a5b056f565156a3e3a361c0ab842d2e3a4f52943e48a67c1b1b780cb3fe615be5e827dbe20ca27417d21cf24cfb5ad16c6f4745ca11cd39382f76ea4d0
+  data.tar.gz: cbd85e78c2530f845c670914f26ce80df3003b7a519013c1e9617c45dd8a247d37afd6080b73c75f01a3804d2bd1e0001a2e6ad7f4f215f51329d8119f3327f3

data/.travis.yml

@@ -1,7 +1,15 @@
 language: ruby
 sudo: false
 rvm:
-  - 2.4
-  - 2.3
-  - 2.2
-  - 2.1
+- 2.4
+- 2.3
+- 2.2
+- 2.1
+deploy:
+  provider: rubygems
+  api_key:
+    secure: VnQH+Ffony43CPwrJ9vBVQ+/4aHFNvlGbXSKZL9Elm2P/FKwgjycwNZ+QtPmKbA9bVUtUkPjK3phJYeL//cTv+asrBBWM/ptBCBWVYB+ICeDXCfhB7id2hcSIWy9xQ4/KdCJxgeD+gwF1Ce95XK7epZLkhcr1OpgNO+cqnA1KlZ7fkZDtFEkXtY8H40oZZ6d5G7S3s+yBUEGHoiAiD2Gj/6RfWqT8iKykT4TzBtQSzyUDVel5/dt3MG2o4kUMcF3IS+HU2fOv61mCBpCP8Y6uDSe14TWPtYrsyR+Y5E5g7OetOq3/JxMacxG7fSo6KYtkL6qYqULgc3YtUoAPyULg4nWHO1aixdBbEiD7WNlBiSeRkUgRxunNHNFwnasW1g1zrkYdcqwkROjPfXChwmFK5ZFho6PpuWpEijttNjbmjwC/IWb/7X04MPwm2tzs5pdVVBsm+Hb1dstxWsm5nLZ+xzFDDfcKqM9ktRUeeRF9SlpY/1eNdedf76IVMcZRRRPvRIJwW/zU7MPGfBqJv1AM74150X4tyGHA+OCV7aUAh9NeJegYhHfi8gFAItjQWo59ZsWXhXjwxRJwKOKTreEmmDlFrdQ7OP6uEBLy+d+4rQgxmQsB/+8TDKV0TH9bhITAqYmue9uu0Fb0mJkSaUMJ4rGl0zGM+58nIwQ2YmoeoY=
+  gem: avatax
+  on:
+    tags: true
+    branch: master

data/lib/avatax/client/addresses.rb

@@ -12,6 +12,11 @@ module AvaTax
       # This is the same API as the POST /api/v2/addresses/resolve endpoint.
       # Both verbs are supported to provide for flexible implementation.
       #
+      # Inorder to get any evaluation for an address please provide atleast one of the following fields/pairs:
+      # 1. postal code
+      # 2. line1 + city + region
+      # 3. line1 + postal code
+      #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.

data/lib/avatax/client/avafileforms.rb

@@ -11,8 +11,8 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires the user role Compliance Root User.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
-      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
+      # * 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 is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param model [AvaFileFormModel[]] The AvaFileForm you wish to create.
       # @return [AvaFileFormModel[]]
       def create_ava_file_forms(model)
@@ -28,8 +28,8 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: Compliance Root User, ComplianceUser, FirmAdmin.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
-      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
+      # * 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 is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param id [Integer] The ID of the AvaFileForm you wish to delete.
       # @return [ErrorDetail[]]
       def delete_ava_file_form(id)
@@ -45,8 +45,8 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
-      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
+      # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * 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.
       # @param id [Integer] The primary key of this AvaFileForm
       # @return [Object]
       def get_ava_file_form(id)
@@ -63,10 +63,9 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
-      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
+      # * 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 is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
       # @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:* outletTypeId
-      # @param include [String] A comma separated list of additional data to retrieve.
       # @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`.
@@ -85,8 +84,8 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires the user role Compliance Root User.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
-      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
+      # * 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 is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param id [Integer] The ID of the AvaFileForm you wish to update
       # @param model [Object] The AvaFileForm model you wish to update.
       # @return [Object]

data/lib/avatax/client/certificates.rb

@@ -25,6 +25,8 @@ module AvaTax
       # 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`.
       #
+      # If the users specified in the certificates do not exist, the API will create the user and link them to the certificate
+      #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
@@ -61,7 +63,7 @@ module AvaTax
       # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
       # @param companyId [Integer] The unique ID number of the company that recorded this certificate
       # @param id [Integer] The unique ID number of this certificate
-      # @return [Object]
+      # @return [ErrorDetail[]]
       def delete_certificate(companyId, id)
         path = "/api/v2/companies/#{companyId}/certificates/#{id}"
         delete(path)
@@ -306,7 +308,7 @@ module AvaTax
       # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
       # @param companyId [Integer] The ID number of the company to search
       # @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.
-      # @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:* status, pdf, pages
+      # @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:* exemptionNumber, status, ecmsId, ecmsStatus, pdf, pages
       # @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`.

data/lib/avatax/client/companies.rb

@@ -3,6 +3,43 @@ module AvaTax
     module Companies 
 
 
+      # Checks whether the integration being used to set up this company and run transactions onto this company is compliant to all requirements.
+      #
+      # Examines the most recent 100 transactions or data from the last month when verifying transaction-related integrations.
+      # For partners who write integrations against AvaTax for many clients, this API is a way to do a quick self testing to verify whether the
+      # written integrations for a company are sufficient enough to be delivered to the respective customers to start using it.
+      #
+      # This API provides messages specific enough (through predefined checks) to guide the partner on what integrations are still missing from the company to get fully certified.
+      # The API makes the following checks to conclude if the company is NOT fully certified:
+      # 1. Any past month items contains generic tax code of P0000000.
+      # 2. All the companies on the requesting account are test companies.
+      # 3. No Voided/Cancelled documents in the past 30 days.
+      # 4. There are less than 2 committed documents.
+      # 5. Any documentCode is a generic GUID string.
+      # 6. Any customerCode on document is a generic GUID string.
+      # 7. No document has more than 1 documentLine.
+      # 8. All of the documents have missing exemptionNo, customerUsageType, taxDateOverride or negative amount.
+      # 9. Any document quantity is a negative number.
+      # 10. Any document have repeated lines.
+      # 11. No document has shipping charge.
+      # 12. All documents have same ItemCodes, descriptions and taxCodes.
+      # 13. Less than 2 addresses used across all documents.
+      # 14. Whether locationCode was used in documents.
+      # 15. Account with AvaGlobal subscription and no documents have VATBuyerId.
+      # 16. Any document has currencyCode not being USD for accounts with AvaGlobal subscription.
+      # 17. All documents have countryCode used for accounts with AvaGlobal subscription.
+      #
+      # ### 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 id [Integer] The ID of the company to check if its integration is certified.
+      # @return [String]
+      def certify_integration(id)
+        path = "/api/v2/companies/#{id}/certify"
+        get(path)
+      end
+
+
       # Change the filing status of this company
       #
       # Changes the current filing status of this company.
@@ -89,6 +126,7 @@ module AvaTax
       #
       # ### Security Policies
       #
+      # * This API depends on the following active services<br />*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
@@ -124,7 +162,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.
+      # * 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 is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param companyId [Integer] The unique identifier of the company
       # @return [Object]
@@ -144,7 +182,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.
+      # * 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 is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
       # @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
@@ -244,6 +282,7 @@ module AvaTax
       #
       # ### Security Policies
       #
+      # * This API depends on the following active services<br />*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[]]
@@ -292,7 +331,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:* contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts
+      # @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
       # @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`.

data/lib/avatax/client/compliance.rb

@@ -3,112 +3,6 @@ module AvaTax
     module Compliance 
 
 
-      # Retrieve a single tax rate.
-      #
-      # This API is available by invitation only.
-      # @param id [Integer] The ID of the tax rate to retrieve.
-      # @return [Object]
-      def get_tax_rate(id)
-        path = "/api/v2/compliance/taxrates/#{id}"
-        get(path)
-      end
-
-
-      # Retrieve a single tax region.
-      #
-      # This API is available by invitation only.
-      # @param id [Integer] The ID of the tax region to retrieve.
-      # @return [Object]
-      def get_tax_region(id)
-        path = "/api/v2/compliance/taxregions/#{id}"
-        get(path)
-      end
-
-
-      # Retrieve jurisdictions and rates in a combined format.
-      #
-      # This API is available by invitation only.
-      # @param effectiveDate [DateTime] Used to limit the jurisdictions returned.
-      # @param endDate [DateTime] Used to limit the jurisdictions returned.
-      # @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/).
-      # @param include [String] A comma separated list of objects to fetch underneath this jurisdiction.
-      # @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 [Object]
-      def query_jurisdiction_rates(options={})
-        path = "/api/v2/compliance/jurisdictionrates"
-        get(path, options)
-      end
-
-
-      # Retrieve all unique jurisdictions.
-      #
-      # This API is available by invitation only.
-      #
-      # You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values:
-      #
-      # * TaxRates
-      # @param country [String] The two-character ISO-3166 code for the country.
-      # @param region [String] The two or three character region code for the region.
-      # @param effectiveDate [DateTime] Used to limit the jurisdictions or rates returned.
-      # @param endDate [DateTime] Used to limit the jurisdictions or rates returned.
-      # @param aggregationOption [String] Aggregation method used if rates are returned using the '$include' parameter. (See StackAggregationOption::* for a list of allowable values)
-      # @param include [String] A comma separated list of objects to fetch underneath this tax rate.
-      # @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.
-      # @return [Object]
-      def query_jurisdictions(country, region, options={})
-        path = "/api/v2/compliance/jurisdictions/#{country}/#{region}"
-        get(path, options)
-      end
-
-
-      # Retrieve all tax rates.
-      #
-      # This API is available by invitation only.
-      # @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/).
-      # @param include [String] A comma separated list of objects to fetch underneath this tax rate.
-      # @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 [Object]
-      def query_tax_rates(options={})
-        path = "/api/v2/compliance/taxrates"
-        get(path, options)
-      end
-
-
-      # Retrieve all tax region jurisdictions.
-      #
-      # This API is available by invitation only.
-      # @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/).
-      # @param include [String] A comma separated list of objects to fetch underneath this tax region jurisdiction.
-      # @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 [Object]
-      def query_tax_region_jurisdictions(options={})
-        path = "/api/v2/compliance/taxregionjurisdictions"
-        get(path, options)
-      end
-
-
-      # Retrieve all tax regions.
-      #
-      # This API is available by invitation only.
-      # @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/).
-      # @param include [String] A comma separated list of objects to fetch underneath this tax region.
-      # @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 [Object]
-      def query_tax_regions(options={})
-        path = "/api/v2/compliance/taxregions"
-        get(path, options)
-      end
-
-
       # API to modify the reference fields at the document and the line level.
       #
       # 

data/lib/avatax/client/customers.rb

@@ -76,6 +76,7 @@ module AvaTax
       #
       # * Certificates - Fetch a list of certificates linked to this customer.
       # * 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
@@ -96,6 +97,38 @@ module AvaTax
       end
 
 
+      # Link attributes to a customer
+      #
+      # Link one or many attributes to a customer.
+      #
+      # A customer may have multiple attributes that control its behavior. You may link or unlink attributes to a
+      # customer at any time. The full list of defined attributes may be found using `QueryCompanyCustomerAttributes` API.
+      #
+      # A customer object defines information about a person or business that purchases products from your
+      # company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this
+      # record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and
+      # 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`.
+      #
+      # ### 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.
+      # @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.
+      # @return [FetchResult]
+      def link_attributes_to_customer(companyId, customerCode, model)
+        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/attributes/link"
+        put(path, model)
+      end
+
+
       # Link certificates to a customer
       #
       # Link one or more certificates to a customer.
@@ -155,6 +188,37 @@ module AvaTax
       end
 
 
+      # Retrieve a customer's attributes
+      #
+      # Retrieve the attributes linked to the customer identified by this URL.
+      #
+      # A customer may have multiple attributes that control its behavior. You may link or unlink attributes to a
+      # customer at any time. The full list of defined attributes may be found using `QueryCompanyCustomerAttributes` API.
+      #
+      # A customer object defines information about a person or business that purchases products from your
+      # company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this
+      # record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and
+      # 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`.
+      #
+      # ### 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.
+      # @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]
+      def list_attributes_for_customer(companyId, customerCode)
+        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/attributes"
+        get(path)
+      end
+
+
       # List certificates linked to a customer
       #
       # List all certificates linked to a customer.
@@ -177,7 +241,7 @@ module AvaTax
       # @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.
-      # @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:* status, pdf, pages
+      # @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:* exemptionNumber, status, ecmsId, ecmsStatus, pdf, pages
       # @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`.
@@ -188,7 +252,7 @@ module AvaTax
       end
 
 
-      # List active certificates for a location
+      # List valid certificates for a location
       #
       # List valid certificates linked to a customer in a particular country and region.
       #
@@ -234,6 +298,7 @@ module AvaTax
       # You can use the `$include` parameter to fetch the following additional objects for expansion:
       #
       # * 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
@@ -257,6 +322,38 @@ module AvaTax
       end
 
 
+      # Unlink attributes from a customer
+      #
+      # Unlink one or many attributes from a customer.
+      #
+      # A customer may have multiple attributes that control its behavior. You may link or unlink attributes to a
+      # customer at any time. The full list of defined attributes may be found using `QueryCompanyCustomerAttributes` API.
+      #
+      # A customer object defines information about a person or business that purchases products from your
+      # company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this
+      # record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and
+      # 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`.
+      #
+      # ### 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.
+      # @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.
+      # @return [FetchResult]
+      def unlink_attributes_from_customer(companyId, customerCode, model)
+        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/attributes/unlink"
+        put(path, model)
+      end
+
+
       # Unlink certificates from a customer
       #
       # Remove one or more certificates to a customer.