About QuickBooks qbXML Requests/Responses

Where can I find what tags/nodes/requests are available?

Use the QuickBooks OSR (choose the command type from the 'Select Message' dropdown box):

Where can I find a schema definition / .XSD file for qbXML?

You can find the .XSD schema files in the QuickBooks SDK. You should:

  • Download and install the QuickBooks SDK
  • Browse to: C:\Program Files\Intuit\IDN\Common\tools\validator\
  • (I'm unsure of which .XSD files contain which schemas… ???)

Where can I find the .XML files used to generate the QuickBooks OSR?

You can also take a look at the .xml files that Intuit uses to produce the On-Screen Reference for QuickBooks that is shipped with the QuickBooks SDK:

  • Download and install the QuickBooks SDK
  • Browse to: C:\Program Files\Intuit\IDN\QBSDK7.0\docs
  • The files you are interested in are “qbxmlops70.xml”, “qbxmlops60.xml”, and “qbxmlopsCA30.xml”

What about QuickBooks Point of Sale Editions?

For Point of Sale editions, your qbXML requests change a little. They follow this format:

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

I'm Getting qbXML Errors, But Can't Tell What's Wrong...?

Things to check and keep in mind when working with qbXML:

  • The order of tags in qbXML *is* important. If you don't use the same tag order as in the OSR, you'll get errors.
  • Check the version of qbXML you're using <?qbxml version=”…”?>, older qbXML versions don't support all of the tags.
  • Use the XML Validator tool included with the QuickBooks SDK
  • Remember that some characters need to be converted to XML entities in XML:
    • & goes to &amp;
    • < goes to &lt;
    • > goes to &gt;
    • ” goes to &quot;

Error Handling: stopOnError vs continueOnError

quickbooks_qbxml.txt · Last modified: 2013/01/21 12:44 (external edit)