Skip to main content
Use the @bijection/connectors/quickbooks-pos entrypoint to declare QuickBooks Point of Sale (Web Connector) resources.

​
Availability

This page describes the pinned source package. Published availability is unestablished for this artifact. Source build and package availability.

​
Resources and modes

Declare a resource in application code, then bind deployment-specific settings and credentials. See typed resources, connections and source inspection.

​
Point of Sale company

​
sync: QBWC sessions read qbposXML records modified within windows from each confirmed position, then deleted customers, vendors and items; TimeModified versions, read-only

The following example matches configuration standard.

​
Configuration: standard

Case: quickbooks-pos/company/sync/standard. Connection and resource configuration are declared by this exact case. Credential kind: qbwc. Keep credential material in the private credential inventory.
Native admission analysis is available for this exact declaration. Collection: customers
Collection: inventoryAdjustments
Collection: items
Collection: salesReceipts
Collection: vendors
Collection: vouchers
Recorded checks Hosted qualification: unestablished for this catalog configuration. Installed connections report their own identity, authority and current status.

​
Configuration: inventory

Case: quickbooks-pos/company/sync/inventory. Connection and resource configuration are declared by this exact case. Credential kind: qbwc. Keep credential material in the private credential inventory.
Native admission analysis is available for this exact declaration. Collection: inventoryAdjustments
Collection: items
Collection: salesReceipts
Collection: vouchers
Recorded checks Hosted qualification: unestablished for this catalog configuration. Installed connections report their own identity, authority and current status.

​
Provider guidance

Compiled declaration examples and configuration details are published in the connector reference. Reads one QuickBooks Desktop Point of Sale company through the QuickBooks Web Connector (QBWC), on the platform’s native qbwc transport. Intuit discontinued Point of Sale 19.0 on 2023-10-03 together with its connected services (Payments, gift cards, Mobile Sync, live support); installations still run without them and without security patches, and QBWC still serves QBPOS applications. For QuickBooks Desktop accounting use quickbooks-desktop; for the cloud API use quickbooks. QBWC, installed beside Point of Sale on the store’s Windows machine, connects out over HTTPS to the deployment on a schedule and is handed qbposXML requests. Nothing is dialled. company.sync declares one atomic group: one QBWC session reads every selected collection in turn and publishes each to its own table. collections selects a subset (all six by default). qbposXML is text: every scalar publishes as Point of Sale’s own string, an aggregate as an object, an item or tender list as an array, and an element Point of Sale did not return as null. maxResponseBytes bounds one retained response (512 KiB by default, at most 640 KiB); every (15 minutes by default) only bounds how long acquisition waits if the wake a retained response sends is lost. QBWC’s own poll interval is the .qwc file’s. Inventory. items publishes quantityOnHand and the other quantities as Point of Sale states them when the item record changes. Intuit’s qbposXML reference for ItemInventoryQuery says quantity changes made by other transactions do not move an item’s TimeModified, so a modified-since read does not see them: a published on-hand quantity can lag, and the movements themselves are the salesReceipts, vouchers and inventoryAdjustments collections. Per-store on-hand quantities are OnHandStore01 to OnHandStore20 in the item; a custom declaration on the transport can name them.

​
Setup

  1. Bind the connection: typed setup holds the QBWC username, optionally a pinned companyFile (compared with the strCompanyFileName QBWC states when a session opens; what Point of Sale reports there is not documented, so pin it only to the value a first session recorded) and runEveryMinutes (15 by default).
  2. Install the credential (quickbooksPos.credential, kind qbwc): its password is a secret of at least sixteen characters that the operator generates and types into QBWC once.
  3. After the source’s first acquisition has minted its route, issue the .qwc file with POST /api/integrations/qbwc-setup (Deploy authority, body {source, url}). Its QBType is QBPOS. QBWC requires HTTPS except to localhost.
  4. With the Point of Sale company open, add the .qwc file in QBWC, grant access when Point of Sale asks, and enter the password.
US edition only: the session negotiates qbposXML 2.0 through 4.0.

​
What a session does

Per collection, in name order, the host asks for the records modified at or after the collection’s confirmed position (every record on the first read), then, for customers, vendors and items, the deleted objects since its deletion position (ListDeletedQuery, one ListDelType each). qbposXML has no iterator, so a query asks its whole window at once; an answer over maxResponseBytes is not retained, and the query is asked again over the earlier half of its window until an answer fits, each finished window moving the position past it. Each response is retained before QBWC is answered, then published keyed by ListID/TxnID and versioned by TimeModified (qbposXML has no EditSequence). qbposXML reports no deletion of a posted sales receipt, voucher or adjustment (only held documents are deleted), so those collections read no deletions. No coverage is claimed. Interrupted sessions, busy, failures and the read-only scope behave as in quickbooks-desktop. Nothing here has reached QuickBooks Point of Sale or a real QuickBooks Web Connector. The shared transport’s histories run against a controlled QuickBooks Desktop company file; the qbposXML session is unit-tested against a controlled Point of Sale company; neither exercises this declaration’s field paths.

​
Provider references

Provider references and prerequisites are maintained in the connector guidance above. No separate provider-documentation review date is recorded.

​
Source and evidence

Canonical connector source, native analysis and check receipts. Connector artifact: 905888ea276a2a28e36981a79e8142b2547ea451c3e63162cb6915ad4a7d1305. The resource declaration examples above are compiled and compared with exact catalog declarations. Recorded checks apply only to their source, declaration and runtime identities. Configure a connection and inspect its status to establish deployment-specific readiness.