Method: AvaTax::Client::Definitions#list_parameters

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

#list_parameters(options = {}) ⇒ FetchResult

Retrieve the full list of Avalara-supported extra parameters for creating transactions.

Returns the full list of Avalara-supported extra parameters for the 'Create Transaction' API call. This list of parameters is available for use when configuring your transaction. Some parameters are only available for use if you have subscribed to certain features of AvaTax. Swagger Name: AvaTaxClient

Parameters:

  • filter (String) —

    A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
    Not filterable: serviceTypes, regularExpression, attributeSubType, values

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


724
725
 
# File 'lib/avatax/client/definitions.rb', line 724

def list_parameters(options={})        path = "/api/v2/definitions/parameters"
get(path, options, AvaTax::VERSION)      end