Employees resource

Endpoints, filters and the create and update fields for employees in the Wirebook API, with curl, TypeScript and Python examples.

What it is

Employees (QuickBooks Employee list).

Employees 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/employees lists employees. Filters: name, active, modifiedSince, modifiedUntil, plus limit (1 to 100, default 25) and cursor. The response has data, hasMore, nextCursor and cursorExpiresAt.

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

POST https://wirebook.buffersoltech.com/v1/qbd/employees 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/employees/{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/employees. Unknown fields are rejected with 400 invalid_request and the JSON path of the first problem. Lengths are the QuickBooks limits.

text

field                       type     required  max length
isActive                    boolean  no
salutation                  string   no        15
firstName                   string   yes       25
middleName                  string   no        5
lastName                    string   yes       25
jobTitle                    string   no        41
employeeAddress             object   no
employeeAddress.addr1       string   no        41
employeeAddress.addr2       string   no        41
employeeAddress.addr3       string   no        41
employeeAddress.city        string   no        31
employeeAddress.state       string   no        21
employeeAddress.postalCode  string   no        13
employeeAddress.country     string   no        31
printAs                     string   no        41
phone                       string   no        21
mobile                      string   no        21
email                       string   no        1023

Update fields

Fields for POST https://wirebook.buffersoltech.com/v1/qbd/employees/{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.

text

field                       type     required  max length
revisionNumber              string   yes
isActive                    boolean  no
salutation                  string   no        15
firstName                   string   no        25
middleName                  string   no        5
lastName                    string   no        25
jobTitle                    string   no        41
employeeAddress             object   no
employeeAddress.addr1       string   no        41
employeeAddress.addr2       string   no        41
employeeAddress.addr3       string   no        41
employeeAddress.city        string   no        31
employeeAddress.state       string   no        21
employeeAddress.postalCode  string   no        13
employeeAddress.country     string   no        31
printAs                     string   no        41
phone                       string   no        21
mobile                      string   no        21
email                       string   no        1023

Example with curl

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

bash

curl -X POST https://wirebook.buffersoltech.com/v1/qbd/employees \
  -H "Authorization: Bearer sk_test_..." \
  -H "X-End-User-Id: acme-42" \
  -H "Idempotency-Key: employees-create-1" \
  -H "Content-Type: application/json" \
  -d '{"firstName":"Example","lastName":"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.employees.create({
  "firstName": "Example",
  "lastName": "Example"
});

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

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

Example with Python

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

python

import os
from wirebook import Wirebook

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

created = qb.qbd.employees.create({
    "firstName": "Example",
    "lastName": "Example",
})

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

qb.qbd.employees.update("<listId>", {
    "revisionNumber": "1700000000",
    "salutation": "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.