Radial Integration | 2016

TDF Tax Quote

Overview

The webstore calls the TDF Tax Quote operation to perform the following tax quote processing:

• Calculate and return the tax quote for every line item.
• Calculate the duties and applicable taxes for international shipments, based on the inputs and configuration.
• Calculate tax for duty, for any line items that have duty.
• Calculate any legal fees and applicable taxes.
• Calculate tax for fees, for any line items that have fees.

This synchronous operation creates a quote request (TaxDutyQuoteRequest) on the Tax Service and returns either a valid response (TaxDutyQuoteResponse) or a fault with details.

URI Summary

Schemas

• TaxDutyFee-Datatypes-1.0.xsd
• TaxDutyFee-QuoteRequest-1.0.xsd
• TaxDutyFee-QuoteResponse-1.0.xsd

Request Example

The request is a TaxDutyQuoteRequest message.

<TaxDutyQuoteRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://api.gsicommerce.com/schema/checkout/1.0 
   TaxDutyFee-QuoteRequest-1.0.xsd">
   <Currency>USD</Currency>
   <VATInclusivePricing>false</VATInclusivePricing>
   <CustomerTaxId>string</CustomerTaxId>
   <BillingInformation ref="bill_dest1"/>
   <Shipping>
      <ShipGroups>
         <ShipGroup id="shipgroup_1">
            <DestinationTarget ref="dest1"/>
            <Items>
               <OrderItem lineNumber="1">
                  <ItemId>1</ItemId>
                  <ItemDesc>shirt</ItemDesc>
                  <HTSCode>newCode</HTSCode>
                  <Origins>
                     <AdminOrigin>
                        <Line1>401 Allendale Rd</Line1>
                        <Line2>Building 1</Line2>
                        <Line3>Floor 2</Line3>
                        <Line4>Appartment 3</Line4>
                        <City>King of Prussia</City>
                        <MainDivision>PA</MainDivision>
                        <CountryCode>USA</CountryCode>
                        <PostalCode>19460</PostalCode>
                     </AdminOrigin>
                     <ShippingOrigin>
                        <Line1>401 Allendale Rd</Line1>
                        <Line2>Building 1</Line2>
                        <Line3>Floor 2</Line3>
                        <Line4>Appartment 3</Line4>
                        <City>King of Prussia</City>
                        <MainDivision>PA</MainDivision>
                        <CountryCode>USA</CountryCode>
                        <PostalCode>19460</PostalCode>
                     </ShippingOrigin>
                     <ManufacturingCountryCode>US</ManufacturingCountryCode>
                  </Origins>
                  <Quantity>3</Quantity>
                  <Pricing>
                     <Merchandise>
                        <Amount>1000.00</Amount>
                        <TaxClass>93000</TaxClass>
                        <PromotionalDiscounts>
                           <Discount id="id1" calculateDuty="true">
                              <Amount>100.00</Amount>
                           </Discount>
                        </PromotionalDiscounts>
                        <UnitPrice>100.00</UnitPrice>
                     </Merchandise>
                     <Shipping>
                        <Amount>100.00</Amount>
                        <PromotionalDiscounts>
                           <Discount id="id2" calculateDuty="true">
                              <Amount>10.00</Amount>
                           </Discount>
                        </PromotionalDiscounts>
                     </Shipping>
                     <Duty>
                        <Amount>100.00</Amount>
                        <PromotionalDiscounts>
                           <Discount id="id3" calculateDuty="true">
                              <Amount>10.00</Amount>
                           </Discount>
                        </PromotionalDiscounts>
                        <CalculationError>string</CalculationError>
                     </Duty>
                  </Pricing>
                  <Gifting id="giftingId">
                     <ItemId>itemId</ItemId>
                     <ItemDesc>itemDesc</ItemDesc>
                     <Pricing>
                        <Amount>1000.00</Amount>
                        <TaxClass>93000</TaxClass>
                        <PromotionalDiscounts>
                           <Discount id="discountId" calculateDuty="true">
                              <Amount>100.00</Amount>
                           </Discount>
                        </PromotionalDiscounts>
                        <UnitPrice>1000.00</UnitPrice>
                     </Pricing>
                  </Gifting>
                  <Customization>
                     <CustomFeatureList>
                        <CustomFeature id="color-blue">
                           <CustomizationId>1234</CustomizationId>
                           <ItemId>blueId</ItemId>
                           <ItemDesc>Color Blue</ItemDesc>
                           <Upcharge>
                              <Amount>100.00</Amount>
                              <TaxClass>93000</TaxClass>
                              <PromotionalDiscounts>
                                 <Discount id="discountid" calculateDuty="true">
                                    <Amount>10.00</Amount>
                                 </Discount>
                              </PromotionalDiscounts>
                              <UnitPrice>100.00</UnitPrice>
                           </Upcharge>
                        </CustomFeature>
                     </CustomFeatureList>
                     <BasePrice>
                        <Amount>100.00</Amount>
                        <TaxClass>93000</TaxClass>
                        <PromotionalDiscounts>
                           <Discount id="discountId" calculateDuty="false">
                              <Amount>10.00</Amount>
                           </Discount>
                        </PromotionalDiscounts>
                        <UnitPrice>1000.00</UnitPrice>
                     </BasePrice>
                  </Customization>
               </OrderItem>
            </Items>
            <Gifting id="giftingId">
               <ItemId>itemId</ItemId>
               <ItemDesc>itemDesc</ItemDesc>
               <Pricing>
                  <Amount>1000.00</Amount>
                  <TaxClass>9300</TaxClass>
                  <PromotionalDiscounts>
                     <Discount id="discountId" calculateDuty="false">
                        <Amount>100.00</Amount>
                     </Discount>
                  </PromotionalDiscounts>
                  <UnitPrice>1000.00</UnitPrice>
               </Pricing>
            </Gifting>
         </ShipGroup>
      </ShipGroups>
      <Destinations>
         <MailingAddress id="bill_dest1">
            <PersonName>
               <LastName>John</LastName>
               <FirstName>Smith</FirstName>
            </PersonName>
            <Address>
               <Line1>401 Allendale Rd</Line1>
               <Line2>Building 1</Line2>
               <Line3>Floor 2</Line3>
               <Line4>Appartment 3</Line4>
               <City>King of Prussia</City>
               <MainDivision>PA</MainDivision>
               <CountryCode>USA</CountryCode>
               <PostalCode>19460</PostalCode>
            </Address>
         </MailingAddress>
         <MailingAddress id="dest1">
            <PersonName>
               <LastName>John</LastName>
               <FirstName>Smith</FirstName>
            </PersonName>
            <Address>
               <Line1>401 Allendale Rd</Line1>
               <Line2>Building 1</Line2>
               <Line3>Floor 2</Line3>
               <Line4>Appartment 3</Line4>
               <City>King of Prussia</City>
               <MainDivision>PA</MainDivision>
               <CountryCode>USA</CountryCode>
               <PostalCode>19460</PostalCode>                
            </Address>
         </MailingAddress>
      </Destinations>
   </Shipping>
</TaxDutyQuoteRequest>

Response Example

The response is a TaxDutyQuoteResponse message.

<TaxDutyQuoteResponse xmlns="http://api.gsicommerce.com/schema/checkout/1.0"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://api.gsicommerce.com/schema/checkout/1.0 
   TaxDutyFee-QuoteResponse-1.0.xsd">
   <Shipping>
      <ShipGroups>
         <ShipGroup id="ship_group1">
            <DestinationTarget ref="dest1"/>
            <Items>
               <OrderItem lineNumber="1">
                  <ItemId>123</ItemId>
                  <ItemDesc>Black Tennis Shoes</ItemDesc>
                  <HTSCode>duty code</HTSCode>
                  <Quantity>2</Quantity>
                  <Pricing>
                     <Merchandise>
                        <Amount>1000.00</Amount>
                        <TaxData>
                           <TaxClass>9300</TaxClass>
                           <Taxes>
                              <Tax taxType="SALES" taxability="TAXABLE">
                                 <Situs>DESTINATION</Situs>
                                 <Jurisdiction jurisdictionLevel="STATE" 
                                 jurisdictionId="PA">Pennsylvania</Jurisdiction>
                                 <Imposition impositionType="imp">imposition</Imposition>
                                 <EffectiveRate>0.06</EffectiveRate>
                                 <TaxableAmount>1000.00</TaxableAmount>
                                 <CalculatedTax>60.00</CalculatedTax>
                                 <SellerRegistrationId>123</SellerRegistrationId>
                              </Tax>
                           </Taxes>
                        </TaxData>
                        <PromotionalDiscounts>
                           <Discount id="334" calculateDuty="false">
                              <Amount>20.00</Amount>
                              <Taxes>
                                 <Tax taxType="SALES" taxability="TAXABLE">
                                    <Situs>DESTINATION</Situs>
                                    <Jurisdiction jurisdictionLevel="STATE" 
                                    jurisdictionId="PA">Pennsylvania</Jurisdiction>
                                    <Imposition impositionType="imp">imposition</Imposition>
                                    <EffectiveRate>0.06</EffectiveRate>
                                    <TaxableAmount>20.00</TaxableAmount>
                                    <CalculatedTax>1.20</CalculatedTax>
                                    <SellerRegistrationId>123</SellerRegistrationId>
                                 </Tax>
                              </Taxes>
                           </Discount>
                        </PromotionalDiscounts>
                        <UnitPrice>500.00</UnitPrice>
                     </Merchandise>
                     <Shipping>
                        <Amount>20.00</Amount>
                        <TaxData>
                           <TaxClass>34343</TaxClass>
                           <Taxes>
                              <Tax taxType="SALES" taxability="TAXABLE">
                                 <Situs>DESTINATION</Situs>
                                 <Jurisdiction jurisdictionLevel="STATE" 
                                 jurisdictionId="PA">Pennsylvania</Jurisdiction>
                                 <Imposition impositionType="imp">imposition</Imposition>
                                 <EffectiveRate>0.06</EffectiveRate>
                                 <TaxableAmount>20.00</TaxableAmount>
                                 <CalculatedTax>1.20</CalculatedTax>
                                 <SellerRegistrationId>123</SellerRegistrationId>
                              </Tax>
                           </Taxes>
                        </TaxData>
                     </Shipping>
                     <Duty>
                        <Amount>4.00</Amount>
                        <TaxData>
                           <TaxClass>34343</TaxClass>
                           <Taxes>
                              <Tax taxType="IMPORT_VAT" taxability="TAXABLE">
                                 <Situs>DESTINATION</Situs>
                                 <Jurisdiction jurisdictionLevel="STATE" 
                                 jurisdictionId="PA">Pennsylvania</Jurisdiction>
                                 <Imposition impositionType="imp">imposition</Imposition>
                                 <EffectiveRate>0.04</EffectiveRate>
                                 <TaxableAmount>4.00</TaxableAmount>
                                 <CalculatedTax>0.16</CalculatedTax>
                                 <SellerRegistrationId>123</SellerRegistrationId>
                              </Tax>
                           </Taxes>
                        </TaxData>
                     </Duty>
                  </Pricing>
               </OrderItem>
            </Items>
            <Gifting id="giftingId">
               <ItemId>itemId</ItemId>
               <ItemDesc>itemDesc</ItemDesc>
               <Pricing>
                  <Amount>1000.00</Amount>
                  <TaxClass>9300</TaxClass>
                  <PromotionalDiscounts>
                     <Discount id="discountId" calculateDuty="false">
                        <Amount>100.00</Amount>
                     </Discount>
                  </PromotionalDiscounts>
                  <UnitPrice>1000.00</UnitPrice>
               </Pricing>
            </Gifting>
         </ShipGroup>
      </ShipGroups>
      <Destinations>
         <MailingAddress id="dest1">
            <PersonName>
               <LastName>John</LastName>
               <FirstName>Smith</FirstName>
            </PersonName>
            <Address>
               <Line1>630 Allendale Road</Line1>
               <City>King Of Prussia</City>
               <MainDivision>PA</MainDivision>
               <CountryCode>US</CountryCode>
               <PostalCode>19406</PostalCode>
            </Address>
         </MailingAddress>
      </Destinations>
   </Shipping>
   <TaxTransactionId>3721007</TaxTransactionId>
</TaxDutyQuoteResponse>

Request and Response Data Elements

Fault Responses

Invalid XML

<?xml version="1.0" encoding="UTF-8"?>
<Fault xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <CreateTimestamp>2011-07-23T20:07:39+00:00</CreateTimestamp>
   <Code>INVALID_XML</Code>
   <Description>The xml submitted for quote request was invalid.</Description>
</Fault>

Internal Error

<?xml version="1.0" encoding="UTF-8"?>
<Fault xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <CreateTimestamp>2011-07-23T20:07:39+00:00</CreateTimestamp>
   <Code>INTERNAL_ERROR</Code>
   <Description>There was an internal server error.</Description>
</Fault>
  
<?xml version="1.0" encoding="UTF-8"?>
<Fault xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <CreateTimestamp/>
   <Code>INTERNAL_ERROR</Code>
   <Description>Vertex call failed. With error: An error occurred while calculating tax on transaction
   identified by "1". This may be an incorrect use of the calculation engine. Please contact your 
   software vendor. Error trying to calculate tax on transaction identified by (1). Unknown country. 
   Expecting an ISO Country Code - Alpha 3 (e.g., USA), or a well-known country name (e.g., United States 
   of America). (country=AA) </Description>
</Fault>

<?xml version="1.0" encoding="UTF-8"?>
<Fault xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <CreateTimestamp/>
   <Code>INTERNAL_ERROR</Code>
   <Description>Discount found more than the amount. Please check your request for accuracy.</Description>
</Fault>

Invalid Request

<?xml version="1.0" encoding="UTF-8"?>
<Fault xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <CreateTimestamp>2015-08-20T17:18:29+00:00</CreateTimestamp>
   <Code>InvalidRequestXmlException</Code>
   <Description>cvc-complex-type.2.4.a: Invalid content was found starting with element 
   'CurrencyConversionRate'. One of '{"http://api.gsicommerce.com/schema/checkout/1.0":Currency}' 
   is expected.</Description>
</Fault>

<?xml version="1.0" encoding="UTF-8"?>
<Fault xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <CreateTimestamp>2015-08-20T17:18:18+00:00</CreateTimestamp>
   <Code>InvalidRequestXmlException</Code>
   <Description>The element type "Currency" must be terminated by the matching end-tag "</Currency>".</Description>
</Fault>

<?xml version="1.0" encoding="UTF-8"?>
<Fault xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <CreateTimestamp>2015-08-20T17:16:43+00:00</CreateTimestamp>
   <Code>InvalidRequestXmlException</Code>
   <Description>cvc-enumeration-valid: Value 'USDx' is not facet-valid with respect to enumeration '
   [AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, 
   BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EEK, 
   EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, GWP, HKD, HNL, HRK, HTG, HUF, 
   IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, 
   LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, 
   NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, 
   SBD, SCR, SDG, SEK, SGD, SHP, SKK, SLL, SOS, SRD, STD, SVC, SYP, SZL, THB, TJS, TMM, TND, TOP, TRY, 
   TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XDR, XOF, XPF, YER, ZAR, ZMK, 
   ZWR]'. It must be a value from the enumeration.</Description>
</Fault>

Copyright © 2017 Radial. All rights reserved.