avatax 22.8.0 → 23.8.1

data/lib/avatax/client/transactions.rb

@@ -19,6 +19,7 @@ module AvaTax
       #
       #  * Lines
       #  * Details (implies lines)
+      # * AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)
       #  * Summary (implies details)
       #  * Addresses
       # * SummaryOnly (omit lines and details - reduces API response size)
@@ -35,7 +36,7 @@ module AvaTax
       # @param model [Object] information about the transaction and lines to be added
       # @return [Object]
       def add_lines(model, options={})        path = "/api/v2/companies/transactions/lines/add"
-        post(path, model, options, "22.8.0")      end
+        post(path, model, options, AvaTax::VERSION)      end
 
       # Correct a previously created transaction
       #
@@ -55,6 +56,7 @@ module AvaTax
       #
       # * Lines
       # * Details (implies lines)
+      # * AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)
       # * Summary (implies details)
       # * Addresses
       # * SummaryOnly (omit lines and details - reduces API response size)
@@ -81,7 +83,7 @@ module AvaTax
       # @param model [Object] The adjustment you wish to make
       # @return [Object]
       def adjust_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/adjust"
-        post(path, model, options, "22.8.0")      end
+        post(path, model, options, AvaTax::VERSION)      end
 
       # Get audit information about a transaction
       #
@@ -118,7 +120,7 @@ module AvaTax
       # @param transactionCode [String] The code identifying the transaction
       # @return [Object]
       def audit_transaction(companyCode, transactionCode)        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/audit"
-        get(path, {}, "22.8.0")      end
+        get(path, {}, AvaTax::VERSION)      end
 
       # Get audit information about a transaction
       #
@@ -156,7 +158,7 @@ module AvaTax
       # @param documentType [String] The document type of the original transaction (See DocumentType::* for a list of allowable values)
       # @return [Object]
       def audit_transaction_with_type(companyCode, transactionCode, documentType)        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/types/#{documentType}/audit"
-        get(path, {}, "22.8.0")      end
+        get(path, {}, AvaTax::VERSION)      end
 
       # Lock a set of documents
       #
@@ -176,7 +178,7 @@ module AvaTax
       # @param model [Object] bulk lock request
       # @return [Object]
       def bulk_lock_transaction(model)        path = "/api/v2/transactions/lock"
-        post(path, model, {}, "22.8.0")      end
+        post(path, model, {}, AvaTax::VERSION)      end
 
       # Change a transaction's code
       #
@@ -196,6 +198,7 @@ module AvaTax
       #
       # * Lines
       # * Details (implies lines)
+      # * AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)
       # * Summary (implies details)
       # * Addresses
       # * SummaryOnly (omit lines and details - reduces API response size)
@@ -222,7 +225,7 @@ module AvaTax
       # @param model [Object] The code change request you wish to execute
       # @return [Object]
       def change_transaction_code(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/changecode"
-        post(path, model, options, "22.8.0")      end
+        post(path, model, options, AvaTax::VERSION)      end
 
       # Commit a transaction for reporting
       #
@@ -241,6 +244,7 @@ module AvaTax
       #
       # * Lines
       # * Details (implies lines)
+      # * AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)
       # * Summary (implies details)
       # * Addresses
       # * SummaryOnly (omit lines and details - reduces API response size)
@@ -266,7 +270,7 @@ module AvaTax
       # @param model [Object] The commit request you wish to execute
       # @return [Object]
       def commit_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/commit"
-        post(path, model, options, "22.8.0")      end
+        post(path, model, options, AvaTax::VERSION)      end
 
       # Create or adjust a transaction
       #
@@ -283,6 +287,8 @@ module AvaTax
       #
       # To generate a refund for a transaction, use the `RefundTransaction` API.
       #
+      # An address is required for calculation. If no address is provided at the line level, the document level address will be used.
+      #
       # If you don't specify the field `type` in your request, you will get an estimate of type `SalesOrder`, which will not be recorded in the database.
       #
       # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
@@ -291,6 +297,7 @@ module AvaTax
       #
       # * Lines
       # * Details (implies lines)
+      # * AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)
       # * Summary (implies details)
       # * Addresses
       # * SummaryOnly (omit lines and details - reduces API response size)
@@ -313,7 +320,7 @@ module AvaTax
       # @param model [Object] The transaction you wish to create or adjust
       # @return [Object]
       def create_or_adjust_transaction(model, options={})        path = "/api/v2/transactions/createoradjust"
-        post(path, model, options, "22.8.0")      end
+        post(path, model, options, AvaTax::VERSION)      end
 
       # Create a new transaction
       #
@@ -332,6 +339,8 @@ module AvaTax
       #
       # To generate a refund for a transaction, use the `RefundTransaction` API.
       #
+      # An address is required for calculation. If no address is provided at the line level, the document level address will be used.
+      #
       # The field `type` identifies the kind of transaction - for example, a sale, purchase, or refund. If you do not specify
       # a `type` value, you will receive an estimate of type `SalesOrder`, which will not be recorded.
       #
@@ -344,6 +353,7 @@ module AvaTax
       #
       # * Lines
       # * Details (implies lines)
+      # * AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)
       # * Summary (implies details)
       # * Addresses
       # * SummaryOnly (omit lines and details - reduces API response size)
@@ -367,7 +377,7 @@ module AvaTax
       # @param model [Object] The transaction you wish to create
       # @return [Object]
       def create_transaction(model, options={})        path = "/api/v2/transactions/create"
-        post(path, model, options, "22.8.0")      end
+        post(path, model, options, AvaTax::VERSION)      end
 
       # Remove lines from an existing unlocked transaction
       #
@@ -382,6 +392,7 @@ module AvaTax
       #
       #  * Lines
       #  * Details (implies lines)
+      # * AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)
       #  * Summary (implies details)
       #  * Addresses
       # * SummaryOnly (omit lines and details - reduces API response size)
@@ -398,7 +409,19 @@ module AvaTax
       # @param model [Object] information about the transaction and lines to be removed
       # @return [Object]
       def delete_lines(model, options={})        path = "/api/v2/companies/transactions/lines/delete"
-        post(path, model, options, "22.8.0")      end
+        post(path, model, options, AvaTax::VERSION)      end
+
+      # Fetches the Variance data generated for all the transactions done by Company.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyCode [String] 
+      # @return [Object]
+      def get_all_variance_report_by_company_code(companyCode)        path = "/api/v2/companies/#{companyCode}/AllVariance"
+        get(path, {}, AvaTax::VERSION)      end
 
       # Retrieve a single transaction by code
       #
@@ -416,6 +439,7 @@ module AvaTax
       #
       # * Lines
       # * Details (implies lines)
+      # * AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)
       # * Summary (implies details)
       # * Addresses
       # * SummaryOnly (omit lines and details - reduces API response size)
@@ -440,7 +464,7 @@ module AvaTax
       # @param include [String] Specifies objects to include in this fetch call
       # @return [Object]
       def get_transaction_by_code(companyCode, transactionCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}"
-        get(path, options, "22.8.0")      end
+        get(path, options, AvaTax::VERSION)      end
 
       # Retrieve a single transaction by code
       #
@@ -465,7 +489,7 @@ module AvaTax
       # @param include [String] Specifies objects to include in this fetch call
       # @return [Object]
       def get_transaction_by_code_and_type(companyCode, transactionCode, documentType, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/types/#{documentType}"
-        get(path, options, "22.8.0")      end
+        get(path, options, AvaTax::VERSION)      end
 
       # Retrieve a single transaction by ID
       #
@@ -480,6 +504,7 @@ module AvaTax
       #
       # * Lines
       # * Details (implies lines)
+      # * AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)
       # * Summary (implies details)
       # * Addresses
       # * SummaryOnly (omit lines and details - reduces API response size)
@@ -495,7 +520,20 @@ module AvaTax
       # @param include [String] Specifies objects to include in this fetch call
       # @return [Object]
       def get_transaction_by_id(id, options={})        path = "/api/v2/transactions/#{id}"
-        get(path, options, "22.8.0")      end
+        get(path, options, AvaTax::VERSION)      end
+
+      # Fetches the Variance data generated for particular Company by transaction ID
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyCode [String] 
+      # @param transactionId [String] 
+      # @return [Object]
+      def get_variance_report_by_company_code_by_transaction_id(companyCode, transactionId)        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionId}/variance"
+        get(path, {}, AvaTax::VERSION)      end
 
       # Retrieve all transactions
       #
@@ -516,6 +554,7 @@ module AvaTax
       #
       # * Lines
       # * Details (implies lines)
+      # * AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)
       # * Summary (implies details)
       # * Addresses
       # * SummaryOnly (omit lines and details - reduces API response size)
@@ -543,7 +582,7 @@ module AvaTax
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def list_transactions_by_company(companyCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions"
-        get(path, options, "22.8.0")      end
+        get(path, options, AvaTax::VERSION)      end
 
       # Lock a single transaction
       #
@@ -552,7 +591,7 @@ module AvaTax
       # This API is mainly used for connector developers to simulate what happens when the Returns product locks a document.
       # After this API call succeeds, the document will be locked and can't be voided or adjusted.
       #
-      # This API is only available to customers in Sandbox with AvaTaxPro subscription. On production servers, this API is available by invitation only.
+      # On Sandbox, this API is only available to customers who have both an AvaTaxPro and a Managed Returns subscription. On Production, this API is only available internally for the Avalara Returns team.
       #
       # If you have more than one document with the same `code`, specify the `documentType` parameter to choose between them.
       #
@@ -563,6 +602,7 @@ module AvaTax
       #
       # * Lines
       # * Details (implies lines)
+      # * AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)
       # * Summary (implies details)
       # * Addresses
       # * SummaryOnly (omit lines and details - reduces API response size)
@@ -589,7 +629,7 @@ module AvaTax
       # @param model [Object] The lock request you wish to execute
       # @return [Object]
       def lock_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/lock"
-        post(path, model, options, "22.8.0")      end
+        post(path, model, options, AvaTax::VERSION)      end
 
       # Create a refund for a transaction
       #
@@ -618,6 +658,7 @@ module AvaTax
       #
       # * Lines
       # * Details (implies lines)
+      # * AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)
       # * Summary (implies details)
       # * Addresses
       # * SummaryOnly (omit lines and details - reduces API response size)
@@ -646,7 +687,7 @@ module AvaTax
       # @param model [Object] Information about the refund to create
       # @return [Object]
       def refund_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/refund"
-        post(path, model, options, "22.8.0")      end
+        post(path, model, options, AvaTax::VERSION)      end
 
       # Perform multiple actions on a transaction
       #
@@ -665,6 +706,7 @@ module AvaTax
       #
       # * Lines
       # * Details (implies lines)
+      # * AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)
       # * Summary (implies details)
       # * Addresses
       # * SummaryOnly (omit lines and details - reduces API response size)
@@ -690,7 +732,7 @@ module AvaTax
       # @param model [Object] The data from an external system to reconcile against AvaTax
       # @return [Object]
       def settle_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/settle"
-        post(path, model, options, "22.8.0")      end
+        post(path, model, options, AvaTax::VERSION)      end
 
       # Uncommit a transaction for reporting
       #
@@ -703,6 +745,7 @@ module AvaTax
       #
       # * Lines
       # * Details (implies lines)
+      # * AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)
       # * Summary (implies details)
       # * Addresses
       # * SummaryOnly (omit lines and details - reduces API response size)
@@ -728,7 +771,7 @@ module AvaTax
       # @param include [String] Specifies objects to include in this fetch call
       # @return [Object]
       def uncommit_transaction(companyCode, transactionCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/uncommit"
-        post(path, options, "22.8.0")      end
+        post(path, {}, options, AvaTax::VERSION)      end
 
       # Unvoids a transaction
       #
@@ -738,6 +781,7 @@ module AvaTax
       #
       # * Lines
       # * Details (implies lines)
+      # * AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)
       # * Summary (implies details)
       # * Addresses
       # * SummaryOnly (omit lines and details - reduces API response size)
@@ -763,7 +807,20 @@ module AvaTax
       # @param include [String] Specifies objects to include in this fetch call
       # @return [Object]
       def unvoid_transaction(companyCode, transactionCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/unvoid"
-        post(path, options, "22.8.0")      end
+        post(path, {}, options, AvaTax::VERSION)      end
+
+      # Generates the Variance report which will capture the difference between "Tax Calculated by Avalara" Vs "Actual Tax" paid at custom clearance at line / header level.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyCode [String] 
+      # @param model [VarianceRequestModel[]] 
+      # @return [Object]
+      def variance_report(companyCode, model)        path = "/api/v2/companies/#{companyCode}/variance"
+        post(path, model, {}, AvaTax::VERSION)      end
 
       # Verify a transaction
       #
@@ -780,6 +837,7 @@ module AvaTax
       #
       # * Lines
       # * Details (implies lines)
+      # * AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)
       # * Summary (implies details)
       # * Addresses
       # * SummaryOnly (omit lines and details - reduces API response size)
@@ -806,7 +864,7 @@ module AvaTax
       # @param model [Object] The data from an external system to reconcile against AvaTax
       # @return [Object]
       def verify_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/verify"
-        post(path, model, options, "22.8.0")      end
+        post(path, model, options, AvaTax::VERSION)      end
 
       # Void a transaction
       #
@@ -825,6 +883,7 @@ module AvaTax
       #
       # * Lines
       # * Details (implies lines)
+      # * AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)
       # * Summary (implies details)
       # * Addresses
       # * SummaryOnly (omit lines and details - reduces API response size)
@@ -851,7 +910,7 @@ module AvaTax
       # @param model [Object] The void request you wish to execute. To void a transaction the code must be set to 'DocVoided'
       # @return [Object]
       def void_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/void"
-        post(path, model, options, "22.8.0")      end
+        post(path, model, options, AvaTax::VERSION)      end
     end
   end
 end

data/lib/avatax/client/upcs.rb

@@ -17,7 +17,7 @@ module AvaTax
       # @param model [UPCModel[]] The UPC you wish to create.
       # @return [UPCModel[]]
       def create_u_p_cs(companyId, model)        path = "/api/v2/companies/#{companyId}/upcs"
-        post(path, model, {}, "22.8.0")      end
+        post(path, model, {}, AvaTax::VERSION)      end
 
       # Delete a single UPC
       #
@@ -32,7 +32,7 @@ module AvaTax
       # @param id [Integer] The ID of the UPC you wish to delete.
       # @return [ErrorDetail[]]
       def delete_u_p_c(companyId, id)        path = "/api/v2/companies/#{companyId}/upcs/#{id}"
-        delete(path, {}, "22.8.0")      end
+        delete(path, {}, AvaTax::VERSION)      end
 
       # Retrieve a single UPC
       #
@@ -48,7 +48,7 @@ module AvaTax
       # @param id [Integer] The primary key of this UPC
       # @return [Object]
       def get_u_p_c(companyId, id)        path = "/api/v2/companies/#{companyId}/upcs/#{id}"
-        get(path, {}, "22.8.0")      end
+        get(path, {}, AvaTax::VERSION)      end
 
       # Retrieve UPCs for this company
       #
@@ -71,7 +71,7 @@ module AvaTax
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def list_u_p_cs_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/upcs"
-        get(path, options, "22.8.0")      end
+        get(path, options, AvaTax::VERSION)      end
 
       # Retrieve all UPCs
       #
@@ -93,7 +93,7 @@ module AvaTax
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def query_u_p_cs(options={})        path = "/api/v2/upcs"
-        get(path, options, "22.8.0")      end
+        get(path, options, AvaTax::VERSION)      end
 
       # Update a single UPC
       #
@@ -112,7 +112,7 @@ module AvaTax
       # @param model [Object] The UPC you wish to update.
       # @return [Object]
       def update_u_p_c(companyId, id, model)        path = "/api/v2/companies/#{companyId}/upcs/#{id}"
-        put(path, model, {}, "22.8.0")      end
+        put(path, model, {}, AvaTax::VERSION)      end
     end
   end
 end

data/lib/avatax/client/userdefinedfields.rb

@@ -16,13 +16,13 @@ module AvaTax
       # @param id [Integer] The id of the User Defined Field you wish to delete.
       # @return [ErrorDetail[]]
       def delete_user_defined_field(companyId, id)        path = "/api/v2/companies/#{companyId}/userdefinedfields/#{id}"
-        delete(path, {}, "22.8.0")      end
+        delete(path, {}, AvaTax::VERSION)      end
 
       # 
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] 
@@ -30,7 +30,7 @@ module AvaTax
       # @param allowDefaults [Boolean] If true this will add defaulted UDFs to the list that are not named yet
       # @return [FetchResult]
       def list_user_defined_fields_by_company_id(companyId, options={})        path = "/api/v2/companies/#{companyId}/userdefinedfields"
-        get(path, options, "22.8.0")      end
+        get(path, options, AvaTax::VERSION)      end
 
       # Update a User Defined Field identified by id for a company
       #
@@ -46,7 +46,7 @@ module AvaTax
       # @param model [Object] 
       # @return [Object]
       def update_user_defined_field(companyId, model, options={})        path = "/api/v2/companies/#{companyId}/userdefinedfields"
-        post(path, model, options, "22.8.0")      end
+        post(path, model, options, AvaTax::VERSION)      end
     end
   end
 end

data/lib/avatax/client/users.rb

@@ -20,7 +20,7 @@ module AvaTax
       # @param model [Object] An object containing your current password and the new password.
       # @return [String]
       def change_password(model)        path = "/api/v2/passwords"
-        put(path, model, {}, "22.8.0")      end
+        put(path, model, {}, AvaTax::VERSION)      end
 
       # Create new users
       #
@@ -42,7 +42,7 @@ module AvaTax
       # @param model [UserModel[]] The user or array of users you wish to create.
       # @return [UserModel[]]
       def create_users(accountId, model)        path = "/api/v2/accounts/#{accountId}/users"
-        post(path, model, {}, "22.8.0")      end
+        post(path, model, {}, AvaTax::VERSION)      end
 
       # Delete a single user
       #
@@ -61,7 +61,7 @@ module AvaTax
       # @param accountId [Integer] The accountID of the user you wish to delete.
       # @return [ErrorDetail[]]
       def delete_user(id, accountId)        path = "/api/v2/accounts/#{accountId}/users/#{id}"
-        delete(path, {}, "22.8.0")      end
+        delete(path, {}, AvaTax::VERSION)      end
 
       # Retrieve a single user
       #
@@ -74,14 +74,14 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # Swagger Name: AvaTaxClient	  
       # @param id [Integer] The ID of the user to retrieve.
       # @param accountId [Integer] The accountID of the user you wish to get.
       # @param include [String] Optional fetch commands.
       # @return [Object]
       def get_user(id, accountId, options={})        path = "/api/v2/accounts/#{accountId}/users/#{id}"
-        get(path, options, "22.8.0")      end
+        get(path, options, AvaTax::VERSION)      end
 
       # Retrieve all entitlements for a single user
       #
@@ -103,13 +103,13 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # Swagger Name: AvaTaxClient	  
       # @param id [Integer] The ID of the user to retrieve.
       # @param accountId [Integer] The accountID of the user you wish to get.
       # @return [Object]
       def get_user_entitlements(id, accountId)        path = "/api/v2/accounts/#{accountId}/users/#{id}/entitlements"
-        get(path, {}, "22.8.0")      end
+        get(path, {}, AvaTax::VERSION)      end
 
       # Retrieve users for this account
       #
@@ -128,7 +128,7 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # Swagger Name: AvaTaxClient	  
       # @param accountId [Integer] The accountID of the user you wish to list.
       # @param include [String] Optional fetch commands.
@@ -138,7 +138,7 @@ module AvaTax
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def list_users_by_account(accountId, options={})        path = "/api/v2/accounts/#{accountId}/users"
-        get(path, options, "22.8.0")      end
+        get(path, options, AvaTax::VERSION)      end
 
       # Retrieve all users
       #
@@ -159,7 +159,7 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # Swagger Name: AvaTaxClient	  
       # @param include [String] Optional fetch commands.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* SuppressNewUserEmail
@@ -168,7 +168,7 @@ module AvaTax
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def query_users(options={})        path = "/api/v2/users"
-        get(path, options, "22.8.0")      end
+        get(path, options, AvaTax::VERSION)      end
 
       # Update a single user
       #
@@ -186,7 +186,7 @@ module AvaTax
       # @param model [Object] The user object you wish to update.
       # @return [Object]
       def update_user(id, accountId, model)        path = "/api/v2/accounts/#{accountId}/users/#{id}"
-        put(path, model, {}, "22.8.0")      end
+        put(path, model, {}, AvaTax::VERSION)      end
     end
   end
 end

data/lib/avatax/client/utilities.rb

@@ -17,7 +17,7 @@ module AvaTax
       # @param serviceTypeId [String] The service to check
       # @return [Object]
       def get_my_subscription(serviceTypeId)        path = "/api/v2/utilities/subscriptions/#{serviceTypeId}"
-        get(path, {}, "22.8.0")      end
+        get(path, {}, AvaTax::VERSION)      end
 
       # List all services to which the current user is subscribed
       #
@@ -32,7 +32,7 @@ module AvaTax
       # Swagger Name: AvaTaxClient	  
       # @return [FetchResult]
       def list_my_subscriptions()        path = "/api/v2/utilities/subscriptions"
-        get(path, {}, "22.8.0")      end
+        get(path, {}, AvaTax::VERSION)      end
 
       # Tests connectivity and version of the service
       #
@@ -59,7 +59,7 @@ module AvaTax
       # Swagger Name: AvaTaxClient	  
       # @return [Object]
       def ping()        path = "/api/v2/utilities/ping"
-        get(path, {}, "22.8.0")      end
+        get(path, {}, AvaTax::VERSION)      end
     end
   end
 end

data/lib/avatax/client.rb

@@ -33,5 +33,6 @@ module AvaTax
     include AvaTax::Client::Utilities
     include AvaTax::Client::ShippingVerification
     include AvaTax::Client::AgeVerification
+    include AvaTax::Client::ECommerceToken
   end
 end

data/lib/avatax/configuration.rb

@@ -19,7 +19,8 @@ module AvaTax
       :custom_logger_options,
       :proxy,
       :faraday_response,
-      :response_big_decimal_conversion
+      :response_big_decimal_conversion,
+      :log_request_and_response_info
     ].freeze
 
     DEFAULT_APP_NAME = nil
@@ -36,6 +37,7 @@ module AvaTax
     DEFAULT_PROXY = nil
     DEFAULT_FARADAY_RESPONSE = false
     DEFAULT_RESPONSE_BIG_DECIMAL_CONVERSION = false
+    DEFAULT_LOG_REQUEST_AND_RESPONSE_INFO = false
 
     attr_accessor *VALID_OPTIONS_KEYS
 
@@ -70,6 +72,7 @@ module AvaTax
       self.proxy = DEFAULT_PROXY
       self.faraday_response = DEFAULT_FARADAY_RESPONSE
       self.response_big_decimal_conversion = DEFAULT_RESPONSE_BIG_DECIMAL_CONVERSION
+      self.log_request_and_response_info = DEFAULT_LOG_REQUEST_AND_RESPONSE_INFO
     end
 
   end