avatax 18.7.1 → 18.9.0

data/lib/avatax/client/distancethresholds.rb

@@ -61,8 +61,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company whose DistanceThreshold objects you wish to list.
       # @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] A comma separated list of additional data to retrieve.
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @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_distance_thresholds(companyId, options={})
@@ -83,8 +83,8 @@ module AvaTax
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # @param include [String] A comma separated list of additional data to retrieve.
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def query_distance_thresholds(options={})

data/lib/avatax/client/filingcalendars.rb

@@ -158,8 +158,8 @@ module AvaTax
       # This API is available by invitation only.
       # @param companyId [Integer] The ID of the company that owns these batches
       # @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.
+      # @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`.
       # @param returnCountry [String] A comma separated list of countries
       # @param returnRegion [String] A comma separated list of regions
@@ -178,8 +178,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns these batches
       # @param filingCalendarId [Integer] Specific filing calendar id for the request
       # @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.
+      # @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_filing_requests(companyId, options={})
@@ -219,8 +219,8 @@ module AvaTax
       #
       # This API is available by invitation only.
       # @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.
+      # @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`.
       # @param returnCountry [String] If specified, fetches only filing calendars that apply to tax filings in this specific country. Uses ISO 3166 country codes.
       # @param returnRegion [String] If specified, fetches only filing calendars that apply to tax filings in this specific region. Uses ISO 3166 region codes.
@@ -241,8 +241,8 @@ module AvaTax
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param filingCalendarId [Integer] Specific filing calendar id for the request
       # @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.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def query_filing_requests(options={})

data/lib/avatax/client/filings.rb

@@ -256,10 +256,11 @@ module AvaTax
       # based on filing frequency of filing.
       # @param companyId [Integer] The ID of the company that owns the filings.
       # @param id [Integer] The id of the filing return your retrieving
+      # @param details [Boolean] Indicates if you would like the credit details returned
       # @return [FetchResult]
-      def get_filing_return(companyId, id)
+      def get_filing_return(companyId, id, options={})
         path = "/api/v2/companies/#{companyId}/filings/returns/#{id}"
-        get(path)
+        get(path, options)
       end
 
 

data/lib/avatax/client/items.rb

@@ -41,7 +41,7 @@ module AvaTax
 
       # Retrieve a single item
       #
-      # Get the item object identified by this URL.
+      # Get the `Item` object identified by this URL.
       #
       # Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
       # can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,
@@ -68,6 +68,7 @@ module AvaTax
       # team can manage your item catalog and adjust the tax behavior of items without having to modify your software.
       #
       # 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:
@@ -76,8 +77,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that defined these items
       # @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] A comma separated list of additional data to retrieve.
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @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_items_by_company(companyId, options={})
@@ -97,6 +98,7 @@ module AvaTax
       # team can manage your item catalog and adjust the tax behavior of items without having to modify your software.
       #
       # 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:
@@ -104,8 +106,8 @@ module AvaTax
       # * Attributes
       # @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] A comma separated list of additional data to retrieve.
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def query_items(options={})
@@ -124,8 +126,8 @@ module AvaTax
       # from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance
       # team can manage your item catalog and adjust the tax behavior of items without having to modify your software.
       #
-      # 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.
+      # 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 companyId [Integer] The ID of the company that this item belongs to.
       # @param id [Integer] The ID of the item you wish to update
       # @param model [Object] The item object you wish to update.

data/lib/avatax/client/jurisdictionoverrides.rb

@@ -63,8 +63,8 @@ module AvaTax
       # @param accountId [Integer] The ID of the account that owns this override
       # @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] A comma separated list of additional data to retrieve.
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @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_jurisdiction_overrides_by_account(accountId, options={})
@@ -86,8 +86,8 @@ module AvaTax
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # @param include [String] A comma separated list of additional data to retrieve.
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def query_jurisdiction_overrides(options={})

data/lib/avatax/client/locations.rb

@@ -64,8 +64,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns these locations
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # @param include [String] A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def list_locations_by_company(companyId, options={})
@@ -90,8 +90,8 @@ module AvaTax
       # * LocationSettings
       # @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] A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def query_locations(options={})

data/lib/avatax/client/multidocument.rb

@@ -191,8 +191,8 @@ module AvaTax
       # * 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 top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def list_multi_document_transactions(options={})

data/lib/avatax/client/nexus.rb

@@ -5,15 +5,25 @@ module AvaTax
 
       # Create a new nexus
       #
-      # Creates one or more new nexus objects attached to this company.
-      # The concept of 'Nexus' indicates a place where your company has sufficient physical presence and is obligated
-      # to collect and remit transaction-based taxes.
-      # When defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax
-      # in all jurisdictions affected by your transactions.
-      # Note that not all fields within a nexus can be updated; Avalara publishes a list of all defined nexus at the
-      # '/api/v2/definitions/nexus' endpoint.
-      # You may only define nexus matching the official list of declared nexus.
-      # Please allow 1 minute before using the created nexus in your transactions.
+      # Creates one or more new nexus declarations attached to this company.
+      #
+      # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
+      # taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your
+      # accountant or lawyer prior to declaring nexus.
+      #
+      # To create a nexus declaration for your company, you must first call the Definitions API `ListNexus` to obtain a
+      # list of Avalara-defined nexus. Once you have determined which nexus you wish to declare, you should customize
+      # only the user-selectable fields in this object.
+      #
+      # The user selectable fields for the nexus object are `companyId`, `effectiveDate`, `endDate`, `localNexusTypeId`,
+      # `taxId`, `nexusTypeId`, `hasPermanentEstablishment`, and `isSellerImporterOfRecord`.
+      #
+      # When calling `CreateNexus` or `UpdateNexus`, all values in your nexus object except for the user-selectable fields
+      # must match an Avalara-defined system nexus object. You can retrieve a list of Avalara-defined system nexus objects
+      # by calling `ListNexus`. If any data does not match, AvaTax may not recognize your nexus declaration.
+      #
+      # Please note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance
+      # of calculating tax for a location.
       # @param companyId [Integer] The ID of the company that owns this nexus.
       # @param model [NexusModel[]] The nexus you wish to create.
       # @return [NexusModel[]]
@@ -29,18 +39,17 @@ module AvaTax
       # API declares nexus for this company, for the list of addresses provided,
       # for the date range provided. You may also use this API to extend effective date on an already-declared nexus.
       #
-      # The concept of 'Nexus' indicates a place where your company has sufficient physical presence and is obligated
-      # to collect and remit transaction-based taxes.
-      #
-      # When defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax
-      # in all jurisdictions affected by your transactions.
+      # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
+      # taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your
+      # accountant or lawyer prior to declaring nexus.
       #
       # Note that not all fields within a nexus can be updated; Avalara publishes a list of all defined nexus at the
       # '/api/v2/definitions/nexus' endpoint.
       #
       # You may only define nexus matching the official list of declared nexus.
       #
-      # Please allow 1 minute before using the created nexus in your transactions.
+      # Please note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance
+      # of calculating tax for a location.
       # @param companyId [Integer] The ID of the company that will own this nexus.
       # @param model [DeclareNexusByAddressModel[]] The nexus you wish to create.
       # @return [NexusByAddressModel[]]
@@ -53,7 +62,13 @@ module AvaTax
       # Delete a single nexus
       #
       # Marks the existing nexus object at this URL as deleted.
-      # Please allow 1 minute to stop collecting tax in your transaction on the deleted Nexus.
+      #
+      # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
+      # taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your
+      # accountant or lawyer prior to declaring nexus.
+      #
+      # Please note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance
+      # of calculating tax for a location.
       # @param companyId [Integer] The ID of the company that owns this nexus.
       # @param id [Integer] The ID of the nexus you wish to delete.
       # @return [ErrorDetail[]]
@@ -66,10 +81,10 @@ module AvaTax
       # Retrieve a single nexus
       #
       # Get the nexus object identified by this URL.
-      # The concept of 'Nexus' indicates a place where your company has sufficient physical presence and is obligated
-      # to collect and remit transaction-based taxes.
-      # When defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax
-      # in all jurisdictions affected by your transactions.
+      #
+      # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
+      # taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your
+      # accountant or lawyer prior to declaring nexus.
       # @param companyId [Integer] The ID of the company that owns this nexus object
       # @param id [Integer] The primary key of this nexus
       # @return [Object]
@@ -83,11 +98,9 @@ module AvaTax
       #
       # Retrieves a list of nexus related to a tax form.
       #
-      # The concept of `Nexus` indicates a place where your company has sufficient physical presence and is obligated
-      # to collect and remit transaction-based taxes.
-      #
-      # When defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax
-      # in all jurisdictions affected by your transactions.
+      # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
+      # taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your
+      # accountant or lawyer prior to declaring nexus.
       #
       # This API is intended to provide useful information when examining a tax form. If you are about to begin filing
       # a tax form, you may want to know whether you have declared nexus in all the jurisdictions related to that tax
@@ -104,18 +117,18 @@ module AvaTax
       # Retrieve nexus for this company
       #
       # List all nexus objects defined for this company.
-      # The concept of 'Nexus' indicates a place where your company has sufficient physical presence and is obligated
-      # to collect and remit transaction-based taxes.
-      # When defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax
-      # in all jurisdictions affected by your transactions.
+      #
+      # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
+      # taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your
+      # accountant or lawyer prior to declaring nexus.
       #
       # 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 companyId [Integer] The ID of the company that owns these nexus objects
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # @param include [String] A comma separated list of additional data to retrieve.
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def list_nexus_by_company(companyId, options={})
@@ -127,17 +140,17 @@ module AvaTax
       # Retrieve all nexus
       #
       # Get multiple nexus objects across all companies.
-      # The concept of 'Nexus' indicates a place where your company has sufficient physical presence and is obligated
-      # to collect and remit transaction-based taxes.
-      # When defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax
-      # in all jurisdictions affected by your transactions.
+      #
+      # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
+      # taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your
+      # accountant or lawyer prior to declaring nexus.
       #
       # 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 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] A comma separated list of additional data to retrieve.
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def query_nexus(options={})
@@ -148,17 +161,25 @@ module AvaTax
 
       # Update a single nexus
       #
-      # Replace the existing nexus object at this URL with an updated object.
-      # The concept of 'Nexus' indicates a place where your company has sufficient physical presence and is obligated
-      # to collect and remit transaction-based taxes.
-      # When defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax
-      # in all jurisdictions affected by your transactions.
-      # Note that not all fields within a nexus can be updated; Avalara publishes a list of all defined nexus at the
-      # '/api/v2/definitions/nexus' endpoint.
-      # You may only define nexus matching the official list of declared nexus.
-      # 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.
-      # Please allow 1 minute for your updated Nexus to take effect on your transactions.
+      # Replace the existing nexus declaration object at this URL with an updated object.
+      #
+      # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
+      # taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your
+      # accountant or lawyer prior to declaring nexus.
+      #
+      # To create a nexus declaration for your company, you must first call the Definitions API `ListNexus` to obtain a
+      # list of Avalara-defined nexus. Once you have determined which nexus you wish to declare, you should customize
+      # only the user-selectable fields in this object.
+      #
+      # The user selectable fields for the nexus object are `companyId`, `effectiveDate`, `endDate`, `localNexusTypeId`,
+      # `taxId`, `nexusTypeId`, `hasPermanentEstablishment`, and `isSellerImporterOfRecord`.
+      #
+      # When calling `CreateNexus` or `UpdateNexus`, all values in your nexus object except for the user-selectable fields
+      # must match an Avalara-defined system nexus object. You can retrieve a list of Avalara-defined system nexus objects
+      # by calling `ListNexus`. If any data does not match, AvaTax may not recognize your nexus declaration.
+      #
+      # Please note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance
+      # of calculating tax for a location.
       # @param companyId [Integer] The ID of the company that this nexus belongs to.
       # @param id [Integer] The ID of the nexus you wish to update
       # @param model [Object] The nexus object you wish to update.

data/lib/avatax/client/notices.rb

@@ -264,8 +264,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns these notices.
       # @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] A comma separated list of additional data to retrieve.
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @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_notices_by_company(companyId, options={})
@@ -285,8 +285,8 @@ module AvaTax
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # @param include [String] A comma separated list of additional data to retrieve.
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def query_notices(options={})

data/lib/avatax/client/notifications.rb

@@ -57,8 +57,8 @@ module AvaTax
       # You may 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 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.
+      # @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_notifications(options={})

data/lib/avatax/client/registrar.rb

@@ -3,22 +3,6 @@ module AvaTax
     module Registrar 
 
 
-      # Change Password
-      #
-      # # For Registrar Use Only
-      # This API is for use by Avalara Registrar administrative users only.
-      #
-      # Allows a user to change their password via the API.
-      # This API only allows the currently authenticated user to change their password; it cannot be used to apply to a
-      # different user than the one authenticating the current API call.
-      # @param model [Object] An object containing your current password and the new password.
-      # @return [String]
-      def change_password(model)
-        path = "/api/v2/passwords"
-        put(path, model)
-      end
-
-
       # Create a new account
       #
       # # For Registrar Use Only
@@ -121,21 +105,6 @@ module AvaTax
       end
 
 
-      # Delete a single user
-      #
-      # # For Registrar Use Only
-      # This API is for use by Avalara Registrar administrative users only.
-      #
-      # Mark the user object identified by this URL as deleted.
-      # @param id [Integer] The ID of the user you wish to delete.
-      # @param accountId [Integer] The accountID of the user you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_user(id, accountId)
-        path = "/api/v2/accounts/#{accountId}/users/#{id}"
-        delete(path)
-      end
-
-
       # Reset a user's password programmatically
       #
       # # For Registrar Use Only