About the O Series Tax GIS API

Proper tax area assignment is key to returning the expected tax calculations for your transactions, and a tax area lookup is the interaction between Vertex® O Series and your host system in determining the tax area for a given address.

Use the Use the Tax Calculation and Tax GIS API to retrieve tax area information by:

Postal address
Latitude and Longitude
Tax Area ID
Jurisdiction-defined Code

Tax Area Lookup OAS file

See OAS - Tax Calculation and Tax GIS API to download the OpenAPI Specification (OAS) file for the O Series Tax Area Lookup API.

About tax area lookups

There are two approaches to performing tax area lookups:

Look up tax areas before transaction processing and store them in the host system.
Assign tax areas during transaction processing. If multiple tax areas are returned, choose from the set of tax areas that match the set of required jurisdictions for the calculation.

For details on managing and configuring tax areas lookups, see: Manage tax area lookups in O Series on Vertex Community.

About tax areas

A tax area represents a unique set of jurisdictions. Each tax area has a unique identifier, called a Tax Area ID (TAID), that enables you to access specific jurisdiction information about the tax area in the TaxGIS database.

The jurisdiction information in the TaxGIS database is updated monthly by Vertex; you can apply these updates by using the O Series Data Update feature.
O Series references the TaxGIS database to assign Tax Area IDs to user-provided addresses.

URL for Tax Calculation and Tax GIS API endpoints

The server URL pattern for accessing tax area lookup API endpoints is in the following format:

<server:port>/vertex-ws/<version>/<endpoint>

where:

<server:port> identifies your network address.
vertex-ws designates the Vertex O Series Transaction web service APIs.
<version> is the version of the API.
<endpoint> is the target of the interaction.

For example:

 https://example.server.com:8095/vertex-ws/v2/address-lookup

Tax area lookup API endpoints

Version	Endpoint	Description
`/v2`	`/address-lookup`	POST - Retrieves tax area information using a postal address as the criteria. The address lookup process takes an address and attempts to verify and cleanse the address by determining possible Vertex-defined tax areas and associated jurisdictions.
`/v2`	`/coordinates-lookup`	POST - Retrieves tax area information using the latitude and the longitude as the criteria. The coordinates lookup process takes a latitude and a longitude and attempts to determine possible Vertex-defined tax areas and associated jurisdictions. ⚠️This lookup request is not currently available for O Series Cloud deployments.
`/v2`	`/taxareaid-lookup`	POST - Retrieves tax area information by using the unique Tax Area ID.
`/v2`	`/external-jurisdiction-lookup`	POST - Retrieves tax area information by using a jurisdiction-defined code.
`/v2`	`/find-taxareas`	POST - Retrieves tax area information for multiple searches, using any of the available search criteria.
`/v2`	`/changed-taxareas`	GET - Identifies tax areas that have changed for any reason within a date range. ⚠️This lookup request is not available for O Series tax calculation deployments hosted on Microsoft Azure.
`/v2`	`/changed-taxareas/{taxareaid}`	GET - Identifies whether a specific tax area has changed for any reason within a date range. ⚠️This lookup request is not available for O Series tax calculation deployments hosted on Microsoft Azure.