Batch Tax Area Lookup
Learn about batch tax area lookups.
Lookup tax areas by batch
Endpoint | Method | Key value | Required fields |
---|---|---|---|
/v2/find-taxareas | POST | lookupRequest | postalAddress and/or coordinates , latitude , longitude and/or taxAreaId and/or externalJurisdictionCode , country |
This request retrieves tax area information for multiple searches, using any of the available search criteria. This operation allows multiple tax area searches in a single web service call. All the available search criteria may be used.
Sample request - Batch lookup
[
{
"lookupId": "string",
"lookupRequest": {
"asOfDate": "2024-03-07",
"postalAddress": {
"city": "string",
"country": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string"
},
"returnTimeElapsedDetailsIndicator": true
}
}
]
Sample response - Batch lookup
{
"data": [
{
"lookupId": "string",
"results": [
{
"addressCleansingResultMessages": [
{
"code": "string",
"type": "string",
"value": "string"
}
],
"asOfDate": "2024-03-07",
"confidenceIndicator": "string",
"jurisdictions": [
{
"effectiveDate": "2024-03-07",
"expirationDate": "2024-03-07",
"externalJurisdictionCode": "string",
"jurisdictionId": "string",
"jurisdictionType": "APO",
"value": "string"
}
],
"postalAddresses": [
{
"city": "string",
"country": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string"
}
],
"statuses": [
{
"lookupResult": "NORMAL",
"value": "string"
}
],
"taxAreaId": "string"
}
]
}
],
"meta": {
"app": "string",
"timeElapsed(ms)": 0,
"timeReceived": "2024-03-07T19:44:37Z",
"timeElapsedDetails": [
{
"key": "string",
"value": "string"
}
]
}
}
Updated 3 months ago