qbws

This sample is a Node.js web service application that communicates with QuickBooks via QBWebConnector. The sample focuses primarily on demonstrating how to setup all web service web methods to run against QBWebConnector and does not focus on any particular use case. For simplicity, it sends three request XMLs: CustomerQuery, InvoiceQuery and BillQuery.

Status

This project replicates the functionality of the ASP.NET web service found in the QBSDK. Unfortunately that means some things are hard coded that should not be, and other things are left unimplemented. Eventually, qbws will diverge from that C# example to serve less of an SDK example and more as a reliable utility.

Usage

Install the package using npm install qbws. The following code is all you need to run the service:

var qbws = require('qbws');
qbws.run();

Documentation

The QuickBooks Web Connector Programmer's Guide is a very useful resource to understand how the Web Connector operates and how to write a custom web service to interact with it.

API documentation for qbws is available here. Many of that information is taken directly from the QBWC Programmer's Guide.

Changelog

v0.2.1

• Correct authenticate() and sendRequestXML() (see issue #3)
• Added a bunch of JSDoc style comments

v0.2.0

• Functional port of Intuit's WCWebService provided in the QBSDK samples
• Many things are hard coded for demonstration purposes:
  • Login credentials
  • Requests (CustomerQuery, InvoiceQuery, BillQuery)
  • Company file location

Next Milestones

• v0.2.2: Include documentation for all functions (likely using JSDoc)
• v0.3.0: Conversion to Node.js utility

Feature Wishlist

• Conversion to asynchronous architecture for the service methods
• QBXML validation using a separate package
  • Likely to be optional as this could potentially slow down response time by a significant amount for large queries
• Module config settings