logo

Retrieve tax service tracking logs

Retrieves a collection of tax service tracking logs.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

q
string

Use this field to perform a partial search of text fields.

Responses
200

Tax logs retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
id
string (ResourceId) <= 50 characters

Unique resource ID.

status
integer

Response code of the HTTP request.

duration
integer

Duration of the HTTP request in milliseconds.

initiatedTime
string <date-time>

Date and time the HTTP request is initiated.

url
string

URL of the tax service endpoint.

method
string

Method of the HTTP request.

request
string

Request body of the HTTP request.

response
string

Response body of the HTTP request.

object (HttpHeaders)

HTTP headers.

property name*
additional property
string
object (HttpHeaders)

HTTP headers.

property name*
additional property
string
entityId
string

ID of the resource associated with the tax service request.

organizationId
string <= 50 characters

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

taxService
string

Name of the tax service used for the request.

Enum: "taxjar" "avalara"
taxServiceCredentialSource
string

Source of the credentials that are used to send or retrieve data.

Enum: "default" "merchant"
customerId
string

ID of the customer associated with the tax service request.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/tracking/taxes
Request samples 
// all parameters are optional
const firstCollection = await api.tracking.getAllTaxTrackingLogs();

// alternatively you can specify one or more of them
const params = {limit: 20, offset: 100};
const secondCollection = await api.tracking.getAllTaxTrackingLogs(params);

// access the collection items, each item is a Member
secondCollection.items.forEach(entry => console.log(entry.fields.eventType));
Response samples
application/json
[
  • {
    }
]
➔ Next to Retrieve a tax service tracking log