Input & Output by API

Overview

Each API is described with its request and response parameters are defined here.

APIs

establishSession

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

</request>

Response:

<?xml version="1.0" encoding="utf-8"?>

<xsd:schema attributeFormDefault="unqualified" elementFormDefault="qualified" version="1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <xsd:element name="response">

    <xsd:complexType>

      <xsd:sequence>

        <xsd:element name="sessionId" type="xsd:string" />

      </xsd:sequence>

    </xsd:complexType>

  </xsd:element>

</xsd:schema>

terminateSession

Request:

<request>

       <sessionId> SESSION_ID </sessionId>

</request>

Response:

See Message Response.

getRateforLocation

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

      <locationCode>LOCATIONCODE</locationCode>

            <transactionDate>YYYY-MM-DD</transactionDate

       <locationName>LOCATIONNAME</locationName>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

       <taxType>TAXTYPE</taxType>

       <subCompanyName>SUBCOMPANYNAME</subCompanyName>

       <vertical>VERTICAL</vertical>

</request>

Response:

See Rate Response.

getRate

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <zip>ZIP</zip>

       <taxType>TAXTYPE</taxType>

       <state>STATE</state>

       <county>COUNTY</county>

       <city>CITY</city>

       <vertical>VERTICAL</vertical>

</request>

Response:

See Rate Response.

getRateHighest

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <zip>ZIP</zip>

       <taxType>TAXTYPE</taxType>

       <state>STATE</state>

       <county>COUNTY</county>

       <city>CITY</city>

       <vertical >VERTICAL </vertical >

</request>

Response:

See Rate Response.

getRateLowest

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <zip>ZIP</zip>

       <taxType>TAXTYPE</taxType>

       <state>STATE</state>

       <county>COUNTY</county>

       <city>CITY</city>

       <vertical>VERTICAL</vertical>

</request>

Response:

See Rate Response.

getRateforGeocode

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <geocode>GEOCODE</geocode>

       <zip>ZIP</zip>

       <taxType>TAXTYPE</taxType>

       <vertical>VERTICAL</vertical>

</request>

Response:

See Rate Response.

getAllLocations

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

       <subCompanyName>SUBCOMPANYNAME</subCompanyName>

</request>

Response:

See Location Response.

getAllMappedLocations

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

       <subCompanyName>SUBCOMPANYNAME</subCompanyName>

</request>

Response:

See Location Response.

getAllUnmappedLocations

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

       <subCompanyName>SUBCOMPANYNAME</subCompanyName>

</request>

Response:

See Location Response.

getLastUpdated

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

</request>

Response:

<?xml version="1.0" encoding="utf-16"?>

<xsd:schema attributeFormDefault="unqualified" elementFormDefault="qualified" version="1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <xsd:element name="response">

    <xsd:complexType>

      <xsd:sequence>

        <xsd:element name="lastUpdate" type="xsd:dateTime" />

      </xsd:sequence>

    </xsd:complexType>

  </xsd:element>

</xsd:schema>

createLocation

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <locationName>LOCATIONNAME</locationName>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

       <subCompanyName>SUBCOMPANYNAME</subCompanyName>

       <locationCode>LOCATIONCODE</locationCode>

       <streetAddress1>STREETADDRESS1</streetAddress1>

       <streetAddress2>STREETADDRESS2</streetAddress2>

       <county>COUNTY</county>

       <city>CITY</city>

       <state>STATE</state>

       <country>COUNTRY</country>

       <zip>ZIP</zip>

       <latitude>LATITUDE</latitude>

       <longitude>LONGITUDE</longitude>

       <oclIndicator>OCLINDICATOR</oclIndicator>

</request>

Response:

See Message Response.

updateLocation

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <locationId>LOCATIONID</locationId>

       <locationName>LOCATIONNAME</locationName>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

       <subCompanyName>SUBCOMPANYNAME</subCompanyName>

       <newLocationName>NEWLOCATIONNAME</newLocationName>

       <newParentCompanyName>NEWPARENTCOMPANYNAME</newParentCompanyName>

       <newSubCompanyName>NEWSUBCOMPANYNAME</newSubCompanyName>

       <locationCode>LOCATIONCODE</locationCode>

       <streetAddress1>STREETADDRESS1</streetAddress1>

       <streetAddress2>STREETADDRESS2</streetAddress2>

       <county>COUNTY</county>

       <city>CITY</city>

       <state>STATE</state>

       <country>COUNTRY</country>

       <zip>ZIP</zip>

       <latitude>LATITUDE</latitude>

       <longitude>LONGITUDE</longitude>

       <oclIndicator>OCLINDICATOR</oclIndicator>

</request>

Response:

See Message Response.

deleteLocation

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <locationId>LOCATIONID</locationId>

       <locationName>LOCATIONNAME</locationName>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

       <subCompanyName>SUBCOMPANYNAME</subCompanyName>

</request>

Response:

See Message Response.

createCompany

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <companyName>COMPANYNAME</companyName>

</request>

Response:

See Message Response.

updateCompany

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <companyName>COMPANYNAME</companyName>

       <newCompanyName>NEWCOMPANYNAME</newCompanyName>

</request>

Response:

See Message Response.

deleteCompany

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <companyName>COMPANYNAME</companyName>

</request>

Response:

See Message Response.

createSubCompany

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

       <subCompanyName>SUBCOMPANYNAME</subCompanyName>

</request>

Response:

See Message Response.

updateSubCompany

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

       <subCompanyName>SUBCOMPANYNAME</subCompanyName>

       <newParentCompanyName>NEWPARENTCOMPANYNAME</newParentCompanyName>

       <newSubCompanyName>NEWSUBCOMPANYNAME</newSubCompanyName>

</request>

Response:

See Message Response.

deleteSubCompany

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

       <subCompanyName>SUBCOMPANYNAME</subCompanyName>

</request>

Response:

See Message Response.

mapLocation

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <locationId>LOCATIONID</locationId>

       <locationName>LOCATIONNAME</locationName>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

       <subCompanyName>SUBCOMPANYNAME</subCompanyName>

       <geocode>GEOCODE</geocode>

       <zip>ZIP</zip>

       <sdCode>SDCODE</sdCode>

       <city >CITY </city >

</request>

Response:

See Message Response.

getMappedGeocode

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <locationId>LOCATIONID</locationId>

       <locationName>LOCATIONNAME</locationName>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

       <subCompanyName>SUBCOMPANYNAME</subCompanyName>

</request>

Response:

See Geocode Response.

getUnmappedGeocode

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <locationId>LOCATIONID</locationId>

       <locationName>LOCATIONNAME</locationName>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

       <subCompanyName>SUBCOMPANYNAME</subCompanyName>

</request>

Response:

See Geocode Response.

getHighestUnmappedGeocode

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <locationId>LOCATIONID</locationId>

       <locationName>LOCATIONNAME</locationName>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

       <subCompanyName>SUBCOMPANYNAME</subCompanyName>

       <taxType>TAXTYPE</taxType>

</request>

Response:

See Geocode Response.

getLowestUnmappedGeocode

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <locationId>LOCATIONID</locationId>

       <locationName>LOCATIONNAME</locationName>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

       <subCompanyName>SUBCOMPANYNAME</subCompanyName>

       <taxType>TAXTYPE</taxType>

</request>

Response:

See Geocode Response.

getHighestGeocode

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <zip>ZIP</zip>

       <taxType>TAXTYPE</taxType>

       <state>STATE</state>

       <county>COUNTY</county>

       <city>CITY</city>

       <vertical>VERTICAL</vertical>

</request>

Response:

See Geocode Response.

getLowestGeocode

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <zip>ZIP</zip>

       <taxType>TAXTYPE</taxType>

       <state>STATE</state>

       <county>COUNTY</county>

       <city>CITY</city>

       <vertical>VERTICAL</vertical>

</request>

Response:

See Geocode Response.

getAllCompanies

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

</request>

Response:

See Company Response.

getAllSubCompanies

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

</request>

Response:

See SubCompany Response.

createUser

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <newUsername>NEWUSERNAME</newUsername>

       <newUserPassword>NEWUSERPASSWORD</newUserPassword>

       <userEnabled>USERENABLED</userEnabled>

       <roleName>ROLENAME</roleName>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

       <subCompanyName>SUBCOMPANYNAME</subCompanyName>

</request>

Response:

See Message Response.

deleteParentUser

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

       <deleteUsername>DELETEUSERNAME</deleteUsername>

</request>

Response:

See Message Response.

deleteSubUser

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

       <subCompanyName>SUBCOMPANYNAME</subCompanyName>

       <deleteUsername>DELETEUSERNAME</deleteUsername>

</request>

Response:

See Message Response.

updateParentUser

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

       <updateUsername>UPDATEUSERNAME</updateUsername>

       <newParentCompanyName>NEWPARENTCOMPANYNAME</newParentCompanyName>

</request>

Response:

See Message Response.

updateSubUser

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

       <subCompanyName>SUBCOMPANYNAME</subCompanyName>

       <updateUsername>UPDATEUSERNAME</updateUsername>

       <newSubCompanyName>NEWSUBCOMPANYNAME</newSubCompanyName>

</request>

Response:

See Message Response.

updateMappedGeocode

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <locationId>LOCATIONID</locationId>

       <locationName>LOCATIONNAME</locationName>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

       <subCompanyName>SUBCOMPANYNAME</subCompanyName>

       <newGeocode>NEWGEOCODE</newGeocode>

       <zip>ZIP</zip>

       <sdCode>SDCODE</sdCode>

       <city>CITY</city>

</request>

Response:

See Message Response.

isMapped

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <locationId>LOCATIONID</locationId>

       <locationName>LOCATIONNAME</locationName>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

       <subCompanyName>SUBCOMPANYNAME</subCompanyName>

</request>

Response:

See Value Response.

getLocationId

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <locationName>LOCATIONNAME</locationName>

       <parentCompanyName>PARENTCOMPANYNAME</parentCompanyName>

       <subCompanyName>SUBCOMPANYNAME</subCompanyName>

</request>

Response:

See LocationId Response.

getDefaultMailingRate

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <zip>ZIP</zip>

       <taxType>TAXTYPE</taxType>

       <state>STATE</state>

       <county>COUNTY</county>

       <city>CITY</city>

       <vertical>VERTICAL</vertical>

</request>

Response:

See Rate Response.

getDefaultMailingGeocode

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <zip>ZIP</zip>

       <taxType>TAXTYPE</taxType>

       <state>STATE</state>

       <county>COUNTY</county>

       <city>CITY</city>

       <vertical>VERTICAL</vertical>

</request>

Response:

See Geocode Response.

getRateforGeoSpatial

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <fipscode>FIPSCODE</fipscode>

       <taxType>TAXTYPE</taxType>

       <specialTypes>SPECIALTYPES</specialTypes>

       <vertical>VERTICAL</vertical>

</request>

Response:

See Rate Response.

getRateforLatLon

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <latitude>LATITUDE</latitude>

       <longitude>LONGITUDE</longitude>

       <taxType>TAXTYPE</taxType>

       <vertical>VERTICAL</vertical>

</request>

Response:

See Rate Response.

cleanseAddress

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

       <streetAddress1>STREETADDRESS1</streetAddress1>

       <streetAddress2>STREETADDRESS2</streetAddress2>

       <city>CITY</city>

       <state>STATE</state>

       <country>COUNTRY</country>

       <zip>ZIP</zip>

</request>

Response:

See Address Response.

getStreetLevelRate

Request:

<request>

       <username>RATEPOINT_USERNAME</username>

       <password>RATEPOINT_PASSWORD</password>

    <transactionDate>YYYY-MM-DD</transactionDate>

       <streetAddress1>STREETADDRESS1</streetAddress1>

       <streetAddress2>STREETADDRESS2</streetAddress2>

       <city>CITY</city>

       <state>STATE</state>

       <country>COUNTRY</country>

       <zip>ZIP</zip>

       <taxType>TAXTYPE</taxType>

       <vertical>VERTICAL</vertical>

</request>

Response:

See Rate with Address Response.