list(criteria=None,
*auth_args)
Static Method
| source code
|
Retrieve Tax objects.
- Parameters:
criteria - a dict of parameters; valid keys are:
-
filter <table
class="filter_list"><tr><td>filter.id</td><td>Filter
by the Id of the
tax</td></tr><tr><td>filter.label</td><td>Filter
by the label(name) of the
tax</td></tr></table>
-
max Allows up to a max of 50 list items to
return. [min value: 0, max value: 50, default: 20]
-
offset Used in paging of the list. This is the
start offset of the page. [min value: 0, default: 0]
-
sorting Allows for ascending or descending
sorting of the list. The value maps properties to the sort
direction (either asc for ascending or
desc for descending). Sortable properties are:
id label.
auth_args - an Authentication object used for the API call. If no value is
passed the gloabl keys simplify.public_key and
simplify.private_key are used. For backwards compatibility the
public and private keys may be passed instead of an
Authentication object. - Returns:
- an object which contains the list of Tax objects in the
<code>list</code> property and the total number of
objects available for the given criteria in the
<code>total</code> property.
|