Documentation
Everything you need to connect Wirebook to your sites and systems.
Start here
- Getting startedCreate a Wirebook account, make a key and send your first request against a sample company file.
- Connect flowHow your customer connects their QuickBooks Desktop company file to Wirebook without your help.
- AuthenticationSign in to Wirebook with magic links, passkeys and two factor, and call the API with keys.
Build
- API referenceThe Wirebook REST API: authentication, request lifecycle, idempotency, errors and rate limits.
- ResourcesEvery object the Wirebook API reads and writes in QuickBooks Desktop, with a page of fields for each.
- IdempotencyHow the Idempotency-Key header makes writes to QuickBooks safe to retry in the Wirebook API.
- WebhooksEvents Wirebook sends to your server, how to verify the signature, and how failed deliveries are retried.
- SDKsThe TypeScript and Python SDKs for the Wirebook API: install, client, typed models, waiting and pagination.
- LimitsRate limits, daily request caps, size limits and file limits in the Wirebook API, and the errors they return.
- ErrorsWhat the common QuickBooks and Web Connector errors mean, and what to do about each in Wirebook.
- Data retentionHow long Wirebook keeps request bodies, parsed results, request metadata, idempotency keys and webhook logs.
- TroubleshootingSymptoms and fixes for Wirebook: company files that are Asleep or Broken, requests that stay queued, QuickBooks status codes and unknown outcomes.
Resource fields
- Customers resourceEndpoints, filters and the create and update fields for customers in the Wirebook API, with curl, TypeScript and Python examples.
- Vendors resourceEndpoints, filters and the create and update fields for vendors in the Wirebook API, with curl, TypeScript and Python examples.
- Items resourceEndpoints, filters and the create and update fields for items in the Wirebook API, with curl, TypeScript and Python examples.
- Accounts resourceEndpoints, filters and the create and update fields for accounts in the Wirebook API, with curl, TypeScript and Python examples.
- Invoices resourceEndpoints, filters and the create and update fields for invoices in the Wirebook API, with curl, TypeScript and Python examples.
- Bills resourceEndpoints, filters and the create and update fields for bills in the Wirebook API, with curl, TypeScript and Python examples.
- Payments resourceEndpoints, filters and the create fields for payments in the Wirebook API, with curl, TypeScript and Python examples.
- Estimates resourceEndpoints, filters and the create and update fields for estimates in the Wirebook API, with curl, TypeScript and Python examples.
- Sales orders resourceEndpoints, filters and the create and update fields for sales-orders in the Wirebook API, with curl, TypeScript and Python examples.
- Sales receipts resourceEndpoints, filters and the create and update fields for sales-receipts in the Wirebook API, with curl, TypeScript and Python examples.
- Credit memos resourceEndpoints, filters and the create and update fields for credit-memos in the Wirebook API, with curl, TypeScript and Python examples.
- Purchase orders resourceEndpoints, filters and the create and update fields for purchase-orders in the Wirebook API, with curl, TypeScript and Python examples.
- Classes resourceEndpoints, filters and the create and update fields for classes in the Wirebook API, with curl, TypeScript and Python examples.
- Terms resourceEndpoints, filters and the create and update fields for terms in the Wirebook API, with curl, TypeScript and Python examples.
- Employees resourceEndpoints, filters and the create and update fields for employees in the Wirebook API, with curl, TypeScript and Python examples.