avatax 14.4.4 → 17.5.0

data/lib/avatax/client/taxcodes.rb

@@ -0,0 +1,127 @@
+module AvaTax
+  class Client
+    module TaxCodes 
+
+
+      # Create a new tax code
+      # 
+      # Create one or more new taxcode objects attached to this company.
+      # A 'TaxCode' represents a uniquely identified type of product, good, or service.
+      # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
+      # If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and
+      # taxability rules for this product in all supported jurisdictions.
+      # 
+      # @param int companyId The ID of the company that owns this tax code.
+      # @param TaxCodeModel[] model The tax code you wish to create.
+      # @return TaxCodeModel[]
+      def create_tax_codes(companyId, model)
+        path = "/api/v2/companies/#{companyId}/taxcodes"
+        
+        post(path, model)
+      end
+
+
+      # Delete a single tax code
+      # 
+      # Marks the existing TaxCode object at this URL as deleted.
+      # 
+      # @param int companyId The ID of the company that owns this tax code.
+      # @param int id The ID of the tax code you wish to delete.
+      # @return ErrorDetail[]
+      def delete_tax_code(companyId, id)
+        path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
+        
+        delete(path)
+      end
+
+
+      # Retrieve a single tax code
+      # 
+      # Get the taxcode object identified by this URL.
+      # A 'TaxCode' represents a uniquely identified type of product, good, or service.
+      # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
+      # If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and
+      # taxability rules for this product in all supported jurisdictions.
+      # 
+      # @param int companyId The ID of the company that owns this tax code
+      # @param int id The primary key of this tax code
+      # @return TaxCodeModel
+      def get_tax_code(companyId, id)
+        path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
+        
+        get(path)
+      end
+
+
+      # Retrieve tax codes for this company
+      # 
+      # List all taxcode objects attached to this company.
+      # A 'TaxCode' represents a uniquely identified type of product, good, or service.
+      # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
+      # If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and
+      # taxability rules for this product in all supported jurisdictions.
+      # 
+      # 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.
+      # 
+      # @param int companyId The ID of the company that owns these tax codes
+      # @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
+      # @param string include A comma separated list of child objects to return underneath the primary object.
+      # @param int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
+      # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
+      # @return FetchResult
+      def list_tax_codes_by_company(companyId, options={})
+        path = "/api/v2/companies/#{companyId}/taxcodes"
+        
+        get(path, options)
+      end
+
+
+      # Retrieve all tax codes
+      # 
+      # Get multiple taxcode objects across all companies.
+      # A 'TaxCode' represents a uniquely identified type of product, good, or service.
+      # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
+      # If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and
+      # taxability rules for this product in all supported jurisdictions.
+      # 
+      # 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.
+      # 
+      # @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
+      # @param string include A comma separated list of child objects to return underneath the primary object.
+      # @param int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
+      # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
+      # @return FetchResult
+      def query_tax_codes(options={})
+        path = "/api/v2/taxcodes"
+        
+        get(path, options)
+      end
+
+
+      # Update a single tax code
+      # 
+      # Replace the existing taxcode object at this URL with an updated object.
+      # A 'TaxCode' represents a uniquely identified type of product, good, or service.
+      # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
+      # If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and
+      # taxability rules for this product in all supported jurisdictions.
+      # All data from the existing object will be replaced with data in the object you PUT. 
+      # To set a field's value to null, you may either set its value to null or omit that field from the object you post.
+      # 
+      # @param int companyId The ID of the company that this tax code belongs to.
+      # @param int id The ID of the tax code you wish to update
+      # @param TaxCodeModel model The tax code you wish to update.
+      # @return TaxCodeModel
+      def update_tax_code(companyId, id, model)
+        path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
+        
+        put(path, model)
+      end
+
+    end
+  end
+end

data/lib/avatax/client/taxrules.rb

@@ -0,0 +1,127 @@
+module AvaTax
+  class Client
+    module TaxRules 
+
+
+      # Create a new tax rule
+      # 
+      # Create one or more new taxrule objects attached to this company.
+      # A tax rule represents a custom taxability rule for a product or service sold by your company.
+      # If you have obtained a custom tax ruling from an auditor that changes the behavior of certain goods or services
+      # within certain taxing jurisdictions, or you have obtained special tax concessions for certain dates or locations,
+      # you may wish to create a TaxRule object to override the AvaTax engine's default behavior in those circumstances.
+      # 
+      # @param int companyId The ID of the company that owns this tax rule.
+      # @param TaxRuleModel[] model The tax rule you wish to create.
+      # @return TaxRuleModel[]
+      def create_tax_rules(companyId, model)
+        path = "/api/v2/companies/#{companyId}/taxrules"
+        
+        post(path, model)
+      end
+
+
+      # Delete a single tax rule
+      # 
+      # Mark the TaxRule identified by this URL as deleted.
+      # 
+      # @param int companyId The ID of the company that owns this tax rule.
+      # @param int id The ID of the tax rule you wish to delete.
+      # @return ErrorDetail[]
+      def delete_tax_rule(companyId, id)
+        path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
+        
+        delete(path)
+      end
+
+
+      # Retrieve a single tax rule
+      # 
+      # Get the taxrule object identified by this URL.
+      # A tax rule represents a custom taxability rule for a product or service sold by your company.
+      # If you have obtained a custom tax ruling from an auditor that changes the behavior of certain goods or services
+      # within certain taxing jurisdictions, or you have obtained special tax concessions for certain dates or locations,
+      # you may wish to create a TaxRule object to override the AvaTax engine's default behavior in those circumstances.
+      # 
+      # @param int companyId The ID of the company that owns this tax rule
+      # @param int id The primary key of this tax rule
+      # @return TaxRuleModel
+      def get_tax_rule(companyId, id)
+        path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
+        
+        get(path)
+      end
+
+
+      # Retrieve tax rules for this company
+      # 
+      # List all taxrule objects attached to this company.
+      # A tax rule represents a custom taxability rule for a product or service sold by your company.
+      # If you have obtained a custom tax ruling from an auditor that changes the behavior of certain goods or services
+      # within certain taxing jurisdictions, or you have obtained special tax concessions for certain dates or locations,
+      # you may wish to create a TaxRule object to override the AvaTax engine's default behavior in those circumstances.
+      # 
+      # 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.
+      # 
+      # @param int companyId The ID of the company that owns these tax rules
+      # @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
+      # @param string include A comma separated list of child objects to return underneath the primary object.
+      # @param int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
+      # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
+      # @return FetchResult
+      def list_tax_rules(companyId, options={})
+        path = "/api/v2/companies/#{companyId}/taxrules"
+        
+        get(path, options)
+      end
+
+
+      # Retrieve all tax rules
+      # 
+      # Get multiple taxrule objects across all companies.
+      # A tax rule represents a custom taxability rule for a product or service sold by your company.
+      # If you have obtained a custom tax ruling from an auditor that changes the behavior of certain goods or services
+      # within certain taxing jurisdictions, or you have obtained special tax concessions for certain dates or locations,
+      # you may wish to create a TaxRule object to override the AvaTax engine's default behavior in those circumstances.
+      # 
+      # 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.
+      # 
+      # @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
+      # @param string include A comma separated list of child objects to return underneath the primary object.
+      # @param int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
+      # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
+      # @return FetchResult
+      def query_tax_rules(options={})
+        path = "/api/v2/taxrules"
+        
+        get(path, options)
+      end
+
+
+      # Update a single tax rule
+      # 
+      # Replace the existing taxrule object at this URL with an updated object.
+      # A tax rule represents a custom taxability rule for a product or service sold by your company.
+      # If you have obtained a custom tax ruling from an auditor that changes the behavior of certain goods or services
+      # within certain taxing jurisdictions, or you have obtained special tax concessions for certain dates or locations,
+      # you may wish to create a TaxRule object to override the AvaTax engine's default behavior in those circumstances.
+      # All data from the existing object will be replaced with data in the object you PUT. 
+      # To set a field's value to null, you may either set its value to null or omit that field from the object you post.
+      # 
+      # @param int companyId The ID of the company that this tax rule belongs to.
+      # @param int id The ID of the tax rule you wish to update
+      # @param TaxRuleModel model The tax rule you wish to update.
+      # @return TaxRuleModel
+      def update_tax_rule(companyId, id, model)
+        path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
+        
+        put(path, model)
+      end
+
+    end
+  end
+end

data/lib/avatax/client/transactions.rb

@@ -0,0 +1,473 @@
+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
+      # be able to append multiple calls together and form an extremely large transaction. If customer does not specify line number
+      # in the lines to be added, a new random Guid string will be generated for line number. If customer are not satisfied with
+      # the line number for the transaction lines, they can turn on the renumber switch to have REST v2 automatically renumber all 
+      # transaction lines for them, in this case, the line number becomes: "1", "2", "3", ...
+      # 
+      # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
+      # sales, purchases, inventory transfer, and returns (also called refunds).
+      # 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:
+      #  
+      # * Lines
+      # * Details (implies lines)
+      # * Summary (implies details)
+      # * Addresses
+      #  
+      # If you don't specify '$include' parameter, it will include both details and addresses.
+      # 
+      # @param string include A comma separated list of child objects to return underneath the primary object.
+      # @param AddTransactionLineModel model information about the transaction and lines to be added
+      # @return TransactionModel
+      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
+      # sales, purchases, inventory transfer, and returns (also called refunds).
+      # 
+      # When you adjust a committed transaction, the original transaction will be updated with the status code `Adjusted`, and
+      # both revisions will be available for retrieval based on their code and ID numbers.
+      # Only transactions in `Committed` status are reported by Avalara Managed Returns.
+      # 
+      # Transactions that have been previously reported to a tax authority by Avalara Managed Returns are considered `locked` and are 
+      # no longer available for adjustments.
+      # 
+      # @param string companyCode The company code of the company that recorded this transaction
+      # @param string transactionCode The transaction code to adjust
+      # @param AdjustTransactionModel model The adjustment you wish to make
+      # @return TransactionModel
+      def adjust_transaction(companyCode, transactionCode, model)
+        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/adjust"
+        
+        post(path, model)
+      end
+
+
+      # Get audit information about a transaction
+      # 
+      # Retrieve audit information about a transaction stored in AvaTax.
+      #  
+      # The 'AuditTransaction' endpoint retrieves audit information related to a specific transaction. This audit 
+      # information includes the following:
+      # 
+      # * The `CompanyId` of the company that created the transaction
+      # * The server timestamp representing the exact server time when the transaction was created
+      # * The server duration - how long it took to process this transaction
+      # * Whether exact API call details were logged
+      # * A reconstructed API call showing what the original CreateTransaction call looked like
+      # 
+      # This API can be used to examine information about a previously created transaction.
+      # 
+      # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
+      # sales, purchases, inventory transfer, and returns (also called refunds).
+      # 
+      # @param string companyCode The code identifying the company that owns this transaction
+      # @param string transactionCode The code identifying the transaction
+      # @return AuditTransactionModel
+      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' endpoint retrieves audit information related to a specific transaction. This audit 
+      # information includes the following:
+      # 
+      # * The `CompanyId` of the company that created the transaction
+      # * The server timestamp representing the exact server time when the transaction was created
+      # * The server duration - how long it took to process this transaction
+      # * Whether exact API call details were logged
+      # * A reconstructed API call showing what the original CreateTransaction call looked like
+      # 
+      # This API can be used to examine information about a previously created transaction.
+      # 
+      # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
+      # sales, purchases, inventory transfer, and returns (also called refunds).
+      # 
+      # @param string companyCode The code identifying the company that owns this transaction
+      # @param string transactionCode The code identifying the transaction
+      # @param string documentType The document type of the original transaction (See DocumentType::* for a list of allowable values)
+      # @return AuditTransactionModel
+      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.
+      # After this API call succeeds, documents will be locked and can't be voided.
+      # 
+      # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
+      # sales, purchases, inventory transfer, and returns (also called refunds).
+      # 
+      # @param BulkLockTransactionModel model bulk lock request
+      # @return BulkLockTransactionResult
+      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 to a new code.
+      # After this API call succeeds, the transaction will have a new URL matching its new code.
+      # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
+      # sales, purchases, inventory transfer, and returns (also called refunds).
+      # 
+      # @param string companyCode The company code of the company that recorded this transaction
+      # @param string transactionCode The transaction code to change
+      # @param ChangeTransactionCodeModel model The code change request you wish to execute
+      # @return TransactionModel
+      def change_transaction_code(companyCode, transactionCode, model)
+        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/changecode"
+        
+        post(path, model)
+      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.
+      # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
+      # sales, purchases, inventory transfer, and returns (also called refunds).
+      # Any changes made to a committed transaction will generate a transaction history.
+      # 
+      # @param string companyCode The company code of the company that recorded this transaction
+      # @param string transactionCode The transaction code to commit
+      # @param CommitTransactionModel model The commit request you wish to execute
+      # @return TransactionModel
+      def commit_transaction(companyCode, transactionCode, model)
+        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/commit"
+        
+        post(path, model)
+      end
+
+
+      # Create a new transaction
+      # 
+      # Records a new transaction or adjust an existing in AvaTax.
+      # 
+      # The `CreateOrAdjustTransaction` endpoint is used to create a new transaction if the input transaction does not exist
+      # or if there exists a transaction identified by code, the original transaction will be adjusted by using the meta data 
+      # in the input transaction
+      # 
+      # If you don't specify type in the provided data, a new transaction with type of SalesOrder will be recorded by default.
+      # 
+      # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
+      # sales, purchases, inventory transfer, and returns (also called refunds).
+      # 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:
+      #  
+      # * Lines
+      # * Details (implies lines)
+      # * Summary (implies details)
+      # * Addresses
+      #  
+      # If you don't specify '$include' parameter, it will include both details and addresses.
+      # 
+      # @param string include A comma separated list of child objects to return underneath the primary object.
+      # @param CreateOrAdjustTransactionModel model The transaction you wish to create
+      # @return TransactionModel
+      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.
+      # 
+      # The `CreateTransaction` endpoint uses the configuration values specified by your company to identify the correct tax rules
+      # and rates to apply to all line items in this transaction, and reports the total tax calculated by AvaTax based on your
+      # company's configuration and the data provided in this API call.
+      # 
+      # If you don't specify type in the provided data, a new transaction with type of SalesOrder will be recorded by default.
+      # 
+      # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
+      # sales, purchases, inventory transfer, and returns (also called refunds).
+      # 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:
+      #  
+      # * Lines
+      # * Details (implies lines)
+      # * Summary (implies details)
+      # * Addresses
+      #  
+      # If you don't specify '$include' parameter, it will include both details and addresses.
+      # 
+      # @param string include A comma separated list of child objects to return underneath the primary object.
+      # @param CreateTransactionModel model The transaction you wish to create
+      # @return TransactionModel
+      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
+      # be able to delete transaction lines and adjust original transaction the way they like
+      # 
+      # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
+      # sales, purchases, inventory transfer, and returns (also called refunds).
+      # 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:
+      #  
+      # * Lines
+      # * Details (implies lines)
+      # * Summary (implies details)
+      # * Addresses
+      #  
+      # If you don't specify '$include' parameter, it will include both details and addresses.
+      # 
+      # @param string include A comma separated list of child objects to return underneath the primary object.
+      # @param RemoveTransactionLineModel model information about the transaction and lines to be removed
+      # @return TransactionModel
+      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 URL.
+      # If this transaction was adjusted, the return value of this API will be the current transaction with this code, and previous revisions of
+      # the transaction will be attached to the 'history' data field.
+      # 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:
+      #  
+      # * Lines
+      # * Details (implies lines)
+      # * Summary (implies details)
+      # * Addresses
+      # 
+      # @param string companyCode The company code of the company that recorded this transaction
+      # @param string transactionCode The transaction code to retrieve
+      # @param string include A comma separated list of child objects to return underneath the primary object.
+      # @return TransactionModel
+      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
+      # 
+      # Get the current transaction identified by this URL.
+      # If this transaction was adjusted, the return value of this API will be the current transaction with this code, and previous revisions of
+      # the transaction will be attached to the 'history' data field.
+      # 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:
+      #  
+      # * Lines
+      # * Details (implies lines)
+      # * Summary (implies details)
+      # * Addresses
+      # 
+      # @param string companyCode The company code of the company that recorded this transaction
+      # @param string transactionCode The transaction code to retrieve
+      # @param string documentType The transaction type to retrieve (See DocumentType::* for a list of allowable values)
+      # @param string include A comma separated list of child objects to return underneath the primary object.
+      # @return TransactionModel
+      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
+      # by using the 'Adjust Transaction' endpoint.
+      # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
+      # sales, purchases, inventory transfer, and returns (also called refunds).
+      # 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:
+      #  
+      # * Lines
+      # * Details (implies lines)
+      # * Summary (implies details)
+      # * Addresses
+      # 
+      # @param int id The unique ID number of the transaction to retrieve
+      # @param string include A comma separated list of child objects to return underneath the primary object.
+      # @return TransactionModel
+      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.
+      # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
+      # sales, purchases, inventory transfer, and returns (also called refunds).
+      # 
+      # 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.
+      # 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:
+      #  
+      # * Lines
+      # * Details (implies lines)
+      # * Summary (implies details)
+      # * Addresses
+      # 
+      # @param string companyCode The company code of the company that recorded this transaction
+      # @param string include A comma separated list of child objects to return underneath the primary object.
+      # @param string filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
+      # @param int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
+      # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param string orderBy 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
+      # 
+      # 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.
+      # 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.
+      # 
+      # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
+      # sales, purchases, inventory transfer, and returns (also called refunds).
+      # 
+      # @param string companyCode The company code of the company that recorded this transaction
+      # @param string transactionCode The transaction code to lock
+      # @param LockTransactionModel model The lock request you wish to execute
+      # @return TransactionModel
+      def lock_transaction(companyCode, transactionCode, model)
+        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/lock"
+        
+        post(path, model)
+      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
+      # for a previously created `SalesInvoice` transaction. You can choose to create a full or partial refund, and
+      # specify individual line items from the original sale for refund.
+      # 
+      # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
+      # sales, purchases, inventory transfer, and returns (also called refunds).
+      # 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:
+      #  
+      # * Lines
+      # * Details (implies lines)
+      # * Summary (implies details)
+      # * Addresses
+      #  
+      # If you don't specify '$include' parameter, it will include both details and addresses.
+      # 
+      # @param string companyCode The code of the company that made the original sale
+      # @param string transactionCode The transaction code of the original sale
+      # @param string include A comma separated list of child objects to return underneath the primary object.
+      # @param RefundTransactionModel model Information about the refund to create
+      # @return TransactionModel
+      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 the same functions as /verify, /changecode, and /commit. You may specify one or many actions in each call to this endpoint.
+      # 
+      # @param string companyCode The company code of the company that recorded this transaction
+      # @param string transactionCode The transaction code to settle
+      # @param SettleTransactionModel model The settle request containing the actions you wish to execute
+      # @return TransactionModel
+      def settle_transaction(companyCode, transactionCode, model)
+        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/settle"
+        
+        post(path, model)
+      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.
+      # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
+      # sales, purchases, inventory transfer, and returns (also called refunds).
+      # 
+      # @param string companyCode The company code of the company that recorded this transaction
+      # @param string transactionCode The transaction code to settle
+      # @param VerifyTransactionModel model The settle request you wish to execute
+      # @return TransactionModel
+      def verify_transaction(companyCode, transactionCode, model)
+        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/verify"
+        
+        post(path, model)
+      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
+      # sales, purchases, inventory transfer, and returns (also called refunds).
+      # When you void a transaction, that transaction's status is recorded as 'DocVoided'.
+      # Transactions that have been previously reported to a tax authority by Avalara Managed Returns are no longer available to be voided.
+      # 
+      # @param string companyCode The company code of the company that recorded this transaction
+      # @param string transactionCode The transaction code to void
+      # @param VoidTransactionModel model The void request you wish to execute
+      # @return TransactionModel
+      def void_transaction(companyCode, transactionCode, model)
+        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/void"
+        
+        post(path, model)
+      end
+
+    end
+  end
+end