avatax 20.5.0 → 20.12.1

data/lib/avatax/client/jurisdictionoverrides.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module JurisdictionOverrides 
-
-
-      # Create one or more overrides
-      #
+module AvaTax
+  class Client
+    module JurisdictionOverrides 
+
+
+      # Create one or more overrides
+      #
       # Creates one or more jurisdiction override objects for this account.
       #
       # A Jurisdiction Override is a configuration setting that allows you to select the taxing
@@ -14,28 +14,28 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
       # @param accountId [Integer] The ID of the account that owns this override
       # @param model [JurisdictionOverrideModel[]] The jurisdiction override objects to create
-      # @return [JurisdictionOverrideModel[]]
-      def create_jurisdiction_overrides(accountId, model)        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
-        post(path, model)      end
-
-      # Delete a single override
-      #
+      # @return [JurisdictionOverrideModel[]]
+      def create_jurisdiction_overrides(accountId, model)        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
+        post(path, model)      end
+
+      # Delete a single override
+      #
       # Marks the item object at this URL as deleted.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
       # @param accountId [Integer] The ID of the account that owns this override
       # @param id [Integer] The ID of the override you wish to delete
-      # @return [ErrorDetail[]]
-      def delete_jurisdiction_override(accountId, id)        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
-        delete(path)      end
-
-      # Retrieve a single override
-      #
+      # @return [ErrorDetail[]]
+      def delete_jurisdiction_override(accountId, id)        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
+        delete(path)      end
+
+      # Retrieve a single override
+      #
       # Get the item object identified by this URL.
       #
       # A Jurisdiction Override is a configuration setting that allows you to select the taxing
@@ -45,15 +45,15 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param accountId [Integer] The ID of the account that owns this override
       # @param id [Integer] The primary key of this override
-      # @return [Object]
-      def get_jurisdiction_override(accountId, id)        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
-        get(path)      end
-
-      # Retrieve overrides for this account
-      #
+      # @return [Object]
+      def get_jurisdiction_override(accountId, id)        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
+        get(path)      end
+
+      # Retrieve overrides for this account
+      #
       # List all jurisdiction override objects defined for this account.
       #
       # A Jurisdiction Override is a configuration setting that allows you to select the taxing
@@ -66,19 +66,19 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param accountId [Integer] The ID of the account that owns this override
       # @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:* country, Jurisdictions
       # @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_jurisdiction_overrides_by_account(accountId, options={})        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
-        get(path, options)      end
-
-      # Retrieve all overrides
-      #
+      # @return [FetchResult]
+      def list_jurisdiction_overrides_by_account(accountId, options={})        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
+        get(path, options)      end
+
+      # Retrieve all overrides
+      #
       # Get multiple jurisdiction override objects across all companies.
       #
       # A Jurisdiction Override is a configuration setting that allows you to select the taxing
@@ -91,29 +91,29 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * 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:* country, Jurisdictions
       # @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_jurisdiction_overrides(options={})        path = "/api/v2/jurisdictionoverrides"
-        get(path, options)      end
-
-      # Update a single jurisdictionoverride
-      #
+      # @return [FetchResult]
+      def query_jurisdiction_overrides(options={})        path = "/api/v2/jurisdictionoverrides"
+        get(path, options)      end
+
+      # Update a single jurisdictionoverride
+      #
       # Replace the existing jurisdictionoverride object at this URL with an updated object.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
       # @param accountId [Integer] The ID of the account that this jurisdictionoverride belongs to.
       # @param id [Integer] The ID of the jurisdictionoverride you wish to update
       # @param model [Object] The jurisdictionoverride object you wish to update.
-      # @return [Object]
-      def update_jurisdiction_override(accountId, id, model)        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
-        put(path, model)      end
-    end
-  end
+      # @return [Object]
+      def update_jurisdiction_override(accountId, id, model)        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
+        put(path, model)      end
+    end
+  end
 end

data/lib/avatax/client/locations.rb

@@ -1,36 +1,80 @@
-module AvaTax
-  class Client
-    module Locations 
-
-
-      # Create a new location
-      #
+module AvaTax
+  class Client
+    module Locations 
+
+
+      # Add parameters to a location.
+      #
+      # Add parameters to a location.
+      #
+      # Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters".
+      #
+      # A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.
+      #
+      # A parameter specified on a transaction line will override a location parameter if they share the same parameter name.
+      #
+      # To see available parameters for this location, call `/api/v2/definitions/parameters?$filter=attributeType eq Company`
+      #
+      # Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter "$showSubscribed=true" to the parameter definition call above.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The ID of the company that owns this location parameter.
+      # @param locationId [Integer] The location id.
+      # @param model [LocationParameterModel[]] The location parameters you wish to create.
+      # @return [LocationParameterModel[]]
+      def create_location_parameters(companyId, locationId, model)        path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters"
+        post(path, model)      end
+
+      # Create a new location
+      #
       # Create one or more new location objects attached to this company.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The ID of the company that owns this location.
       # @param model [LocationModel[]] The location you wish to create.
-      # @return [LocationModel[]]
-      def create_locations(companyId, model)        path = "/api/v2/companies/#{companyId}/locations"
-        post(path, model)      end
-
-      # Delete a single location
-      #
+      # @return [LocationModel[]]
+      def create_locations(companyId, model)        path = "/api/v2/companies/#{companyId}/locations"
+        post(path, model)      end
+
+      # Delete a single location
+      #
       # Mark the location object at this URL as deleted.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The ID of the company that owns this location.
       # @param id [Integer] The ID of the location you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_location(companyId, id)        path = "/api/v2/companies/#{companyId}/locations/#{id}"
-        delete(path)      end
-
-      # Retrieve a single location
-      #
+      # @return [ErrorDetail[]]
+      def delete_location(companyId, id)        path = "/api/v2/companies/#{companyId}/locations/#{id}"
+        delete(path)      end
+
+      # Delete a single location parameter
+      #
+      # Delete a single location parameter.
+      #
+      # Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters".
+      #
+      # A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.
+      #
+      # A parameter specified on a transaction line will override a location parameter if they share the same parameter name.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The company id
+      # @param locationId [Integer] The location id
+      # @param id [Integer] The parameter id
+      # @return [ErrorDetail[]]
+      def delete_location_parameter(companyId, locationId, id)        path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
+        delete(path)      end
+
+      # Retrieve a single location
+      #
       # Get the location object identified by this URL.
       # An 'Location' represents a physical address where a company does business.
       # Many taxing authorities require that you define a list of all locations where your company does business.
@@ -44,16 +88,62 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param companyId [Integer] The ID of the company that owns this location
       # @param id [Integer] The primary key of this location
       # @param include [String] A comma separated list of additional data to retrieve.
-      # @return [Object]
-      def get_location(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/locations/#{id}"
-        get(path, options)      end
-
-      # Retrieve locations for this company
-      #
+      # @return [Object]
+      def get_location(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/locations/#{id}"
+        get(path, options)      end
+
+      # Retrieve a single company location parameter
+      #
+      # Retrieve a single location parameter.
+      #
+      # Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters".
+      #
+      # A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.
+      #
+      # A parameter specified on a transaction line will override a location parameter if they share the same parameter name.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # @param companyId [Integer] The company id
+      # @param locationId [Integer] The location id
+      # @param id [Integer] The parameter id
+      # @return [Object]
+      def get_location_parameter(companyId, locationId, id)        path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
+        get(path)      end
+
+      # Retrieve parameters for a location
+      #
+      # List parameters for a location.
+      #
+      # Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters".
+      #
+      # A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.
+      #
+      # A parameter specified on a transaction line will override a location parameter if they share the same parameter name.
+      #
+      # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
+      # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # @param companyId [Integer] The company id
+      # @param locationId [Integer] The ID of the location
+      # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* name, unit
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
+      # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
+      # @return [FetchResult]
+      def list_location_parameters(companyId, locationId, options={})        path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters"
+        get(path, options)      end
+
+      # Retrieve locations for this company
+      #
       # List all location objects defined for this company.
       # An 'Location' represents a physical address where a company does business.
       # Many taxing authorities require that you define a list of all locations where your company does business.
@@ -69,19 +159,19 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param companyId [Integer] The ID of the company that owns these 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/).<br />*Not filterable:* settings, 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:* isMarketplaceOutsideUsa, settings, parameters
       # @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_locations_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/locations"
-        get(path, options)      end
-
-      # Retrieve all locations
-      #
+      # @return [FetchResult]
+      def list_locations_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/locations"
+        get(path, options)      end
+
+      # Retrieve all locations
+      #
       # Get multiple location objects across all companies.
       # An 'Location' represents a physical address where a company does business.
       # Many taxing authorities require that you define a list of all locations where your company does business.
@@ -98,46 +188,67 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # @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:* settings, parameters
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # @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:* isMarketplaceOutsideUsa, settings, parameters
       # @param include [String] A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.
       # @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_locations(options={})        path = "/api/v2/locations"
-        get(path, options)      end
-
-      # Update a single location
-      #
+      # @return [FetchResult]
+      def query_locations(options={})        path = "/api/v2/locations"
+        get(path, options)      end
+
+      # Update a single location
+      #
       # Replace the existing location object at this URL with an updated object.
       # 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, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The ID of the company that this location belongs to.
       # @param id [Integer] The ID of the location you wish to update
       # @param model [Object] The location you wish to update.
-      # @return [Object]
-      def update_location(companyId, id, model)        path = "/api/v2/companies/#{companyId}/locations/#{id}"
-        put(path, model)      end
-
-      # Validate the location against local requirements
-      #
+      # @return [Object]
+      def update_location(companyId, id, model)        path = "/api/v2/companies/#{companyId}/locations/#{id}"
+        put(path, model)      end
+
+      # Update a location parameter
+      #
+      # Update a location parameter.
+      #
+      # Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters".
+      #
+      # A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.
+      #
+      # A parameter specified on a transaction line will override a location parameter if they share the same parameter name.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The company id.
+      # @param locationId [Integer] The location id
+      # @param id [Integer] The location parameter id
+      # @param model [Object] The location parameter object you wish to update.
+      # @return [Object]
+      def update_location_parameter(companyId, locationId, id, model)        path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
+        put(path, model)      end
+
+      # Validate the location against local requirements
+      #
       # Returns validation information for this location.
       # This API call is intended to compare this location against the currently known taxing authority rules and regulations,
       # and provide information about what additional work is required to completely setup this location.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param companyId [Integer] The ID of the company that owns this location
       # @param id [Integer] The primary key of this location
-      # @return [Object]
-      def validate_location(companyId, id)        path = "/api/v2/companies/#{companyId}/locations/#{id}/validate"
-        get(path)      end
-    end
-  end
+      # @return [Object]
+      def validate_location(companyId, id)        path = "/api/v2/companies/#{companyId}/locations/#{id}/validate"
+        get(path)      end
+    end
+  end
 end

data/lib/avatax/client/multidocument.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module MultiDocument 
-
-
-      # Adjust a MultiDocument transaction
-      #
+module AvaTax
+  class Client
+    module MultiDocument 
+
+
+      # Adjust a MultiDocument transaction
+      #
       # Adjusts the current MultiDocument transaction uniquely identified by this URL.
       #
       # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
@@ -20,22 +20,24 @@ module AvaTax
       # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
       # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
       # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
+      # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
       # * Replace ' ' with '%20' For example: document Code becomes document%20Code
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param code [String] The transaction code for this MultiDocument transaction
       # @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
       # @param include [String] Specifies objects to include in this fetch call
       # @param model [Object] The adjust request you wish to execute
-      # @return [Object]
-      def adjust_multi_document_transaction(code, type, model, options={})        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/adjust"
-        post(path, model, options)      end
-
-      # Get audit information about a MultiDocument transaction
-      #
+      # @return [Object]
+      def adjust_multi_document_transaction(code, type, model, options={})        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/adjust"
+        post(path, model, options)      end
+
+      # Get audit information about a MultiDocument transaction
+      #
       # Retrieve audit information about a MultiDocument transaction stored in AvaTax.
       #
       # The audit API retrieves audit information related to a specific MultiDocument transaction. This audit
@@ -55,20 +57,22 @@ module AvaTax
       # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
       # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
       # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
+      # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
       # * Replace ' ' with '%20' For example: document Code becomes document%20Code
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param code [String] The transaction code for this MultiDocument transaction
       # @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
-      # @return [Object]
-      def audit_multi_document_transaction(code, type)        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/audit"
-        get(path)      end
-
-      # Commit a MultiDocument transaction
-      #
+      # @return [Object]
+      def audit_multi_document_transaction(code, type)        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/audit"
+        get(path)      end
+
+      # Commit a MultiDocument transaction
+      #
       # Marks a list of transactions by changing its status to `Committed`.
       #
       # Transactions that are committed are available to be reported to a tax authority by Avalara Managed Returns.
@@ -82,19 +86,21 @@ module AvaTax
       # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
       # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
       # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
+      # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
       # * Replace ' ' with '%20' For example: document Code becomes document%20Code
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param model [Object] The commit request you wish to execute
-      # @return [Object]
-      def commit_multi_document_transaction(model)        path = "/api/v2/transactions/multidocument/commit"
-        post(path, model)      end
-
-      # Create a new MultiDocument transaction
-      #
+      # @return [Object]
+      def commit_multi_document_transaction(model)        path = "/api/v2/transactions/multidocument/commit"
+        post(path, model)      end
+
+      # Create a new MultiDocument transaction
+      #
       # Records a new MultiDocument transaction in AvaTax.
       #
       # A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can
@@ -132,20 +138,22 @@ module AvaTax
       # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
       # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
       # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
+      # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
       # * Replace ' ' with '%20' For example: document Code becomes document%20Code
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param include [String] Specifies objects to include in the response after transaction is created
       # @param model [Object] the multi document transaction model
-      # @return [Object]
-      def create_multi_document_transaction(model, options={})        path = "/api/v2/transactions/multidocument"
-        post(path, model, options)      end
-
-      # Retrieve a MultiDocument transaction
-      #
+      # @return [Object]
+      def create_multi_document_transaction(model, options={})        path = "/api/v2/transactions/multidocument"
+        post(path, model, options)      end
+
+      # Retrieve a MultiDocument transaction
+      #
       # Get the current MultiDocument transaction identified by this URL.
       #
       # If this transaction was adjusted, the return value of this API will be the current transaction with this code.
@@ -163,21 +171,23 @@ module AvaTax
       # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
       # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
       # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
+      # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
       # * Replace ' ' with '%20' For example: document Code becomes document%20Code
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
-      # @param code [String] 
-      # @param type [String]  (See DocumentType::* for a list of allowable values)
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+      # @param code [String] The multidocument code to retrieve
+      # @param type [String] The transaction type to retrieve (See DocumentType::* for a list of allowable values)
       # @param include [String] Specifies objects to include in the response after transaction is created
-      # @return [Object]
-      def get_multi_document_transaction_by_code_and_type(code, type, options={})        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}"
-        get(path, options)      end
-
-      # Retrieve a MultiDocument transaction by ID
-      #
+      # @return [Object]
+      def get_multi_document_transaction_by_code_and_type(code, type, options={})        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}"
+        get(path, options)      end
+
+      # Retrieve a MultiDocument transaction by ID
+      #
       # Get the unique MultiDocument transaction identified by this URL.
       #
       # A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can
@@ -204,20 +214,22 @@ module AvaTax
       # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
       # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
       # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
+      # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
       # * Replace ' ' with '%20' For example: document Code becomes document%20Code
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param id [Integer] The unique ID number of the MultiDocument transaction to retrieve
       # @param include [String] Specifies objects to include in the response after transaction is created
-      # @return [Object]
-      def get_multi_document_transaction_by_id(id, options={})        path = "/api/v2/transactions/multidocument/#{id}"
-        get(path, options)      end
-
-      # Retrieve all MultiDocument transactions
-      #
+      # @return [Object]
+      def get_multi_document_transaction_by_id(id, options={})        path = "/api/v2/transactions/multidocument/#{id}"
+        get(path, options)      end
+
+      # Retrieve all MultiDocument transactions
+      #
       # List all MultiDocument transactions within this account.
       #
       # This endpoint is limited to returning 1,000 MultiDocument transactions at a time. To retrieve more than 1,000 MultiDocument
@@ -242,23 +254,25 @@ module AvaTax
       # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
       # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
       # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
+      # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
       # * Replace ' ' with '%20' For example: document Code becomes document%20Code
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param 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:* documents
       # @param include [String] Specifies objects to include in the response after transaction is created
       # @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_multi_document_transactions(options={})        path = "/api/v2/transactions/multidocument"
-        get(path, options)      end
-
-      # Create a refund for a MultiDocument transaction
-      #
+      # @return [FetchResult]
+      def list_multi_document_transactions(options={})        path = "/api/v2/transactions/multidocument"
+        get(path, options)      end
+
+      # Create a refund for a MultiDocument transaction
+      #
       # Create a refund for a MultiDocument transaction.
       #
       # A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can
@@ -300,22 +314,24 @@ module AvaTax
       # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
       # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
       # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
+      # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
       # * Replace ' ' with '%20' For example: document Code becomes document%20Code
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param code [String] The code of this MultiDocument transaction
       # @param type [String] The type of this MultiDocument transaction (See DocumentType::* for a list of allowable values)
       # @param include [String] Specifies objects to include in the response after transaction is created
       # @param model [Object] Information about the refund to create
-      # @return [Object]
-      def refund_multi_document_transaction(code, type, model, options={})        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/refund"
-        post(path, model, options)      end
-
-      # Verify a MultiDocument transaction
-      #
+      # @return [Object]
+      def refund_multi_document_transaction(code, type, model, options={})        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/refund"
+        post(path, model, options)      end
+
+      # Verify a MultiDocument transaction
+      #
       # Verifies that the MultiDocument transaction uniquely identified by this URL matches certain expected values.
       #
       # If the transaction does not match these expected values, this API will return an error code indicating which value did not match.
@@ -327,19 +343,21 @@ module AvaTax
       # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
       # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
       # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
+      # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
       # * Replace ' ' with '%20' For example: document Code becomes document%20Code
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param model [Object] Information from your accounting system to verify against this MultiDocument transaction as it is stored in AvaTax
-      # @return [Object]
-      def verify_multi_document_transaction(model)        path = "/api/v2/transactions/multidocument/verify"
-        post(path, model)      end
-
-      # Void a MultiDocument transaction
-      #
+      # @return [Object]
+      def verify_multi_document_transaction(model)        path = "/api/v2/transactions/multidocument/verify"
+        post(path, model)      end
+
+      # Void a MultiDocument transaction
+      #
       # Voids the current transaction uniquely identified by this URL.
       #
       # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
@@ -354,18 +372,20 @@ module AvaTax
       # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
       # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
       # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
+      # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
+      # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
       # * Replace ' ' with '%20' For example: document Code becomes document%20Code
       #
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param code [String] The transaction code for this MultiDocument transaction
       # @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
       # @param model [Object] The void request you wish to execute
-      # @return [Object]
-      def void_multi_document_transaction(code, type, model)        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/void"
-        post(path, model)      end
-    end
-  end
+      # @return [Object]
+      def void_multi_document_transaction(code, type, model)        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/void"
+        post(path, model)      end
+    end
+  end
 end