Method: AvaTax::Client::Definitions#list_nexus_by_country

Defined in:
lib/avatax/client/definitions.rb

#list_nexus_by_country(country, options = {}) ⇒ FetchResult

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. Swagger Name: AvaTaxClient

Parameters:

  • country (String) —

    The country in which you want to fetch the system nexus

  • filter (String) —

    A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
    Not filterable: streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters

  • 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.

  • skip (Integer) —

    If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.

  • orderBy (String) —

    A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.

Returns:

  • (FetchResult) 


524
525
 
# File 'lib/avatax/client/definitions.rb', line 524

def list_nexus_by_country(country, options={})        path = "/api/v2/definitions/nexus/#{country}"
get(path, options, AvaTax::VERSION)      end