Pitney Bowes Tax Calculator allows anyone to determine local tax jurisdictions & tax rates in the United States based on address inputs or location coordinates
Status: Preview |
Tier: Premium |
Version: 4.0.0 |
Name |
Summary |
getSpecificTaxByAddress (string taxRateTypeId, string address, string purchaseAmount) |
Get Tax By Address |
getBatchTaxByAddress (string taxRateTypeId, TaxAddressRequest body) |
Post Tax By Address |
Get Tax By Location |
|
getBatchTaxByLocation (string taxRateTypeId, TaxLocationRequest body) |
Post Tax By Location |
getSpecificTaxRateByAddress (string taxRateTypeId, string address) |
Get Taxrate By Address |
getBatchTaxRateByAddress (string taxRateTypeId, TaxRateAddressRequest body) |
Post Taxrate By Address |
getSpecificTaxRateByLocation (string taxRateTypeId, string latitude, string longitude) |
Get Taxrate By Location |
getBatchTaxRateByLocation (string taxRateTypeId, TaxRateLocationRequest body) |
Post Taxrate By Location |
Get IPD Tax by Address |
|
Get IPD Tax for batch requests |
Name |
Summary |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Get Tax By Address
Description: This service calculates and returns taxes applicable at a specific address. Address, purchase amount and supported tax rate type are inputs to the service.
Syntax:
PitneyBowesTaxCalculator.getSpecificTaxByAddress (string taxRateTypeId, string address, string purchaseAmount)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
taxRateTypeId |
string (Tax Type)Values: [General, Auto, Medical, Construction] |
The tax rate id. |
True |
|
address |
string (Address) |
The address to be searched. |
True |
|
purchaseAmount |
string (Purchase Amount) |
The amount on which tax to be calculated. |
True |
Returns:
Type:taxResponse
Summary: Post Tax By Address
Description: This is a Batch offering for 'Tax By Address' service. It accepts a single address, purchase amount or a list of addresses, purchase amounts and retrieve applicable taxes.
Syntax:
PitneyBowesTaxCalculator.getBatchTaxByAddress (string taxRateTypeId, TaxAddressRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
taxRateTypeId |
string (Tax Type)Values: [General, Auto, Medical, Construction] |
The tax rate id. |
True |
|
body |
|
|
True |
Returns:
Type:taxResponses
Summary: Get Tax By Location
Description: This service calculates and returns tax applicable at a specific location. Longitude, latitude, purchase amount and supported tax rate type are inputs to the service.
Syntax:
PitneyBowesTaxCalculator.getSpecificTaxByLocation (string taxRateTypeId, string latitude, string longitude, string purchaseAmount)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
taxRateTypeId |
string (Tax Type)Values: [General, Auto, Medical, Construction] |
The tax rate id. |
True |
|
latitude |
string (Latitude) |
Latitude of the location. |
True |
|
longitude |
string (Longitude) |
Longitude of the location. |
True |
|
purchaseAmount |
string (Purchase Amount) |
The amount on which tax to be calculated. |
True |
Returns:
Type:taxResponse
Summary: Post Tax By Location
Description: This is a Batch offering for 'Tax By Location' service. It accepts a single location coordinate, purchase amount or a list of location coordinates, purchase amounts and retrieve applicable tax.
Syntax:
PitneyBowesTaxCalculator.getBatchTaxByLocation (string taxRateTypeId, TaxLocationRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
taxRateTypeId |
string (Tax Type)Values: [General, Auto, Medical, Construction] |
The tax rate id. |
True |
|
body |
|
|
True |
Returns:
Type:taxResponses
Summary: Get Taxrate By Address
Description: Retrieves tax rates applicable to a specific address. This service accepts address and supported tax rate type as inputs to retrieve applicable tax rates.
Syntax:
PitneyBowesTaxCalculator.getSpecificTaxRateByAddress (string taxRateTypeId, string address)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
taxRateTypeId |
string (Tax Type)Values: [General, Auto, Medical, Construction] |
The tax rate id. |
True |
|
address |
string (Address) |
The address to be searched. |
True |
Returns:
Type:taxResponse
Summary: Post Taxrate By Address
Description: This is a Batch offering for 'Taxrate By Address' service. It accepts a single address or a list of addresses and retrieve applicable tax rates.
Syntax:
PitneyBowesTaxCalculator.getBatchTaxRateByAddress (string taxRateTypeId, TaxRateAddressRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
taxRateTypeId |
string (Tax Type)Values: [General, Auto, Medical, Construction] |
The tax rate id. |
True |
|
body |
|
|
True |
Returns:
Type:taxResponses
Summary: Get Taxrate By Location
Description: Retrieves tax rates applicable to a specific location. This service accepts longitude, latitude and supported tax rate type as inputs to retrieve applicable tax rates.
Syntax:
PitneyBowesTaxCalculator.getSpecificTaxRateByLocation (string taxRateTypeId, string latitude, string longitude)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
taxRateTypeId |
string (Tax Type)Values: [General, Auto, Medical, Construction] |
The tax rate id. |
True |
|
latitude |
string (Latitude) |
Latitude of the location. |
True |
|
longitude |
string (Longitude) |
Longitude of the location. |
True |
Returns:
Type:taxResponse
Summary: Post Taxrate By Location
Description: This is a Batch offering for 'Taxrate By Location' service. It accepts a single location coordinate or a list of location coordinates and retrieve applicable tax rates.
Syntax:
PitneyBowesTaxCalculator.getBatchTaxRateByLocation (string taxRateTypeId, TaxRateLocationRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
taxRateTypeId |
string (Tax Type)Values: [General, Auto, Medical, Construction] |
The tax rate id. |
True |
|
body |
|
|
True |
Returns:
Type:taxResponses
Summary: Get IPD Tax by Address
Description: This will accept 'address' as a parameter and will return one or many IPDs details for that region in which address will fall.
Syntax:
PitneyBowesTaxCalculator.getIPDTaxByAddress (string address, [Optional]string returnLatLongFields, [Optional]string latLongFormat)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
address |
string (Address) |
The address to be searched. |
True |
|
returnLatLongFields |
string (Return Lat/Lon)Values: [Y, N] |
This preference Option sets flag for returning geometry coordinates(Y/N) |
False |
|
latLongFormat |
string (Lat/Lon Format)Values: [PreZero, PreZeroDecimal, Decimal, DecimalAssumed] |
(default is Decimal) - Returns Desired Latitude Longitude Format |
False |
Returns:
Type:TaxDistrictResponse
Summary: Get IPD Tax for batch requests
Description: Get IPD Tax for batch requests
Syntax:
PitneyBowesTaxCalculator.getIPDTaxByAddressBatch (IPDTaxByAddressBatchRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
True |
Returns:
Summary:
Description:
Properties:
Name |
Type |
Summary |
objectId |
string
|
|
displayName |
string
|
|
streetSide |
string
|
|
businessName |
string
|
|
addressLine1 |
string
|
|
addressLine2 |
string
|
|
addressLine3 |
string
|
|
city |
string
|
|
stateProvince |
string
|
|
county |
string
|
|
postalCode |
string
|
|
latitude |
string
|
|
longitude |
string
|
|
status |
string
|
|
urbanizationName |
string
|
|
formattedAddress |
string Matched Address formatted Address |
|
mainAddressLine |
string Matched Address main addressLine |
|
addressLastLine |
string Matched Address Last line |
|
placeName |
string Matched Address place Name |
|
areaName1 |
string Matched Address State Name |
|
areaName2 |
string Matched Address county name |
|
areaName3 |
string Matched Address city Name |
|
areaName4 |
string Matched Address locality Name |
|
postCode |
string Matched Address Zip code |
|
postCodeExt |
string Matched Address zip code extension |
|
country |
string Matched Address country ISO code |
|
addressNumber |
string Matched Address address number |
|
streetName |
string Matched Address street Name |
|
unitType |
string Matched Address apartment/house type |
|
unitValue |
string Matched Address apartment/house number |
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
bufferRelation |
|
|
distanceToBorder |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
description |
string Buffer Relation Description |
|
value |
string Buffer Relation Value |
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string
|
|
code |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
cbsa |
|
|
matchLevel |
string
|
|
matchCode |
string
|
|
tract |
string
|
|
mcd |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
code |
string County Code |
|
name |
string County Name |
|
fips |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
FIND_ADDR_POINT_INTERP |
string
|
|
FIND_SEARCH_AREA |
string
|
|
FIND_ADDRESS_RANGE |
string
|
|
FIND_EXPANDED_SEARCH_RADIUS |
string
|
|
FIND_ALTERNATE_LOOKUP |
string
|
|
FIND_STREET_CENTROID |
string
|
|
FIND_FIRST_LETTER_EXPANDED |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
unit |
string Ditance to Border Unit |
|
value |
string Distance to Border Value |
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
description |
string Insurance Premium Districts Type |
|
value |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
type |
string Geometry Type |
|
coordinates |
array of (number(double)) Coordinates(lat, lon) |
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
purchaseAmount |
string Purchase Amount |
|
objectId |
string Unique ID |
|
geometry |
array of (Geometry) Geometry |
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string IPD ID |
|
districtName |
string IPD Name |
|
districtType |
|
|
taxCodeDescription |
string Tax code descriptions |
|
effectiveDate |
string IPD Effective Date |
|
expirationDate |
string IPD Expiration Date |
|
boundaryBuffer |
|
|
rates |
array of (rate)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
addresses |
array of (IPDTaxRateAddress) Tax Address |
|
preferences |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
state |
|
|
county |
|
|
place |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
objectId |
string Unique ID |
|
mainAddressLine |
string Main Address Line |
|
addressLastLine |
string Address Last Line |
|
placeName |
string Place Name |
|
areaName1 |
string State or Province |
|
areaName2 |
string Area Name 2 |
|
areaName3 |
string City or Town |
|
areaName4 |
string Area Name 4 |
|
postCode1 |
string Postal Code |
|
postCode2 |
string Postal Code Ext |
|
country |
string Three-digit ISO country code |
|
addressNumber |
string Address Number |
|
streetName |
string Street Name |
|
unitType |
string Unit Type |
|
unitValue |
string Unit Value |
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
matchCode |
string
|
|
matchLevel |
string
|
|
streetMatchCode |
string
|
|
streetMatchLevel |
string
|
|
geometry |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string
|
|
code |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string Place Name |
|
code |
string Place Code |
|
classCode |
string Place Class Code |
|
incorporatedFlag |
string Place Incorporated Flag |
|
lastAnnexedDate |
string Place Last Annexed Date |
|
lastUpdatedDate |
string Place Last updated Date |
|
lastVerifiedDate |
string Place Last Verified Date |
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
fallbackToGeographic |
string Fall Back to Geographic |
|
matchMode |
string Match mode |
|
distanceUnits |
string Distance Unit |
|
customPreferences |
|
|
outputCasing |
string Output Casting |
|
latLongOffset |
string Lat/Lon offset |
|
squeeze |
string Squeeze Street End Points |
|
returnLatLongFields |
string Return Geometry coordinates(Y/N) |
|
returnCensusFields |
string Return Census Fields(Y/N) |
|
useGeoTaxAuxiliaryFile |
string Use GeoTAX Auxiliary File(Y/N) |
|
latLongFormat |
string Lat/Lon Return Format |
|
defaultBufferWidth |
string Width ofPolygon Buffers |
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string Tax Rate Name |
|
format |
string Tax Rate Format |
|
formatDescription |
string Tax Rate Format Description |
|
value |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
totalTaxRate |
number(double) Total Sales Tax rate |
|
totalTaxAmount |
number(double) Total Sales Tax Amount |
|
stateTaxRate |
number(double) State Sales Tax Rate |
|
stateTaxAmount |
number(double) State Sales Tax Amount |
|
countyTaxRate |
number(double) County Sales Tax Rate |
|
countyTaxAmount |
number(double) County Sales Tax Amount |
|
municipalTaxRate |
number(double) Municipality Sales Tax Rate |
|
municipalTaxAmount |
number(double) Municipality Sales Tax Aount |
|
spdsTax |
array of (SpecialPurposeDistrictTax)
|
|
specialTaxRulesApplied |
boolean Special Tax Rules Applied |
|
specialTaxRulesDescriptor |
string Special Tax Rules Descriptor |
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
districtName |
string SPD Name |
|
districtCode |
string SPD district code |
|
districtNumber |
string 3-digit district type code |
|
versionDate |
string SPD version date |
|
effectiveDate |
string SPD effective date |
|
compiledDate |
string SPD compiled date |
|
updateDate |
string SPD update date |
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
districtNumber |
string District Number of SPD |
|
taxRate |
number(double) Tax rate for SPD |
|
taxAmount |
number(double) Tax Amount for SPD |
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
fips |
string
|
|
code |
string State Code |
|
name |
string State Name |
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
purchaseAmount |
string Purchase Amount |
|
objectId |
string Unique ID |
|
mainAddressLine |
string Main Address |
|
addressLastLine |
string Address Last Line |
|
placeName |
string Place Name |
|
areaName1 |
string State or Province |
|
areaName2 |
string Area Name 2 |
|
areaName3 |
string City or Town |
|
areaName4 |
string Area Name 4 |
|
postCode1 |
string Postal Code |
|
postCode2 |
string Postal Code Ext |
|
country |
string Three-digit ISO country code |
|
addressNumber |
string Address Number |
|
streetName |
string Street Name |
|
unitType |
string Unit Type |
|
unitValue |
string Unit Value |
|
distanceUnits |
string Distance Unit |
|
bufferWidth |
string Buffer Width |
|
userBufferWidth |
string User Buffer Width |
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
taxAddresses |
array of (TaxAddress) Tax Address |
|
preferences |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
objectId |
string Unique ID |
|
confidence |
number(double) Percentage Overlap of Geocode |
|
jurisdiction |
|
|
numOfIpdsFound |
integer(int32) Number of Insurance Premium Tax Districts |
|
ipds |
array of (ipd)
|
|
matchedAddress |
|
|
census |
|
|
latLongFields |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
taxDistrictResponse |
array of (TaxDistrictResponse)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
state |
|
|
county |
|
|
place |
|
|
spds |
array of (SpecialPurposeDistrict)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
locations |
array of (GeoTaxLocations) Tax Location |
|
preferences |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
objectId |
string Unique ID |
|
mainAddressLine |
string Main Address Line |
|
addressLastLine |
string Address Last Line |
|
placeName |
string Place Name |
|
areaName1 |
string State or Province |
|
areaName2 |
string Area Name 2 |
|
areaName3 |
string City or Town |
|
areaName4 |
string Area Name 4 |
|
postCode1 |
string Postal Code |
|
postCode2 |
string Postal Code Ext |
|
country |
string Three-digit ISO country code |
|
addressNumber |
string Address Number |
|
streetName |
string Street Name |
|
unitType |
string Unit Type |
|
unitValue |
string Unit Value |
|
distanceUnits |
string Distance Unit |
|
bufferWidth |
string Buffer Width |
|
userBufferWidth |
string User Buffer Width |
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
taxRateAddresses |
array of (TaxRateAddress) Tax Rate Address |
|
preferences |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
locations |
array of (GeoTaxLocations) Tax Location |
|
preferences |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
objectId |
string
|
|
gnisCode |
string
|
|
confidence |
number(double) Probability that the point falls in the specified Place |
|
jurisdiction |
|
|
matchedAddress |
|
|
salesTax |
|
|
useTax |
|
|
census |
|
|
latLongFields |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
taxResponses |
array of (taxResponse)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
totalTaxRate |
number(double) Total Use Tax Rate |
|
totalTaxAmount |
number(double) Total Use Tax Amount |
|
stateTaxRate |
number(double) State Use Tax Rate |
|
stateTaxAmount |
number(double) State Use Tax Amount |
|
countyTaxRate |
number(double) County Use Tax Rate |
|
countyTaxAmount |
number(double) County Use Tax Amount |
|
municipalTaxRate |
number(double) Municipality Use Tax Rate |
|
municipalTaxAmount |
number(double) Municipality Use Tax Amount |
|
spdsTax |
array of (SpecialPurposeDistrictTax)
|
|
specialTaxRulesApplied |
boolean
|
|
specialTaxRulesDescriptor |
string
|
|