TaxCloud Web Service Base Documentation

Click here for a complete list of operations.

OrderDetails

Review Jurisdiction Details for a Captured Order

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /1.0 HTTP/1.1
Host: api.taxcloud.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://taxcloud.net/OrderDetails"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <OrderDetails xmlns="http://taxcloud.net">
      <apiLoginID>string</apiLoginID>
      <apiKey>string</apiKey>
      <orderID>string</orderID>
    </OrderDetails>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <OrderDetailsResponse xmlns="http://taxcloud.net">
      <OrderDetailsResult>
        <CartItems>
          <CartItemDetailsResponse>
            <CartItemIndex>int</CartItemIndex>
            <ItemID>string</ItemID>
            <TIC>string</TIC>
            <Price>double</Price>
            <ItemQty>float</ItemQty>
            <SubTotal>double</SubTotal>
            <TaxAmount>double</TaxAmount>
            <CapturedDate>string</CapturedDate>
            <ReturnedDate>string</ReturnedDate>
            <TaxType>string</TaxType>
            <StateName>string</StateName>
            <StateCode>string</StateCode>
            <StateRate>decimal</StateRate>
            <StateTax>double</StateTax>
            <CountyName>string</CountyName>
            <CountyCode>string</CountyCode>
            <CountyRate>decimal</CountyRate>
            <CountyTax>double</CountyTax>
            <CityName>string</CityName>
            <CityCode>string</CityCode>
            <CityRate>decimal</CityRate>
            <CityTax>double</CityTax>
            <OtherName>string</OtherName>
            <OtherCode>string</OtherCode>
            <OtherRate>decimal</OtherRate>
            <OtherTax>double</OtherTax>
          </CartItemDetailsResponse>
          <CartItemDetailsResponse>
            <CartItemIndex>int</CartItemIndex>
            <ItemID>string</ItemID>
            <TIC>string</TIC>
            <Price>double</Price>
            <ItemQty>float</ItemQty>
            <SubTotal>double</SubTotal>
            <TaxAmount>double</TaxAmount>
            <CapturedDate>string</CapturedDate>
            <ReturnedDate>string</ReturnedDate>
            <TaxType>string</TaxType>
            <StateName>string</StateName>
            <StateCode>string</StateCode>
            <StateRate>decimal</StateRate>
            <StateTax>double</StateTax>
            <CountyName>string</CountyName>
            <CountyCode>string</CountyCode>
            <CountyRate>decimal</CountyRate>
            <CountyTax>double</CountyTax>
            <CityName>string</CityName>
            <CityCode>string</CityCode>
            <CityRate>decimal</CityRate>
            <CityTax>double</CityTax>
            <OtherName>string</OtherName>
            <OtherCode>string</OtherCode>
            <OtherRate>decimal</OtherRate>
            <OtherTax>double</OtherTax>
          </CartItemDetailsResponse>
        </CartItems>
        <OrderID>string</OrderID>
        <LookupDate>string</LookupDate>
        <AuthorizedDate>string</AuthorizedDate>
        <CapturedDate>string</CapturedDate>
        <ReturnedDate>string</ReturnedDate>
        <ExemptionCertificateID>string</ExemptionCertificateID>
      </OrderDetailsResult>
    </OrderDetailsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /1.0 HTTP/1.1
Host: api.taxcloud.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <OrderDetails xmlns="http://taxcloud.net">
      <apiLoginID>string</apiLoginID>
      <apiKey>string</apiKey>
      <orderID>string</orderID>
    </OrderDetails>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <OrderDetailsResponse xmlns="http://taxcloud.net">
      <OrderDetailsResult>
        <CartItems>
          <CartItemDetailsResponse>
            <CartItemIndex>int</CartItemIndex>
            <ItemID>string</ItemID>
            <TIC>string</TIC>
            <Price>double</Price>
            <ItemQty>float</ItemQty>
            <SubTotal>double</SubTotal>
            <TaxAmount>double</TaxAmount>
            <CapturedDate>string</CapturedDate>
            <ReturnedDate>string</ReturnedDate>
            <TaxType>string</TaxType>
            <StateName>string</StateName>
            <StateCode>string</StateCode>
            <StateRate>decimal</StateRate>
            <StateTax>double</StateTax>
            <CountyName>string</CountyName>
            <CountyCode>string</CountyCode>
            <CountyRate>decimal</CountyRate>
            <CountyTax>double</CountyTax>
            <CityName>string</CityName>
            <CityCode>string</CityCode>
            <CityRate>decimal</CityRate>
            <CityTax>double</CityTax>
            <OtherName>string</OtherName>
            <OtherCode>string</OtherCode>
            <OtherRate>decimal</OtherRate>
            <OtherTax>double</OtherTax>
          </CartItemDetailsResponse>
          <CartItemDetailsResponse>
            <CartItemIndex>int</CartItemIndex>
            <ItemID>string</ItemID>
            <TIC>string</TIC>
            <Price>double</Price>
            <ItemQty>float</ItemQty>
            <SubTotal>double</SubTotal>
            <TaxAmount>double</TaxAmount>
            <CapturedDate>string</CapturedDate>
            <ReturnedDate>string</ReturnedDate>
            <TaxType>string</TaxType>
            <StateName>string</StateName>
            <StateCode>string</StateCode>
            <StateRate>decimal</StateRate>
            <StateTax>double</StateTax>
            <CountyName>string</CountyName>
            <CountyCode>string</CountyCode>
            <CountyRate>decimal</CountyRate>
            <CountyTax>double</CountyTax>
            <CityName>string</CityName>
            <CityCode>string</CityCode>
            <CityRate>decimal</CityRate>
            <CityTax>double</CityTax>
            <OtherName>string</OtherName>
            <OtherCode>string</OtherCode>
            <OtherRate>decimal</OtherRate>
            <OtherTax>double</OtherTax>
          </CartItemDetailsResponse>
        </CartItems>
        <OrderID>string</OrderID>
        <LookupDate>string</LookupDate>
        <AuthorizedDate>string</AuthorizedDate>
        <CapturedDate>string</CapturedDate>
        <ReturnedDate>string</ReturnedDate>
        <ExemptionCertificateID>string</ExemptionCertificateID>
      </OrderDetailsResult>
    </OrderDetailsResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /1.0/OrderDetails HTTP/1.1
Host: api.taxcloud.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

apiLoginID=string&apiKey=string&orderID=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<OrderDetailsRsp xmlns="http://taxcloud.net">
  <CartItems>
    <CartItemDetailsResponse>
      <CartItemIndex>int</CartItemIndex>
      <ItemID>string</ItemID>
      <TIC>string</TIC>
      <Price>double</Price>
      <ItemQty>float</ItemQty>
      <SubTotal>double</SubTotal>
      <TaxAmount>double</TaxAmount>
      <CapturedDate>string</CapturedDate>
      <ReturnedDate>string</ReturnedDate>
      <TaxType>string</TaxType>
      <StateName>string</StateName>
      <StateCode>string</StateCode>
      <StateRate>decimal</StateRate>
      <StateTax>double</StateTax>
      <CountyName>string</CountyName>
      <CountyCode>string</CountyCode>
      <CountyRate>decimal</CountyRate>
      <CountyTax>double</CountyTax>
      <CityName>string</CityName>
      <CityCode>string</CityCode>
      <CityRate>decimal</CityRate>
      <CityTax>double</CityTax>
      <OtherName>string</OtherName>
      <OtherCode>string</OtherCode>
      <OtherRate>decimal</OtherRate>
      <OtherTax>double</OtherTax>
    </CartItemDetailsResponse>
    <CartItemDetailsResponse>
      <CartItemIndex>int</CartItemIndex>
      <ItemID>string</ItemID>
      <TIC>string</TIC>
      <Price>double</Price>
      <ItemQty>float</ItemQty>
      <SubTotal>double</SubTotal>
      <TaxAmount>double</TaxAmount>
      <CapturedDate>string</CapturedDate>
      <ReturnedDate>string</ReturnedDate>
      <TaxType>string</TaxType>
      <StateName>string</StateName>
      <StateCode>string</StateCode>
      <StateRate>decimal</StateRate>
      <StateTax>double</StateTax>
      <CountyName>string</CountyName>
      <CountyCode>string</CountyCode>
      <CountyRate>decimal</CountyRate>
      <CountyTax>double</CountyTax>
      <CityName>string</CityName>
      <CityCode>string</CityCode>
      <CityRate>decimal</CityRate>
      <CityTax>double</CityTax>
      <OtherName>string</OtherName>
      <OtherCode>string</OtherCode>
      <OtherRate>decimal</OtherRate>
      <OtherTax>double</OtherTax>
    </CartItemDetailsResponse>
  </CartItems>
  <OrderID>string</OrderID>
  <LookupDate>string</LookupDate>
  <AuthorizedDate>string</AuthorizedDate>
  <CapturedDate>string</CapturedDate>
  <ReturnedDate>string</ReturnedDate>
  <ExemptionCertificateID>string</ExemptionCertificateID>
</OrderDetailsRsp>