avatax 20.9.0 → 21.10.0

data/lib/avatax/client/transactions.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module Transactions 
-
-
-      # Add lines to an existing unlocked transaction
-      #
+module AvaTax
+  class Client
+    module Transactions 
+
+
+      # Add lines to an existing unlocked transaction
+      #
       # Add lines to an existing unlocked transaction.
       #
       #  The `AddLines` API allows you to add additional transaction lines to existing transaction, so that customer will
@@ -29,15 +29,15 @@ 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, BasicReturns.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # @param include [String] Specifies objects to include in the response after transaction is created
       # @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)      end
-
-      # Correct a previously created transaction
-      #
+      # @return [Object]
+      def add_lines(model, options={})        path = "/api/v2/companies/transactions/lines/add"
+        post(path, model, options)      end
+
+      # Correct a previously created transaction
+      #
       # Replaces the current transaction uniquely identified by this URL with a new transaction.
       #
       # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
@@ -71,18 +71,18 @@ 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, BasicReturns.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param transactionCode [String] The transaction code to adjust
       # @param documentType [String] (Optional): The document type of the transaction to adjust. (See DocumentType::* for a list of allowable values)
       # @param include [String] Specifies objects to include in this fetch call
       # @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)      end
-
-      # Get audit information about a transaction
-      #
+      # @return [Object]
+      def adjust_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/adjust"
+        post(path, model, options)      end
+
+      # Get audit information about a transaction
+      #
       # Retrieve audit information about a transaction stored in AvaTax.
       #
       # The `AuditTransaction` API retrieves audit information related to a specific transaction. This audit
@@ -110,15 +110,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, BasicReturns.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # @param companyCode [String] The code identifying the company that owns this transaction
       # @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)      end
-
-      # Get audit information about a transaction
-      #
+      # @return [Object]
+      def audit_transaction(companyCode, transactionCode)        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/audit"
+        get(path)      end
+
+      # Get audit information about a transaction
+      #
       # Retrieve audit information about a transaction stored in AvaTax.
       #
       # The `AuditTransaction` API retrieves audit information related to a specific transaction. This audit
@@ -146,16 +146,16 @@ 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, BasicReturns.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # @param companyCode [String] The code identifying the company that owns this transaction
       # @param transactionCode [String] The code identifying the transaction
       # @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)      end
-
-      # Lock a set of documents
-      #
+      # @return [Object]
+      def audit_transaction_with_type(companyCode, transactionCode, documentType)        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/types/#{documentType}/audit"
+        get(path)      end
+
+      # Lock a set of documents
+      #
       # This API is available by invitation only.
       #
       # Lock a set of transactions uniquely identified by DocumentIds provided. This API allows locking multiple documents at once.
@@ -167,14 +167,14 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires the user role Compliance Root User.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
+      # * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
       # @param model [Object] bulk lock request
-      # @return [Object]
-      def bulk_lock_transaction(model)        path = "/api/v2/transactions/lock"
-        post(path, model)      end
-
-      # Change a transaction's code
-      #
+      # @return [Object]
+      def bulk_lock_transaction(model)        path = "/api/v2/transactions/lock"
+        post(path, model)      end
+
+      # Change a transaction's code
+      #
       # Renames a transaction uniquely identified by this URL by changing its `code` value.
       #
       # This API is available as long as the transaction is in `saved` or `posted` status. When a transaction
@@ -208,18 +208,18 @@ 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, BasicReturns.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param transactionCode [String] The transaction code to change
       # @param documentType [String] (Optional): The document type of the transaction to change document code. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
       # @param include [String] Specifies objects to include in this fetch call
       # @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)      end
-
-      # Commit a transaction for reporting
-      #
+      # @return [Object]
+      def change_transaction_code(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/changecode"
+        post(path, model, options)      end
+
+      # Commit a transaction for reporting
+      #
       # Marks a transaction by changing its status to `Committed`.
       #
       # Transactions that are committed are available to be reported to a tax authority by Avalara Managed Returns.
@@ -251,18 +251,18 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param transactionCode [String] The transaction code to commit
       # @param documentType [String] (Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
       # @param include [String] Specifies objects to include in this fetch call
       # @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)      end
-
-      # Create or adjust a transaction
-      #
+      # @return [Object]
+      def commit_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/commit"
+        post(path, model, options)      end
+
+      # Create or adjust a transaction
+      #
       # Records a new transaction or adjust an existing transaction in AvaTax.
       #
       # The `CreateOrAdjustTransaction` endpoint is used to create a new transaction or update an existing one. This API
@@ -300,15 +300,15 @@ 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, BasicReturns.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # @param include [String] Specifies objects to include in the response after transaction is created
       # @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)      end
-
-      # Create a new transaction
-      #
+      # @return [Object]
+      def create_or_adjust_transaction(model, options={})        path = "/api/v2/transactions/createoradjust"
+        post(path, model, options)      end
+
+      # Create a new transaction
+      #
       # Records a new transaction in AvaTax.
       #
       # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
@@ -353,15 +353,15 @@ 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, BasicReturns.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # @param include [String] Specifies objects to include in the response after transaction is created
       # @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)      end
-
-      # Remove lines from an existing unlocked transaction
-      #
+      # @return [Object]
+      def create_transaction(model, options={})        path = "/api/v2/transactions/create"
+        post(path, model, options)      end
+
+      # Remove lines from an existing unlocked transaction
+      #
       # Remove lines to an existing unlocked transaction.
       #
       #  The `DeleteLines` API allows you to remove transaction lines from existing unlocked transaction, so that customer will
@@ -383,15 +383,15 @@ 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, BasicReturns.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # @param include [String] Specifies objects to include in the response after transaction is created
       # @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)      end
-
-      # Retrieve a single transaction by code
-      #
+      # @return [Object]
+      def delete_lines(model, options={})        path = "/api/v2/companies/transactions/lines/delete"
+        post(path, model, options)      end
+
+      # Retrieve a single transaction by code
+      #
       # Get the current transaction identified by this company code, transaction code, and document type.
       #
       # A transaction is uniquely identified by `companyCode`, `code` (often called Transaction Code), and `documentType`.
@@ -422,17 +422,17 @@ 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, BasicReturns.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param transactionCode [String] The transaction code to retrieve
       # @param documentType [String] (Optional): The document type of the transaction to retrieve (See DocumentType::* for a list of allowable values)
       # @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)      end
-
-      # Retrieve a single transaction by code
-      #
+      # @return [Object]
+      def get_transaction_by_code(companyCode, transactionCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}"
+        get(path, options)      end
+
+      # Retrieve a single transaction by code
+      #
       # DEPRECATED: Please use the `GetTransactionByCode` API instead.
       #
       # NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
@@ -446,17 +446,17 @@ 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, BasicReturns.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param transactionCode [String] The transaction code to retrieve
       # @param documentType [String] The transaction type to retrieve (See DocumentType::* for a list of allowable values)
       # @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)      end
-
-      # Retrieve a single transaction by ID
-      #
+      # @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)      end
+
+      # Retrieve a single transaction by ID
+      #
       # Get the unique transaction identified by this URL.
       #
       # This endpoint retrieves the exact transaction identified by this ID number even if that transaction was later adjusted
@@ -478,15 +478,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, BasicReturns.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # @param id [Integer] The unique ID number of the transaction to retrieve
       # @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)      end
-
-      # Retrieve all transactions
-      #
+      # @return [Object]
+      def get_transaction_by_id(id, options={})        path = "/api/v2/transactions/#{id}"
+        get(path, options)      end
+
+      # Retrieve all transactions
+      #
       # List all transactions attached to this company.
       #
       # This endpoint is limited to returning 1,000 transactions at a time maximum.
@@ -520,23 +520,23 @@ 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, BasicReturns.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param dataSourceId [Integer] Optionally filter transactions to those from a specific data source.
       # @param include [String] Specifies objects to include in this fetch call
-      # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* totalDiscount, lines, addresses, locationTypes, summary, taxDetailsByTaxType, parameters, messages, invoiceMessages, isFakeTransaction
+      # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* exchangeRateCurrencyCode, totalDiscount, lines, addresses, locationTypes, summary, taxDetailsByTaxType, parameters, userDefinedFields, messages, invoiceMessages, isFakeTransaction, deliveryTerms
       # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
-      # @return [FetchResult]
-      def list_transactions_by_company(companyCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions"
-        get(path, options)      end
-
-      # Lock a single transaction
-      #
+      # @return [FetchResult]
+      def list_transactions_by_company(companyCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions"
+        get(path, options)      end
+
+      # Lock a single transaction
+      #
       # Lock a transaction uniquely identified by this URL.
       #
-      # This API is mainly used for connector developer to simulate what happens when Returns product locks a document.
+      # 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.
@@ -567,18 +567,18 @@ 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 />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
+      # * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param transactionCode [String] The transaction code to lock
       # @param documentType [String] (Optional): The document type of the transaction to lock. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
       # @param include [String] Specifies objects to include in this fetch call
       # @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)      end
-
-      # Create a refund for a transaction
-      #
+      # @return [Object]
+      def lock_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/lock"
+        post(path, model, options)      end
+
+      # Create a refund for a transaction
+      #
       # Create a refund for a transaction.
       #
       # The `RefundTransaction` API allows you to quickly and easily create a `ReturnInvoice` representing a refund
@@ -622,19 +622,19 @@ 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, BasicReturns.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # @param companyCode [String] The code of the company that made the original sale
       # @param transactionCode [String] The transaction code of the original sale
       # @param include [String] Specifies objects to include in the response after transaction is created
       # @param documentType [String] (Optional): The document type of the transaction to refund. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
       # @param useTaxDateOverride [Boolean] (Optional): If set to true, processes refund using taxDateOverride rather than taxAmountOverride (Note: taxAmountOverride is not allowed for SST states).
       # @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)      end
-
-      # Perform multiple actions on a transaction
-      #
+      # @return [Object]
+      def refund_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/refund"
+        post(path, model, options)      end
+
+      # Perform multiple actions on a transaction
+      #
       # Performs one or more actions against the current transaction uniquely identified by this URL.
       #
       # The `SettleTransaction` API call can perform the work of `ChangeCode`, `VerifyTransaction`, and `CommitTransaction`.
@@ -666,18 +666,18 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param transactionCode [String] The transaction code to settle
       # @param documentType [String] (Optional): The document type of the transaction to settle. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
       # @param include [String] Specifies objects to include in this fetch call
       # @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)      end
-
-      # Uncommit a transaction for reporting
-      #
+      # @return [Object]
+      def settle_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/settle"
+        post(path, model, options)      end
+
+      # Uncommit a transaction for reporting
+      #
       # Adjusts a transaction by changing it to an uncommitted status.
       #
       # Transactions that have been previously reported to a tax authority by Avalara Managed Returns are considered `locked` and are
@@ -704,17 +704,17 @@ 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, BasicReturns.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param transactionCode [String] The transaction code to Uncommit
       # @param documentType [String] (Optional): The document type of the transaction to Uncommit. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
       # @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)      end
-
-      # Unvoids a transaction
-      #
+      # @return [Object]
+      def uncommit_transaction(companyCode, transactionCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/uncommit"
+        post(path, options)      end
+
+      # Unvoids a transaction
+      #
       # Unvoids a voided transaction
       #
       # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
@@ -738,17 +738,17 @@ 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, BasicReturns.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param transactionCode [String] The transaction code to commit
       # @param documentType [String] (Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
       # @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)      end
-
-      # Verify a transaction
-      #
+      # @return [Object]
+      def unvoid_transaction(companyCode, transactionCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/unvoid"
+        post(path, options)      end
+
+      # Verify a transaction
+      #
       # Verifies that the 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.
@@ -779,18 +779,18 @@ 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, BasicReturns.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param transactionCode [String] The transaction code to settle
       # @param documentType [String] (Optional): The document type of the transaction to verify. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
       # @param include [String] Specifies objects to include in this fetch call
       # @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)      end
-
-      # Void a transaction
-      #
+      # @return [Object]
+      def verify_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/verify"
+        post(path, model, options)      end
+
+      # Void a 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
@@ -823,15 +823,15 @@ 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, BasicReturns.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param transactionCode [String] The transaction code to void
       # @param documentType [String] (Optional): The document type of the transaction to void. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
       # @param include [String] Specifies objects to include in this fetch call
       # @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)      end
-    end
-  end
+      # @return [Object]
+      def void_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/void"
+        post(path, model, options)      end
+    end
+  end
 end