avatax 21.1.2 → 21.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a779b97acfcbecb8782c8f98309982313d1409cbb44f28d3ef65f396116e2c15
-  data.tar.gz: c491a1f18172047a20a1d4bfcdadafb05e077827402a4451d45aa9ef5cc63338
+  metadata.gz: 6b4068baf63fb55ea1a9a36451d2ddb2ba8cf9aa324895cec37c3a88f3dc8815
+  data.tar.gz: 653b1ea0ed11a2a7164181e1603aaa7290f7399565c77ebc67d6df302be6bd50
 SHA512:
-  metadata.gz: 98b845ac4ef06403f88ecf26fd0ba2d29547e6df6a8be1f3af2c494b5b4f6bae10fc1ef8bf655244636123497011f528d653f6648824704313a4e7193d1bb01d
-  data.tar.gz: dad022262512d018cba8963e3abde005460b159f86b0a41e678a06aded9b3598565512bef7eb0b17fc4be4e472a0f5a21af4e8a10e8bd9e140d94720bb227c6a
+  metadata.gz: c7263c7b290df9d1acbb3b273306e7c88c0ed7bec36cb292dd35e3844d5341d3bfecd2bbf7f83e68d208e8e5da91b9bf88dde7d5bc529283bbc04fb7953d1a3c
+  data.tar.gz: 124df35966420847491ac29c883cf67f1fd59edc5c3f5d235f4bfa8a24d7a2499bbe80b556064087143bb07ca6f239b1b955532d9c71a30de98cd9a8c7012b39

data/lib/avatax/client/companies.rb

@@ -292,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
       #

data/lib/avatax/client/definitions.rb

@@ -38,6 +38,17 @@ module AvaTax
       def get_login_verifier_by_form(form, options={})        path = "/api/v2/definitions/filingcalendars/loginverifiers/#{form}"
         get(path, options)      end
 
+      # List all market place locations.
+      #
+      # List all market place locations.
+      # @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 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_all_marketplace_locations(options={})        path = "/api/v2/definitions/listallmarketplacelocations"
+        get(path, options)      end
+
       # Retrieve the full list of the AvaFile Forms available
       #
       # This API is deprecated.
@@ -106,6 +117,19 @@ module AvaTax
       def list_certificate_exposure_zones(options={})        path = "/api/v2/definitions/certificateexposurezones"
         get(path, options)      end
 
+      # Retrieve the full list of Avalara-supported usage of extra parameters for classification of a item.
+      #
+      # Returns the full list of Avalara-supported usage of extra parameters for item classification.
+      # The list of parameters is available for use with Item Classification.
+      # Some parameters are only available for use if you have subscribed to certain features of AvaTax.
+      # @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:* values
+      # @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_classification_parameters_usage(options={})        path = "/api/v2/definitions/classification/parametersusage"
+        get(path, options)      end
+
       # Retrieve the full list of communications service types
       #
       # Returns full list of service types for a given transaction type ID.
@@ -564,7 +588,16 @@ module AvaTax
 
       # Retrieve the parameters by companyCode and itemCode.
       #
-      # Returns the list of parameters based on the company country and state jurisdiction and the item code.
+      # Returns the list of parameters based on the company's service types and the item code.
+      # Ignores nexus if a service type is configured in the 'IgnoreNexusForServiceTypes' configuration section.
+      # Ignores nexus for the AvaAlcohol service type.
+      #
+      # NOTE: If your company code or item code contains any of these characters /, +, ? or a space, please use the following encoding before making a request:
+      # * Replace '/' with '\_-ava2f-\_' For example: 'Company/Code' becomes 'Company_-ava2f-_Code'
+      # * Replace '+' with '\_-ava2b-\_' For example: 'Company+Code' becomes 'Company_-ava2b-_Code'
+      # * Replace '?' with '\_-ava3f-\_' For example: 'Company?Code' becomes 'Company_-ava3f-_Code'
+      # * Replace '%' with '\_-ava25-\_' For example: 'Company%Code' becomes 'Company_-ava25-_Code'
+      # * Replace '#' with '\_-ava23-\_' For example: 'Company#Code' becomes 'Company_-ava23-_Code'
       #
       # ### Security Policies
       #
@@ -653,6 +686,14 @@ module AvaTax
       #
       # Tax authorities use product classification systems as a way to identify products and associate them with a tax rate.
       # More than one tax authority might use the same product classification system, but they might charge different tax rates for products.
+      #
+      #
+      # NOTE: If your company code contains any of these characters /, +, ? or a space, please use the following encoding before making a request:
+      # * Replace '/' with '\_-ava2f-\_' For example: 'Company/Code' becomes 'Company_-ava2f-_Code'
+      # * Replace '+' with '\_-ava2b-\_' For example: 'Company+Code' becomes 'Company_-ava2b-_Code'
+      # * Replace '?' with '\_-ava3f-\_' For example: 'Company?Code' becomes 'Company_-ava3f-_Code'
+      # * Replace '%' with '\_-ava25-\_' For example: 'Company%Code' becomes 'Company_-ava25-_Code'
+      # * Replace '#' with '\_-ava23-\_' For example: 'Company#Code' becomes 'Company_-ava23-_Code'
       # @param companyCode [String] The company code.
       # @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:* countries
       # @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.
@@ -715,6 +756,19 @@ module AvaTax
       def list_resource_file_types(options={})        path = "/api/v2/definitions/resourcefiletypes"
         get(path, options)      end
 
+      # Retrieve the full list of Avalara-supported usage of parameters used for returns.
+      #
+      # Returns the full list of Avalara-supported usage of extra parameters for the returns.
+      # This list of parameters is available for use with Returns.
+      # Some parameters are only available for use if you have subscribed to certain features of AvaTax.
+      # @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:* values
+      # @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_returns_parameters_usage(options={})        path = "/api/v2/definitions/returns/parametersusage"
+        get(path, options)      end
+
       # Retrieve the full list of Avalara-supported permissions
       #
       # Returns the full list of Avalara-supported permission types.
@@ -742,6 +796,17 @@ module AvaTax
       def list_subscription_types(options={})        path = "/api/v2/definitions/subscriptiontypes"
         get(path, options)      end
 
+      # Retrieve the list all tags supported by avalara
+      #
+      # Retrieves the list of suggested locations for a marketplace.
+      # @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 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_tags(options={})        path = "/api/v2/definitions/tags"
+        get(path, options)      end
+
       # Retrieve the full list of Avalara-supported tax authorities.
       #
       # Returns the full list of Avalara-supported tax authorities.

data/lib/avatax/client/items.rb

@@ -39,6 +39,27 @@ module AvaTax
       def batch_delete_item_parameters(companyId, itemId)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
         delete(path)      end
 
+      # Bulk upload items from a product catalog
+      #
+      # Create/Update one or more item objects attached to this company.
+      #
+      # Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
+      # can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,
+      # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
+      # from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance
+      # team can manage your item catalog and adjust the tax behavior of items without having to modify your software.
+      #
+      # The tax code takes precedence over the tax code id if both are provided.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The ID of the company that owns this items.
+      # @param model [Object] The items you wish to upload.
+      # @return [Object]
+      def bulk_upload_items(companyId, model)        path = "/api/v2/companies/#{companyId}/items/upload"
+        post(path, model)      end
+
       # Add classifications to an item.
       #
       # Add classifications to an item.
@@ -104,6 +125,22 @@ module AvaTax
       def create_items(companyId, model)        path = "/api/v2/companies/#{companyId}/items"
         post(path, model)      end
 
+      # Create tags for a item
+      #
+      # Creates one or more new `Tag` objects attached to this Item.
+      #
+      # Item tags puts multiple labels for an item. So that item can be easily grouped by these tags.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The ID of the company that defined these items
+      # @param itemId [Integer] The ID of the item as defined by the company that owns this tag.
+      # @param model [ItemTagDetailModel[]] Tags you wish to associate with the Item
+      # @return [ItemTagDetailModel[]]
+      def create_item_tags(companyId, itemId, model)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags"
+        post(path, model)      end
+
       # Delete a single item
       #
       # Deletes the item object at this URL.
@@ -163,6 +200,37 @@ module AvaTax
       def delete_item_parameter(companyId, itemId, id)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
         delete(path)      end
 
+      # Delete item tag by id
+      #
+      # Deletes the `Tag` object of an Item at this URL.
+      #
+      # Item tags puts multiple labels for an item. So that item can be easily grouped by these tags.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The ID of the company that defined these items
+      # @param itemId [Integer] The ID of the item as defined by the company that owns this tag.
+      # @param itemTagDetailId [Integer] The ID of the item tag detail you wish to delete.
+      # @return [ErrorDetail[]]
+      def delete_item_tag(companyId, itemId, itemTagDetailId)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags/#{itemTagDetailId}"
+        delete(path)      end
+
+      # Delete all item tags
+      #
+      # Deletes all `Tags` objects of an Item at this URL.
+      #
+      # Item tags puts multiple labels for an item. So that item can be easily grouped by these tags.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The ID of the company that defined these items.
+      # @param itemId [Integer] The ID of the item as defined by the company that owns this tag.
+      # @return [ErrorDetail[]]
+      def delete_item_tags(companyId, itemId)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags"
+        delete(path)      end
+
       # Retrieve a single item
       #
       # Get the `Item` object identified by this URL.
@@ -221,6 +289,24 @@ module AvaTax
       def get_item_parameter(companyId, itemId, id)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
         get(path)      end
 
+      # Retrieve tags for an item
+      #
+      # Get the `Tag` objects of an Item identified by this URL.
+      #
+      # Item tags puts multiple labels for an item. So that item can be easily grouped by these tags.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # @param companyId [Integer] The ID of the company that defined these items
+      # @param itemId [Integer] The ID of the item as defined by the company that owns this tag.
+      # @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:* tagName
+      # @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 [FetchResult]
+      def get_item_tags(companyId, itemId, options={})        path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags"
+        get(path, options)      end
+
       # Retrieve classifications for an item.
       #
       # List classifications for an item.
@@ -263,7 +349,7 @@ module AvaTax
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param companyId [Integer] The company id
       # @param itemId [Integer] The item 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 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, isNeededForCalculation, isNeededForReturns, isNeededForClassification
       # @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`.
@@ -289,12 +375,13 @@ module AvaTax
       #
       # * Parameters
       # * Classifications
+      # * Tags
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param companyId [Integer] The ID of the company that defined these items
-      # @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:* taxCode, classifications, 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:* taxCode, classifications, parameters, tags
       # @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.
@@ -320,7 +407,7 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, 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:* taxCode, classifications, 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:* taxCode, classifications, parameters, tags
       # @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.
@@ -329,6 +416,34 @@ module AvaTax
       def query_items(options={})        path = "/api/v2/items"
         get(path, options)      end
 
+      # Retrieve all items associated with given tag
+      #
+      # Get multiple item objects associated with given tag.
+      #
+      # Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
+      # can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,
+      # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
+      # from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance
+      # team can manage your item catalog and adjust the tax behavior of items without having to modify your software.
+      #
+      # 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, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # @param companyId [Integer] The ID of the company that defined these items.
+      # @param tag [String] The master tag to be associated with item.
+      # @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:* taxCode, classifications, parameters, tags
+      # @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`.
+      # @return [FetchResult]
+      def query_items_by_tag(companyId, tag, options={})        path = "/api/v2/companies/#{companyId}/items/bytags/#{tag}"
+        get(path, options)      end
+
       # Sync items from a product catalog
       #
       # Syncs a list of items with AvaTax without waiting for them to be created. It is ideal for syncing large product catalogs

data/lib/avatax/client/notices.rb

@@ -3,424 +3,55 @@ module AvaTax
     module Notices 
 
 
-      # Create a new notice comment.
+      # Creates a new tax notice responsibility type.
       #
-      # This API is available by invitation only.
-      # 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
+      # This API is available by invitation only and only available for users with Compliance admin access.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, 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.
-      # @param companyId [Integer] The ID of the company that owns this notice.
-      # @param id [Integer] The ID of the tax notice we are adding the comment for.
-      # @param model [NoticeCommentModel[]] The notice comments you wish to create.
-      # @return [NoticeCommentModel[]]
-      def create_notice_comment(companyId, id, model)        path = "/api/v2/companies/#{companyId}/notices/#{id}/comments"
-        post(path, model)      end
-
-      # Create a new notice finance details.
-      #
-      # This API is available by invitation only.
-      # 'Notice finance details' is the categorical breakdown of the total charge levied by the tax authority on our customer,
-      # as broken down in our "notice log" found in Workflow. Main examples of the categories are 'Tax Due', 'Interest', 'Penalty', 'Total Abated'.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, 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.
-      # @param companyId [Integer] The ID of the company that owns this notice.
-      # @param id [Integer] The ID of the notice added to the finance details.
-      # @param model [NoticeFinanceModel[]] The notice finance details you wish to create.
-      # @return [NoticeFinanceModel[]]
-      def create_notice_finance_details(companyId, id, model)        path = "/api/v2/companies/#{companyId}/notices/#{id}/financedetails"
-        post(path, model)      end
-
-      # Create a new notice responsibility.
-      #
-      # This API is available by invitation only.
-      # 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, 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.
-      # @param companyId [Integer] The ID of the company that owns this notice.
-      # @param id [Integer] The ID of the tax notice we are adding the responsibility for.
-      # @param model [NoticeResponsibilityDetailModel[]] The notice responsibilities you wish to create.
-      # @return [NoticeResponsibilityDetailModel[]]
-      def create_notice_responsibilities(companyId, id, model)        path = "/api/v2/companies/#{companyId}/notices/#{id}/responsibilities"
-        post(path, model)      end
-
-      # Create a new notice root cause.
-      #
-      # This API is available by invitation only.
-      # 'Notice root causes' are are those who are responsible for the notice.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, 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.
-      # @param companyId [Integer] The ID of the company that owns this notice.
-      # @param id [Integer] The ID of the tax notice we are adding the responsibility for.
-      # @param model [NoticeRootCauseDetailModel[]] The notice root causes you wish to create.
-      # @return [NoticeRootCauseDetailModel[]]
-      def create_notice_root_causes(companyId, id, model)        path = "/api/v2/companies/#{companyId}/notices/#{id}/rootcauses"
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * 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 model [Object] The responsibility type to create
+      # @return [Object]
+      def create_notice_responsibility_type(model)        path = "/api/v2/notices/responsibilities"
         post(path, model)      end
 
-      # Create a new notice.
+      # Creates a new tax notice root cause type.
       #
-      # This API is available by invitation only.
-      # Create one or more new notice objects.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
+      # This API is available by invitation only and only available for users with Compliance admin access.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, 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.
-      # @param companyId [Integer] The ID of the company that owns this notice.
-      # @param model [NoticeModel[]] The notice object you wish to create.
-      # @return [NoticeModel[]]
-      def create_notices(companyId, model)        path = "/api/v2/companies/#{companyId}/notices"
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * 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 model [Object] The root cause type to create
+      # @return [Object]
+      def create_notice_root_cause_type(model)        path = "/api/v2/notices/rootcauses"
         post(path, model)      end
 
-      # Delete a single notice.
-      #
-      # This API is available by invitation only.
-      # 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, 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.
-      # @param companyId [Integer] The ID of the company that owns this notice.
-      # @param id [Integer] The ID of the notice you wish to delete the finance detail from.
-      # @param commentDetailsId [Integer] The ID of the comment you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_comment_details(companyId, id, commentDetailsId)        path = "/api/v2/companies/#{companyId}/notices/#{id}/commentdetails/#{commentdetailsid}"
-        delete(path)      end
-
-      # Delete a single notice.
-      #
-      # This API is available by invitation only.
-      # 'Notice finance details' is the categorical breakdown of the total charge levied by the tax authority on our customer,
-      # as broken down in our "notice log" found in Workflow. Main examples of the categories are 'Tax Due', 'Interest', 'Penalty', 'Total Abated'.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, 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.
-      # @param companyId [Integer] The ID of the company that owns this notice.
-      # @param id [Integer] The ID of the notice you wish to delete the finance detail from.
-      # @param financeDetailsId [Integer] The ID of the finance detail you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_finance_details(companyId, id, financeDetailsId)        path = "/api/v2/companies/#{companyId}/notices/#{id}/financedetails/#{financedetailsid}"
-        delete(path)      end
-
-      # Delete a single notice.
+      # Delete a tax notice responsibility type.
       #
-      # This API is available by invitation only.
-      # Mark the existing notice object at this URL as deleted.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
+      # This API is available by invitation only and only available for users with Compliance admin access.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, 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.
-      # @param companyId [Integer] The ID of the company that owns this notice.
-      # @param id [Integer] The ID of the notice you wish to delete.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # @param responsibilityId [Integer] The unique ID of the responsibility type
       # @return [ErrorDetail[]]
-      def delete_notice(companyId, id)        path = "/api/v2/companies/#{companyId}/notices/#{id}"
+      def delete_notice_responsibility_type(responsibilityId)        path = "/api/v2/notices/responsibilities/#{responsibilityId}"
         delete(path)      end
 
-      # Delete a single responsibility
+      # Delete a tax notice root cause type.
       #
-      # This API is available by invitation only.
-      # Mark the existing notice object at this URL as deleted.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
+      # This API is available by invitation only and only available for users with Compliance admin access.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, 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.
-      # @param companyId [Integer] The ID of the company that owns this notice.
-      # @param noticeId [Integer] The ID of the notice you wish to delete.
-      # @param id [Integer] The ID of the responsibility you wish to delete.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # @param rootCauseId [Integer] The unique ID of the root cause type
       # @return [ErrorDetail[]]
-      def delete_responsibilities(companyId, noticeId, id)        path = "/api/v2/companies/#{companyId}/notices/#{noticeId}/responsibilities/#{id}"
+      def delete_notice_root_cause_type(rootCauseId)        path = "/api/v2/notices/rootcauses/#{rootCauseId}"
         delete(path)      end
-
-      # Delete a single root cause.
-      #
-      # This API is available by invitation only.
-      # Mark the existing notice object at this URL as deleted.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, 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.
-      # @param companyId [Integer] The ID of the company that owns this notice.
-      # @param noticeId [Integer] The ID of the notice you wish to delete.
-      # @param id [Integer] The ID of the root cause you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_root_causes(companyId, noticeId, id)        path = "/api/v2/companies/#{companyId}/notices/#{noticeId}/rootcauses/#{id}"
-        delete(path)      end
-
-      # Retrieve a single attachment
-      #
-      # This API is available by invitation only.
-      # Get the file attachment identified by this URL.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, 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.
-      # @param companyId [Integer] The ID of the company for this attachment.
-      # @param id [Integer] The ResourceFileId of the attachment to download.
-      # @return [Object]
-      def download_notice_attachment(companyId, id)        path = "/api/v2/companies/#{companyId}/notices/files/#{id}/attachment"
-        get(path)      end
-
-      # Retrieve a single notice.
-      #
-      # This API is available by invitation only.
-      # Get the tax notice object identified by this URL.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, 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.
-      # @param companyId [Integer] The ID of the company for this notice.
-      # @param id [Integer] The ID of this notice.
-      # @return [Object]
-      def get_notice(companyId, id)        path = "/api/v2/companies/#{companyId}/notices/#{id}"
-        get(path)      end
-
-      # Retrieve notice comments for a specific notice.
-      #
-      # This API is available by invitation only.
-      # 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, 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.
-      # @param id [Integer] The ID of the notice.
-      # @param companyId [Integer] The ID of the company that owns these notices.
-      # @return [FetchResult]
-      def get_notice_comments(id, companyId)        path = "/api/v2/companies/#{companyId}/notices/#{id}/comments"
-        get(path)      end
-
-      # Retrieve notice finance details for a specific notice.
-      #
-      # This API is available by invitation only.
-      # 'Notice finance details' is the categorical breakdown of the total charge levied by the tax authority on our customer,
-      # as broken down in our "notice log" found in Workflow. Main examples of the categories are 'Tax Due', 'Interest', 'Penalty', 'Total Abated'.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, 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.
-      # @param id [Integer] The ID of the company that owns these notices.
-      # @param companyId [Integer] The ID of the company that owns these notices.
-      # @return [FetchResult]
-      def get_notice_finance_details(id, companyId)        path = "/api/v2/companies/#{companyId}/notices/#{id}/financedetails"
-        get(path)      end
-
-      # Retrieve notice responsibilities for a specific notice.
-      #
-      # This API is available by invitation only.
-      # 'Notice responsibilities' are are those who are responsible for the notice.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, 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.
-      # @param id [Integer] The ID of the notice.
-      # @param companyId [Integer] The ID of the company that owns these notices.
-      # @return [FetchResult]
-      def get_notice_responsibilities(id, companyId)        path = "/api/v2/companies/#{companyId}/notices/#{id}/responsibilities"
-        get(path)      end
-
-      # Retrieve notice root causes for a specific notice.
-      #
-      # This API is available by invitation only.
-      # 'Notice root causes' are are those who are responsible for the notice.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, 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.
-      # @param id [Integer] The ID of the notice.
-      # @param companyId [Integer] The ID of the company that owns these notices.
-      # @return [FetchResult]
-      def get_notice_root_causes(id, companyId)        path = "/api/v2/companies/#{companyId}/notices/#{id}/rootcauses"
-        get(path)      end
-
-      # Retrieve notices for a company.
-      #
-      # This API is available by invitation only.
-      # List all tax notice objects assigned to this company.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # 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 Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, 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.
-      # @param companyId [Integer] The ID of the company that owns these notices.
-      # @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, totalRemit, ticketReferenceNo, ticketReferenceUrl, reason, type, createdByUserName, documentReference, jurisdictionName, jurisdictionType, comments, finances, responsibility, rootCause
-      # @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`.
-      # @return [FetchResult]
-      def list_notices_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/notices"
-        get(path, options)      end
-
-      # Retrieve all notices.
-      #
-      # This API is available by invitation only.
-      #
-      # This API is deprecated - please use POST `/api/v2/notices/query` API.
-      #
-      # Get multiple notice objects across all companies.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # 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 Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, 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.
-      # @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, totalRemit, ticketReferenceNo, ticketReferenceUrl, reason, type, createdByUserName, documentReference, jurisdictionName, jurisdictionType, comments, finances, responsibility, rootCause
-      # @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`.
-      # @return [FetchResult]
-      def query_notices(options={})        path = "/api/v2/notices"
-        get(path, options)      end
-
-      # Retrieve all notices.
-      #
-      # This API is available by invitation only.
-      #
-      # This API is intended to replace the GET `/api/v2/notices` API. The fetch request object is posted on the body of the request instead of the URI, so it's not limited by a set number of characters.
-      # The documentation of the GET API shows how filtering, sorting and pagination works.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, 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.
-      # @param model [Object] Query object to filter, sort and paginate the filing calendars.
-      # @return [FetchResult]
-      def query_notices_post(model)        path = "/api/v2/notices/query"
-        post(path, model)      end
-
-      # Update a single notice finance detail.
-      #
-      # This API is available by invitation only.
-      # All data from the existing object will be replaced with data in the object you PUT.
-      # To set a field's value to null, you may either set its value to null or omit that field from the object you post.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, 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.
-      # @param companyId [Integer] The ID of the company that this notice finance detail belongs to.
-      # @param noticeid [Integer] The ID of the notice finance detail you wish to update.
-      # @param financeDetailsId [Integer] The ID of the finance detail you wish to delete.
-      # @param model [Object] The notice finance detail object you wish to update.
-      # @return [Object]
-      def update_finance_details(companyId, noticeid, financeDetailsId, model)        path = "/api/v2/companies/#{companyId}/notices/#{noticeid}/financedetails/#{financedetailsid}"
-        put(path, model)      end
-
-      # Update a single notice.
-      #
-      # This API is available by invitation only.
-      # Replace the existing notice object at this URL with an updated object.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      # All data from the existing object will be replaced with data in the object you PUT.
-      # To set a field's value to null, you may either set its value to null or omit that field from the object you post.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, 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.
-      # @param companyId [Integer] The ID of the company that this notice belongs to.
-      # @param id [Integer] The ID of the notice you wish to update.
-      # @param model [Object] The notice object you wish to update.
-      # @return [Object]
-      def update_notice(companyId, id, model)        path = "/api/v2/companies/#{companyId}/notices/#{id}"
-        put(path, model)      end
-
-      # Update a single notice comment.
-      #
-      # This API is available by invitation only.
-      # All data from the existing object will be replaced with data in the object you PUT.
-      # To set a field's value to null, you may either set its value to null or omit that field from the object you post.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, 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.
-      # @param companyId [Integer] The ID of the company that this notice comment belongs to.
-      # @param noticeid [Integer] The ID of the notice you wish to update.
-      # @param commentDetailsId [Integer] The ID of the comment you wish to update.
-      # @param model [Object] The notice comment object you wish to update.
-      # @return [Object]
-      def update_notice_comments(companyId, noticeid, commentDetailsId, model)        path = "/api/v2/companies/#{companyId}/notices/#{noticeid}/commentdetails/#{commentdetailsid}"
-        put(path, model)      end
-
-      # Upload a new notice attachment.
-      #
-      # This API is available by invitation only.
-      #
-      # Uploads a file attachment for a tax notice.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, 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.
-      # @param companyId [Integer] The ID of the company for this attachment.
-      # @param model [Object] The upload request.
-      # @return [Object]
-      def upload_attachment(companyId, model)        path = "/api/v2/companies/#{companyId}/notices/files/attachment"
-        post(path, model)      end
     end
   end
 end

data/lib/avatax/client/registrar.rb

@@ -115,6 +115,16 @@ module AvaTax
       def delete_subscription(accountId, id)        path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
         delete(path)      end
 
+      # Retrieve List of Accounts by Account Migration Status
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # @param writeMode [String]  (See TssAccountMigrationId::* for a list of allowable values)
+      # @return [Object]
+      def list_accounts_by_tss_write_mode(writeMode)        path = "/api/v2/accounts/ListAccountsByTssWriteMode/#{writeMode}"
+        get(path)      end
+
       # Reset a user's password programmatically
       #
       # # For Registrar Use Only

data/lib/avatax/client/reports.rb

@@ -18,7 +18,7 @@ module AvaTax
       # * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
       # * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
       #
-      # This API works for all report types.
+      # * We throttle this API. You can only call this API up to 5 times in a minute.
       #
       # ### Security Policies
       #

data/lib/avatax/client/settings.rb

@@ -16,6 +16,11 @@ module AvaTax
       # When creating this object, you may define your own `set`, `name`, and `value` parameters.
       # To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
       #
+      # Use Set = Transactions, Name = TaxCodePrioritization/HSCodePrioritization and Value = Transaction/ItemMaster for prioritizing which TaxCodes/HsCodes should be used for calculating taxes.
+      #
+      # Example: To prioritize TaxCodes passed in a Transaction over values stored with Items when calculating tax, use
+      # Set = Transactions, Name = TaxCodePrioritization, Value = Transaction
+      #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
@@ -89,7 +94,7 @@ module AvaTax
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param companyId [Integer] The ID of the company that owns these settings
-      # @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 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:* modifiedDate, ModifiedUserId
       # @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.
@@ -117,7 +122,7 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, 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/).
+      # @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:* modifiedDate, ModifiedUserId
       # @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.

data/lib/avatax/client/transactions.rb

@@ -524,7 +524,7 @@ module AvaTax
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param dataSourceId [Integer] Optionally filter transactions to those from a specific data source.
       # @param include [String] Specifies objects to include in this fetch call
-      # @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:* exchangeRateCurrencyCode, totalDiscount, lines, addresses, locationTypes, summary, taxDetailsByTaxType, parameters, messages, invoiceMessages, isFakeTransaction
+      # @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:* exchangeRateCurrencyCode, totalDiscount, lines, addresses, locationTypes, summary, taxDetailsByTaxType, parameters, userDefinedFields, messages, invoiceMessages, isFakeTransaction, deliveryTerms
       # @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/users.rb

@@ -126,7 +126,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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param accountId [Integer] The accountID of the user you wish to list.
       # @param include [String] Optional fetch commands.
-      # @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 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:* SuppressNewUserEmail
       # @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`.
@@ -155,7 +155,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, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param include [String] Optional fetch commands.
-      # @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 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:* SuppressNewUserEmail
       # @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/version.rb

@@ -1,3 +1,3 @@
 module AvaTax
-  VERSION = '21.1.2'.freeze unless defined?(::AvaTax::VERSION)
+  VERSION = '21.7.1'.freeze unless defined?(::AvaTax::VERSION)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avatax
 version: !ruby/object:Gem::Version
-  version: 21.1.2
+  version: 21.7.1
 platform: ruby
 authors:
 - Marcus Vorwaller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-23 00:00:00.000000000 Z
+date: 2021-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -206,8 +206,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for the AvaTax API
-test_files: []
+test_files:
+- spec/avatax/client/accounts_spec.rb
+- spec/avatax/client/transactions_spec.rb
+- spec/avatax/request_spec.rb
+- spec/avatax_spec.rb
+- spec/credentials.yaml.example
+- spec/fixtures/accounts.json
+- spec/spec_helper.rb