avatax 17.9.1 → 17.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0680587db1990a807285ce4440ee7ab4c2b6038c'
-  data.tar.gz: 8b57b3f6eab1e7ad9db997186e2ea8c890ad6149
+  metadata.gz: b243bcb1b50952e1aae1ffe36d1169a9048d7e71
+  data.tar.gz: 053fee8c45e531196f13e9854ddbf36097f3c9da
 SHA512:
-  metadata.gz: 64b065f5aecbc0d52212ce81ca68e4106e92e0f5ce9b702ad28b7bac6a8a6b7733b0c5721e9a499a976fcf0a405ea4e75898ff1f8d81afab0c334d4ea65fe14c
-  data.tar.gz: 1a21be078475e0781f14d183b2c79a7696c2c838a95f6da867df3642ccfb64955976441d87df713ebb14ce8d16ee7b2411e9238f89586ea642fad736a4c869ba
+  metadata.gz: d47dbf4dfe6f35453e071218abf4e0fb5fbfe857fbcd6cd6fba776ab8b420cd1fe18fc6815a8c03f0a5ae5dba3926382b2c73f24f3f5c7484cc091318f3f0090
+  data.tar.gz: 581986d1507f38f63922e2b0e8c3c74972340cbc5ab7e6f0aa0d817a5c7bf78b72ba2cab7e71a5dfa3b754c47904af74548fe777bd78a56955e778a6a619781a

data/lib/avatax/client/companies.rb

@@ -94,6 +94,20 @@ module AvaTax
       end
 
 
+      # Check the funding configuration of a company
+      #
+      # This API is available by invitation only.
+      # Requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
+      # Returns the funding configuration of the requested company.
+      # .
+      # @param companyId [Integer] The unique identifier of the company
+      # @return [Object]
+      def funding_configuration_by_company(companyId)
+        path = "/api/v2/companies/#{companyId}/funding/configuration"
+        get(path)
+      end
+
+
       # Retrieve a single company
       #
       # Get the company object identified by this URL.
@@ -162,12 +176,12 @@ module AvaTax
       end
 
 
-      # Check managed returns funding configuration for a company
+      # Check managed returns funding status for a company
       #
       # This API is available by invitation only.
       # Requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
       # Returns a list of funding setup requests and their current status.
-      # Each object in the result is a request that was made to setup or adjust funding configuration for this company.
+      # Each object in the result is a request that was made to setup or adjust funding status for this company.
       # @param id [Integer] The unique identifier of the company
       # @return [FundingStatusModel[]]
       def list_funding_requests_by_company(id)

data/lib/avatax/client/definitions.rb

@@ -289,6 +289,7 @@ module AvaTax
       # Retrieve the full list of Avalara-supported nexus for all countries and regions.
       #
       # Returns the full list of all Avalara-supported nexus for all countries and regions.
+      #
       # This API is intended to be useful if your user interface needs to display a selectable list of nexus.
       # @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/) .
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
@@ -312,9 +313,9 @@ module AvaTax
       # @param line2 [String] The first address line portion of this address.
       # @param line3 [String] The first address line portion of this address.
       # @param city [String] The city portion of this address.
-      # @param region [String] The region, state, or province code portion of this address.
+      # @param region [String] Name or ISO 3166 code identifying the region portion of the address.      This field supports many different region identifiers:   * Two and three character ISO 3166 region codes   * Fully spelled out names of the region in ISO supported languages   * Common alternative spellings for many regions      For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
       # @param postalCode [String] The postal code or zip code portion of this address.
-      # @param country [String] The two-character ISO-3166 code of the country portion of this address.
+      # @param country [String] Name or ISO 3166 code identifying the country portion of this address.      This field supports many different country identifiers:   * Two character ISO 3166 codes   * Three character ISO 3166 codes   * Fully spelled out names of the country in ISO supported languages   * Common alternative spellings for many countries      For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
       # @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/) .
       # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
@@ -329,6 +330,7 @@ module AvaTax
       # Retrieve the full list of Avalara-supported nexus for a country.
       #
       # Returns all Avalara-supported nexus for the specified country.
+      #
       # This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country.
       # @param country [String] The country in which you want to fetch the system nexus
       # @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/) .
@@ -345,6 +347,7 @@ module AvaTax
       # Retrieve the full list of Avalara-supported nexus for a country and region.
       #
       # Returns all Avalara-supported nexus for the specified country and region.
+      #
       # This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region.
       # @param country [String] The two-character ISO-3166 code for the country.
       # @param region [String] The two or three character region code for the region.

data/lib/avatax/client/filings.rb

@@ -210,11 +210,11 @@ module AvaTax
       #
       # This API is available by invitation only.
       # @param companyId [Integer] The ID of the company that owns the filings.
-      # @param filingId [Integer] The unique id of the worksheet return.
+      # @param filingReturnId [Integer] The unique id of the worksheet return.
       # @param fileId [Integer] The unique id of the document you are downloading
       # @return [Object]
-      def get_filing_attachment(companyId, filingId, options={})
-        path = "/api/v2/companies/#{companyId}/filings/#{filingId}/attachment"
+      def get_filing_attachment(companyId, filingReturnId, options={})
+        path = "/api/v2/companies/#{companyId}/filings/#{filingReturnId}/attachment"
         get(path, options)
       end
 
@@ -340,6 +340,7 @@ module AvaTax
       # @param status [String] The status of the return(s) you are trying to retrieve (See FilingStatusId::* for a list of allowable values)
       # @param country [String] The country of the return(s) you are trying to retrieve
       # @param region [String] The region of the return(s) you are trying to retrieve
+      # @param filingCalendarId [Integer] The filing calendar id of the return you are trying to retrieve
       # @return [FetchResult]
       def get_filings_returns(companyId, options={})
         path = "/api/v2/companies/#{companyId}/filings/returns"

data/lib/avatax/client/free.rb

@@ -56,9 +56,9 @@ module AvaTax
       # @param line2 [String] The street address of the location.
       # @param line3 [String] The street address of the location.
       # @param city [String] The city name of the location.
-      # @param region [String] The state or region of the location
+      # @param region [String] Name or ISO 3166 code identifying the region within the country.    This field supports many different region identifiers:   * Two and three character ISO 3166 region codes   * Fully spelled out names of the region in ISO supported languages   * Common alternative spellings for many regions    For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
       # @param postalCode [String] The postal code of the location.
-      # @param country [String] The two letter ISO-3166 country code.
+      # @param country [String] Name or ISO 3166 code identifying the country.    This field supports many different country identifiers:   * Two character ISO 3166 codes   * Three character ISO 3166 codes   * Fully spelled out names of the country in ISO supported languages   * Common alternative spellings for many countries    For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
       # @return [Object]
       def tax_rates_by_address(options={})
         path = "/api/v2/taxrates/byaddress"
@@ -66,10 +66,12 @@ module AvaTax
       end
 
 
-      # FREE API - Sales tax rates for a specified country and postal code
+      # FREE API - Sales tax rates for a specified country and postal code. This API is only available for US postal codes.
       #
       # # Free-To-Use
       #
+      # This API is only available for a US postal codes.
+      #
       # The TaxRates API is a free-to-use, no cost option for estimating sales tax rates.
       # Any customer can request a free AvaTax account and make use of the TaxRates API.
       #
@@ -93,7 +95,7 @@ module AvaTax
       #
       # Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/)
       # for information on how to upgrade to the full AvaTax CreateTransaction API.
-      # @param country [String] The two letter ISO-3166 country code.
+      # @param country [String] Name or ISO 3166 code identifying the country.    This field supports many different country identifiers:   * Two character ISO 3166 codes   * Three character ISO 3166 codes   * Fully spelled out names of the country in ISO supported languages   * Common alternative spellings for many countries    For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
       # @param postalCode [String] The postal code of the location.
       # @return [Object]
       def tax_rates_by_postal_code(options={})

data/lib/avatax/client/multidocument.rb

@@ -0,0 +1,291 @@
+module AvaTax
+  class Client
+    module MultiDocument 
+
+
+      # Adjust a MultiDocument transaction
+      #
+      # Adjusts the current MultiDocument transaction uniquely identified by this URL.
+      #
+      # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
+      # sales, purchases, inventory transfer, and returns (also called refunds).
+      #
+      # When you adjust a transaction, that transaction's status is recorded as `Adjusted`.
+      #
+      # Both the revisions will be available for retrieval based on their code and ID numbers. Only transactions in Committed status can be reported on a tax filing by Avalara's Managed Returns Service.
+      #
+      # 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 code [String] The transaction code for this MultiDocument transaction
+      # @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
+      # @param include [String] Specifies objects to include in this fetch call
+      # @param model [Object] The adjust request you wish to execute
+      # @return [Object]
+      def adjust_multi_document_transaction(code, type, model, options={})
+        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/adjust"
+        post(path, model, options)
+      end
+
+
+      # Get audit information about a MultiDocument transaction
+      #
+      # Retrieve audit information about a MultiDocument transaction stored in AvaTax.
+      #
+      # The audit API retrieves audit information related to a specific MultiDocument transaction. This audit
+      # information includes the following:
+      #
+      # * The `code` of the MultiDocument transaction
+      # * The `type` of the MultiDocument 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 create call looked 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).
+      # @param code [String] The transaction code for this MultiDocument transaction
+      # @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
+      # @return [Object]
+      def audit_multi_document_transaction(code, type)
+        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/audit"
+        get(path)
+      end
+
+
+      # Commit a MultiDocument transaction
+      #
+      # Marks a list of transactions by changing its status to `Committed`.
+      #
+      # Transactions that are committed are available to be reported to a tax authority by Avalara Managed Returns.
+      #
+      # 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 model [Object] The commit request you wish to execute
+      # @return [Object]
+      def commit_multi_document_transaction(model)
+        path = "/api/v2/transactions/multidocument/commit"
+        post(path, model)
+      end
+
+
+      # Create a new MultiDocument transaction
+      #
+      # Records a new MultiDocument transaction in AvaTax.
+      #
+      # A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can
+      # involve a marketplace of vendors, each of which contributes some portion of the final transaction. Within
+      # a MultiDocument transaction, each individual buyer and seller pair are matched up and converted to a separate
+      # document. This separation of documents allows each seller to file their taxes separately.
+      #
+      # This API will report an error if you attempt to create a transaction when one already exists with the specified `code`.
+      # If you would like the API to automatically update the transaction when it already exists, please set the `allowAdjust`
+      # value to `true`.
+      #
+      # To generate a refund for a transaction, use the `RefundTransaction` API.
+      #
+      # 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.
+      #
+      # The origin and destination locations for a transaction must be identified by either address or geocode. For address-based transactions, please
+      # provide addresses in the fields `line`, `city`, `region`, `country` and `postalCode`. For geocode-based transactions, please provide the geocode
+      # information in the fields `latitude` and `longitude`. If either `latitude` or `longitude` or both are null, the transaction will be calculated
+      # using the best available address location information.
+      #
+      # 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
+      # * SummaryOnly (omit lines and details - reduces API response size)
+      # * LinesOnly (omit details - reduces API response size)
+      # * ForceTimeout - Simulates a timeout. This adds a 30 second delay and error to your API call. This can be used to test your code to ensure it can respond correctly in the case of a dropped connection.
+      #
+      # If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`.
+      # @param include [String] Specifies objects to include in the response after transaction is created
+      # @param model [Object] the multi document transaction model
+      # @return [Object]
+      def create_multi_document_transaction(model, options={})
+        path = "/api/v2/transactions/multidocument"
+        post(path, model, options)
+      end
+
+
+      # Retrieve a MultiDocument transaction
+      #
+      # Get the current MultiDocument transaction identified by this URL.
+      #
+      # If this transaction was adjusted, the return value of this API will be the current transaction with this code.
+      #
+      # 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
+      # * SummaryOnly (omit lines and details - reduces API response size)
+      # * LinesOnly (omit details - reduces API response size)
+      # @param code [String] 
+      # @param type [String]  (See DocumentType::* for a list of allowable values)
+      # @param include [String] Specifies objects to include in the response after transaction is created
+      # @return [Object]
+      def get_multi_document_transaction_by_code_and_type(code, type, options={})
+        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}"
+        get(path, options)
+      end
+
+
+      # Retrieve a MultiDocument transaction by ID
+      #
+      # Get the unique MultiDocument transaction identified by this URL.
+      #
+      # A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can
+      # involve a marketplace of vendors, each of which contributes some portion of the final transaction. Within
+      # a MultiDocument transaction, each individual buyer and seller pair are matched up and converted to a separate
+      # document. This separation of documents allows each seller to file their taxes separately.
+      #
+      # This endpoint retrieves the exact transaction identified by this ID number even if that transaction was later adjusted
+      # by using the `AdjustTransaction` 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
+      # * SummaryOnly (omit lines and details - reduces API response size)
+      # * LinesOnly (omit details - reduces API response size)
+      # @param id [Integer] The unique ID number of the MultiDocument transaction to retrieve
+      # @param include [String] Specifies objects to include in the response after transaction is created
+      # @return [Object]
+      def get_multi_document_transaction_by_id(id, options={})
+        path = "/api/v2/transactions/multidocument/#{id}"
+        get(path, options)
+      end
+
+
+      # Retrieve all MultiDocument transactions
+      #
+      # List all MultiDocument transactions within this account.
+      #
+      # This endpoint is limited to returning 1,000 MultiDocument transactions at a time. To retrieve more than 1,000 MultiDocument
+      # transactions, please use the pagination features of the API.
+      #
+      # 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
+      # * SummaryOnly (omit lines and details - reduces API response size)
+      # * LinesOnly (omit details - reduces API response size)
+      # @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/) .
+      # @param include [String] Specifies objects to include in the response after transaction is created
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
+      # @return [FetchResult]
+      def list_multi_document_transactions(options={})
+        path = "/api/v2/transactions/multidocument"
+        get(path, options)
+      end
+
+
+      # Create a refund for a MultiDocument transaction
+      #
+      # Create a refund for a MultiDocument transaction.
+      #
+      # A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can
+      # involve a marketplace of vendors, each of which contributes some portion of the final transaction. Within
+      # a MultiDocument transaction, each individual buyer and seller pair are matched up and converted to a separate
+      # document. This separation of documents allows each seller to file their taxes separately.
+      #
+      # 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.
+      #
+      # The `RefundTransaction` API ensures that the tax amount you refund to the customer exactly matches the tax that
+      # was calculated during the original transaction, regardless of any changes to your company's configuration, rules,
+      # nexus, or any other setting.
+      #
+      # This API is intended to be a shortcut to allow you to quickly and accurately generate a refund for the following
+      # common refund scenarios:
+      #
+      # * A full refund of a previous sale
+      # * Refunding the tax that was charged on a previous sale, when the customer provides an exemption certificate after the purchase
+      # * Refunding one or more items (lines) from a previous sale
+      # * Granting a customer a percentage refund of a previous sale
+      #
+      # For more complex scenarios than the ones above, please use `CreateTransaction` with document type `ReturnInvoice` to
+      # create a custom refund 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:
+      #
+      # * Lines
+      # * Details (implies lines)
+      # * Summary (implies details)
+      # * Addresses
+      # * SummaryOnly (omit lines and details - reduces API response size)
+      # * LinesOnly (omit details - reduces API response size)
+      #
+      # If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`.
+      # @param code [String] The code of this MultiDocument transaction
+      # @param type [String] The type of this MultiDocument transaction (See DocumentType::* for a list of allowable values)
+      # @param include [String] Specifies objects to include in the response after transaction is created
+      # @param model [Object] Information about the refund to create
+      # @return [Object]
+      def refund_multi_document_transaction(code, type, model, options={})
+        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/refund"
+        post(path, model, options)
+      end
+
+
+      # Verify a MultiDocument transaction
+      #
+      # Verifies that the MultiDocument transaction uniquely identified by this URL matches certain expected values.
+      #
+      # If the transaction does not match these expected values, this API will return an error code indicating which value did not match.
+      #
+      # 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 model [Object] Information from your accounting system to verify against this MultiDocument transaction as it is stored in AvaTax
+      # @return [Object]
+      def verify_multi_document_transaction(model)
+        path = "/api/v2/transactions/multidocument/verify"
+        post(path, model)
+      end
+
+
+      # Void a MultiDocument transaction
+      #
+      # 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 Service are considered `locked`,
+      # and they are no longer available to be voided.
+      # @param code [String] The transaction code for this MultiDocument transaction
+      # @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
+      # @param model [Object] The void request you wish to execute
+      # @return [Object]
+      def void_multi_document_transaction(code, type, model)
+        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/void"
+        post(path, model)
+      end
+
+    end
+  end
+end

data/lib/avatax/client/registrar.rb

@@ -51,22 +51,6 @@ module AvaTax
       end
 
 
-      # Create new users
-      #
-      # # For Registrar Use Only
-      # This API is for use by Avalara Registrar administrative users only.
-      #
-      # Create one or more new user objects attached to this account.
-      # A user represents one person with access privileges to make API calls and work with a specific account.
-      # @param accountId [Integer] The unique ID number of the account where these users will be created.
-      # @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)
-      end
-
-
       # Delete a single account
       #
       # # For Registrar Use Only
@@ -191,4 +175,4 @@ module AvaTax
 
     end
   end
-end
+end

data/lib/avatax/client/taxcontent.rb

@@ -53,6 +53,31 @@ module AvaTax
         get(path, options)
       end
 
+
+      # Download a file listing tax rates by postal code
+      #
+      # Download a CSV file containing all five digit postal codes in the United States and their sales
+      # and use tax rates for tangible personal property.
+      #
+      # This rates file is intended to be used as a default for tax calculation when your software cannot
+      # call the `CreateTransaction` API call. When using this file, your software will be unable to
+      # handle complex tax rules such as:
+      #
+      # * Zip+9 - This tax file does not contain
+      # * Different product types - This tax file contains tangible personal property tax rates only.
+      # * Mixed sourcing - This tax file cannot be used to resolve origin-based taxes.
+      # * Threshold-based taxes - This tax file does not contain information about thresholds.
+      #
+      # If you use this file to provide default tax rates, please ensure that your software calls `CreateTransaction`
+      # to reconcile the actual transaction and determine the difference between the estimated general tax
+      # rate and the final transaction tax.
+      # @param date [DateTime] The date for which point-of-sale data would be calculated (today by default). Example input: 2016-12-31
+      # @return [Object]
+      def download_tax_rates_by_zip_code(date)
+        path = "/api/v2/taxratesbyzipcode/download/#{date}"
+        get(path)
+      end
+
     end
   end
 end

data/lib/avatax/client/transactions.rb

@@ -15,7 +15,7 @@ module AvaTax
       #
       #  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:
+      #  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)
@@ -129,8 +129,13 @@ module AvaTax
 
       # 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.
+      # 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
+      # is `committed`, it can be modified by using the [AdjustTransaction](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/AdjustTransaction/) method.
+      #
+      # 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 companyCode [String] The company code of the company that recorded this transaction
@@ -179,7 +184,7 @@ module AvaTax
       #
       # 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:
+      # 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)
@@ -203,8 +208,11 @@ module AvaTax
       #
       # 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
+      # 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).
+      #
+      # The `CreateTransaction` endpoint uses the tax profile of your company to identify the correct tax rules
+      # and rates to apply to all line items in this transaction. The end result will be the total tax calculated by AvaTax based on your
       # company's configuration and the data provided in this API call.
       #
       # The `CreateTransaction` API will report an error if a committed transaction already exists with the same `code`. To
@@ -213,11 +221,15 @@ module AvaTax
       #
       # To generate a refund for a transaction, use the `RefundTransaction` API.
       #
-      # 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.
+      # 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.
       #
-      # 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:
+      # The origin and destination locations for a transaction must be identified by either address or geocode. For address-based transactions, please
+      # provide addresses in the fields `line`, `city`, `region`, `country` and `postalCode`. For geocode-based transactions, please provide the geocode
+      # information in the fields `latitude` and `longitude`. If either `latitude` or `longitude` or both are null, the transaction will be calculated
+      # using the best available address location information.
+      #
+      # 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)
@@ -246,7 +258,7 @@ module AvaTax
       #
       #  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:
+      #  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)
@@ -271,8 +283,7 @@ module AvaTax
       #
       # To fetch other kinds of transactions, use `GetTransactionByCodeAndType`.
       #
-      # 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.
+      # If this transaction was adjusted, the return value of this API will be the current transaction with this code.
       #
       # 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:
       #
@@ -296,8 +307,7 @@ module AvaTax
       #
       # 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.
+      # If this transaction was adjusted, the return value of this API will be the current transaction with this code.
       #
       # 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:
       #
@@ -321,11 +331,14 @@ module AvaTax
       # 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.
+      # by using the `AdjustTransaction` 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:
+      #
+      # 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)
@@ -345,12 +358,18 @@ module AvaTax
       # Retrieve all transactions
       #
       # List all transactions attached to this company.
+      #
       # This endpoint is limited to returning 1,000 transactions at a time maximum.
+      #
+      # When listing transactions, you must specify a `date` range filter. If you do not specify a `$filter` that includes a `date` field
+      # criteria, the query will default to looking at only those transactions with `date` in the past 30 days.
+      #
       # 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
@@ -416,7 +435,7 @@ module AvaTax
       # For more complex scenarios than the ones above, please use `CreateTransaction` with document type `ReturnInvoice` to
       # create a custom refund 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:
+      # 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)
@@ -484,4 +503,4 @@ module AvaTax
 
     end
   end
-end
+end

data/lib/avatax/client/users.rb

@@ -3,6 +3,26 @@ module AvaTax
     module Users 
 
 
+      # Create new users
+      #
+      # Create one or more new user objects attached to this account.
+      #
+      # A user represents one person with access privileges to make API calls and work with a specific account.
+      #
+      # Users who are account administrators or company users are permitted to create user records to invite
+      # additional team members to work with AvaTax.
+      #
+      # A newly created user will receive an email inviting them to create their password. This means that you
+      # must provide a valid email address for all user accounts created.
+      # @param accountId [Integer] The unique ID number of the account where these users will be created.
+      # @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)
+      end
+
+
       # Retrieve a single user
       #
       # Get the user object identified by this URL.

data/lib/avatax/version.rb

@@ -1,3 +1,3 @@
 module AvaTax
-  VERSION = '17.9.1'.freeze unless defined?(::AvaTax::VERSION)
+  VERSION = '17.12.0'.freeze unless defined?(::AvaTax::VERSION)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avatax
 version: !ruby/object:Gem::Version
-  version: 17.9.1
+  version: 17.12.0
 platform: ruby
 authors:
 - Marcus Vorwaller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-20 00:00:00.000000000 Z
+date: 2018-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -159,6 +159,7 @@ files:
 - lib/avatax/client/items.rb
 - lib/avatax/client/jurisdictionoverrides.rb
 - lib/avatax/client/locations.rb
+- lib/avatax/client/multidocument.rb
 - lib/avatax/client/nexus.rb
 - lib/avatax/client/notices.rb
 - lib/avatax/client/onboarding.rb
@@ -216,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for the AvaTax API