Preferences - geotax_sdk - 2.2

GeoTAX SDK Developer Guide
Product type
Software
Portfolio
Locate
Product family
Geo Addressing
Product
GeoTAX SDK
Version
2.2
Language
English
Product name
GeoTAX SDK
Title
GeoTAX SDK Developer Guide
Copyright
2024
First publish date
2023
Last updated
2024-08-30
Published on
2024-08-30T02:47:25.239000

Default Preferences

Field Description
custom Set options to customize the application.
geocoding Set options when geocoding.
matching Set options when matching.
output Set options for the information returned in the output.

Geocoding Preferences

To get or set geocoding-related options:

Field Description
defaultBufferWidth Set a different default buffer width in feet. The default integer value is 0.
userBoundaryBufferDistance Specify the buffer distance in feet for user-defined boundary files.
usePointData

Set this option when working with Point data files.

  • Yes (Y)

  • No (N) (default)
latLongOffset Represents the perpendicular offset distance in feet from the latitude longitude point. Street level geocoding returns a latitude and longitude point in the center of a street. An offset can more accurately represent locations of buildings on a street. It is also used to distinguish addresses on opposite sides of a street.

  • None (default)

  • 20
  • 40 (recommended)
  • 60
Squeeze Specifies if the street end points should be "squeezed" when determining the geocode of an address in street-level matching. When Squeeze is enabled, both street and end points are moved closer to the center of the segment by 50 feet.

  • Yes (Y)

  • No (N) (default)
latLongAltFormat Specify the format for the latitude longitude coordinates.
  • DecimalDirectional—Longitude and latitude in decimal degrees (default).
  • DecimalSign—Use signed latitude and longitude.
  • NoDecimalDirectional—Use degrees, minutes, seconds.
  • NoDecimalSign—Use the directional indicator (N, S, E, W).

Matching Preferences

Field Description
useGeoTaxAuxiliaryFile Specifies whether or not LookUpByAddress should attempt a match to the GeoTAX Auxiliary file. The GeoTAX Auxiliary file contains new addresses that have not yet been added to the Primary File.
useUserAuxiliaryFile Specifies whether to attempt a match to a User Auxiliary file. User Auxiliary files are user-defined files that override results from the primary files in street-level matching.
matchMode

Match modes determines the leniency used to make a match between your input and the reference database. Select a match mode based on the quality of your input and your desired output. For example, if you have an input database that is prone to errors, you may want to select the relaxed match mode.

  • Exact—Requires a very tight match. This restrictive mode generates the fewest match candidates, which decreases the processing time. When using this mode, ensure that your input is very clean; free of misspellings and incomplete addresses.
  • Close—Requires a close match and generates a moderate number of match candidates. (default)
  • Relaxed—Allows a loose match and generates the most match candidates, which increases the processing time and results in more multiple matches. Use this mode if you are not confident that your input is free of misspellings and incomplete addresses. This is the only mode that does not respect the street parity when making an address match.

Output Preference

Field Description
taxDistrict Represents the type of tax district information returned.
  • Insurance Premium Tax Districts
  • Payroll Tax Districts
  • Special Purpose Tax Districts

For a description of the fields in each output group, see LookUpByAddress Output.
taxCrossReferenceKey

Identify a third-party tax compliance software vendor. This controls the sales tax value returned in the GeoTAXKey output field.

  • None—Do not return either the Sovos or Vertex jurisdiction codes (default).
  • Sovos—Return the Sovos jurisdiction code for the address.
  • Vertex—Return the Vertex jurisdiction code for the address. Choose this option if you obtained a Vertex file from Precisely.
    Note: If you specify a taxCrossReferenceKey, specify Special Purpose Districts under taxDistrict to obtain the best Sales tax cross-reference key match possible.
salesTaxRateType

Represents the sales and use tax rate type to return or none:

  • None—Do not return sales and use tax rates. (default)
  • General—Return the General sales and use tax rates.
  • Automotive—Return the Automotive sales and use tax rates.
  • Construction—Return the Construction sales and use tax rates.
  • Medical—Return the Medical sales and use tax rates.
    Note: If you specify salesTaxRateType, select Special Purpose Districts under taxDistrict to obtain the best match possible to the tax rate file.
usePTC Use a payroll tax correspondence (PTC) file to determine the payroll system tax codes for a given address.
userBoundary Return data from user-defined boundary files.
outputCasing Specifies the casing of these output fields: TaxCounty.name, Census.name, TaxPlace.name, Ipd.districtName, PayrollTaxDistrict.districtName, SpecialPurposeDistrict.districtName, Ptc.payrollDescription
  • Mixed—Returns the output in mixed case (default). For example, Boulder.
  • Upper—Returns the output in upper case. For example, BOULDER.