geo (1.3.0)

Download OpenAPI specification:Download

Geographic Microservice

Authentication

ApiKeyAuth

Security Scheme Type API Key
Header parameter name: X-API-Key

Coordinate

Delete a Coordinate

Delete a Taxneuxs Coordinate record from the Coordinate database

Authorizations:
query Parameters
coordinateId
string

Taxnexus Record Id of a Coordinate

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Get a single Taxnexus Coordinate from Address Information

Return a fully-populated Coordinate record including Tax Type array

Authorizations:
query Parameters
address
string

Postal Address URL encoded; partial addresses allowed

placeName
string

Alternate City, ST format to backup addressQuery

coordinateId
string

Taxnexus Record Id of a Coordinate

date
string

Transaction date (defaults to current)

ref
string

Source system reference

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Process a batch of Coordinate GET requests

Processes a batch of Coordinate GET requests and returns an array of Coordinate records including Tax Type IDs

Authorizations:
Request Body schema: application/json

An array of new Coordinate records

Array of objects (CoordinateRequestItem)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Get a single Taxnexus Coordinate from Address Information

Response is one minimized Coordinate record including Tax Type IDs

Authorizations:
query Parameters
address
string

Postal Address URL encoded; partial addresses allowed

placeName
string

Alternate City, ST format to backup addressQuery

coordinateId
string

Taxnexus Record Id of a Coordinate

date
string

Transaction date (defaults to current)

ref
string

Source system reference

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Get a single Taxnexus Coordinate as an observable array

Response is one minimized Coordinate record including Tax Type IDs as an observable array

Authorizations:
query Parameters
address
string

Postal Address URL encoded; partial addresses allowed

placeName
string

Alternate City, ST format to backup addressQuery

coordinateId
string

Taxnexus Record Id of a Coordinate

date
string

Transaction date (defaults to current)

ref
string

Source system reference

Responses

Response samples

Content type
application/json
[
  • {
    }
]

cors

getCoordinatesOptions

CORS support

Responses

getCoordinatesObservableOptions

CORS support

Responses

getCountiesOptions

CORS support

Responses

getCountiesObservableOptions

CORS support

Responses

getCountriesOptions

CORS support

Responses

getCountriesObservableOptions

CORS support

Responses

getDomainsOptions

CORS support

Responses

getDomainsObservableOptions

CORS support

Responses

getPlacesOptions

CORS support

Responses

getPlacesObservableOptions

CORS support

Responses

getStatesOptions

CORS support

Responses

getStatesObservableOptions

CORS support

Responses

getTaxnexusCodesOptions

CORS support

Responses

getTaxnexusCodesObservableOptions

CORS support

Responses

getTaxRatesOptions

CORS support

Responses

getTaxRateObservableOptions

CORS support

Responses

getTaxTypesOptions

CORS support

Responses

getTaxTypeObservableOptions

CORS support

Responses

County

Retrieve Counties

Retrieve Counties, filter with parameters

Authorizations:
query Parameters
state
string

The State or Province abbreviation (2 char)

county
string

The County Name

countyId
string

The ID of this Object

geocode
string

The Geocode of this Place record

limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip? (default 0)

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Store new Counties

Create New Counties

Authorizations:
Request Body schema: application/json
Array of objects (County)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Get counties in an observable array

Returns a county retrieval in a observable array

Authorizations:
query Parameters
state
string

The State or Province abbreviation (2 char)

county
string

The County Name

countyId
string

The ID of this Object

geocode
string

The Geocode of this Place record

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Country

Retrieve Countries

Retrieve Countries, filter with parameters

Authorizations:
query Parameters
countryId
string

The ID of this Object

countryCode
string

The Country abbreviation (2 char)

limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip? (default 0)

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Store new Countries

Create New Countries

Authorizations:
Request Body schema: application/json
Array of objects (Country)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Get countries in an observable array

Returns a country retrieval in a observable array

Authorizations:
query Parameters
countryId
string

The ID of this Object

countryCode
string

The Country abbreviation (2 char)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Domain

Get Domain records

Return all Domain records or by ID

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Store new Domain records

Store a batch of new Domain records

Authorizations:
Request Body schema: application/json
Array of objects (Domain)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Get domains in an observable array

Returns a domain retrieval in a observable array

Authorizations:

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Place

Retrieve Places

Retrieve Places, filter with parameters

Authorizations:
query Parameters
limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip? (default 0)

state
string

The State or Province abbreviation (2 char)

placeId
string

The ID of a Place record

geocode
string

The Geocode of this Place record

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Store new Place records

Store a batch of new Place records

Authorizations:
Request Body schema: application/json

The new Places request package

Array of objects (Place)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Get places in an observable array

Returns a place retrieval in a observable array

Authorizations:
query Parameters
state
string

The State or Province abbreviation (2 char)

placeId
string

The ID of a Place record

geocode
string

The Geocode of this Place record

Responses

Response samples

Content type
application/json
[
  • {
    }
]

State

Retrieve States

Retrieve States, filter with parameters

Authorizations:
query Parameters
limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip? (default 0)

countryCode
string

The Country abbreviation (2 char)

StateID
string

The ID of this Object

geocode
string

The Geocode of this Place record

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Store new State records

Store a batch of new State records

Authorizations:
Request Body schema: application/json

The new Places request package

Array of objects (State)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Get states in an observable array

Returns a state retrieval in a observable array

Authorizations:
query Parameters
countryCode
string

The Country abbreviation (2 char)

StateID
string

The ID of this Object

geocode
string

The Geocode of this Place record

Responses

Response samples

Content type
application/json
[
  • {
    }
]

TaxnexusCode

Get a list of TaxnexusCodes

Return a list of TaxnexusCodes

Authorizations:
query Parameters
limit
integer <int64>

How many objects to return at one time

taxnexusCodeId
string

Taxnexus Code ID

offset
integer <int64>

How many objects to skip? (default 0)

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Store new TaxnexusCode records

Store a batch of new TaxnexusCode records

Authorizations:
Request Body schema: application/json

The new Places request package

Array of objects (TaxnexusCode)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Get taxnexuscodes in an observable array

Returns a taxnexuscode retrieval in a observable array

Authorizations:
query Parameters
countryCode
string

The Country abbreviation (2 char)

StateID
string

The ID of this Object

geocode
string

The Geocode of this Place record

Responses

Response samples

Content type
application/json
[
  • {
    }
]

TaxRate

Combined Tax Rates

Returns SALES TAX rates based on County or Place ID

Authorizations:
query Parameters
placeId
string

The ID of a Place record

countyId
string

The ID of this Object

journalDate
required
string

Journal Entry Date (transaction date), required

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Get taxrates in an observable array

Returns a taxrate retrieval in a observable array

Authorizations:
query Parameters
placeId
string

The ID of a Place record

countyId
string

The ID of this Object

journalDate
required
string

Journal Entry Date (transaction date), required

Responses

Response samples

Content type
application/json
[
  • {
    }
]

TaxType

Get a list of Tax Types

Return a list of tax types

Authorizations:
query Parameters
active
boolean

Retrieve only active records?

address
string

Postal Address URL encoded; partial addresses allowed

countryCode
string

The Country abbreviation (2 char)

county
string

The County Name

date
string

Transaction date (defaults to current)

limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip? (default 0)

place
string

The City name (must be accompanied by State)

state
string

The State or Province abbreviation (2 char)

ids
string

Taxnexus Record Ids of the Tax Types in a JSON array url encoded

taxTypeId
string

Taxnexus Record Id of the Tax Type

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Store new TaxType records

Store a batch of new TaxType records

Authorizations:
Request Body schema: application/json

The new Places request package

Array of objects (TaxType)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Get taxtypes in an observable array

Returns a taxtype retrieval in a observable array

Authorizations:

Responses

Response samples

Content type
application/json
[
  • {
    }
]