API reference
Search…
⌃K
Links

List all avalara accounts

How to fetch a collection of avalara accounts via API
To fetch a collection of avalara accounts, send a GET request to the /api/avalara_accounts endpoint.

Request

GET https://yourdomain.commercelayer.io/api/avalara_accounts

Example

Request
Response
The following request fetches a collection of avalara accounts:
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/avalara_accounts/' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token'
On success, the API responds with a 200 OK status code, returning a paginated collection of resource objects:
{
"data": [
{
"id": "xYZkjABcde",
"type": "avalara_accounts",
"links": {
"self": "https://yourdomain.commercelayer.io/api/avalara_accounts/xYZkjABcde"
},
"attributes": {
"name": "Personal tax calculator",
"created_at": "2018-01-01T12:00:00.000Z",
"updated_at": "2018-01-01T12:00:00.000Z",
"reference": "ANY-EXTERNAL-REFEFERNCE",
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
"metadata": {
"foo": "bar"
},
"username": "[email protected]",
"company_code": "MYCOMPANY",
"commit_invoice": "true",
"ddp": "true"
},
"relationships": {
"markets": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/avalara_accounts/xYZkjABcde/relationships/markets",
"related": "https://yourdomain.commercelayer.io/api/avalara_accounts/xYZkjABcde/markets"
}
},
"attachments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/avalara_accounts/xYZkjABcde/relationships/attachments",
"related": "https://yourdomain.commercelayer.io/api/avalara_accounts/xYZkjABcde/attachments"
}
},
"tax_categories": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/avalara_accounts/xYZkjABcde/relationships/tax_categories",
"related": "https://yourdomain.commercelayer.io/api/avalara_accounts/xYZkjABcde/tax_categories"
}
}
},
"meta": {
"mode": "test"
}
},
{
"other": "... 9 avalara_accounts (first page)"
}
],
"meta": {
"record_count": 140,
"page_count": 14
},
"links": {
"first": "https://yourdomain.commercelayer.io/api/avalara_accounts?page[number]=1&page[size]=10",
"next": "https://yourdomain.commercelayer.io/api/avalara_accounts?page[number]=2&page[size]=10",
"last": "https://yourdomain.commercelayer.io/api/avalara_accounts?page[number]=14&page[size]=10"
}
}
Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of avalara accounts can be sorted by the following fields:
  • name
  • id
  • created_at
  • updated_at
  • reference
  • reference_origin

Filterable fields

The list of avalara accounts can be filtered by the following fields:

Attributes

  • name
  • id
  • created_at
  • updated_at
  • reference
  • reference_origin

Relationships

  • markets
  • attachments
  • tax_categories