Get started with the QuickBooks POS SDK

The QuickBooks POS SDK is a software development kit that supports development of applications that integrate with the QuickBooks Point of Sale product. Communications with QuickBooks POS parallels communication between the QuickBooks SDK and QuickBooks Desktop – it follows the same request and response model and uses a set of XML known as qbposXML which is very similar to qbXML and is used in the same way to construct request and response messages. Much of the general information in the QuickBooks Desktop SDK documentation applies to working with the QuickBooks POS SDK.

POS SDK features

The QuickBooks Point of Sale Software Development Kit (QBPOS SDK) offers a variety of software libraries, utilities, technical documentation, and samples to help you integrate your application with QuickBooks POS in the shortest possible time. The entire SDK is designed around a single specification—which means that apps designed for one edition of QuickBooks POS can be used with other editions.

How does the SDK communicate with QuickBooks POS?
Communication between your application and Quick Books Point of Sale is based on a client/server model. The application sends a request message to QuickBooks POS, and QuickBooks POS sends back a response.
Which QBPOS products does the SDK support?
The SDK supports version 4.0 R5 and beyond (including versions 5.0 and 6.0) of all QuickBooks POS products: QuickBooks POS Basic, Pro, and Pro Multi-Store.
What’s included in the POS SDK?
The SDK includes the following:

We consider it our job to provide you with the tools and to make it easy to learn how to use them.

What QBPOS features does the SDK support?
The SDK supports most QuickBooks POS features at the data-access level, such as adding, modifying, or deleting, as appropriate in QBPOS, the central QBPOS documents such as items, purchase orders, customer orders, vouchers, and so forth. The current SDK does not support event notification or user interface integration.
What programming background is required?
The SDK is based on programming standards such as XML (eXtensible Markup Language) and COM (Component Object Module). It works with most common programming languages.
Is the SDK backward- (and forward-) compatible?
Yes, and yes. However, to work with new releases of QBPOS, your application may need to use a new version of the SDK runtime. Also, the SDK cannot predict future features. While current programs will work with future releases of QBPOS, they would need to be revised in order to use new QBPOS or SDK features.
Is the 64-bit SDK available for QBPOS?
No. Only the 32-bit SDK is available for QBPOS.
Products supported by the QuickBooks POS SDK

QuickBooks Point of Sale (QBPOS) SDK 4.0 enables you to integrate your applications with all editions (Basic, Pro, and Pro Multi-Store) of QuickBooks Point of Sale 4.0 (R5 and later), 5.0, and 6.0 (and any future releases).

Documentation and sample code for the POS SDK is included in the SDK download.

The QuickBooks Point of Sale Software Development Kit (QBPOS SDK) is expected to be backward and forward compatible. Backward compatible means that programs written for newer QBPOS SDK runtime versions should also be able to support the older QBPOS SDK runtime versions, PROVIDED that you use the appropriate older qbposXML spec when communicating with those older versions.

The SDK is also forward-compatible, which means that applications written for current versions of the qbposXML specification are expected to work with future releases of QuickBooks POS. Programs written to use the qbposXML 2.0, 1.2, 1.1, or 1.0 specs should continue to work with newer versions of the SDK runtime without recompiling. However, in order to be forward compatible with a new release of QBPOS, your application may require that an updated version of the QBPOS SDK runtime be installed. (Note: qbposXML 1.2 fixed a bug in which the QtySold field was not returned in the SalesOrderRet: qbposXML 1.2 is available for QBPOS v5 R7 and later.)

Applications written for current versions of the qbposXML will not be able to use any new features provided by the newer spec versions. To use any such new features you will need to use the new spec version in your application and add the features to your application code as well.

Download and install the QuickBooks POS SDK

You must be logged in to Intuit Developer to access the installers or merge modules. If you are not logged in, you will be redirected to the login page before you can access the files. If file does not download, seek answers at Developer Support for QBXML SDK v13.

Development tools for the POS SDK

Some third party tools are being developed to make your programming easier. Tools available now include:

Sample applications and code for the POS SDK

See the POS SDK sample code included when the POS SDK is installed.