avatax 20.7.0 → 21.3.0

data/lib/avatax/client/locations.rb

@@ -3,6 +3,30 @@ module AvaTax
     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.
@@ -13,11 +37,8 @@ module AvaTax
       # @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
-
+      def create_locations(companyId, model)        path = "/api/v2/companies/#{companyId}/locations"
+        post(path, model)      end
 
       # Delete a single location
       #
@@ -29,11 +50,28 @@ module AvaTax
       # @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
+      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
       #
@@ -50,16 +88,59 @@ 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
+      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
       #
@@ -78,19 +159,16 @@ 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
-
+      def list_locations_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/locations"
+        get(path, options)      end
 
       # Retrieve all locations
       #
@@ -110,18 +188,15 @@ 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
-
+      def query_locations(options={})        path = "/api/v2/locations"
+        get(path, options)      end
 
       # Update a single location
       #
@@ -136,11 +211,29 @@ module AvaTax
       # @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
+      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
       #
@@ -150,15 +243,12 @@ 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
       # @return [Object]
-      def validate_location(companyId, id)
-        path = "/api/v2/companies/#{companyId}/locations/#{id}/validate"
-        get(path)
-      end
-
+      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

@@ -27,17 +27,14 @@ module AvaTax
       # ### 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
-
+      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
       #
@@ -67,15 +64,12 @@ module AvaTax
       # ### 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
-
+      def audit_multi_document_transaction(code, type)        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/audit"
+        get(path)      end
 
       # Commit a MultiDocument transaction
       #
@@ -99,14 +93,11 @@ module AvaTax
       # ### 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
-
+      def commit_multi_document_transaction(model)        path = "/api/v2/transactions/multidocument/commit"
+        post(path, model)      end
 
       # Create a new MultiDocument transaction
       #
@@ -154,15 +145,12 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param 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
-
+      def create_multi_document_transaction(model, options={})        path = "/api/v2/transactions/multidocument"
+        post(path, model, options)      end
 
       # Retrieve a MultiDocument transaction
       #
@@ -190,16 +178,13 @@ module AvaTax
       # ### 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
-
+      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
       #
@@ -236,15 +221,12 @@ module AvaTax
       # ### 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
-
+      def get_multi_document_transaction_by_id(id, options={})        path = "/api/v2/transactions/multidocument/#{id}"
+        get(path, options)      end
 
       # Retrieve all MultiDocument transactions
       #
@@ -279,18 +261,15 @@ module AvaTax
       # ### 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
-
+      def list_multi_document_transactions(options={})        path = "/api/v2/transactions/multidocument"
+        get(path, options)      end
 
       # Create a refund for a MultiDocument transaction
       #
@@ -342,17 +321,14 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param 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
-
+      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
       #
@@ -374,14 +350,11 @@ module AvaTax
       # ### 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
-
+      def verify_multi_document_transaction(model)        path = "/api/v2/transactions/multidocument/verify"
+        post(path, model)      end
 
       # Void a MultiDocument transaction
       #
@@ -406,16 +379,13 @@ module AvaTax
       # ### 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
-
+      def void_multi_document_transaction(code, type, model)        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/void"
+        post(path, model)      end
     end
   end
 end

data/lib/avatax/client/nexus.rb

@@ -31,11 +31,31 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns this nexus.
       # @param model [NexusModel[]] The nexus you wish to create.
       # @return [NexusModel[]]
-      def create_nexus(companyId, model)
-        path = "/api/v2/companies/#{companyId}/nexus"
-        post(path, model)
-      end
+      def create_nexus(companyId, model)        path = "/api/v2/companies/#{companyId}/nexus"
+        post(path, model)      end
 
+      # Add parameters to a nexus.
+      #
+      # Add parameters to the nexus.
+      # Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters".
+      #
+      # A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.
+      #
+      # A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name.
+      #
+      # To see available parameters for this item, call `/api/v2/definitions/parameters?$filter=attributeType eq Nexus`
+      #
+      # Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter "$showSubscribed=true" to the parameter definition call above.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The ID of the company that owns this nexus parameter.
+      # @param nexusId [Integer] The nexus id.
+      # @param model [NexusParameterDetailModel[]] The nexus parameters you wish to create.
+      # @return [NexusParameterDetailModel[]]
+      def create_nexus_parameters(companyId, nexusId, model)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
+        post(path, model)      end
 
       # Creates nexus for a list of addresses.
       #
@@ -61,11 +81,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that will own this nexus.
       # @param model [DeclareNexusByAddressModel[]] The nexus you wish to create.
       # @return [NexusByAddressModel[]]
-      def declare_nexus_by_address(companyId, model)
-        path = "/api/v2/companies/#{companyId}/nexus/byaddress"
-        post(path, model)
-      end
-
+      def declare_nexus_by_address(companyId, model)        path = "/api/v2/companies/#{companyId}/nexus/byaddress"
+        post(path, model)      end
 
       # Delete a single nexus
       #
@@ -85,11 +102,45 @@ module AvaTax
       # @param id [Integer] The ID of the nexus you wish to delete.
       # @param cascadeDelete [Boolean] If true, deletes all the child nexus if they exist along with parent nexus
       # @return [ErrorDetail[]]
-      def delete_nexus(companyId, id, options={})
-        path = "/api/v2/companies/#{companyId}/nexus/#{id}"
-        delete(path, options)
-      end
+      def delete_nexus(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/nexus/#{id}"
+        delete(path, options)      end
 
+      # Delete a single nexus parameter
+      #
+      # Delete a single nexus parameter.
+      # Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters".
+      #
+      # A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.
+      #
+      # A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The company id
+      # @param nexusId [Integer] The nexus id
+      # @param id [Integer] The parameter id
+      # @return [ErrorDetail[]]
+      def delete_nexus_parameter(companyId, nexusId, id)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
+        delete(path)      end
+
+      # Delete all parameters for an nexus
+      #
+      # Delete all the parameters for a given nexus.
+      # Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters".
+      #
+      # A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.
+      #
+      # A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name.
+      #
+      # ### 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 nexus.
+      # @param nexusId [Integer] The ID of the nexus you wish to delete the parameters.
+      # @return [ErrorDetail[]]
+      def delete_nexus_parameters(companyId, nexusId)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
+        delete(path)      end
 
       # Retrieve a single nexus
       #
@@ -109,11 +160,8 @@ module AvaTax
       # @param id [Integer] The primary key of this nexus
       # @param include [String] 
       # @return [Object]
-      def get_nexus(companyId, id, options={})
-        path = "/api/v2/companies/#{companyId}/nexus/#{id}"
-        get(path, options)
-      end
-
+      def get_nexus(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/nexus/#{id}"
+        get(path, options)      end
 
       # List company nexus related to a tax form
       #
@@ -137,11 +185,27 @@ module AvaTax
       # @param formCode [String] The form code that we are looking up the nexus for
       # @param include [String] 
       # @return [Object]
-      def get_nexus_by_form_code(companyId, formCode, options={})
-        path = "/api/v2/companies/#{companyId}/nexus/byform/#{formCode}"
-        get(path, options)
-      end
+      def get_nexus_by_form_code(companyId, formCode, options={})        path = "/api/v2/companies/#{companyId}/nexus/byform/#{formCode}"
+        get(path, options)      end
 
+      # Retrieve a single nexus parameter
+      #
+      # Retrieve a single nexus parameter.
+      # Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller.In AvaTax, these tax-affecting properties are called "parameters".
+      #
+      # A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.
+      #
+      # A parameter specified on a transaction line will override an nexus parameter if they share the same parameter name.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # @param companyId [Integer] The company id
+      # @param nexusId [Integer] The nexus id
+      # @param id [Integer] The parameter id
+      # @return [Object]
+      def get_nexus_parameter(companyId, nexusId, id)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
+        get(path)      end
 
       # Retrieve nexus for this company
       #
@@ -161,17 +225,39 @@ module AvaTax
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param companyId [Integer] The ID of the company that owns these nexus objects
-      # @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, 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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters, taxableNexus
       # @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_nexus_by_company(companyId, options={})
-        path = "/api/v2/companies/#{companyId}/nexus"
-        get(path, options)
-      end
+      def list_nexus_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/nexus"
+        get(path, options)      end
 
+      # Retrieve parameters for a nexus
+      #
+      # List parameters for a nexus.
+      # Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters".
+      #
+      # A parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.
+      #
+      # A parameter specified on a transaction line will override an nexus 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, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # @param companyId [Integer] The company id
+      # @param nexusId [Integer] The nexus id
+      # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* name, unit
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
+      # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
+      # @return [FetchResult]
+      def list_nexus_parameters(companyId, nexusId, options={})        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
+        get(path, options)      end
 
       # Retrieve all nexus
       #
@@ -190,17 +276,14 @@ 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, 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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, 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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters, taxableNexus
       # @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_nexus(options={})
-        path = "/api/v2/nexus"
-        get(path, options)
-      end
-
+      def query_nexus(options={})        path = "/api/v2/nexus"
+        get(path, options)      end
 
       # Update a single nexus
       #
@@ -231,11 +314,29 @@ module AvaTax
       # @param id [Integer] The ID of the nexus you wish to update
       # @param model [Object] The nexus object you wish to update.
       # @return [Object]
-      def update_nexus(companyId, id, model)
-        path = "/api/v2/companies/#{companyId}/nexus/#{id}"
-        put(path, model)
-      end
+      def update_nexus(companyId, id, model)        path = "/api/v2/companies/#{companyId}/nexus/#{id}"
+        put(path, model)      end
 
+      # Update an nexus parameter
+      #
+      # Update an nexus parameter.
+      #
+      # Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters".
+      #
+      # A parameter added to a nexus will be used in tax calculation based on the locationcode and parameter value the transaction state line might have lines added.
+      #
+      # A parameter specified on a transaction line will override an item parameter if they share the same parameter name.????? I dont know about this?
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The company id.
+      # @param nexusId [Integer] The nexus id
+      # @param id [Integer] The nexus parameter id
+      # @param model [Object] The nexus object you wish to update.
+      # @return [Object]
+      def update_nexus_parameter(companyId, nexusId, id, model)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
+        put(path, model)      end
     end
   end
 end