Radial Integration | 2016

TDF Tax Distribute

Overview

The order management system calls the TDF Tax Distribute operation to perform the following processing:

• Account for tax credits.
• Distribute tax credits for any adjustments.
• Record tax credit details for legal and reporting purposes.

This asynchronous operation creates a distribute request (TaxDistributeRequest) on the Tax Service and returns an acknowledgment (AckReply).

URI Summary

Schemas

• TaxDutyFee-Datatypes-1.0.xsd
• TaxDutyFee-DistributeRequest-1.0.xsd

Request Example

The request is a TaxDistributeRequest message.

<?xml version="1.0" encoding="UTF-8"?>
<TaxDistributeRequest  xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <OrderId>0001200001234502</OrderId>
   <OriginalOrderId>0001200001234500</OriginalOrderId>
   <WebOrderNumber>00145678908</WebOrderNumber>
   <InvoiceNumber>42374659867655665</InvoiceNumber>
   <OrderDateTime>2014-01-30T14:58:08.707Z</OrderDateTime>
   <OriginalOrderDateTime>2014-01-29T14:58:08.707Z</OriginalOrderDateTime>
   <ShipDateTime>2014-01-31T14:58:08.707Z</ShipDateTime>
   <Currency>USD</Currency>
   <CurrencyConversionRate>1.00</CurrencyConversionRate>
   <VATInvoiceNumber>12456</VATInvoiceNumber>
   <CustomerTaxId>12345</CustomerTaxId>
   <BillingInformation ref="bill_dest_1"/>
   <!--Optional:-->
   <Shipping>
      <ShipGroups>
         <ShipGroup chargeType="FLATRATE" id="shipgroup_1">
            <DestinationTarget ref="dest_1"/>
            <Items>
               <OrderItem lineNumber="1">
                  <ItemId>123457175304</ItemId>
                  <ItemDesc>Product Description</ItemDesc>
                  <HTSCode>1234.12.1234</HTSCode>
                  <VendorPartNumber>TDF7889</VendorPartNumber>
                  <ShippingCartonId>1XZ4556</ShippingCartonId>
                  <Origins>
                     <AdminOrigin>
                        <Line1>935 1st Ave</Line1>
                        <City>King Of Prussia</City>
                        <MainDivisionCode>PA</MainDivisionCode>
                        <CountryCode>US</CountryCode>
                        <PostalCode>19406</PostalCode>
                     </AdminOrigin>
                     <ShippingOrigin>
                        <Line1>4 Whatever Rd</Line1>
                        <City>Louisville</City>
                        <MainDivisionCode>KY</MainDivisionCode>
                        <CountryCode>US</CountryCode>
                        <PostalCode>40258</PostalCode>
                     </ShippingOrigin>
                     <ManufacturingCountryCode>US</ManufacturingCountryCode>
                  </Origins>
                  <Quantity>1</Quantity>
                  <TaxCreditAmount>-5.00</TaxCreditAmount>
               </OrderItem>
               <OrderItem lineNumber="2">
                  <ItemId>123457175303</ItemId>
                  <ItemDesc>Product Description 2</ItemDesc>
                  <HTSCode>1234.12.1234</HTSCode>
                  <VendorPartNumber>TDF7888</VendorPartNumber>
                  <ShippingCartonId>1XZ4556</ShippingCartonId>
                  <Origins>
                     <AdminOrigin>
                        <Line1>935 1st Ave</Line1>
                        <City>King Of Prussia</City>
                        <MainDivisionCode>PA</MainDivisionCode>
                        <CountryCode>US</CountryCode>
                        <PostalCode>19406</PostalCode>
                     </AdminOrigin>
                     <ShippingOrigin>
                        <Line1>4 Whatever Rd</Line1>
                        <City>Louisville</City>
                        <MainDivisionCode>KY</MainDivisionCode>
                        <CountryCode>US</CountryCode>
                        <PostalCode>40258</PostalCode>
                     </ShippingOrigin>
                     <ManufacturingCountryCode>CA</ManufacturingCountryCode>
                  </Origins>
                  <Quantity>1</Quantity>
                  <TaxCreditAmount>-25.00</TaxCreditAmount>
               </OrderItem>
            </Items>
         </ShipGroup>
      <ShipGroups>
      <Destinations>
         <MailingAddress id="dest_1">
            <PersonName>
               <!--Optional:-->
               <Honorific>Mr</Honorific>
               <LastName>LastName1</LastName>
               <!--Optional:-->
               <MiddleName>MiddleName1</MiddleName>
               <FirstName>FirstName1</FirstName>
               <!--You may enter ANY elements at this point-->
               <!--<AnyElement/>-->
            </PersonName>
            <Address>
               <Line1>123 Elm</Line1>
               <Line2>Line 2</Line2>
               <Line3>Line 3</Line3>
               <City>Philadelphia</City>
               <MainDivisionCode>PA</MainDivisionCode>
               <CountryCode>US</CountryCode>
               <PostalCode>19128</PostalCode>
            </Address>
         </MailingAddress>
         <MailingAddress id="bill_dest_1">
            <PersonName>
               <!--Optional:-->
               <Honorific>Dr</Honorific>
               <LastName>LastName2</LastName>
               <!--Optional:-->
               <MiddleName>MiddleName2</MiddleName>
               <FirstName>FirstName2</FirstName>
               <!--You may enter ANY elements at this point-->
               <!--<AnyElement/>-->
            </PersonName>
            <Address>
               <Line1>630 Allendale Rd</Line1>
               <Line2>Line 2</Line2>
               <Line3>Line 3</Line3>
               <City>King Of Prussia</City>
               <MainDivisionCode>PA</MainDivisionCode>
               <CountryCode>US</CountryCode>
               <PostalCode>19406</PostalCode>
            </Address>
         </MailingAddress>
      </Destinations>
   </Shipping>
   <Fees>
      <Fee>
         <FeeType>ConvenienceStoreSurcharge</FeeType>
         <Description>Payment Convenience Store Surcharge</Description>
         <TaxCreditAmount>-7.00</TaxCreditAmount>
      </Fee>
   </Fees>
</TaxDistributeRequest>

Request Data Elements

Success Response

<?xml version="1.0" encoding="UTF-8"?>
<AckReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <Received/>
</AckReply>

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>

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.