API Reference

Retrieve locations

get
https://example.com/tax-config-api/config/v2/locations

Returns a list of locations ordered by owningPartyId. You can filter by owningPartyName, owningPartyCode, owningPartyId and expiredIndicator using 'eq' operator. 'expiredIndicator' filter is used to retrieve locations that are no longer active i.e. their end date is prior to today. For example, owningPartyId eq '37f038e2-22ec-4e5b-93f4-f065bea65542', expiredIndicator eq 'true'.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 0
Defaults to 0

OData pagination number of records to skip. See http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip

integer
1 to 500
Defaults to 20

OData pagination number of items to return. See http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptiontop

string

The $filter system query option restricts the set of items returned. See http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter

Responses

Updated over 1 year ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json

Updated over 1 year ago