Tax Jurisdiction - Spectrum_OnDemand - enterprise_tax - web_services - Latest

Spectrum OnDemand Web Services (REST)

Product type
Software
Portfolio
Verify
Product family
Spectrum
Product
Spectrum > Geocoding > Enterprise Tax
Spectrum > Web Services
Spectrum > Spatial > Spectrum Spatial
Spectrum > Spectrum Platform
Spectrum > Quality > Addressing
Spectrum > Quality > Spectrum Quality
Spectrum > Spatial > Spectrum Spatial Insights
Spectrum > Discovery
Spectrum OnDemand
Spectrum > Dataflow Designer
Spectrum > Spatial > Spectrum Spatial Analyst
Spectrum > Quality > Context Graph
Version
Latest
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (REST)
Copyright
2024
First publish date
2006
ft:lastEdition
2024-07-17
ft:lastPublication
2024-07-17T23:23:16.481321

Tax jurisdiction data contains information about the "place" for the location. A "place" is a geographic area defined on the basis of population criteria that vary by state; or, an area recognized as significant because it is located in an incorporated municipality. Places are used to determine tax jurisdiction.

The table below lists the output fields that contain tax jurisdiction data. To include tax jurisdiction data in the output, set Option.GeoTAXOutputRecordType = T.
Note: Fields denoted by an asterisk "*" are always included in the output regardless of whether or not you choose to include tax jurisdiction data in the output. Contents returned when available; otherwise, left blank.
Response Element Max. Field Length with null terminator Description

Confidence.SurfaceType

3

Indicates the confidence surface type. Setting a non-zero buffer width enables confidence generation. To determine a confidence level, a confidence surface is first generated. The confidence surface provides the smallest possible area wherein an address is likely to be located.

0
Undefined
1
The search failed - the address was not found.
2
Intersection confidence surface generated.
3
Interpolated street segment.
4
Point-level match.
5
State confidence surface generated.
6
County confidence surface generated.
7
City confidence surface generated.
8
Reserved
9
A ZIP Code confidence surface generated.
10
A ZIP+2 confidence surface generated.
11
A ZIP+4 confidence surface generated.
12
Reserved
13
A street centroid confidence surface generated.

GeoTAXKey

10

The value in this field varies depending on the option you specified in the Option.TaxKey option:

If you specified T, GeoTAXKey contains the proprietary codes used in Sovos tax compliance software. You can use this code in your Sovos application to find out the tax rate for the jurisdiction. The Sovos jurisdiction code formats are as follows:
  • Sovos SUT - 2-digit SUT state code, 5-digit ZIP Code, 2-digit SUT geocode
  • Sovos TWE - variable-length TWE geocode

If you specified V, GeoTAXKey contains the proprietary Vertex® jurisdiction code (comprised of a two-digit Vertex® state code, three-digit FIPS county code, and four-digit Vertex® city code). You can use this code in your Vertex® application to find out the tax rate for the jurisdiction.

GeoTAXKey.MatchCode

2

Return code denoting the level of match obtained against the Vertex or Sovos cross reference files.

E
Exact match using five fields: FIPS state code, FIPS county code, FIPS or GNIS place code, ZIP Code, and FIPS place name.
P
Partial match using four fields: FIPS state code, FIPS county code, FIPS or GNIS place code, and ZIP Code.
A
Alternate match using two fields: ZIP Code, FIPS place name.
N
Record is default coded based on valid state code.
null
No matching record found.

GeoTAXKey.MatchLevel

12

A description of the value returned in the GeoTAXKey.MatchCode field.

Exact
Exact match. See description in GeoTAXKey.MatchCode.
Partial
Partial match. See description in GeoTAXKey.MatchCode.
Alternate
Alternate match. See description in GeoTAXKey.MatchCode.
DefaultCode
Record is default coded. See description in GeoTAXKey.MatchCode.
NoMatch
No matching record found.

GNISCode*

10

Unique nine-digit Geographic Names Information System (GNIS) code.

Place.ClassCode*

3

Place class code. Place class codes are used to determine the proper taxing jurisdictions

Place.Code*

6

Five-digit Federal Information Processing Standards (FIPS) place code. A "place" is a geographic area defined on the basis of population criteria that vary by state. Or, an area recognized as significant because it is located in an incorporated municipality.

Place.IncorporatedFlag*

8

Indicates whether the address is located in an incorporated or unincorporated place. A "place" is a geographic area defined on the basis of population criteria that vary by state. Or, an area recognized as significant because it is located in an incorporated municipality.

Inc
Incorporated place code.
Uninc
Unincorporated place code.
Unknown
Incorporation status unknown.

Place.LastAnnexedDate*

8

Last annexed date, in the format MM/YYYY, representing the month and year of the most recent boundary change or the most recent available boundary information.

Place.LastUpdatedDate*

8

Last updated date, in the format MM/YYYY, reflecting the month and year when TomTom updated the database to reflect attribute (name change, FIPS change, etc.) or boundary edits to the Place.

Place.LastVerifiedDate*

8

Last verified date, in the format MM/YYYY, representing the month and year that TomTom verified municipality change information.

Place.Name*

41

The name of the "place" where the address is located. A "place" is a geographic area defined on the basis of population criteria that vary by state. Or, an area recognized as significant because it is located in an incorporated municipality.

Place.PointStatus*

2

Returns the result for a comparison between the matched address point to the polygon defined by the Place.txb file.

For more information on buffers, see Buffering.

Note: The buffer distance for Place.txb is internally set to zero and cannot be modified.
P
The point is in the polygon.
I
The point is in the buffer area inside the polygon.
B
The point is in the buffer area and outside of the polygon.
blank
Polygon not found.

Place.DistanceToBorder*

10

Returns the distance between the matched address point to the polygon defined by the Place.txb file.

Place.Confidence

4

Provides the percentage overlap of the geocode to the Place polygon layer. The returned percentage value describes the probability that the point falls in the specified Place.