QuickBooks Point of Sales Specific qbXML Information

Example CustomerQuery

Example CustomerQuery Request

<?xml version="1.0"?>
<?qbposxml version="1.0"?>
<QBPOSXML>
<QBPOSXMLMsgsRq onError="stopOnError">
<CustomerQueryRq requestID="xyz">
...
</CustomerQueryRq>
</QBPOSXMLMsgsRq>
</QBPOSXML>

Example CustomerQuery Response

<?qbposxml version="1.0"?>
<QBPOSXML>
  <QBPOSXMLMsgsRq onError="stopOnError">
    <CustomerAddRq>
      <CustomerAdd>
        <CompanyName>CompanyName</CompanyName>
        <FirstName>Young</FirstName>
        <LastName>Yuk</LastName>
      </CustomerAdd>
    </CustomerAddRq>
  </QBPOSXMLMsgsRq>
</QBPOSXML>

Example SalesReceiptAdd

Example SalesReceiptAdd Request

<?xml version="1.0" encoding="utf-8"?>
                <?qbposxml version="1.0"?>
                <QBPOSXML>
                        <QBPOSXMLMsgsRq onError="stopOnError">

<SalesReceiptAddRq requestID="U2FsZXNSZWNlaXB0QWRkfDI1">
        <SalesReceiptAdd>
                <!--<Associate>STRTYPE</Associate> <!-- optional -->
                <!--<Cashier>STRTYPE</Cashier> <!-- optional -->
                <!--<Comments>STRTYPE</Comments> <!-- optional -->

		<!-- You get the ListIDs back from the CustomerQuery request -->
                <CustomerListID>-8971210688282328063</CustomerListID> <!-- optional -->

                <!--<Discount>AMTTYPE</Discount> <!-- optional -->
                <!--<DiscountPercent>FLOATTYPE</DiscountPercent> <!-- optional -->
                <!-- PriceLevelNumber may have one of the following values: 1, 2, 3, 4, 5 -->
                <!--<PriceLevelNumber>ENUMTYPE</PriceLevelNumber> <!-- optional -->
                <!--<PromoCode>STRTYPE</PromoCode> <!-- optional -->
                <!-- QuickBooksFlag may have one of the following values: NotPosted, Completed, Error, UnbilledPurchases -->
                <!--<QuickBooksFlag>ENUMTYPE</QuickBooksFlag> <!-- optional -->
                <!--<SalesOrderTxnID>IDTYPE</SalesOrderTxnID> <!-- optional -->

                <!-- SalesReceiptType may have one of the following values: Sales, Return, Deposit, Refund, Payout, Payin -->
                <SalesReceiptType>Sales</SalesReceiptType> <!-- optional -->

                <!--<ShipDate>DATETYPE</ShipDate> <!-- optional -->
                <!--<StoreNumber>INTTYPE</StoreNumber> <!-- optional -->
                <!--<TaxCategory>STRTYPE</TaxCategory> <!-- optional -->
                <!--<TipReceiver>STRTYPE</TipReceiver> <!-- optional -->
                <!--<TrackingNumber>STRTYPE</TrackingNumber> <!-- optional -->

                <TxnDate>2010-10-19</TxnDate> <!-- optional -->

                <!-- TxnState may have one of the following values: Normal, Held -->
                <!--<TxnState>ENUMTYPE</TxnState> <!-- optional -->
                <!--<Workstation>INTTYPE</Workstation> <!-- optional -->

                <ShippingInformation> <!-- optional -->
                        <AddressName>STRTYPE</AddressName> <!-- optional -->
                        <City>STRTYPE</City> <!-- optional -->
                        <CompanyName>STRTYPE</CompanyName> <!-- optional -->
                        <Country>STRTYPE</Country> <!-- optional -->
                        <!--<FullName>STRTYPE</FullName>--> <!-- optional -->
                        <Phone>STRTYPE</Phone> <!-- optional -->
                        <Phone2>STRTYPE</Phone2> <!-- optional -->
                        <Phone3>STRTYPE</Phone3> <!-- optional -->
                        <Phone4>STRTYPE</Phone4> <!-- optional -->
                        <PostalCode>STRTYPE</PostalCode> <!-- optional -->
                        <ShipBy>STRTYPE</ShipBy> <!-- optional -->
                        <Shipping>3.95</Shipping> <!-- optional -->
                        <State>STRTYPE</State> <!-- optional -->
                        <Street>STRTYPE</Street> <!-- optional -->
                        <Street2>STRTYPE</Street2> <!-- optional -->

                </ShippingInformation>

                <SalesReceiptItemAdd> <!-- optional, may repeat -->
			<!-- You get the ListIDs back from the ItemQuery/ItemInventoryQuery request -->
                        <ListID>-9219717379653729279</ListID> <!-- required -->

                        <!--<ALU>STRTYPE</ALU>--> <!-- optional -->
                        <!--<Associate>STRTYPE</Associate>--> <!-- optional -->
                        <!--<Attribute>STRTYPE</Attribute>--> <!-- optional -->
                        <!--<Commission>AMTTYPE</Commission>--> <!-- optional -->
                        <Desc1>Test Description</Desc1> <!-- optional -->
                        <!--<Desc2>STRTYPE</Desc2>--> <!-- optional -->
                        <!--<Discount>AMTTYPE</Discount>--> <!-- optional -->
                        <!--<DiscountPercent>FLOATTYPE</DiscountPercent>--> <!-- optional -->
                        <!--<DiscountType>STRTYPE</DiscountType>--> <!-- optional -->
                        <!--<ExtendedPrice>AMTTYPE</ExtendedPrice>--> <!-- optional -->
                        <Price>25.95</Price> <!-- optional -->
                        <Qty>1</Qty>
                        <!--<SerialNumber>STRTYPE</SerialNumber>--> <!-- optional -->
                        <!--<Size>STRTYPE</Size>--> <!-- optional -->
                        <!--<TaxCode>STRTYPE</TaxCode>--> <!-- optional -->
                        <!--<UnitOfMeasure>STRTYPE</UnitOfMeasure>--> <!-- optional -->
                        <!--<UPC>STRTYPE</UPC>--> <!-- optional -->

                </SalesReceiptItemAdd>

                <!--
                <TenderAccountAdd>
                        <TenderAmount >AMTTYPE</TenderAmount>
                        <TipAmount >AMTTYPE</TipAmount>
                </TenderAccountAdd>
		-->
                <TenderCashAdd>
                        <TenderAmount>32.04</TenderAmount>
                </TenderCashAdd>
		<!--
                <TenderCheckAdd>
                        <CheckNumber >STRTYPE</CheckNumber>
                        <TenderAmount >AMTTYPE</TenderAmount>
                </TenderCheckAdd>
                <TenderCreditCardAdd>
                        <CardName >STRTYPE</CardName>
                        <TenderAmount >AMTTYPE</TenderAmount>
                        <TipAmount >AMTTYPE</TipAmount>
                </TenderCreditCardAdd>
                <TenderDebitCardAdd>
                        <Cashback >AMTTYPE</Cashback>
                        <TenderAmount >AMTTYPE</TenderAmount>
                </TenderDebitCardAdd>
                <TenderDepositAdd>
                        <TenderAmount >AMTTYPE</TenderAmount>
                </TenderDepositAdd>
                <TenderGiftAdd>
                        <GiftCertificateNumber >STRTYPE</GiftCertificateNumber>
                        <TenderAmount >AMTTYPE</TenderAmount>
                </TenderGiftAdd>
                <TenderGiftCardAdd>
                        <TenderAmount>AMTTYPE</TenderAmount>
                        <TipAmount>AMTTYPE</TipAmount>
                </TenderGiftCardAdd>
                -->
        </SalesReceiptAdd>
</SalesReceiptAddRq>

                        </QBPOSXMLMsgsRq>
                </QBPOSXML>

Example SalesReceiptAdd Response

<?xml version="1.0"?>
<QBPOSXML>
    <QBPOSXMLMsgsRs>
        <SalesReceiptAddRs requestID="U2FsZXNSZWNlaXB0QWRkfDI1" statusCode="0" statusMessage="Status OK" statusSeverity="Info">
            <SalesReceiptRet>
                <TxnID>-8062359429816876799</TxnID>
                <TimeModified>2010-10-19T09:50:25-05:00</TimeModified>
                <Associate>Sysadmin</Associate>
                <Cashier>Sysadmin</Cashier>
                <CustomerListID>-8971210688282328063</CustomerListID>
                <Discount>0.00</Discount>
                <DiscountPercent>0.00</DiscountPercent>
                <HistoryDocStatus>Regular</HistoryDocStatus>
                <ItemsCount>1</ItemsCount>
                <PriceLevelNumber>1</PriceLevelNumber>
                <QuickBooksFlag>NotPosted</QuickBooksFlag>
                <SalesReceiptNumber>197</SalesReceiptNumber>
                <SalesReceiptType>Sales</SalesReceiptType>
                <StoreExchangeStatus>Modified</StoreExchangeStatus>
                <StoreNumber>1</StoreNumber>
                <Subtotal>25.95</Subtotal>
                <TaxAmount>2.14</TaxAmount>
                <TaxCategory>Local Sales Tax</TaxCategory>
                <TaxPercentage>8.25</TaxPercentage>
                <TenderType>Cash</TenderType>
                <Total>32.04</Total>
                <TxnDate>2010-10-19</TxnDate>
                <Workstation>1</Workstation>
                <BillingInformation>
    <CompanyName>XXXXX</CompanyName>
    <FirstName>XXX</FirstName>
    <LastName>XXX</LastName>
    <Phone>XXX-XXX-XXXX</Phone>
                </BillingInformation>
                <ShippingInformation>
    <City>STRTYPE</City>
    <CompanyName>STRTYPE</CompanyName>
    <Phone>STRTYPE</Phone>
    <Phone2>STRTYPE</Phone2>
    <PostalCode>STRTYPE</PostalCode>
    <ShipBy>STRTYPE</ShipBy>
    <Shipping>3.95</Shipping>
    <State>STRTYPE</State>
    <Street>STRTYPE</Street>
                </ShippingInformation>
                <SalesReceiptItemRet>
    <ListID>-9219717379653729279</ListID>
    <Associate>Sysadmin</Associate>
    <Attribute>White</Attribute>
    <Commission>0.00</Commission>
    <Cost>0.00</Cost>
    <Desc1>Test Description</Desc1>
    <Desc2>2007</Desc2>
    <Discount>-12.96</Discount>
    <DiscountPercent>0.00</DiscountPercent>
    <ExtendedPrice>25.95</ExtendedPrice>
    <ExtendedTax>2.14</ExtendedTax>
    <ItemNumber>30017</ItemNumber>
    <Price>25.95</Price>
    <PriceLevelNumber>1</PriceLevelNumber>
    <Qty>1.00</Qty>
    <TaxAmount>2.14</TaxAmount>
    <TaxCode>Tax</TaxCode>
    <TaxPercentage>8.25</TaxPercentage>
                </SalesReceiptItemRet>
                <TenderCashRet>
    <TenderAmount>32.04</TenderAmount>
                </TenderCashRet>
            </SalesReceiptRet>
        </SalesReceiptAddRs>
    </QBPOSXMLMsgsRs>
</QBPOSXML>
quickbooks_qbxml_pointofsale.txt · Last modified: 2013/01/21 12:44 (external edit)