Chapter 3.4 - Special Tax Jurisdictions

Special Tax Jurisdiction information is returned along with the primary jurisdiction results if the Options (Options) bitwise value includes 16.

Special Tax Jurisdiction Example 1 - Address

This request includes the Return Special Tax Jurisdictions Options (Options) bitwise value of 16, indicating that we want to get Special Tax Jurisdictions back. The input for this request is an address, and we are using the GeocodeAddress GeocodeAddress method. The same information can be passed to the GeocodeAllMatches method with the same results.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
   <s:Header>
      <o:Security s:mustUnderstand="1" xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <o:UsernameToken>
            <o:Username>USERNAME</o:Username>
            <o:Password>PASSWORD</o:Password>
         </o:UsernameToken>
      </o:Security>
   </s:Header>
   <s:Body>
      <GeocodeAddress xmlns="http://tempuri.org/">
         <inputAddress xmlns:a="http://schemas.datacontract.org/2004/07/EZGeoSaaS" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:CassCertify>false</a:CassCertify>
            <a:City>New York</a:City>
            <a:CityStateZip/>
            <a:MinimumScore>0.7</a:MinimumScore>
            <a:Offset>3</a:Offset>
            <a:Options>312</a:Options>
            <a:SecondaryUnit/>
            <a:Source/>
            <a:State>NY</a:State>
            <a:StreetAddress>1260 6th Ave</a:StreetAddress>
            <a:Zip>10020</a:Zip>
         </inputAddress>
      </GeocodeAddress>
   </s:Body>
</s:Envelope>

Response

Special Tax Jurisdiction information is returned:

  • SpecialTaxDistrictName is the Special Tax Jurisdiction Name
  • SpecialTaxDistrictPCode contains the PCode for the Special Tax Jurisdiction
  • PCode returns the PCode that should be used for taxation - in this case, the Special Tax Jurisdiction PCode

The underlying primary jurisdiction is also returned:

  • PrimaryJurisdictionName is the name of the underlying primary jurisdiction that is returned if Special Tax Jurisdictions are not turned on
  • PrimaryJurisdictionPCode provides the PCode for the underlying primary jurisdiction
View the Response XML
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
   <s:Header>
      <o:Security s:mustUnderstand="1" xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <u:Timestamp u:Id="_0">
            <u:Created>2019-02-07T17:39:59.044Z</u:Created>
            <u:Expires>2019-02-07T17:44:59.044Z</u:Expires>
         </u:Timestamp>
      </o:Security>
   </s:Header>
   <s:Body>
      <GeocodeAddressResponse xmlns="http://tempuri.org/">
         <GeocodeAddressResult xmlns:a="http://schemas.datacontract.org/2004/07/EZGeoSaaS" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:Alternate>0</a:Alternate>
            <a:CassAddress i:nil="true"/>
            <a:CensusBlockGroup>1005</a:CensusBlockGroup>
            <a:CensusTract>10400</a:CensusTract>
            <a:CityName>NEW YORK CITY</a:CityName>
            <a:Country>USA</a:Country>
            <a:County>NEW YORK</a:County>
            <a:ErrorMessage/>
            <a:FeatureID>2395220</a:FeatureID>
            <a:FipsCode>9902604301</a:FipsCode>
            <a:FipsPlaceName>NYC</a:FipsPlaceName>
            <a:Incorporated>true</a:Incorporated>
            <a:InputAddress xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
               <b:string>1260 6TH AVE</b:string>
               <b:string>NEW YORK, NY 10020</b:string>
            </a:InputAddress>
            <a:Latitude>40.759881426441147</a:Latitude>
            <a:Longitude>-73.9803850946123</a:Longitude>
            <a:NetworkID>nt</a:NetworkID>
            <a:PCode>2604301</a:PCode>
            <a:PostalCode>10020</a:PostalCode>
            <a:PostalCodeExtension/>
            <a:PrimaryJurisdictionName>NEW YORK</a:PrimaryJurisdictionName>
            <a:PrimaryJurisdictionPCode>2604100</a:PrimaryJurisdictionPCode>
            <a:Score>0.98</a:Score>
            <a:SecondaryUnit/>
            <a:SpecialTaxDistrictName>NEW YORK SOUTH MANHATTAN</a:SpecialTaxDistrictName>
            <a:SpecialTaxDistrictPCode>2604301</a:SpecialTaxDistrictPCode>
            <a:StandardizedAddress xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
               <b:string>1260 6TH AVE</b:string>
               <b:string>NEW YORK CITY,NY 10020</b:string>
            </a:StandardizedAddress>
            <a:StateName>NY</a:StateName>
            <a:StreetName>6TH AVE</a:StreetName>
            <a:StreetNumber>1260</a:StreetNumber>
            <a:TaxJurisdictionName>NEW YORK SOUTH MANHATTAN</a:TaxJurisdictionName>
            <a:TimeZone/>
            <a:UnderlyingFipsCode>3606151000</a:UnderlyingFipsCode>
         </GeocodeAddressResult>
      </GeocodeAddressResponse>
   </s:Body>
</s:Envelope>

Special Tax Jurisdictions Example 2 - Latitude/Longitude

This request is the same request as Example 1, but using the latitude and longitude of the location instead of an address. The GeocodeLatLong method does not use the Options (Options) bitwise field, but Special Tax Jurisdictions are returned if one exists for the location provided.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
   <s:Header>
      <o:Security s:mustUnderstand="1" xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <o:UsernameToken>
            <o:Username>USERNAME</o:Username>
            <o:Password>PASSWORD</o:Password>
         </o:UsernameToken>
      </o:Security>
   </s:Header>
   <s:Body>
      <tem:GeocodeLatLong>
         <tem:latitude>40.759881426441147</tem:latitude>
         <tem:longitude>-73.9803850946123</tem:longitude>
         <tem:Source/>
      </tem:GeocodeLatLong>
   </s:Body>
</s:Envelope>

Response

The geocoding result contains the same Special Tax Jurisdiction, PCode, and Primary Jurisdiction information as the address input.

View the Response XML
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
   <s:Header>
      <o:Security s:mustUnderstand="1" xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <u:Timestamp u:Id="_0">
            <u:Created>2019-02-07T17:41:00.946Z</u:Created>
            <u:Expires>2019-02-07T17:46:00.946Z</u:Expires>
         </u:Timestamp>
      </o:Security>
   </s:Header>
   <s:Body>
      <GeocodeLatLongResponse xmlns="http://tempuri.org/">
         <GeocodeLatLongResult xmlns:a="http://schemas.datacontract.org/2004/07/EZGeoSaaS" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:Alternate>0</a:Alternate>
            <a:CassAddress i:nil="true"/>
            <a:CensusBlockGroup>0</a:CensusBlockGroup>
            <a:CensusTract>0</a:CensusTract>
            <a:CityName>NEW YORK CITY</a:CityName>
            <a:Country>USA</a:Country>
            <a:County>NEW YORK</a:County>
            <a:ErrorMessage/>
            <a:FeatureID>2395220</a:FeatureID>
            <a:FipsCode>9902604301</a:FipsCode>
            <a:FipsPlaceName>NYC</a:FipsPlaceName>
            <a:Incorporated>true</a:Incorporated>
            <a:InputAddress xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
               <b:string/>
               <b:string/>
            </a:InputAddress>
            <a:Latitude>40.759881426441147</a:Latitude>
            <a:Longitude>-73.9803850946123</a:Longitude>
            <a:NetworkID>nt</a:NetworkID>
            <a:PCode>2604301</a:PCode>
            <a:PostalCode/>
            <a:PostalCodeExtension/>
            <a:PrimaryJurisdictionName>NEW YORK</a:PrimaryJurisdictionName>
            <a:PrimaryJurisdictionPCode>2604100</a:PrimaryJurisdictionPCode>
            <a:Score>0.99999370111861319</a:Score>
            <a:SecondaryUnit/>
            <a:SpecialTaxDistrictName>NEW YORK SOUTH MANHATTAN</a:SpecialTaxDistrictName>
            <a:SpecialTaxDistrictPCode>2604301</a:SpecialTaxDistrictPCode>
            <a:StandardizedAddress xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
               <b:string></b:string>
               <b:string>NEW YORK CITY,NY null</b:string>
            </a:StandardizedAddress>
            <a:StateName>NY</a:StateName>
            <a:StreetName/>
            <a:StreetNumber/>
            <a:TaxJurisdictionName>NEW YORK SOUTH MANHATTAN</a:TaxJurisdictionName>
            <a:TimeZone/>
            <a:UnderlyingFipsCode>3606151000</a:UnderlyingFipsCode>
         </GeocodeLatLongResult>
      </GeocodeLatLongResponse>
   </s:Body>
</s:Envelope>

Special Tax Jurisdiction Example 3 - Turn Off Return of Special Tax Jurisdiction

This is the same address as Example 1, but this time the Options (Options) bitwise value does not include 16 (Return Special Tax Jurisdictions), turning off the return of the Special Tax Jurisdiction information. This example uses the GeocodeAllMatches method.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
   <s:Header>
      <o:Security s:mustUnderstand="1" xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <o:UsernameToken>
            <o:Username>USERNAME</o:Username>
            <o:Password>PASSWORD</o:Password>
         </o:UsernameToken>
      </o:Security>
   </s:Header>
   <s:Body>
      <tem:GeocodeAllMatches>
         <tem:inputAddress xmlns:a="http://schemas.datacontract.org/2004/07/EZGeoSaaS" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:CassCertify>false</a:CassCertify>
            <a:City>New York</a:City>
            <a:CityStateZip/>
            <a:MinimumScore>0.7</a:MinimumScore>
            <a:Offset>3</a:Offset>
            <a:Options>296</a:Options>
            <a:SecondaryUnit/>
            <a:Source/>
            <a:State>NY</a:State>
            <a:StreetAddress>1260 6th Ave</a:StreetAddress>
            <a:Zip>10020</a:Zip>
         </tem:inputAddress>
         <tem:matchCount>10</tem:matchCount>
      </tem:GeocodeAllMatches>
   </s:Body>
</s:Envelope>

Response

The Special Tax Jurisdiction fields (SpecialTaxDistrictName and SpecialTaxDistrictPCode) are included in GeocodeAllMatchesResponse, but are set as:

  • SpecialTaxDistrictName set to nil
  • SpecialTaxDistrictPCode is -1, indicating that no Special Tax Jurisdiction has been returned

The underlying primary jurisdiction is still returned, but is now the jurisdiction that should be used:

  • PCode returns the PCode that should be used for taxation - this matches PrimaryJurisdictionPCode
  • PrimaryJurisdictionName is the name of the underlying primary jurisdiction that is returned if Special Tax Jurisdictions are not turned on
  • PrimaryJurisdictionPCode provides the PCode for the underlying primary jurisdiction
View the Response XML
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
   <s:Header>
      <o:Security s:mustUnderstand="1" xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <u:Timestamp u:Id="_0">
            <u:Created>2019-02-07T20:02:43.569Z</u:Created>
            <u:Expires>2019-02-07T20:07:43.569Z</u:Expires>
         </u:Timestamp>
      </o:Security>
   </s:Header>
   <s:Body>
      <GeocodeAllMatchesResponse xmlns="http://tempuri.org/">
         <GeocodeAllMatchesResult xmlns:a="http://schemas.datacontract.org/2004/07/EZGeoSaaS" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:AddressLocation>
               <a:Alternate>0</a:Alternate>
               <a:CassAddress i:nil="true"/>
               <a:CensusBlockGroup>1005</a:CensusBlockGroup>
               <a:CensusTract>10400</a:CensusTract>
               <a:CityName>NEW YORK CITY</a:CityName>
               <a:Country>USA</a:Country>
               <a:County>NEW YORK</a:County>
               <a:ErrorMessage/>
               <a:FeatureID>2395220</a:FeatureID>
               <a:FipsCode>3606151000</a:FipsCode>
               <a:FipsPlaceName>NYC</a:FipsPlaceName>
               <a:Incorporated>true</a:Incorporated>
               <a:InputAddress xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <b:string>1260 6TH AVE</b:string>
                  <b:string>NEW YORK, NY 10020</b:string>
               </a:InputAddress>
               <a:Latitude>40.759881426441147</a:Latitude>
               <a:Longitude>-73.9803850946123</a:Longitude>
               <a:NetworkID>nt</a:NetworkID>
               <a:PCode>2604100</a:PCode>
               <a:PostalCode>10020</a:PostalCode>
               <a:PostalCodeExtension/>
               <a:PrimaryJurisdictionName>NEW YORK</a:PrimaryJurisdictionName>
               <a:PrimaryJurisdictionPCode>2604100</a:PrimaryJurisdictionPCode>
               <a:Score>0.98</a:Score>
               <a:SecondaryUnit/>
               <a:SpecialTaxDistrictName i:nil="true"/>
               <a:SpecialTaxDistrictPCode>-1</a:SpecialTaxDistrictPCode>
               <a:StandardizedAddress xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <b:string>1260 6TH AVE</b:string>
                  <b:string>NEW YORK CITY,NY 10020</b:string>
               </a:StandardizedAddress>
               <a:StateName>NY</a:StateName>
               <a:StreetName>6TH AVE</a:StreetName>
               <a:StreetNumber>1260</a:StreetNumber>
               <a:TaxJurisdictionName>NEW YORK</a:TaxJurisdictionName>
               <a:TimeZone/>
               <a:UnderlyingFipsCode>3606151000</a:UnderlyingFipsCode>
            </a:AddressLocation>
            <a:AddressLocation>
               <a:Alternate>0</a:Alternate>
               <a:CassAddress i:nil="true"/>
               <a:CensusBlockGroup>1005</a:CensusBlockGroup>
               <a:CensusTract>10400</a:CensusTract>
               <a:CityName>NEW YORK</a:CityName>
               <a:Country>USA</a:Country>
               <a:County>New York</a:County>
               <a:ErrorMessage/>
               <a:FeatureID>2395220</a:FeatureID>
               <a:FipsCode>3606151000</a:FipsCode>
               <a:FipsPlaceName>New York</a:FipsPlaceName>
               <a:Incorporated>true</a:Incorporated>
               <a:InputAddress xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <b:string>1260 6TH AVE</b:string>
                  <b:string>NEW YORK, NY 10020</b:string>
               </a:InputAddress>
               <a:Latitude>40.759905548859038</a:Latitude>
               <a:Longitude>-73.980394003783886</a:Longitude>
               <a:NetworkID>ta</a:NetworkID>
               <a:PCode>2604100</a:PCode>
               <a:PostalCode>10020</a:PostalCode>
               <a:PostalCodeExtension>1797</a:PostalCodeExtension>
               <a:PrimaryJurisdictionName>NEW YORK</a:PrimaryJurisdictionName>
               <a:PrimaryJurisdictionPCode>2604100</a:PrimaryJurisdictionPCode>
               <a:Score>0.96</a:Score>
               <a:SecondaryUnit/>
               <a:SpecialTaxDistrictName i:nil="true"/>
               <a:SpecialTaxDistrictPCode>-1</a:SpecialTaxDistrictPCode>
               <a:StandardizedAddress xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <b:string>1260 6th Ave</b:string>
                  <b:string>NEW YORK,NY 10020-1797</b:string>
               </a:StandardizedAddress>
               <a:StateName>NY</a:StateName>
               <a:StreetName>6th Ave</a:StreetName>
               <a:StreetNumber>1260</a:StreetNumber>
               <a:TaxJurisdictionName>NEW YORK</a:TaxJurisdictionName>
               <a:TimeZone/>
               <a:UnderlyingFipsCode>3606151000</a:UnderlyingFipsCode>
            </a:AddressLocation>
         </GeocodeAllMatchesResult>
      </GeocodeAllMatchesResponse>
   </s:Body>
</s:Envelope>

See Also

Input

Results

PreviousNext