This section describes how to get taxrate for an address using the GeoTAX API service. You may want to try it out with a Free Trial Account.
This method will consume credits.
- HTTP Request
- URL Composition
- Base URL: https://api.cloud.precisely.com
- GeoTAX by address :/v1/geo-tax/address/batch
- Supported Methods: POST only
- Rate Limit (Transactions per second): 50
- Input Fields Each request to the API service requires a few
parameters, all of which are listed below. All requests require a Bearer token, that
can be generated using your account's key-secret. To produce a bearer token for an API
request, the generated key-secret combinations are used . The generated token is valid
for 3600sec (1 hour) and then it needs to be regenerated.
The data should be encoded as a JSON array where each element in the array is a JSON object with field names identical to those in the input/output fields listed below.
Table 1. Parameters Parameter Description Example Value preferencesOptions supported by the GeoTAX Service which include a variety of settings categorized into output, geocoding, matching, and custom. Some of the preferences under geocoding include, defaultBufferWidth, latLongOffset, and many more. defaultBufferWidth:Set a different default buffer width.
Default= The default integer value is 0.addressesList of addresses to be processed. addressLines:Requested address, based on the country's addressing standard.
Single-line request:
"201 N ALTAS PALMAS DR HARLINGEN, TX"
Multi-line request:
"201 N ALTAS PALMAS DR",
"HARLINGEN, TX"
Below is a sample request for GeoTAX by batch address end point.
{ "preferences": { "output": { "taxDistrict": "NONE", "salesTaxRateType": "NONE", "outputCasing": "UPPER", "taxCrossReferenceKey": "NONE", "usePTC": "NO", "userBoundary": "NO" }, "geocoding": { "defaultBufferWidth": 0, "latLongOffset": "NONE", "squeeze": "NO", "latLongAltFormat": "DecimalSign", "usePointData": "NO" }, "matching": { "matchMode": "CLOSE", "useGeoTaxAuxiliaryFile": "NO", "useUserAuxiliaryFile": "NO" } }, "addresses": [ { "addressLines": [ "2001 Main St, Eagle Butte, SD 57625" ] }, { "addressLines": [ "2520 Columbia House Blvd #108, Vancouver, WA 98661" ] } ] }
- URL Composition
Preferences
Below are the preferences for GeoTAX Service:
Default Preferences
| Field | Description |
|---|---|
| custom | - |
| geocoding | Set options when geocoding. |
| matching | Set options when matching. |
| output | Set options for the information returned in the output. |
Geocoding Preferences
To set geocoding related options.
| Field | Description |
|---|---|
| defaultBufferWidth | Set a different default buffer width. The default integer value is 0. |
| userBoundaryBufferDistance | Specify the buffer distance for user-defined boundary files. |
| usePointData | Set this option when working with Point data files.
|
| latLongOffset | Indicates the offset distance in feet from the latLong point.
|
|
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.
|
| latLongAltFormat | Specify another format for the latLong coordinates.
|
Matching Preferences
To set matching related options.
| Field | Description |
|---|---|
| useGeoTaxAuxiliaryFile | Set a different default buffer width.
Default: The default integer value is 0. |
| useUserAuxiliaryFile | Specify the buffer distance for user-defined boundary files. |
| 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.
|
Output Preferences
To set output related options.
| Field | Description |
|---|---|
| taxDistrict | Indicates the type of tax district information returned.
|
| taxCrossReferenceKey | Identify a third-party tax compliance software vendor. This controls the
sales tax value returned in the GeoTAXKey output field.
|
| salesTaxRateType |
Indicates the sales and use tax rate type to return or none:
|
| 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
|
Request Parameters
The below table lists the request parameters for GeoTAX Service:
| Field | Description |
|---|---|
| addressLines | Requested address, based on the country's addressing standard.
Single-line request: |
| addressNumber | House or building number.
Example: |
| admin1 | The largest geographic area, typically a state or province.
Example: |
| admin2 | The secondary geographic area, typically a county or district.
Example: |
| building | A roofed and walled structure built for permanent use. |
| city | Specifies a city or town name.
Example: |
| country | Name of a country in ISO 3166-1 format (Alpha-2, Alpha-3, or numerical), or a
common name of the country.
Example: |
| neighborhood | A city subdivision or locality.
Example: |
| postalCode | Main postal code.
Example: |
| postalCodeExt | Secondary postal code, if one exists.
Example: |
| street | A street name. |
| unit | The unit number.
Example: |
| unitType | A group or suite of rooms within a building that are under common ownership
or tenancy, typically having a common entrance. (APT,
STE, FLAT, etc.)
Example: |