Accounts resource

What it is

The chart of accounts. List also takes a type filter.

Accounts live in the connected QuickBooks Desktop company file. Every call names the file with the X-End-User-Id header, and every field name below is the JSON key you send and receive. Behaviour on this page is validated against the QuickBooks Web Connector simulator and not yet against a real QuickBooks Desktop install. The acceptance run on a Windows rig is a launch step.

Endpoints

GET https://wirebook.buffersoltech.com/v1/qbd/accounts lists accounts. Filters: name, active, modifiedSince, modifiedUntil, type, plus limit (1 to 100, default 25) and cursor. The response has data, hasMore, nextCursor and cursorExpiresAt.

GET https://wirebook.buffersoltech.com/v1/qbd/accounts/{id} returns one record by its listId.

POST https://wirebook.buffersoltech.com/v1/qbd/accounts creates a record and returns 201 with the created object. Send an Idempotency-Key header on every write.

POST https://wirebook.buffersoltech.com/v1/qbd/accounts/{id} updates a record. Send the revisionNumber you read, and a stale one returns 409.

Create fields

Fields for POST https://wirebook.buffersoltech.com/v1/qbd/accounts. Unknown fields are rejected with 400 invalid_request and the JSON path of the first problem. Lengths are the QuickBooks limits.

field               type               required  max length
name                string             yes       31
isActive            boolean            no
parentRef           object             no
parentRef.listId    string             no        36
parentRef.fullName  string             no        209
accountType         string             yes       40
accountNumber       string             no        7
bankNumber          string             no        25
desc                string             no        200
openBalance         number             no
openBalanceDate     date (YYYY-MM-DD)  no

Update fields

Fields for POST https://wirebook.buffersoltech.com/v1/qbd/accounts/{id}. The listId goes in the URL, not in the body. revisionNumber is required: it is the value you read last, and it protects against overwriting a change made in QuickBooks. Every other field is optional and only the fields you send change.

field               type               required  max length
revisionNumber      string             yes
name                string             no        31
isActive            boolean            no
parentRef           object             no
parentRef.listId    string             no        36
parentRef.fullName  string             no        209
accountType         string             no        40
accountNumber       string             no        7
bankNumber          string             no        25
desc                string             no        200
openBalance         number             no
openBalanceDate     date (YYYY-MM-DD)  no

Example with curl

Create a record with the required fields. Replace the key and the end user id with your own.

curl -X POST https://wirebook.buffersoltech.com/v1/qbd/accounts \
  -H "Authorization: Bearer sk_test_..." \
  -H "X-End-User-Id: acme-42" \
  -H "Idempotency-Key: accounts-create-1" \
  -H "Content-Type: application/json" \
  -d '{"name":"Acme Builders","accountType":"Example"}'

Example with TypeScript

Typed with the models generated from the same field specs. create returns the record, or a Queued marker if QuickBooks has not answered yet.

import { Wirebook } from "@wirebook/sdk";

const qb = new Wirebook({ apiKey: process.env.WIREBOOK_API_KEY! }).forUser("acme-42");

const created = await qb.qbd.accounts.create({
  "name": "Acme Builders",
  "accountType": "Example"
});

for await (const row of qb.qbd.accounts.iterate({ limit: 100 })) {
  console.log(row);
}

await qb.qbd.accounts.update("<listId>", {
  "revisionNumber": "1700000000",
  "name": "Updated"
});

Example with Python

The Python SDK takes the same JSON keys, as typed dictionaries.

import os
from wirebook import Wirebook

qb = Wirebook(os.environ["WIREBOOK_API_KEY"]).for_user("acme-42")

created = qb.qbd.accounts.create({
    "name": "Acme Builders",
    "accountType": "Example",
})

for row in qb.qbd.accounts.iterate(limit=100):
    print(row)

qb.qbd.accounts.update("<listId>", {
    "revisionNumber": "1700000000",
    "name": "Updated",
})

Waiting for QuickBooks

A request waits for QuickBooks to answer for 55 seconds. If QuickBooks has not answered by then, the API returns 202 with a request id and a Location header, and you poll GET /v1/requests/{id}. Send Prefer: respond-async to get the 202 straight away without waiting. The company file must be open and polling, see Troubleshooting.

If a write times out after it was sent, its state becomes outcome_unknown. Query by RefNumber before you retry, and do not retry blindly.