logo

Retrieve a tax service tracking log

Retrieves a tax service tracking log with a specified ID.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Responses
200

Tax log retrieved.

Response Schema: application/json
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.

404

Resource not found.

get/tracking/taxes/{id}
Request samples 
const entry = await api.tracking.getTaxTrackingLog({id: 'foobar-001'});
console.log(entry.fields.eventType);
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": 0,
  • "duration": 0,
  • "initiatedTime": "2019-08-24T14:15:22Z",
  • "url": "string",
  • "method": "POST",
  • "request": "string",
  • "response": "string",
  • "requestHeaders": {
    },
  • "responseHeaders": {
    },
  • "entityId": "string",
  • "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8",
  • "taxService": "taxjar",
  • "taxServiceCredentialSource": "default",
  • "customerId": "string",
  • "_links": [
    ]
}
➔ Next to Retrieve value list changes