TDF Tax Invoice

Overview

The order management system calls the TDF Tax Invoice operation to invoice the tax data. The operation records the tax details for legal and reporting purposes. This asynchronous operation creates an invoice request (TaxInvoiceRequest) on the Tax Service and returns an acknowledgment (AckReply).

URI Summary

Action	URI Template	URI Example	Non-URI Request	Response
POST	/v[M.m]/stores/[StoreId]/taxes/invoice.[format]	/v1.0/stores/AStoreId/taxes/invoice.xml	XML	200 + XML response

Schemas

Request Example

The request is a TaxInvoiceRequest message.

<?xml version="1.0" encoding="UTF-8"?>
<TaxInvoiceRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <OrderId>12345</OrderId>
   <OriginalOrderId>0001200001234502</OriginalOrderId>
   <WebOrderNumber>00145678908</WebOrderNumber>
   <InvoiceNumber>4237465</InvoiceNumber>
   <InvoiceType>SALE</InvoiceType>
   <OrderDateTime>2007-10-26T02:36:28</OrderDateTime>
   <OriginalOrderDateTime>2004-02-14T13:44:14</OriginalOrderDateTime>
   <ShipDateTime>2018-11-01T01:36:46-04:00</ShipDateTime>
   <Currency>USD</Currency>
   <CurrencyConversionRate>1.00</CurrencyConversionRate>
   <VATInvoiceNumber>12456</VATInvoiceNumber>
   <VATInclusivePricing>true</VATInclusivePricing>
   <CustomerTaxId>12345</CustomerTaxId>
   <BillingInformation ref="bill_dest_1"/>
   <Shipping>
      <ShipGroups>
         <ShipGroup chargeType="FLATRATE" id="shipgroup_1">
            <DestinationTarget ref="dest_1"/>
            <Items>
               <OrderItem lineNumber="1">
                  <ItemId>123457175304</ItemId>
                  <ItemDesc>Product Description</ItemDesc>
                  <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>
                  <Pricing>
                     <Merchandise>
                        <Amount>99.99</Amount>
                        <TaxData>
                           <TaxClass>76800</TaxClass>
                           <QuoteAmount>6.00</QuoteAmount>
                        </TaxData>
                        <PromotionalDiscounts>
                           <Discount>
                              <Code>ONE0FF</Code>
                              <Description>$1 off promo</Description>
                              <Amount>1.00</Amount>
                              <QuoteAmount>0.06</QuoteAmount>
                           </Discount>
                        </PromotionalDiscounts>
                        <Adjustments>
                           <Adjustment>
                              <Description>$1 off adj</Description>
                              <Amount>1.00</Amount>
                              <QuoteAmount>0.06</QuoteAmount>
                           </Adjustment>
                        </Adjustments>
                        <UnitPrice>99.99</UnitPrice>
                     </Merchandise>
                     <PriceGroup>
                        <Amount>19.99</Amount>
                        <TaxData>
                           <TaxClass>93000</TaxClass>
                           <QuoteAmount>1.20</QuoteAmount>
                        </TaxData>
                        <PromotionalDiscounts>
                           <Discount>
                              <Code>ONE0FF</Code>
                              <Description>$1 off promo</Description>
                              <Amount>1.00</Amount>
                              <QuoteAmount>0.06</QuoteAmount>
                           </Discount>
                        </PromotionalDiscounts>
                        <Adjustments>
                           <Adjustment>
                              <Description>$1 off adj</Description>
                              <Amount>1.00</Amount>
                              <QuoteAmount>0.06</QuoteAmount>
                           </Adjustment>
                        </Adjustments>
                     </PriceGroup>
                  </Pricing>
                  <Gifting>
                     <ItemId>12345284742</ItemId>
                     <Pricing>
                        <Amount>3.99</Amount>
                        <TaxData>
                           <TaxClass>89999</TaxClass>
                           <QuoteAmount>0.24</QuoteAmount>
                        </TaxData>
                        <PromotionalDiscounts>
                           <Discount>
                              <Code>ONE0FF</Code>
                              <Description>$1 off promo</Description>
                              <Amount>1.00</Amount>
                              <QuoteAmount>0.06</QuoteAmount>
                           </Discount>
                        </PromotionalDiscounts>
                        <Adjustments>
                           <Adjustment>
                              <Description>$1 off adj</Description>
                              <Amount>1.00</Amount>
                              <QuoteAmount>0.06</QuoteAmount>
                           </Adjustment>
                        </Adjustments>
                        <UnitPrice>3.99</UnitPrice>
                     </Pricing>
                  </Gifting>
                  <Customization>
                     <CustomFeatureList>
                        <CustomFeature>
                           <ItemId>12345823456</ItemId>
                           <Upcharge>
                              <Amount>2.00</Amount>
                              <TaxData>
                                 <TaxClass>76543</TaxClass>
                                 <QuoteAmount>0.12</QuoteAmount>
                              </TaxData>
                              <PromotionalDiscounts>
                                 <Discount>
                                    <Code>ONE0FF</Code>
                                    <Description>$1 off promo</Description>
                                    <Amount>1.00</Amount>
                                    <QuoteAmount>0.06</QuoteAmount>
                                 </Discount>
                              </PromotionalDiscounts>
                              <Adjustments>
                                 <Adjustment>
                                    <Description>$1 off adj</Description>
                                    <Amount>1.00</Amount>
                                    <QuoteAmount>0.06</QuoteAmount>
                                 </Adjustment>
                              </Adjustments>
                              <UnitPrice>2.00</UnitPrice>
                           </Upcharge>
                        </CustomFeature>
                        <CustomFeature>
                           <ItemId>12345823457</ItemId>
                           <Upcharge>
                              <Amount>5.00</Amount>
                              <TaxData>
                                 <TaxClass>76543</TaxClass>
                                 <QuoteAmount>0.30</QuoteAmount>
                              </TaxData>
                              <UnitPrice>5.00</UnitPrice>
                           </Upcharge>
                        </CustomFeature>
                        <CustomFeature>
                           <ItemId>12345823458</ItemId>
                           <Upcharge>
                              <Amount>1.00</Amount>
                              <TaxData>
                                 <TaxClass>76543</TaxClass>
                                 <QuoteAmount>0.06</QuoteAmount>
                              </TaxData>
                              <UnitPrice>1.00</UnitPrice>
                           </Upcharge>
                        </CustomFeature>
                     </CustomFeatureList>
                     <BasePrice>
                        <Amount>9.99</Amount>
                        <TaxData>
                           <TaxClass>76543</TaxClass>
                           <QuoteAmount>0.60</QuoteAmount>
                        </TaxData>
                        <PromotionalDiscounts>
                           <Discount>
                              <Code>ONE0FF</Code>
                              <Description>$1 off promo</Description>
                              <Amount>1.00</Amount>
                              <QuoteAmount>0.06</QuoteAmount>
                           </Discount>
                        </PromotionalDiscounts>
                        <Adjustments>
                           <Adjustment>
                              <Description>$1 off adj</Description>
                              <Amount>1.00</Amount>
                              <QuoteAmount>0.06</QuoteAmount>
                           </Adjustment>
                        </Adjustments>
                        <UnitPrice>9.99</UnitPrice>
                     </BasePrice>
                  </Customization>
               </OrderItem>
            </Items>
         </ShipGroup>
         <ShipGroup chargeType="FLATRATE" id="shipgroup_2">
            <DestinationTarget ref="dest_2"/>
            <Items>
               <OrderItem lineNumber="3">
                  <ItemId>EXO2716393</ItemId>
                  <ItemDesc>Product Description 3</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>
                  <Pricing>
                     <Merchandise>
                        <Amount>99.99</Amount>
                        <TaxData>
                           <TaxClass>89998</TaxClass>
                        </TaxData>
                        <UnitPrice>99.99</UnitPrice>
                     </Merchandise>
                     <PriceGroup>
                        <Amount>19.99</Amount>
                        <TaxData>
                           <TaxClass>93000</TaxClass>
                        </TaxData>
                     </PriceGroup>
                  </Pricing>
               </OrderItem>
               <OrderItem lineNumber="4">
                  <ItemId>SW2777884</ItemId>
                  <ItemDesc>Product Description 4</ItemDesc>
                  <HTSCode>1227.76.8265</HTSCode>
                  <VendorPartNumber>TDF7887</VendorPartNumber>
                  <ShippingCartonId>1XZ4555</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>UK</ManufacturingCountryCode>
                  </Origins>
                  <Quantity>3</Quantity>
                  <Pricing>
                     <Merchandise>
                        <Amount>99.99</Amount>
                        <TaxData>
                           <TaxClass>89998</TaxClass>
                        </TaxData>
                        <UnitPrice>33.33</UnitPrice>
                     </Merchandise>
                     <PriceGroup>
                        <Amount>9.99</Amount>
                        <TaxData>
                           <TaxClass>93000</TaxClass>
                        </TaxData>
                     </PriceGroup>
                     <FeeListRequest>
                        <Fee>
                           <FeeType>California Surcharge</FeeType>
                           <Description>$18.00 for CA Residents</Description>
                           <FeeId>SW2777884</FeeId>
                           <Charge>
                              <Amount>18.00</Amount>
                              <TaxData>
                                 <TaxClass>89999</TaxClass>
                                 <QuoteAmount>6.00</QuoteAmount>
                              </TaxData>
                              <PromotionalDiscounts>
                                 <Discount>
                                    <Code>ONE0FF</Code>
                                    <Description>$1 off promo</Description>
                                    <Amount>1.00</Amount>
                                    <QuoteAmount>0.06</QuoteAmount>
                                 </Discount>
                              </PromotionalDiscounts>
                              <Adjustments>
                                 <Adjustment>
                                    <Description>$1 off adj</Description>
                                    <Amount>1.00</Amount>
                                    <QuoteAmount>0.06</QuoteAmount>
                                 </Adjustment>
                              </Adjustments>
                           </Charge>
                        </Fee>
                     </FeeListRequest>
                  </Pricing>
               </OrderItem>
            </Items>
         </ShipGroup
      </ShipGroups>
      <Destinations>
         <MailingAddress id="dest_1">
            <PersonName>
               <Honorific>Mr</Honorific>
               <LastName>LastName1</LastName>
               <MiddleName>MiddleName1</MiddleName>
               <FirstName>FirstName1</FirstName>
            </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="dest_2">
            <PersonName>
               <Honorific>Mrs</Honorific>
               <LastName>LastName2</LastName>
               <MiddleName>MiddleName2</MiddleName>
               <FirstName>FirstName2</FirstName>
            </PersonName>
            <Address>
               <Line1>123 Elm</Line1>
               <Line2>Line 2</Line2>
               <Line3>Line 3</Line3>
               <City>SAN FRANCISCO</City>
               <MainDivisionCode>CA</MainDivisionCode>
               <CountryCode>US</CountryCode>
               <PostalCode>94102</PostalCode>
            </Address>
         </MailingAddress>
         <MailingAddress id="bill_dest_1">
            <PersonName>
               <Honorific>Miss</Honorific>
               <LastName>LastName3</LastName>
               <MiddleName>MiddleName3</MiddleName>
               <FirstName>FirstName3</FirstName>
            </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>
   <!--Optional:-->
   <Fees>
      <Fee>
         <FeeType>ConvenienceStoreSurcharge</FeeType>
         <Description>Payment Convenience Store Surcharge</Description>
         <Charge>
            <Amount>7.00</Amount>
            <TaxData>
               <TaxClass>77777</TaxClass>
               <QuoteAmount>0.42</QuoteAmount>
            </TaxData>
            <PromotionalDiscounts>
               <Discount>
                  <Code>ONE0FF</Code>
                  <Description>$1 off promo</Description>
                  <Amount>1.00</Amount>
                  <QuoteAmount>0.06</QuoteAmount>
               </Discount>
            </PromotionalDiscounts>
            <Adjustments>
               <Adjustment>
                  <Description>$1 off adj</Description>
                  <Amount>1.00</Amount>
                  <QuoteAmount>0.06</QuoteAmount>
               </Adjustment>
            </Adjustments>
         </Charge>
      </Fee>
   </Fees>
</TaxInvoiceRequest>

Request Data Elements

Element	Required	Description	Type	Restriction
StoreId	Yes	Store ID used in the URL	String	Max 20 characters
OrderId	Yes	Unique identifier for the order	String	No restrictions
OriginalOrderId	No	Unique identifier for the original order to be used for a Tax Invoice Return or Tax Distribute request	String	No restrictions
WebOrderNumber	No	Webstore order number	String	No restrictions
InvoiceNumber	Yes	Invoice number used for forming tax documentNumber, transactionId, and orderId	String	No restrictions
InvoiceType	No	Invoice type	String	Possible values: SALE CREDIT_MEMO RETURN
TaxTransactionId	No	The same TaxTransactionId present in the tax quotation used during order checkout must be passed in Tax Invoice so that final quotation and invoice can be tied together.	String	Max 40 characters
OrderDateTime	Yes	Date and time of the order	dateTime	No restrictions
OriginalOrderDateTime	No	Date and time of the original order	dateTime	No restrictions
ShipDateTime	Yes	Date and time when the order was shipped	dateTime	No restrictions
Currency	Yes	Type of currency used for the order	String	3-character ISO 4217 code (for example, USD, CAD, EUR). See http://en.wikipedia.org/wiki/ISO_4217.
CurrencyConversionRate	No	Identifier for the currency conversion rate	String	No restrictions
VATInvoiceNumber	No	VAT invoice number, if applicable	String	Max 20 characters without a space
VATInclusivePricing	Yes	Flag that indicates whether the order includes VAT	Boolean	true or false
CustomerTaxId	No	User-defined customer tax ID for the transaction or line item. Mainly used to identify tax exempt status for the customer.	String	Max 40 characters
BillingInformation	Yes	Reference to the customer's billing information	IDREF	Through IDREF, references another element in the message
Shipping	Yes	Information about all shipping groups and destinations in the order	ComplexType	Includes: ShipGroups, Destinations
ShipGroups	No	Information about all shipping groups in the order	ComplexType	Includes: ShipGroup (multiple)
ShipGroup
ShipGroup	Yes	Information about a specific shipping group in the order	ComplexType	Includes attributes: id, chargeType Includes: DestinationTarget, Items
id	Yes	Unique identifier for the shipping group	String	Attribute element; max 12 characters
chargeType	No	Type of shipping charge (for example, FLAT, WEIGHT) for the shipping group	String	Attribute element; no restrictions
DestinationTarget	Yes	Reference to information about the destination target	IDREF	Through IDREF, references another element in the message
Items	Yes	Information about all items in the shipping group	ComplexType	Includes: OrderItem (multiple)
OrderItem
OrderItem	Yes	Information about a specific item in the shipping group	ComplexType	Includes attribute: lineNumber Includes: ItemId, ItemDesc, HTSCode, VendorPartNumber, ShippingCartonId, ScreenSize, LocationCode, Origins, Quantity, Pricing, Gifting, Customization
lineNumber	Yes	Item line number	String	Attribute element; no restrictions
ItemId	Yes	Identifier for the item (SKU)	String	Max 20 characters
ItemDesc	Optional	Description of the item	String	Max 20 characters
HTSCode	No	Harmonized Tariff Schedule (HTS) code used for calculating duty; required if duty calculation is desired	String	No restrictions
VendorPartNumber	No	Identifier for the vendor product number	String	No restrictions
ShippingCartonId	No	Shipping carton ID	String	No restrictions
ScreenSize	No	Screen size (in inches) of electronic devices such as televisions. Drives the Vertex calculations for the environment handling fee (EHF) in Canada and California. Value is set as flexible number field 1 on the Tax Quote and Invoice requests.	String	Max 20 characters
LocationCode	No	Value that can be used for filing a tax return in jurisdictions that require tax filing for individual retail locations	String	Max 20 characters
Origins	Yes	Information about the store and manufacturer of the item	ComplexType	Includes: AdminOrigin, ShippingOrigin, ManufacturingCountryCode
Quantity	Yes	Quantity of the item in the order	Int	No restrictions
Pricing	Yes	Pricing information for the item	ComplexType	Includes: Merchandise, PriceGroup, Duty, FeeListRequest
Gifting	No	Gifting information for the item	ComplexType	Includes: ItemId, ItemDesc, VendorPartNumber, ShippingCartonId, Pricing
Customization	No	Price information for all custom features applied to the item	ComplexType	Includes: CustomFeatureList, BasePrice
Origins
Origins	Yes	Information about the store and manufacturer of the item	ComplexType	Includes: AdminOrigin, ShippingOrigin, ManufacturingCountryCode
AdminOrigin	Yes	Address of the administrative (business) office, order taking location, order acceptance location, or principle negotiation location of the webstore	ComplexType	Includes: Line1, Line2, Line3, Line4, BuildingName, PoBox, City, MainDivision, MainDivisionCode, CountryName, CountryCode, PostalCode
ShippingOrigin	Yes	Address from which the item is expected to ship	ComplexType	Includes: Line1, Line2, Line3, Line4, BuildingName, PoBox, City, MainDivision, MainDivisionCode, CountryName, CountryCode, PostalCode
ManufacturingCountryCode	No	Country where the item was manufactured or underwent the most significant manufacturing process	String	2 through 40 characters. ISO 3166 alpha 2 code is recommended.
Pricing
Pricing	Yes	Pricing information for the item	ComplexType	Includes: Merchandise, PriceGroup, Duty, FeeListRequest
Merchandise	Yes	Price for the item merchandise	ComplexType	Includes: Amount, TaxData, PromotionalDiscounts, Adjustments, UnitPrice
PriceGroup	No	Price group for the item	ComplexType	Includes: Amount, TaxData, PromotionalDiscounts, Adjustments
Duty	No	Duty tax for the item	ComplexType	Includes: Amount, TaxData, PromotionalDiscounts, Adjustments, CalculationError
FeeListRequest	No	Fees for the item	ComplexType	Includes: Fee (multiple)
CalculationError	No	Specific error message related to the internal duty calculation	String	No restrictions
Gifting
Gifting	No	Gifting information for the item	ComplexType	Includes attribute: id Includes: ItemId, ItemDesc, VendorPartNumber, ShippingCartonId, Pricing
id	Optional	Unique identifier for the gift item	String	Attribute element; max 12 characters
ItemId	Required	Identifier for the item (SKU)	String	Max 20 characters
ItemDesc	Optional	Description of the item	String	Max 20 characters
VendorPartNumber	Optional	Identifier for the vendor product number	String	No restrictions
ShippingCartonId	Optional	Shipping carton ID	String	No restrictions
Pricing	Required	Pricing information for the gift	ComplexType	Includes: Amount, TaxData, PromotionalDiscounts, Adjustments, UnitPrice
Customization
Customization	No	Price information for all custom features applied to the item	ComplexType	Includes: CustomFeatureList, BasePrice
CustomFeatureList	Yes	List of each custom feature and its associated upcharge	ComplexType	Includes: CustomFeature (multiple)
CustomFeature	Yes	Information about a specific custom feature for the item	ComplexType	Includes attribute: id Includes: CustomizationId, ItemId, ItemDesc, Upcharge
id	No	Unique identifier for the custom feature	String	Attribute element; max 12 characters
CustomizationId	Yes	Optional value used to group custom features into logical sets	String	Max 20 characters
ItemId	No	Unique identifier for the custom feature (SKU)	String	Max 20 characters
ItemDesc	No	Description of the custom feature	String	Max 20 characters
Upcharge	No	Charge for the custom feature	ComplexType	Includes: Amount, TaxData, PromotionalDiscounts, Adjustments, UnitPrice
BasePrice	No	Base customization price for the item	ComplexType	Includes: Amount, TaxData, PromotionalDiscounts, Adjustment, UnitPrice
Destinations
Destinations	Yes	Destination addresses for the order	ComplexType	Occurs only once. Includes: MailingAddress, Email
MailingAddress
MailingAddress	No	Mailing address for the order	ComplexType	Includes attribute: id Includes: PersonName, Address
id	Yes	Unique identifier for the mailing address	String	Attribute element; max 12 characters
PersonName	Yes	Name of the addressee	Complex Type	Includes: Honorific, LastName, MiddleName, FirstName
Address	Yes	Destination address	ComplexType	Includes: Line1, Line2, Line3, Line4, BuildingName, PoBox, City, MainDivision, MainDivisionCode, CountryName, CountryCode, PostalCode
Email
Email	No	Email address associated with the order	ComplexType	Includes attribute: id Includes: Customer, EmailAddress
id	Yes	Unique identifier for the email address	String	Attribute element; max 12 characters
Customer	No	Name associated with the email address	ComplexType	Includes: Honorific, LastName, MiddleName, FirstName.
EmailAddress	Yes	Email address of the addressee	String	Max 70 characters
Fees
Fees	No	Information about all fees for the order	ComplexType	Includes: Fee (multiple)
Fee	Yes	Information about a specific fee	ComplexType	Includes: FeeType, Description, FeeId, Charge
FeeType	Yes	Type of fee (for example, geographicalSurcharge, importSurchage)	String	No restrictions
Description	Yes	Description of the fee (for example, CA Recycling Fee $18.00)	String	No restrictions
FeeId	Yes	ID for the fee. Item ID is used for any legal fees offered in the output.	String	No Restriction.
Charge	Yes	Amount of the fee	ComplexType	Includes: Amount, TaxData, PromotionalDiscounts, Adjustments
TaxData
TaxData	Optional	Information used to calculate taxes for the item	ComplexType	Includes: TaxClass, QuoteAmount
TaxClass	No	Tax class used to calculate taxes. Default tax class for shipping is 93000. Default tax class for fees is 89999.	String	Max 40 characters
QuoteAmount	No	Quote amount	Decimal	2 precision points
PromotionalDiscounts
PromotionalDiscounts	No	All applicable promotional discounts	ComplexType	Includes: Discount (multiple)
Discount	Yes	Specific promotional discount	ComplexType	Includes attributes: id, calclulateDuty Includes: Code, Description, Amount, QuoteAmount
id	Optional	Unique identifier for the promotional discount	String	Attribute element; max 12 characters
calculateDuty	Optional	Flag that indicates whether duty needs to be calculated for the discount	Boolean	true or false
Code	Optional	Unique identifier for the discount	String	No restrictions
Description	Optional	Description of the discount	String	No restrictions
Amount	Required	Amount used for calculating taxes	Decimal	2 precision points (for example, 123.34)
QuoteAmount	Optional	Tax quote amount	Decimal	2 precision points (for example, 123.34)
Adjustments
Adjustments	No	All applicable tax adjustments	ComplexType	Includes: Adjustment (multiple)
Adjustment	Yes	Specific tax adjustment	ComplexType	Includes attributes: id, calculateDuty Includes: Description, Amount, QuoteAmount, Taxes
id	No	Unique identifier for the adjustment	String	Attribute element; max 12 characters.
calculateDuty	Optional	Specifies duty needs to be calculated for particular adjustment	Boolean	Attribute element; true or false
Description	No	Description of the adjustment	String	No restrictions
Amount	Required	Amount used for calculating taxes	Decimal	2 precision points (for example, 123.34)
QuoteAmount	Optional	Tax quote amount	Decimal	2 precision points (for example, 123.34)
Common (shared) fields
Amount	Yes	Amount used to calculate taxes	Decimal	2 precision points (for example, 123.34)
UnitPrice	Yes	Unit price for the item	Decimal	2 precision points (for example, 123.34)
Honorific	No	Salutation of the payer	String	10 characters
LastName	Yes	Last name of the payer	String	64 characters
MiddleName	No	Middle name of the payer	String	40 characters
FirstName	Yes	First name of the Payer	String	64 characters
Line1	Yes	Line 1 of the destination address	String	No restrictions
Line2	No	Line 2 of the destination address	String	No restrictions
Line3	No	Line 3 of the destination address	String	No restrictions
Line4	No	Line 4 of the destination address	String	No restrictions
BuildingName	No	Name of the building for the destination address	String	No restrictions
PoBox	No	PO box number for the destination address	String	No restrictions
City	Yes	City for the destination address	String	Max 40 characters
MainDivision	No	Name of the destination state, province, or territory	String	No restrictions
MainDivisionCode	No	Two- or three-digit postal abbreviation for the destination state, province, or territory	String	Max 35 characters. ISO 3166-2 code is recommended but not required.
CountryName	No	Name of the destination country	String	No restrictions
CountryCode	Yes	Code of the destination country	String	Between 2 and 40 Characters. ISO 3166 alpha 2 code is recommended but not required.
PostalCode	No	Destination postal code	String	Max 15 characters

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>