Create a customer

Try itPOST /v1/quickbooks-desktop/customers

This request changes data. It runs for real against the QuickBooks Desktop company file of the end user you choose. Use a test key (sk_test_) and a test company file.

ServerSecret key requiredKept only in this page's memory and sent only to the server above. Reloading the page clears it.Daapi-End-User-Id requiredThe end user whose QuickBooks company file this request uses. `Conductor-End-User-Id` is accepted as an alias.

Idempotency-Key

Generated for you. Resending with the same key replays the original result instead of writing twice; a new key is generated after each response unless the API says the request is safe to retry.

Headers (3 optional)

Daapi-Timeout-Seconds integerHow long to wait for QuickBooks, in seconds (1–300). `Conductor-Timeout-Seconds` is accepted as an alias. Default 90, or 60 for the health check. If the request has not been sent by then it is canceled (`504 REQUEST_TIMEOUT_NOT_SENT`); if it was sent it keeps running (`504 QBD_REQUEST_TIMEOUT`).Prefer stringSend `respond-async` to get `202 Accepted` with a request resource immediately instead of waiting for QuickBooks.Daapi-Queue-Ttl-Seconds integerAsync only: the latest time, in seconds from now (10 to 86400), the request may still be sent to QuickBooks. Default 3600.

Request body required

Prefilled with the required fields only. See the request body section below for every field.

POST

/v1/quickbooks-desktop/customers

const url = 'https://api.desktopaccountingapi.com/v1/quickbooks-desktop/customers';
const options = {
  method: 'POST',
  headers: {
    'Daapi-End-User-Id': 'eu_01j9x4m6v4c8k2t7q0r5s3w1zb',
    'Daapi-Timeout-Seconds': '90',
    Prefer: 'respond-async',
    'Daapi-Queue-Ttl-Seconds': '3600',
    'Idempotency-Key': '6f1c2a0e-1f7e-4c55-9a7a-0b2d2c9e3a10',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"name":"example","isActive":true,"classId":"80000001-1234567890","parentId":"80000001-1234567890","companyName":"example","salutation":"example","firstName":"example","middleName":"example","lastName":"example","jobTitle":"example","billingAddress":{"line1":"example","line2":"example","line3":"example","line4":"example","line5":"example","city":"example","state":"example","postalCode":"example","country":"example","note":"example"},"shippingAddress":{"line1":"example","line2":"example","line3":"example","line4":"example","line5":"example","city":"example","state":"example","postalCode":"example","country":"example","note":"example"},"alternateShippingAddresses":[{"name":"example","line1":"example","line2":"example","line3":"example","line4":"example","line5":"example","city":"example","state":"example","postalCode":"example","country":"example","note":"example","isDefaultShippingAddress":true}],"phone":"example","alternatePhone":"example","fax":"example","email":"example","ccEmail":"example","contact":"example","alternateContact":"example","customContactFields":[{"name":"example","value":"example"}],"additionalContacts":[{"salutation":"example","firstName":"example","middleName":"example","lastName":"example","jobTitle":"example","customContactFields":[{"name":"example","value":"example"}]}],"customerTypeId":"80000001-1234567890","termsId":"80000001-1234567890","salesRepresentativeId":"80000001-1234567890","openingBalance":"1250.00","openingBalanceDate":"2026-10-05","salesTaxCodeId":"80000001-1234567890","salesTaxItemId":"80000001-1234567890","resaleNumber":"example","accountNumber":"example","creditLimit":"1250.00","preferredPaymentMethodId":"80000001-1234567890","creditCard":{"number":"example","expirationMonth":1,"expirationYear":1,"name":"example","address":"example","postalCode":"example"},"jobStatus":"awarded","jobStartDate":"2026-10-05","jobProjectedEndDate":"2026-10-05","jobEndDate":"2026-10-05","jobDescription":"example","jobTypeId":"80000001-1234567890","note":"example","additionalNotes":[{"note":"example"}],"preferredDeliveryMethod":"none","priceLevelId":"80000001-1234567890","externalId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","currencyId":"80000001-1234567890"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.desktopaccountingapi.com/v1/quickbooks-desktop/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Daapi-End-User-Id: eu_01j9x4m6v4c8k2t7q0r5s3w1zb' \
  --header 'Daapi-Queue-Ttl-Seconds: 3600' \
  --header 'Daapi-Timeout-Seconds: 90' \
  --header 'Idempotency-Key: 6f1c2a0e-1f7e-4c55-9a7a-0b2d2c9e3a10' \
  --header 'Prefer: respond-async' \
  --data '{ "name": "example", "isActive": true, "classId": "80000001-1234567890", "parentId": "80000001-1234567890", "companyName": "example", "salutation": "example", "firstName": "example", "middleName": "example", "lastName": "example", "jobTitle": "example", "billingAddress": { "line1": "example", "line2": "example", "line3": "example", "line4": "example", "line5": "example", "city": "example", "state": "example", "postalCode": "example", "country": "example", "note": "example" }, "shippingAddress": { "line1": "example", "line2": "example", "line3": "example", "line4": "example", "line5": "example", "city": "example", "state": "example", "postalCode": "example", "country": "example", "note": "example" }, "alternateShippingAddresses": [ { "name": "example", "line1": "example", "line2": "example", "line3": "example", "line4": "example", "line5": "example", "city": "example", "state": "example", "postalCode": "example", "country": "example", "note": "example", "isDefaultShippingAddress": true } ], "phone": "example", "alternatePhone": "example", "fax": "example", "email": "example", "ccEmail": "example", "contact": "example", "alternateContact": "example", "customContactFields": [ { "name": "example", "value": "example" } ], "additionalContacts": [ { "salutation": "example", "firstName": "example", "middleName": "example", "lastName": "example", "jobTitle": "example", "customContactFields": [ { "name": "example", "value": "example" } ] } ], "customerTypeId": "80000001-1234567890", "termsId": "80000001-1234567890", "salesRepresentativeId": "80000001-1234567890", "openingBalance": "1250.00", "openingBalanceDate": "2026-10-05", "salesTaxCodeId": "80000001-1234567890", "salesTaxItemId": "80000001-1234567890", "resaleNumber": "example", "accountNumber": "example", "creditLimit": "1250.00", "preferredPaymentMethodId": "80000001-1234567890", "creditCard": { "number": "example", "expirationMonth": 1, "expirationYear": 1, "name": "example", "address": "example", "postalCode": "example" }, "jobStatus": "awarded", "jobStartDate": "2026-10-05", "jobProjectedEndDate": "2026-10-05", "jobEndDate": "2026-10-05", "jobDescription": "example", "jobTypeId": "80000001-1234567890", "note": "example", "additionalNotes": [ { "note": "example" } ], "preferredDeliveryMethod": "none", "priceLevelId": "80000001-1234567890", "externalId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "currencyId": "80000001-1234567890" }'

Creates a customer in QuickBooks Desktop and returns it. Send an Idempotency-Key header so a retry after a network error never creates a second customer (the SDKs do this for you). See Idempotency and safe retries.

Authorizations

bearerAuth

Parameters

Header Parameters

Daapi-End-User-Id

required

string

/^eu_[0-9a-hjkmnp-tv-z]{26}$/

The end user whose QuickBooks company file this request uses. Conductor-End-User-Id is accepted as an alias.

Example

eu_01j9x4m6v4c8k2t7q0r5s3w1zb

Daapi-Timeout-Seconds

integer

>= 1 <= 300

How long to wait for QuickBooks, in seconds (1–300). Conductor-Timeout-Seconds is accepted as an alias. Default 90, or 60 for the health check. If the request has not been sent by then it is canceled (504 REQUEST_TIMEOUT_NOT_SENT); if it was sent it keeps running (504 QBD_REQUEST_TIMEOUT).

Example

Prefer

string

Allowed value: respond-async

Send respond-async to get 202 Accepted with a request resource immediately instead of waiting for QuickBooks.

Example

respond-async

Daapi-Queue-Ttl-Seconds

integer

>= 10 <= 86400

Async only: the latest time, in seconds from now (10 to 86400), the request may still be sent to QuickBooks. Default 3600.

Example

Idempotency-Key

string

>= 1 characters <= 255 characters /^[\x20-\x7e]+$/

Makes a write safe to retry. Repeating a key with the same request attaches to or replays the original instead of creating a second one. 1–255 printable ASCII characters, retained 7 days. Reusing a key with a different request returns 422 IDEMPOTENCY_KEY_REUSED.

Example

6f1c2a0e-1f7e-4c55-9a7a-0b2d2c9e3a10

Request Body^required

application/json

Fields for creating a customer.

object

name

required

Name of this customer, unique within its parent level.

string

<= 41 characters

isActive

Whether this customer is active. Inactive objects stay in QuickBooks but are hidden from most lists.

boolean

classId

ID of the class for this customer.

string

>= 1 characters <= 36 characters

Example

80000001-1234567890

parentId

ID of the parent object, making this customer a child in the hierarchy.

string

>= 1 characters <= 36 characters

Example

80000001-1234567890

companyName

Company name.

string

<= 41 characters

salutation

Salutation such as Mr. or Dr.

string

<= 15 characters

firstName

First name.

string

<= 25 characters

middleName

Middle name or initial.

string

<= 5 characters

lastName

Last name.

string

<= 25 characters

jobTitle

Job title.

string

<= 41 characters

billingAddress

object

line1

First address line.

string

<= 41 characters

line2

Second address line.

string

<= 41 characters

line3

Third address line.

string

<= 41 characters

line4

Fourth address line.

string

<= 41 characters

line5

Fifth address line.

string

<= 41 characters

city

City or locality.

string

<= 31 characters

state

State, province or region.

string

<= 21 characters

postalCode

Postal or ZIP code.

string

<= 13 characters

country

Country.

string

<= 31 characters

note

Note for this vendor address.

string

<= 41 characters

shippingAddress

object

line1

First address line.

string

<= 41 characters

line2

Second address line.

string

<= 41 characters

line3

Third address line.

string

<= 41 characters

line4

Fourth address line.

string

<= 41 characters

line5

Fifth address line.

string

<= 41 characters

city

City or locality.

string

<= 31 characters

state

State, province or region.

string

<= 21 characters

postalCode

Postal or ZIP code.

string

<= 13 characters

country

Country.

string

<= 31 characters

note

Note for this vendor address.

string

<= 41 characters

alternateShippingAddresses

Alternate shipping addresses entries for this customer.

Array<object>

Fields for creating a ship to address.

object

name

required

Name of this ship to address, unique within its parent level.

string

<= 41 characters

line1

First address line.

string

<= 41 characters

line2

Second address line.

string

<= 41 characters

line3

Third address line.

string

<= 41 characters

line4

Fourth address line.

string

<= 41 characters

line5

Fifth address line.

string

<= 41 characters

city

City or locality.

string

<= 31 characters

state

State, province or region.

string

<= 21 characters

postalCode

Postal or ZIP code.

string

<= 13 characters

country

Country.

string

<= 31 characters

note

Note for this ship to address.

string

<= 41 characters

isDefaultShippingAddress

Whether this ship to address is default shipping address.

boolean

phone

Main phone number.

string

<= 21 characters

alternatePhone

Alternate phone number.

string

<= 21 characters

fax

Fax number.

string

<= 21 characters

email

Email address.

string

<= 1023 characters

ccEmail

Email address copied on emailed forms.

string

<= 1023 characters

contact

Name of the main contact person.

string

<= 41 characters

alternateContact

Name of an alternate contact person.

string

<= 41 characters

customContactFields

Custom contact fields entries for this customer.

Array<object>

Fields for creating an additional contact ref.

object

name

required

Name of this additional contact ref, unique within its parent level.

string

<= 40 characters

value

required

Value.

string

<= 255 characters

additionalContacts

Additional contacts entries for this customer.

Array<object>

Fields for creating a contacts.

object

salutation

Salutation such as Mr. or Dr.

string

<= 15 characters

firstName

required

First name.

string

<= 25 characters

middleName

Middle name or initial.

string

<= 5 characters

lastName

Last name.

string

<= 25 characters

jobTitle

Job title.

string

<= 41 characters

customContactFields

Custom contact fields entries for this contacts.

Array<object>

Fields for creating an additional contact ref.

object

name

required

Name of this additional contact ref, unique within its parent level.

string

<= 40 characters

value

required

Value.

string

<= 255 characters

customerTypeId

ID of the customer type for this customer.

string

>= 1 characters <= 36 characters

Example

80000001-1234567890

termsId

ID of the terms for this customer.

string

>= 1 characters <= 36 characters

Example

80000001-1234567890

salesRepresentativeId

ID of the sales representative for this customer.

string

>= 1 characters <= 36 characters

Example

80000001-1234567890

openingBalance

Opening balance when this customer was created, as a decimal string.

string

/^-?\d{1,13}(\.\d{1,2})?$/

Example

1250.00

openingBalanceDate

Date of the opening balance (YYYY-MM-DD).

string format: date

Example

2026-10-05

salesTaxCodeId

ID of the sales tax code for this customer.

string

>= 1 characters <= 36 characters

Example

80000001-1234567890

salesTaxItemId

ID of the sales tax item for this customer.

string

>= 1 characters <= 36 characters

Example

80000001-1234567890

resaleNumber

Resale number of this customer.

string

<= 21 characters

accountNumber

Account number for this customer.

string

<= 99 characters

creditLimit

Credit limit as a decimal string.

string

/^-?\d{1,13}(\.\d{1,2})?$/

Example

1250.00

preferredPaymentMethodId

ID of the preferred payment method for this customer.

string

>= 1 characters <= 36 characters

Example

80000001-1234567890

creditCard

Credit card details for this customer.

object

number

Number of this credit card info.

string

<= 25 characters

expirationMonth

Expiration month of this credit card info.

integer

>= 1 <= 12

expirationYear

Expiration year of this credit card info.

integer

name

Name of this credit card info, unique within its parent level.

string

<= 41 characters

address

Address of this credit card info.

string

<= 41 characters

postalCode

Postal or ZIP code.

string

<= 41 characters

jobStatus

Job status of this customer.

string

Allowed values: awarded closed in_progress none not_awarded pending

jobStartDate

Job start date (YYYY-MM-DD).

string format: date

Example

2026-10-05

jobProjectedEndDate

Job projected end date (YYYY-MM-DD).

string format: date

Example

2026-10-05

jobEndDate

Job end date (YYYY-MM-DD).

string format: date

Example

2026-10-05

jobDescription

Job description of this customer.

string

<= 99 characters

jobTypeId

ID of the job type for this customer.

string

>= 1 characters <= 36 characters

Example

80000001-1234567890

note

Note for this customer.

string

<= 4095 characters

additionalNotes

Additional notes entries for this customer.

Array<object>

Fields for creating an additional notes.

object

note

required

Note for this additional notes.

string

<= 4095 characters

preferredDeliveryMethod

Preferred delivery method of this customer.

string

Allowed values: none email mail

priceLevelId

ID of the price level for this customer.

string

>= 1 characters <= 36 characters

Example

80000001-1234567890

externalId

Your own UUID for this customer, stored by QuickBooks so you can match records with your system.

string format: uuid

currencyId

ID of the currency for this customer.

string

>= 1 characters <= 36 characters

Example

80000001-1234567890

Responses

201

The created customer.

application/json

Customer as stored in QuickBooks Desktop.

object

required

QuickBooks-assigned ID of this customer.

string

objectType

required

Type of this object.

string

Allowed values: qbd_customer

createdAt

required

When this customer was created, as an ISO 8601 date-time with the QuickBooks computer’s UTC offset.

string format: date-time

updatedAt

required

When this customer was last changed, as an ISO 8601 date-time with the QuickBooks computer’s UTC offset.

string format: date-time

revisionNumber

required

Current revision of this customer. Send it unchanged when updating; a stale value is rejected.

string

name

required

Name of this customer, unique within its parent level.

string | null

fullName

required

Full hierarchical name of this customer: parent names and its own name separated by colons.

string | null

isActive

required

Whether this customer is active. Inactive objects stay in QuickBooks but are hidden from most lists.

boolean | null

class

required

Any of:

object
null

Reference to another QuickBooks object.

object

required

QuickBooks ID of the referenced object.

string | null

fullName

required

Full name of the referenced object at the time of the response.

string | null

parent

required

Any of:

object
null

Reference to another QuickBooks object.

object

required

QuickBooks ID of the referenced object.

string | null

fullName

required

Full name of the referenced object at the time of the response.

string | null

sublevel

required

Depth in the hierarchy: 0 for top-level objects, 1 for their children and so on.

integer | null

companyName

required

Company name.

string | null

salutation

required

Salutation such as Mr. or Dr.

string | null

firstName

required

First name.

string | null

middleName

required

Middle name or initial.

string | null

lastName

required

Last name.

string | null

jobTitle

required

Job title.

string | null

billingAddress

required

Any of:

object
null

Address as stored in QuickBooks Desktop.

object

line1

required

First address line.

string | null

line2

required

Second address line.

string | null

line3

required

Third address line.

string | null

line4

required

Fourth address line.

string | null

line5

required

Fifth address line.

string | null

city

required

City or locality.

string | null

state

required

State, province or region.

string | null

postalCode

required

Postal or ZIP code.

string | null

country

required

Country.

string | null

note

required

Note for this address.

string | null

shippingAddress

required

Any of:

object
null

Address as stored in QuickBooks Desktop.

object

line1

required

First address line.

string | null

line2

required

Second address line.

string | null

line3

required

Third address line.

string | null

line4

required

Fourth address line.

string | null

line5

required

Fifth address line.

string | null

city

required

City or locality.

string | null

state

required

State, province or region.

string | null

postalCode

required

Postal or ZIP code.

string | null

country

required

Country.

string | null

note

required

Note for this address.

string | null

alternateShippingAddresses

required

Any of:

Array<object>
null

Array<object>

Ship to address as stored in QuickBooks Desktop.

object

name

required

Name of this ship to address, unique within its parent level.

string | null

line1

required

First address line.

string | null

line2

required

Second address line.

string | null

line3

required

Third address line.

string | null

line4

required

Fourth address line.

string | null

line5

required

Fifth address line.

string | null

city

required

City or locality.

string | null

state

required

State, province or region.

string | null

postalCode

required

Postal or ZIP code.

string | null

country

required

Country.

string | null

note

required

Note for this ship to address.

string | null

isDefaultShippingAddress

required

Whether this ship to address is default shipping address.

boolean | null

phone

required

Main phone number.

string | null

alternatePhone

required

Alternate phone number.

string | null

fax

required

Fax number.

string | null

email

required

Email address.

string | null

ccEmail

required

Email address copied on emailed forms.

string | null

contact

required

Name of the main contact person.

string | null

alternateContact

required

Name of an alternate contact person.

string | null

customContactFields

required

Custom contact fields entries for this customer.

Array<object>

Additional contact ref as stored in QuickBooks Desktop.

object

name

required

Name of this additional contact ref, unique within its parent level.

string | null

value

required

Value.

string | null

additionalContacts

required

Additional contacts entries for this customer.

Array<object>

Contacts as stored in QuickBooks Desktop.

object

required

QuickBooks-assigned ID of this contacts.

string | null

objectType

required

Type of this object.

string

Allowed values: qbd_contact

createdAt

required

When this contacts was created, as an ISO 8601 date-time with the QuickBooks computer’s UTC offset.

string | null format: date-time

updatedAt

required

When this contacts was last changed, as an ISO 8601 date-time with the QuickBooks computer’s UTC offset.

string | null format: date-time

revisionNumber

required

Current revision of this contacts. Send it unchanged when updating; a stale value is rejected.

string | null

name

required

Name of this contacts, unique within its parent level.

string | null

salutation

required

Salutation such as Mr. or Dr.

string | null

firstName

required

First name.

string | null

middleName

required

Middle name or initial.

string | null

lastName

required

Last name.

string | null

jobTitle

required

Job title.

string | null

customContactFields

required

Custom contact fields entries for this contacts.

Array<object>

Additional contact ref as stored in QuickBooks Desktop.

object

name

required

Name of this additional contact ref, unique within its parent level.

string | null

value

required

Value.

string | null

customerType

required

Any of:

object
null

Reference to another QuickBooks object.

object

required

QuickBooks ID of the referenced object.

string | null

fullName

required

Full name of the referenced object at the time of the response.

string | null

terms

required

Any of:

object
null

Reference to another QuickBooks object.

object

required

QuickBooks ID of the referenced object.

string | null

fullName

required

Full name of the referenced object at the time of the response.

string | null

salesRepresentative

required

Any of:

object
null

Reference to another QuickBooks object.

object

required

QuickBooks ID of the referenced object.

string | null

fullName

required

Full name of the referenced object at the time of the response.

string | null

balance

required

Open balance of this customer alone, as a decimal string.

string | null

/^-?\d{1,13}(\.\d{1,2})?$/

totalBalance

required

Open balance including all child jobs, as a decimal string.

string | null

/^-?\d{1,13}(\.\d{1,2})?$/

salesTaxCode

required

Any of:

object
null

Reference to another QuickBooks object.

object

required

QuickBooks ID of the referenced object.

string | null

fullName

required

Full name of the referenced object at the time of the response.

string | null

salesTaxItem

required

Any of:

object
null

Reference to another QuickBooks object.

object

required

QuickBooks ID of the referenced object.

string | null

fullName

required

Full name of the referenced object at the time of the response.

string | null

resaleNumber

required

Resale number of this customer.

string | null

accountNumber

required

Account number for this customer.

string | null

creditLimit

required

Credit limit as a decimal string.

string | null

/^-?\d{1,13}(\.\d{1,2})?$/

preferredPaymentMethod

required

Any of:

object
null

Reference to another QuickBooks object.

object

required

QuickBooks ID of the referenced object.

string | null

fullName

required

Full name of the referenced object at the time of the response.

string | null

creditCard

required

Any of:

object
null

Credit card info as stored in QuickBooks Desktop.

object

number

required

Number of this credit card info.

string | null

expirationMonth

required

Expiration month of this credit card info.

integer | null

expirationYear

required

Expiration year of this credit card info.

integer | null

name

required

Name of this credit card info, unique within its parent level.

string | null

address

required

Address of this credit card info.

string | null

postalCode

required

Postal or ZIP code.

string | null

jobStatus

required

Job status of this customer.

string | null

Allowed values: awarded closed in_progress none not_awarded pending

jobStartDate

required

Job start date (YYYY-MM-DD).

string | null format: date

jobProjectedEndDate

required

Job projected end date (YYYY-MM-DD).

string | null format: date

jobEndDate

required

Job end date (YYYY-MM-DD).

string | null format: date

jobDescription

required

Job description of this customer.

string | null

jobType

required

Any of:

object
null

Reference to another QuickBooks object.

object

required

QuickBooks ID of the referenced object.

string | null

fullName

required

Full name of the referenced object at the time of the response.

string | null

note

required

Note for this customer.

string | null

additionalNotes

required

Additional notes entries for this customer.

Array<object>

Additional notes as stored in QuickBooks Desktop.

object

required

QuickBooks-assigned ID of this additional notes.

integer | null

date

required

Date (YYYY-MM-DD).

string | null format: date

note

required

Note for this additional notes.

string | null

preferredDeliveryMethod

required

Preferred delivery method of this customer.

string | null

Allowed values: none email mail

priceLevel

required

Any of:

object
null

Reference to another QuickBooks object.

object

required

QuickBooks ID of the referenced object.

string | null

fullName

required

Full name of the referenced object at the time of the response.

string | null

externalId

required

Your own UUID for this customer, stored by QuickBooks so you can match records with your system.

string | null format: uuid

currency

required

Any of:

object
null

Reference to another QuickBooks object.

object

required

QuickBooks ID of the referenced object.

string | null

fullName

required

Full name of the referenced object at the time of the response.

string | null

customFields

required

Custom field values QuickBooks stores on this customer.

Array<object>

Custom field as stored in QuickBooks Desktop.

object

ownerId

required

Owner of the custom field: “0” for public fields shown in the QuickBooks UI.

string | null

name

required

Name of this custom field, unique within its parent level.

string | null

type

required

Type.

string | null

Allowed values: amount_type date_time_type integer_type percent_type price_type quantity_type string_1024_type string_255_type

value

required

Value.

string | null

Example

{
  "objectType": "qbd_customer",
  "createdAt": "2026-10-05T09:14:03-07:00",
  "updatedAt": "2026-10-05T09:14:03-07:00",
  "additionalContacts": [
    {
      "objectType": "qbd_contact",
      "createdAt": "2026-10-05T09:14:03-07:00",
      "updatedAt": "2026-10-05T09:14:03-07:00"
    }
  ],
  "balance": "1250.00",
  "totalBalance": "1250.00",
  "creditLimit": "1250.00",
  "jobStatus": "awarded",
  "jobStartDate": "2026-10-05",
  "jobProjectedEndDate": "2026-10-05",
  "jobEndDate": "2026-10-05",
  "additionalNotes": [
    {
      "date": "2026-10-05"
    }
  ],
  "preferredDeliveryMethod": "none",
  "customFields": [
    {
      "type": "amount_type"
    }
  ]
}

Headers

Daapi-Request-Id

string

Unique ID of this API call (req_...). Present on every response.

RateLimit-Limit

integer

Requests allowed per window for the project (all keys together).

RateLimit-Remaining

integer

Requests left in the current window, as counted by the edge location that served this call.

RateLimit-Reset

integer

Seconds until the current window resets.

202

Accepted in async mode (Prefer: respond-async). Poll Location or wait for a webhook; the request’s result holds the success body.

application/json

object

required

Unique identifier for the request.

string

/^req_[0-9a-hjkmnp-tv-z]{26}$/

objectType

required

Always request.

string

Allowed values: request

createdAt

required

When the request was received. UTC, ISO 8601 with milliseconds.

string format: date-time

projectId

required

Unique identifier for the project.

string

/^proj_[0-9a-hjkmnp-tv-z]{26}$/

endUserId

required

Unique identifier for the end user.

string

/^eu_[0-9a-hjkmnp-tv-z]{26}$/

connectionId

required

The connection that carried the request; null when the call was rejected before the end user had a connection (no setup link created yet).

string | null

/^conn_[0-9a-hjkmnp-tv-z]{26}$/

operationId

required

The API operation, for example endUsers.passthrough or qbd.healthCheck.

string

method

required

HTTP method of the original call.

string

path

required

Path of the original call.

string

mode

required

sync when the caller waited for the result.

string

Allowed values: sync async

status

required

queued: accepted and waiting for its turn or the next Web Connector check-in. waiting_for_connection: async request waiting for an offline connection. sent: handed to QuickBooks; it can no longer be canceled. succeeded and failed are final. canceled: canceled before it was sent. outcome_unknown: a write was sent and its result could not be confirmed.

string

Allowed values: queued waiting_for_connection sent succeeded failed canceled outcome_unknown

outcome

required

Whether a write took effect: applied (QuickBooks confirmed it), not_applied (it certainly did not happen), pending (sent, still processing), unknown (sent, result could not be confirmed) or not_applicable (a read).

string

Allowed values: applied not_applied pending unknown not_applicable

sentAt

required

When the request was handed to the Web Connector. UTC, ISO 8601.

string | null

completedAt

required

When the request reached a final status. UTC, ISO 8601.

string | null

durationMs

required

Milliseconds from creation to completion.

integer | null

idempotencyKeyPresent

required

Whether the call sent an Idempotency-Key.

boolean

previousRequestId

required

An earlier request with the same Idempotency-Key that ended before reaching QuickBooks.

string | null

waitingReason

required

Why a queued request is waiting. quickbooks_not_responding: the Web Connector started a session but QuickBooks has not answered it (usually a QuickBooks dialog is open; see diagnosis). null once the request was sent.

string | null

Allowed values: awaiting_check_in behind_other_requests opening_company_file quickbooks_starting connector_offline quickbooks_unavailable quickbooks_not_responding write_recovery_pending

queuePosition

required

Position in this connection’s queue (1 = next), while queued.

integer | null

queueTtlExpiresAt

required

Async requests only: the latest time the request may still be sent. UTC, ISO 8601.

string | null

timings

required

Where the time went.

object

queuedMs

required

Milliseconds from creation until the request was sent to QuickBooks.

integer | null

quickbooksMs

required

Milliseconds from sending until QuickBooks answered.

integer | null

totalMs

required

Milliseconds from creation to completion.

integer | null

quickbooks

required

Native QuickBooks details.

object

qbxmlVersion

required

QbXML version used.

string | null

messageSetId

required

QbXML newMessageSetID sent with a write.

string | null

statusCode

required

QbXML statusCode of the first response element.

integer | null

statusSeverity

required

QbXML statusSeverity (Info, Warn or Error).

string | null

warnings

required

QuickBooks warnings (statusSeverity="Warn") and values the API read leniently from a damaged company file. The response body never drops a record for these; affected values are null.

Array<object>

object

code

required

QBD_WARNING for a QuickBooks warning status; QBD_VALUE_UNREADABLE when a value in the response was garbled and is returned as null; QBD_MARKUP_REPAIRED when malformed XML text was kept as text.

string

Allowed values: QBD_WARNING QBD_VALUE_UNREADABLE QBD_MARKUP_REPAIRED

statusCode

required

QbXML statusCode of a QuickBooks warning; null for warnings about the response data.

integer | null

message

required

What happened, including the text QuickBooks sent for unreadable values.

string

path

required

Where in result the affected value is, such as data[2].lines[0].amount; null for QuickBooks warning statuses.

string | null

recovered

required

true when an outcome_unknown write was resolved by asking QuickBooks for its stored result.

boolean

timeline

required

Lifecycle steps in order.

Array<object>

object

required

When the step happened. UTC, ISO 8601 with milliseconds.

string format: date-time

status

required

Step, usually a status (queued, waiting, sent, succeeded, diagnosed, …).

string

detail

required

Extra detail, for example the waiting reason or diagnosis cause.

string | null

elapsedMs

required

Milliseconds since the request was created.

integer

diagnosis

required

Any of:

object
null

Why a request is waiting, or why it timed out or expired. The server cannot see the end user’s screen; it ranks causes from Web Connector check-ins, whether QuickBooks answered, native connection errors, the company file identity and the queue.

object

required

When the diagnosis was made. UTC, ISO 8601 with milliseconds.

string format: date-time

summary

required

The most likely cause in one line.

string

connector

required

What the server observed about the end user’s Web Connector.

object

lastSeenAt

required

Last sign of the Web Connector (a check-in or a call inside a session). UTC, ISO 8601.

string | null

lastCheckInAt

required

Last Web Connector check-in. UTC, ISO 8601.

string | null

checkInIntervalSeconds

required

Typical interval between recent check-ins, in seconds.

integer | null

silentForSeconds

required

Seconds since lastSeenAt.

integer | null

sessionOpen

required

Whether a Web Connector session is open now.

boolean

sessionOpenedAt

required

When the open session started. UTC, ISO 8601.

string | null

quickbooksAnswered

required

Whether QuickBooks answered the open session; null without a session.

boolean | null

silentSessions

required

Recent consecutive sessions in which QuickBooks never answered.

integer

lastConnectionErrorCode

required

Error code of the latest QuickBooks connection error, while it persists.

string | null

probableCauses

required

Probable causes, most likely first.

Array<object>

object

code

required

Stable cause code. New codes may be added.

string

Allowed values: quickbooks_modal_dialog web_connector_registration_lost quickbooks_starting other_web_connector_app web_connector_closed computer_offline web_connector_schedule_changed quickbooks_closed_no_unattended_access quickbooks_unavailable wrong_company_file write_recovery_pending behind_other_requests quickbooks_processing session_interrupted same_connector_two_computers awaiting_check_in

likelihood

required

How strongly the observations point at this cause.

string

Allowed values: high medium low

summary

required

One-line description of the cause.

string

explanation

required

What the server observed and why it points at this cause.

string

fixes

required

Actions that resolve the cause, each with the responsible actor.

Array<object>

object

actor

required

Who can apply the fix.

string

Allowed values: developer end_user support

action

required

What to do.

string

details

required

Cause-specific observations, for example connectionErrorCode or silentForMs.

object

key

additional properties

docsUrl

required

Troubleshooting section for this cause.

string format: uri

error

required

Any of:

object
null

object

type

required

Error category. Use it to choose between retrying, fixing the request and asking the end user to act.

string

Allowed values: INVALID_REQUEST_ERROR AUTHENTICATION_ERROR PERMISSION_ERROR BILLING_ERROR RATE_LIMIT_ERROR INTEGRATION_CONNECTION_ERROR INTEGRATION_ERROR OUTCOME_UNKNOWN_ERROR INTERNAL_ERROR

code

required

Stable error code from the error catalog. New codes may be added; a code’s meaning never changes.

string

Allowed values: INVALID_JSON INVALID_PARAMETER UNKNOWN_PARAMETER UNKNOWN_HEADER DECIMAL_PRECISION_EXCEEDED STRING_TOO_LONG UNSUPPORTED_CHARACTER FIELD_NOT_CLEARABLE END_USER_ID_MISSING PAYLOAD_TOO_LARGE IDEMPOTENCY_KEY_INVALID IDEMPOTENCY_KEY_REUSED CURSOR_INVALID CURSOR_PARAMS_MISMATCH CURSOR_EXPIRED RESOURCE_MISSING REQUEST_NOT_CANCELABLE PASSTHROUGH_INVALID_QBXML QBD_FIELD_UNSUPPORTED_BY_VERSION QBD_REGION_UNSUPPORTED API_KEY_MISSING API_KEY_INVALID PUBLISHABLE_KEY_INVALID PUBLISHABLE_KEY_PROJECT_MISMATCH TEST_COMPANY_FILE_LIMIT_REACHED API_KEY_READ_ONLY PERMISSION_DENIED BILLING_REQUIRED PAYMENT_FAILED RATE_LIMITED CONNECTION_QUEUE_FULL WEBHOOK_ENDPOINT_LIMIT_REACHED INTEGRATION_CONNECTION_NOT_SET_UP INTEGRATION_CONNECTION_NOT_ACTIVE INTEGRATION_CONNECTION_DISABLED QBD_CONNECTION_ERROR QBD_CANNOT_START QBD_STARTING QBD_MODAL_DIALOG_OPEN QBD_QUICKBOOKS_NOT_RESPONDING QBD_WRONG_COMPANY_FILE_OPEN QBD_COMPANY_FILE_MISMATCH QBD_COMPANY_FILE_NOT_FOUND QBD_FILE_MODE_CONFLICT QBD_ADMIN_REQUIRED QBD_ACCESS_NOT_GRANTED QBD_VERSION_UNSUPPORTED QBD_REQUEST_ERROR QBD_OBJECT_NOT_FOUND QBD_REFERENCE_NOT_FOUND QBD_DUPLICATE_NAME QBD_REVISION_NUMBER_STALE QBD_OBJECT_IN_USE QBD_FEATURE_NOT_ENABLED QBD_INSUFFICIENT_PERMISSION QBD_RESPONSE_TOO_LARGE QBD_OPERATION_UNSUPPORTED QBD_RESPONSE_UNREADABLE REQUEST_TIMEOUT_NOT_SENT REQUEST_EXPIRED REQUEST_CANCELED QBD_REQUEST_TIMEOUT QBD_WRITE_OUTCOME_UNKNOWN QBD_READ_INTERRUPTED INTERNAL_ERROR SERVICE_UNAVAILABLE

message

required

Developer-facing explanation. May include IDs and field paths; never includes secrets.

string

userFacingMessage

required

A message that is safe to show to the end user.

string

httpStatusCode

required

HTTP status of the response. null for codes that appear only on a request resource (REQUEST_EXPIRED, REQUEST_CANCELED).

integer | null

integrationCode

required

Native QuickBooks code when one exists: a qbXML statusCode ("3200"), an HRESULT ("0x80040414") or a Web Connector code.

string | null

requestId

required

The Daapi-Request-Id of this response. Include it when contacting support.

string

cause

required

Why this error happens.

string

fixes

required

Ordered actions that resolve the error, each with the responsible actor.

Array<object>

object

actor

required

Who can apply the fix.

string

Allowed values: developer end_user support

action

required

What to do.

string

docsUrl

required

Documentation section for this code.

string format: uri

retryable

required

Repeating the identical request (with the same Idempotency-Key for writes) can succeed without changes. Also sent as the Daapi-Should-Retry header.

boolean

outcome

required

string

Allowed values: applied not_applied pending unknown not_applicable

param

required

Request field, query parameter or header the error refers to, when known.

string | null

details

required

Code-specific details, documented per code in the error catalog.

object

key

additional properties

result

The response body the original call returned (or would have returned) on success; null otherwise.

resultExpired

required

true when the result existed but is past the payload retention period (15 days, or 24 hours with payload capture off).

boolean

Example

{
  "id": "req_01j9x4m6v4c8k2t7q0r5s3w1zd",
  "objectType": "request",
  "createdAt": "2026-10-05T16:03:59.002Z",
  "projectId": "proj_01j9x4m6v4c8k2t7q0r5s3w1zf",
  "endUserId": "eu_01j9x4m6v4c8k2t7q0r5s3w1zb",
  "connectionId": "conn_01j9x4m6v4c8k2t7q0r5s3w1zc",
  "operationId": "qbd.healthCheck",
  "method": "GET",
  "path": "/v1/quickbooks-desktop/health-check",
  "mode": "sync",
  "status": "queued",
  "outcome": "applied",
  "waitingReason": "awaiting_check_in",
  "warnings": [
    {
      "code": "QBD_WARNING"
    }
  ],
  "timeline": [
    {
      "at": "2026-10-05T16:03:59.002Z"
    }
  ],
  "diagnosis": {
    "at": "2026-10-05T16:03:59.002Z",
    "summary": "QuickBooks Desktop probably has a dialog window open.",
    "probableCauses": [
      {
        "code": "quickbooks_modal_dialog",
        "likelihood": "high",
        "fixes": [
          {
            "actor": "developer"
          }
        ]
      }
    ]
  },
  "error": {
    "type": "INVALID_REQUEST_ERROR",
    "code": "INVALID_JSON",
    "httpStatusCode": 503,
    "integrationCode": "0x80040414",
    "requestId": "req_01j9x4m6v4c8k2t7q0r5s3w1zd",
    "fixes": [
      {
        "actor": "developer"
      }
    ],
    "docsUrl": "https://www.desktopaccountingapi.com/docs/errors/#qbd_modal_dialog_open",
    "outcome": "applied",
    "param": "companyName"
  }
}

Headers

Daapi-Request-Id

string

Unique ID of this API call (req_...). Present on every response.

RateLimit-Limit

integer

Requests allowed per window for the project (all keys together).

RateLimit-Remaining

integer

Requests left in the current window, as counted by the edge location that served this call.

RateLimit-Reset

integer

Seconds until the current window resets.

Location

string

Path of the request resource, /v1/requests/{id}.

Preference-Applied

string

respond-async when async mode was honored.

400

The request is invalid. Codes: UNKNOWN_HEADER, END_USER_ID_MISSING, INVALID_PARAMETER, UNKNOWN_PARAMETER, INVALID_JSON, DECIMAL_PRECISION_EXCEEDED, STRING_TOO_LONG, UNSUPPORTED_CHARACTER, FIELD_NOT_CLEARABLE, IDEMPOTENCY_KEY_INVALID.

application/json

object

error

required

object

type

required

Error category. Use it to choose between retrying, fixing the request and asking the end user to act.

string

Allowed values: INVALID_REQUEST_ERROR AUTHENTICATION_ERROR PERMISSION_ERROR BILLING_ERROR RATE_LIMIT_ERROR INTEGRATION_CONNECTION_ERROR INTEGRATION_ERROR OUTCOME_UNKNOWN_ERROR INTERNAL_ERROR

code

required

Stable error code from the error catalog. New codes may be added; a code’s meaning never changes.

string

message

required

Developer-facing explanation. May include IDs and field paths; never includes secrets.

string

userFacingMessage

required

A message that is safe to show to the end user.

string

httpStatusCode

required

HTTP status of the response. null for codes that appear only on a request resource (REQUEST_EXPIRED, REQUEST_CANCELED).

integer | null

integrationCode

required

Native QuickBooks code when one exists: a qbXML statusCode ("3200"), an HRESULT ("0x80040414") or a Web Connector code.

string | null

requestId

required

The Daapi-Request-Id of this response. Include it when contacting support.

string

cause

required

Why this error happens.

string

fixes

required

Ordered actions that resolve the error, each with the responsible actor.

Array<object>

object

actor

required

Who can apply the fix.

string

Allowed values: developer end_user support

action

required

What to do.

string

docsUrl

required

Documentation section for this code.

string format: uri

retryable

required

Repeating the identical request (with the same Idempotency-Key for writes) can succeed without changes. Also sent as the Daapi-Should-Retry header.

boolean

outcome

required

string

Allowed values: applied not_applied pending unknown not_applicable

param

required

Request field, query parameter or header the error refers to, when known.

string | null

details

required

Code-specific details, documented per code in the error catalog.

object

key

additional properties

Example

{
  "error": {
    "type": "INVALID_REQUEST_ERROR",
    "code": "INVALID_JSON",
    "httpStatusCode": 503,
    "integrationCode": "0x80040414",
    "requestId": "req_01j9x4m6v4c8k2t7q0r5s3w1zd",
    "fixes": [
      {
        "actor": "developer"
      }
    ],
    "docsUrl": "https://www.desktopaccountingapi.com/docs/errors/#qbd_modal_dialog_open",
    "outcome": "applied",
    "param": "companyName"
  }
}

Headers

Daapi-Request-Id

string

Unique ID of this API call (req_...). Present on every response.

RateLimit-Limit

integer

Requests allowed per window for the project (all keys together).

RateLimit-Remaining

integer

Requests left in the current window, as counted by the edge location that served this call.

RateLimit-Reset

integer

Seconds until the current window resets.

Daapi-Should-Retry

string

Allowed values: true false

true when repeating the identical request can succeed. SDKs follow it instead of status-code heuristics.

Retry-After

integer

Seconds to wait before retrying, on 429 and on retryable 503 responses when a wait is known.

401

The API key is missing or invalid. Codes: API_KEY_MISSING, API_KEY_INVALID.

application/json

object

error

required

object

type

required

Error category. Use it to choose between retrying, fixing the request and asking the end user to act.

string

Allowed values: INVALID_REQUEST_ERROR AUTHENTICATION_ERROR PERMISSION_ERROR BILLING_ERROR RATE_LIMIT_ERROR INTEGRATION_CONNECTION_ERROR INTEGRATION_ERROR OUTCOME_UNKNOWN_ERROR INTERNAL_ERROR

code

required

Stable error code from the error catalog. New codes may be added; a code’s meaning never changes.

string

message

required

Developer-facing explanation. May include IDs and field paths; never includes secrets.

string

userFacingMessage

required

A message that is safe to show to the end user.

string

httpStatusCode

required

HTTP status of the response. null for codes that appear only on a request resource (REQUEST_EXPIRED, REQUEST_CANCELED).

integer | null

integrationCode

required

Native QuickBooks code when one exists: a qbXML statusCode ("3200"), an HRESULT ("0x80040414") or a Web Connector code.

string | null

requestId

required

The Daapi-Request-Id of this response. Include it when contacting support.

string

cause

required

Why this error happens.

string

fixes

required

Ordered actions that resolve the error, each with the responsible actor.

Array<object>

object

actor

required

Who can apply the fix.

string

Allowed values: developer end_user support

action

required

What to do.

string

docsUrl

required

Documentation section for this code.

string format: uri

retryable

required

Repeating the identical request (with the same Idempotency-Key for writes) can succeed without changes. Also sent as the Daapi-Should-Retry header.

boolean

outcome

required

string

Allowed values: applied not_applied pending unknown not_applicable

param

required

Request field, query parameter or header the error refers to, when known.

string | null

details

required

Code-specific details, documented per code in the error catalog.

object

key

additional properties

Example

{
  "error": {
    "type": "INVALID_REQUEST_ERROR",
    "code": "INVALID_JSON",
    "httpStatusCode": 503,
    "integrationCode": "0x80040414",
    "requestId": "req_01j9x4m6v4c8k2t7q0r5s3w1zd",
    "fixes": [
      {
        "actor": "developer"
      }
    ],
    "docsUrl": "https://www.desktopaccountingapi.com/docs/errors/#qbd_modal_dialog_open",
    "outcome": "applied",
    "param": "companyName"
  }
}

Headers

Daapi-Request-Id

string

Unique ID of this API call (req_...). Present on every response.

RateLimit-Limit

integer

Requests allowed per window for the project (all keys together).

RateLimit-Remaining

integer

Requests left in the current window, as counted by the edge location that served this call.

RateLimit-Reset

integer

Seconds until the current window resets.

Daapi-Should-Retry

string

Allowed values: true false

true when repeating the identical request can succeed. SDKs follow it instead of status-code heuristics.

Retry-After

integer

Seconds to wait before retrying, on 429 and on retryable 503 responses when a wait is known.

402

Billing blocks production data requests. Codes: BILLING_REQUIRED, PAYMENT_FAILED.

application/json

object

error

required

object

type

required

Error category. Use it to choose between retrying, fixing the request and asking the end user to act.

string

Allowed values: INVALID_REQUEST_ERROR AUTHENTICATION_ERROR PERMISSION_ERROR BILLING_ERROR RATE_LIMIT_ERROR INTEGRATION_CONNECTION_ERROR INTEGRATION_ERROR OUTCOME_UNKNOWN_ERROR INTERNAL_ERROR

code

required

Stable error code from the error catalog. New codes may be added; a code’s meaning never changes.

string

message

required

Developer-facing explanation. May include IDs and field paths; never includes secrets.

string

userFacingMessage

required

A message that is safe to show to the end user.

string

httpStatusCode

required

HTTP status of the response. null for codes that appear only on a request resource (REQUEST_EXPIRED, REQUEST_CANCELED).

integer | null

integrationCode

required

Native QuickBooks code when one exists: a qbXML statusCode ("3200"), an HRESULT ("0x80040414") or a Web Connector code.

string | null

requestId

required

The Daapi-Request-Id of this response. Include it when contacting support.

string

cause

required

Why this error happens.

string

fixes

required

Ordered actions that resolve the error, each with the responsible actor.

Array<object>

object

actor

required

Who can apply the fix.

string

Allowed values: developer end_user support

action

required

What to do.

string

docsUrl

required

Documentation section for this code.

string format: uri

retryable

required

Repeating the identical request (with the same Idempotency-Key for writes) can succeed without changes. Also sent as the Daapi-Should-Retry header.

boolean

outcome

required

string

Allowed values: applied not_applied pending unknown not_applicable

param

required

Request field, query parameter or header the error refers to, when known.

string | null

details

required

Code-specific details, documented per code in the error catalog.

object

key

additional properties

Example

{
  "error": {
    "type": "INVALID_REQUEST_ERROR",
    "code": "INVALID_JSON",
    "httpStatusCode": 503,
    "integrationCode": "0x80040414",
    "requestId": "req_01j9x4m6v4c8k2t7q0r5s3w1zd",
    "fixes": [
      {
        "actor": "developer"
      }
    ],
    "docsUrl": "https://www.desktopaccountingapi.com/docs/errors/#qbd_modal_dialog_open",
    "outcome": "applied",
    "param": "companyName"
  }
}

Headers

Daapi-Request-Id

string

Unique ID of this API call (req_...). Present on every response.

RateLimit-Limit

integer

Requests allowed per window for the project (all keys together).

RateLimit-Remaining

integer

Requests left in the current window, as counted by the edge location that served this call.

RateLimit-Reset

integer

Seconds until the current window resets.

Daapi-Should-Retry

string

Allowed values: true false

true when repeating the identical request can succeed. SDKs follow it instead of status-code heuristics.

Retry-After

integer

Seconds to wait before retrying, on 429 and on retryable 503 responses when a wait is known.

403

The operation is not permitted. Codes: INTEGRATION_CONNECTION_DISABLED, PERMISSION_DENIED, QBD_INSUFFICIENT_PERMISSION, API_KEY_READ_ONLY.

application/json

object

error

required

object

type

required

Error category. Use it to choose between retrying, fixing the request and asking the end user to act.

string

Allowed values: INVALID_REQUEST_ERROR AUTHENTICATION_ERROR PERMISSION_ERROR BILLING_ERROR RATE_LIMIT_ERROR INTEGRATION_CONNECTION_ERROR INTEGRATION_ERROR OUTCOME_UNKNOWN_ERROR INTERNAL_ERROR

code

required

Stable error code from the error catalog. New codes may be added; a code’s meaning never changes.

string

message

required

Developer-facing explanation. May include IDs and field paths; never includes secrets.

string

userFacingMessage

required

A message that is safe to show to the end user.

string

httpStatusCode

required

HTTP status of the response. null for codes that appear only on a request resource (REQUEST_EXPIRED, REQUEST_CANCELED).

integer | null

integrationCode

required

Native QuickBooks code when one exists: a qbXML statusCode ("3200"), an HRESULT ("0x80040414") or a Web Connector code.

string | null

requestId

required

The Daapi-Request-Id of this response. Include it when contacting support.

string

cause

required

Why this error happens.

string

fixes

required

Ordered actions that resolve the error, each with the responsible actor.

Array<object>

object

actor

required

Who can apply the fix.

string

Allowed values: developer end_user support

action

required

What to do.

string

docsUrl

required

Documentation section for this code.

string format: uri

retryable

required

Repeating the identical request (with the same Idempotency-Key for writes) can succeed without changes. Also sent as the Daapi-Should-Retry header.

boolean

outcome

required

string

Allowed values: applied not_applied pending unknown not_applicable

param

required

Request field, query parameter or header the error refers to, when known.

string | null

details

required

Code-specific details, documented per code in the error catalog.

object

key

additional properties

Example

{
  "error": {
    "type": "INVALID_REQUEST_ERROR",
    "code": "INVALID_JSON",
    "httpStatusCode": 503,
    "integrationCode": "0x80040414",
    "requestId": "req_01j9x4m6v4c8k2t7q0r5s3w1zd",
    "fixes": [
      {
        "actor": "developer"
      }
    ],
    "docsUrl": "https://www.desktopaccountingapi.com/docs/errors/#qbd_modal_dialog_open",
    "outcome": "applied",
    "param": "companyName"
  }
}

Headers

Daapi-Request-Id

string

Unique ID of this API call (req_...). Present on every response.

RateLimit-Limit

integer

Requests allowed per window for the project (all keys together).

RateLimit-Remaining

integer

Requests left in the current window, as counted by the edge location that served this call.

RateLimit-Reset

integer

Seconds until the current window resets.

Daapi-Should-Retry

string

Allowed values: true false

true when repeating the identical request can succeed. SDKs follow it instead of status-code heuristics.

Retry-After

integer

Seconds to wait before retrying, on 429 and on retryable 503 responses when a wait is known.

404

The object does not exist in this project. Codes: RESOURCE_MISSING.

application/json

object

error

required

object

type

required

Error category. Use it to choose between retrying, fixing the request and asking the end user to act.

string

Allowed values: INVALID_REQUEST_ERROR AUTHENTICATION_ERROR PERMISSION_ERROR BILLING_ERROR RATE_LIMIT_ERROR INTEGRATION_CONNECTION_ERROR INTEGRATION_ERROR OUTCOME_UNKNOWN_ERROR INTERNAL_ERROR

code

required

Stable error code from the error catalog. New codes may be added; a code’s meaning never changes.

string

message

required

Developer-facing explanation. May include IDs and field paths; never includes secrets.

string

userFacingMessage

required

A message that is safe to show to the end user.

string

httpStatusCode

required

HTTP status of the response. null for codes that appear only on a request resource (REQUEST_EXPIRED, REQUEST_CANCELED).

integer | null

integrationCode

required

Native QuickBooks code when one exists: a qbXML statusCode ("3200"), an HRESULT ("0x80040414") or a Web Connector code.

string | null

requestId

required

The Daapi-Request-Id of this response. Include it when contacting support.

string

cause

required

Why this error happens.

string

fixes

required

Ordered actions that resolve the error, each with the responsible actor.

Array<object>

object

actor

required

Who can apply the fix.

string

Allowed values: developer end_user support

action

required

What to do.

string

docsUrl

required

Documentation section for this code.

string format: uri

retryable

required

Repeating the identical request (with the same Idempotency-Key for writes) can succeed without changes. Also sent as the Daapi-Should-Retry header.

boolean

outcome

required

string

Allowed values: applied not_applied pending unknown not_applicable

param

required

Request field, query parameter or header the error refers to, when known.

string | null

details

required

Code-specific details, documented per code in the error catalog.

object

key

additional properties

Example

{
  "error": {
    "type": "INVALID_REQUEST_ERROR",
    "code": "INVALID_JSON",
    "httpStatusCode": 503,
    "integrationCode": "0x80040414",
    "requestId": "req_01j9x4m6v4c8k2t7q0r5s3w1zd",
    "fixes": [
      {
        "actor": "developer"
      }
    ],
    "docsUrl": "https://www.desktopaccountingapi.com/docs/errors/#qbd_modal_dialog_open",
    "outcome": "applied",
    "param": "companyName"
  }
}

Headers

Daapi-Request-Id

string

Unique ID of this API call (req_...). Present on every response.

RateLimit-Limit

integer

Requests allowed per window for the project (all keys together).

RateLimit-Remaining

integer

Requests left in the current window, as counted by the edge location that served this call.

RateLimit-Reset

integer

Seconds until the current window resets.

Daapi-Should-Retry

string

Allowed values: true false

true when repeating the identical request can succeed. SDKs follow it instead of status-code heuristics.

Retry-After

integer

Seconds to wait before retrying, on 429 and on retryable 503 responses when a wait is known.

409

The request conflicts with the current state. Codes: INTEGRATION_CONNECTION_NOT_SET_UP, QBD_COMPANY_FILE_MISMATCH, QBD_DUPLICATE_NAME, QBD_OBJECT_IN_USE.

application/json

object

error

required

object

type

required

Error category. Use it to choose between retrying, fixing the request and asking the end user to act.

string

Allowed values: INVALID_REQUEST_ERROR AUTHENTICATION_ERROR PERMISSION_ERROR BILLING_ERROR RATE_LIMIT_ERROR INTEGRATION_CONNECTION_ERROR INTEGRATION_ERROR OUTCOME_UNKNOWN_ERROR INTERNAL_ERROR

code

required

Stable error code from the error catalog. New codes may be added; a code’s meaning never changes.

string

message

required

Developer-facing explanation. May include IDs and field paths; never includes secrets.

string

userFacingMessage

required

A message that is safe to show to the end user.

string

httpStatusCode

required

HTTP status of the response. null for codes that appear only on a request resource (REQUEST_EXPIRED, REQUEST_CANCELED).

integer | null

integrationCode

required

Native QuickBooks code when one exists: a qbXML statusCode ("3200"), an HRESULT ("0x80040414") or a Web Connector code.

string | null

requestId

required

The Daapi-Request-Id of this response. Include it when contacting support.

string

cause

required

Why this error happens.

string

fixes

required

Ordered actions that resolve the error, each with the responsible actor.

Array<object>

object

actor

required

Who can apply the fix.

string

Allowed values: developer end_user support

action

required

What to do.

string

docsUrl

required

Documentation section for this code.

string format: uri

retryable

required

Repeating the identical request (with the same Idempotency-Key for writes) can succeed without changes. Also sent as the Daapi-Should-Retry header.

boolean

outcome

required

string

Allowed values: applied not_applied pending unknown not_applicable

param

required

Request field, query parameter or header the error refers to, when known.

string | null

details

required

Code-specific details, documented per code in the error catalog.

object

key

additional properties

Example

{
  "error": {
    "type": "INVALID_REQUEST_ERROR",
    "code": "INVALID_JSON",
    "httpStatusCode": 503,
    "integrationCode": "0x80040414",
    "requestId": "req_01j9x4m6v4c8k2t7q0r5s3w1zd",
    "fixes": [
      {
        "actor": "developer"
      }
    ],
    "docsUrl": "https://www.desktopaccountingapi.com/docs/errors/#qbd_modal_dialog_open",
    "outcome": "applied",
    "param": "companyName"
  }
}

Headers

Daapi-Request-Id

string

Unique ID of this API call (req_...). Present on every response.

RateLimit-Limit

integer

Requests allowed per window for the project (all keys together).

RateLimit-Remaining

integer

Requests left in the current window, as counted by the edge location that served this call.

RateLimit-Reset

integer

Seconds until the current window resets.

Daapi-Should-Retry

string

Allowed values: true false

true when repeating the identical request can succeed. SDKs follow it instead of status-code heuristics.

Retry-After

integer

Seconds to wait before retrying, on 429 and on retryable 503 responses when a wait is known.

413

The request body is too large. Codes: PAYLOAD_TOO_LARGE.

application/json

object

error

required

object

type

required

Error category. Use it to choose between retrying, fixing the request and asking the end user to act.

string

Allowed values: INVALID_REQUEST_ERROR AUTHENTICATION_ERROR PERMISSION_ERROR BILLING_ERROR RATE_LIMIT_ERROR INTEGRATION_CONNECTION_ERROR INTEGRATION_ERROR OUTCOME_UNKNOWN_ERROR INTERNAL_ERROR

code

required

Stable error code from the error catalog. New codes may be added; a code’s meaning never changes.

string

message

required

Developer-facing explanation. May include IDs and field paths; never includes secrets.

string

userFacingMessage

required

A message that is safe to show to the end user.

string

httpStatusCode

required

HTTP status of the response. null for codes that appear only on a request resource (REQUEST_EXPIRED, REQUEST_CANCELED).

integer | null

integrationCode

required

Native QuickBooks code when one exists: a qbXML statusCode ("3200"), an HRESULT ("0x80040414") or a Web Connector code.

string | null

requestId

required

The Daapi-Request-Id of this response. Include it when contacting support.

string

cause

required

Why this error happens.

string

fixes

required

Ordered actions that resolve the error, each with the responsible actor.

Array<object>

object

actor

required

Who can apply the fix.

string

Allowed values: developer end_user support

action

required

What to do.

string

docsUrl

required

Documentation section for this code.

string format: uri

retryable

required

Repeating the identical request (with the same Idempotency-Key for writes) can succeed without changes. Also sent as the Daapi-Should-Retry header.

boolean

outcome

required

string

Allowed values: applied not_applied pending unknown not_applicable

param

required

Request field, query parameter or header the error refers to, when known.

string | null

details

required

Code-specific details, documented per code in the error catalog.

object

key

additional properties

Example

{
  "error": {
    "type": "INVALID_REQUEST_ERROR",
    "code": "INVALID_JSON",
    "httpStatusCode": 503,
    "integrationCode": "0x80040414",
    "requestId": "req_01j9x4m6v4c8k2t7q0r5s3w1zd",
    "fixes": [
      {
        "actor": "developer"
      }
    ],
    "docsUrl": "https://www.desktopaccountingapi.com/docs/errors/#qbd_modal_dialog_open",
    "outcome": "applied",
    "param": "companyName"
  }
}

Headers

Daapi-Request-Id

string

Unique ID of this API call (req_...). Present on every response.

RateLimit-Limit

integer

Requests allowed per window for the project (all keys together).

RateLimit-Remaining

integer

Requests left in the current window, as counted by the edge location that served this call.

RateLimit-Reset

integer

Seconds until the current window resets.

Daapi-Should-Retry

string

Allowed values: true false

true when repeating the identical request can succeed. SDKs follow it instead of status-code heuristics.

Retry-After

integer

Seconds to wait before retrying, on 429 and on retryable 503 responses when a wait is known.

422

The request is well formed but cannot be processed. Codes: QBD_FIELD_UNSUPPORTED_BY_VERSION, QBD_REGION_UNSUPPORTED, QBD_REQUEST_ERROR, QBD_FEATURE_NOT_ENABLED, IDEMPOTENCY_KEY_REUSED, QBD_REFERENCE_NOT_FOUND.

application/json

object

error

required

object

type

required

Error category. Use it to choose between retrying, fixing the request and asking the end user to act.

string

Allowed values: INVALID_REQUEST_ERROR AUTHENTICATION_ERROR PERMISSION_ERROR BILLING_ERROR RATE_LIMIT_ERROR INTEGRATION_CONNECTION_ERROR INTEGRATION_ERROR OUTCOME_UNKNOWN_ERROR INTERNAL_ERROR

code

required

Stable error code from the error catalog. New codes may be added; a code’s meaning never changes.

string

message

required

Developer-facing explanation. May include IDs and field paths; never includes secrets.

string

userFacingMessage

required

A message that is safe to show to the end user.

string

httpStatusCode

required

HTTP status of the response. null for codes that appear only on a request resource (REQUEST_EXPIRED, REQUEST_CANCELED).

integer | null

integrationCode

required

Native QuickBooks code when one exists: a qbXML statusCode ("3200"), an HRESULT ("0x80040414") or a Web Connector code.

string | null

requestId

required

The Daapi-Request-Id of this response. Include it when contacting support.

string

cause

required

Why this error happens.

string

fixes

required

Ordered actions that resolve the error, each with the responsible actor.

Array<object>

object

actor

required

Who can apply the fix.

string

Allowed values: developer end_user support

action

required

What to do.

string

docsUrl

required

Documentation section for this code.

string format: uri

retryable

required

Repeating the identical request (with the same Idempotency-Key for writes) can succeed without changes. Also sent as the Daapi-Should-Retry header.

boolean

outcome

required

string

Allowed values: applied not_applied pending unknown not_applicable

param

required

Request field, query parameter or header the error refers to, when known.

string | null

details

required

Code-specific details, documented per code in the error catalog.

object

key

additional properties

Example

{
  "error": {
    "type": "INVALID_REQUEST_ERROR",
    "code": "INVALID_JSON",
    "httpStatusCode": 503,
    "integrationCode": "0x80040414",
    "requestId": "req_01j9x4m6v4c8k2t7q0r5s3w1zd",
    "fixes": [
      {
        "actor": "developer"
      }
    ],
    "docsUrl": "https://www.desktopaccountingapi.com/docs/errors/#qbd_modal_dialog_open",
    "outcome": "applied",
    "param": "companyName"
  }
}

Headers

Daapi-Request-Id

string

Unique ID of this API call (req_...). Present on every response.

RateLimit-Limit

integer

Requests allowed per window for the project (all keys together).

RateLimit-Remaining

integer

Requests left in the current window, as counted by the edge location that served this call.

RateLimit-Reset

integer

Seconds until the current window resets.

Daapi-Should-Retry

string

Allowed values: true false

true when repeating the identical request can succeed. SDKs follow it instead of status-code heuristics.

Retry-After

integer

Seconds to wait before retrying, on 429 and on retryable 503 responses when a wait is known.

429

Too many requests. Codes: RATE_LIMITED, CONNECTION_QUEUE_FULL.

application/json

object

error

required

object

type

required

Error category. Use it to choose between retrying, fixing the request and asking the end user to act.

string

Allowed values: INVALID_REQUEST_ERROR AUTHENTICATION_ERROR PERMISSION_ERROR BILLING_ERROR RATE_LIMIT_ERROR INTEGRATION_CONNECTION_ERROR INTEGRATION_ERROR OUTCOME_UNKNOWN_ERROR INTERNAL_ERROR

code

required

Stable error code from the error catalog. New codes may be added; a code’s meaning never changes.

string

message

required

Developer-facing explanation. May include IDs and field paths; never includes secrets.

string

userFacingMessage

required

A message that is safe to show to the end user.

string

httpStatusCode

required

HTTP status of the response. null for codes that appear only on a request resource (REQUEST_EXPIRED, REQUEST_CANCELED).

integer | null

integrationCode

required

Native QuickBooks code when one exists: a qbXML statusCode ("3200"), an HRESULT ("0x80040414") or a Web Connector code.

string | null

requestId

required

The Daapi-Request-Id of this response. Include it when contacting support.

string

cause

required

Why this error happens.

string

fixes

required

Ordered actions that resolve the error, each with the responsible actor.

Array<object>

object

actor

required

Who can apply the fix.

string

Allowed values: developer end_user support

action

required

What to do.

string

docsUrl

required

Documentation section for this code.

string format: uri

retryable

required

Repeating the identical request (with the same Idempotency-Key for writes) can succeed without changes. Also sent as the Daapi-Should-Retry header.

boolean

outcome

required

string

Allowed values: applied not_applied pending unknown not_applicable

param

required

Request field, query parameter or header the error refers to, when known.

string | null

details

required

Code-specific details, documented per code in the error catalog.

object

key

additional properties

Example

{
  "error": {
    "type": "INVALID_REQUEST_ERROR",
    "code": "INVALID_JSON",
    "httpStatusCode": 503,
    "integrationCode": "0x80040414",
    "requestId": "req_01j9x4m6v4c8k2t7q0r5s3w1zd",
    "fixes": [
      {
        "actor": "developer"
      }
    ],
    "docsUrl": "https://www.desktopaccountingapi.com/docs/errors/#qbd_modal_dialog_open",
    "outcome": "applied",
    "param": "companyName"
  }
}

Headers

Daapi-Request-Id

string

Unique ID of this API call (req_...). Present on every response.

RateLimit-Limit

integer

Requests allowed per window for the project (all keys together).

RateLimit-Remaining

integer

Requests left in the current window, as counted by the edge location that served this call.

RateLimit-Reset

integer

Seconds until the current window resets.

Daapi-Should-Retry

string

Allowed values: true false

true when repeating the identical request can succeed. SDKs follow it instead of status-code heuristics.

Retry-After

integer

Seconds to wait before retrying, on 429 and on retryable 503 responses when a wait is known.

500

Unexpected server error. Codes: INTERNAL_ERROR.

application/json

object

error

required

object

type

required

Error category. Use it to choose between retrying, fixing the request and asking the end user to act.

string

Allowed values: INVALID_REQUEST_ERROR AUTHENTICATION_ERROR PERMISSION_ERROR BILLING_ERROR RATE_LIMIT_ERROR INTEGRATION_CONNECTION_ERROR INTEGRATION_ERROR OUTCOME_UNKNOWN_ERROR INTERNAL_ERROR

code

required

Stable error code from the error catalog. New codes may be added; a code’s meaning never changes.

string

message

required

Developer-facing explanation. May include IDs and field paths; never includes secrets.

string

userFacingMessage

required

A message that is safe to show to the end user.

string

httpStatusCode

required

HTTP status of the response. null for codes that appear only on a request resource (REQUEST_EXPIRED, REQUEST_CANCELED).

integer | null

integrationCode

required

Native QuickBooks code when one exists: a qbXML statusCode ("3200"), an HRESULT ("0x80040414") or a Web Connector code.

string | null

requestId

required

The Daapi-Request-Id of this response. Include it when contacting support.

string

cause

required

Why this error happens.

string

fixes

required

Ordered actions that resolve the error, each with the responsible actor.

Array<object>

object

actor

required

Who can apply the fix.

string

Allowed values: developer end_user support

action

required

What to do.

string

docsUrl

required

Documentation section for this code.

string format: uri

retryable

required

Repeating the identical request (with the same Idempotency-Key for writes) can succeed without changes. Also sent as the Daapi-Should-Retry header.

boolean

outcome

required

string

Allowed values: applied not_applied pending unknown not_applicable

param

required

Request field, query parameter or header the error refers to, when known.

string | null

details

required

Code-specific details, documented per code in the error catalog.

object

key

additional properties

Example

{
  "error": {
    "type": "INVALID_REQUEST_ERROR",
    "code": "INVALID_JSON",
    "httpStatusCode": 503,
    "integrationCode": "0x80040414",
    "requestId": "req_01j9x4m6v4c8k2t7q0r5s3w1zd",
    "fixes": [
      {
        "actor": "developer"
      }
    ],
    "docsUrl": "https://www.desktopaccountingapi.com/docs/errors/#qbd_modal_dialog_open",
    "outcome": "applied",
    "param": "companyName"
  }
}

Headers

Daapi-Request-Id

string

Unique ID of this API call (req_...). Present on every response.

RateLimit-Limit

integer

Requests allowed per window for the project (all keys together).

RateLimit-Remaining

integer

Requests left in the current window, as counted by the edge location that served this call.

RateLimit-Reset

integer

Seconds until the current window resets.

Daapi-Should-Retry

string

Allowed values: true false

true when repeating the identical request can succeed. SDKs follow it instead of status-code heuristics.

Retry-After

integer

Seconds to wait before retrying, on 429 and on retryable 503 responses when a wait is known.

502

The result could not be confirmed. Codes: QBD_READ_INTERRUPTED, QBD_WRITE_OUTCOME_UNKNOWN.

application/json

object

error

required

object

type

required

Error category. Use it to choose between retrying, fixing the request and asking the end user to act.

string

Allowed values: INVALID_REQUEST_ERROR AUTHENTICATION_ERROR PERMISSION_ERROR BILLING_ERROR RATE_LIMIT_ERROR INTEGRATION_CONNECTION_ERROR INTEGRATION_ERROR OUTCOME_UNKNOWN_ERROR INTERNAL_ERROR

code

required

Stable error code from the error catalog. New codes may be added; a code’s meaning never changes.

string

message

required

Developer-facing explanation. May include IDs and field paths; never includes secrets.

string

userFacingMessage

required

A message that is safe to show to the end user.

string

httpStatusCode

required

HTTP status of the response. null for codes that appear only on a request resource (REQUEST_EXPIRED, REQUEST_CANCELED).

integer | null

integrationCode

required

Native QuickBooks code when one exists: a qbXML statusCode ("3200"), an HRESULT ("0x80040414") or a Web Connector code.

string | null

requestId

required

The Daapi-Request-Id of this response. Include it when contacting support.

string

cause

required

Why this error happens.

string

fixes

required

Ordered actions that resolve the error, each with the responsible actor.

Array<object>

object

actor

required

Who can apply the fix.

string

Allowed values: developer end_user support

action

required

What to do.

string

docsUrl

required

Documentation section for this code.

string format: uri

retryable

required

Repeating the identical request (with the same Idempotency-Key for writes) can succeed without changes. Also sent as the Daapi-Should-Retry header.

boolean

outcome

required

string

Allowed values: applied not_applied pending unknown not_applicable

param

required

Request field, query parameter or header the error refers to, when known.

string | null

details

required

Code-specific details, documented per code in the error catalog.

object

key

additional properties

Example

{
  "error": {
    "type": "INVALID_REQUEST_ERROR",
    "code": "INVALID_JSON",
    "httpStatusCode": 503,
    "integrationCode": "0x80040414",
    "requestId": "req_01j9x4m6v4c8k2t7q0r5s3w1zd",
    "fixes": [
      {
        "actor": "developer"
      }
    ],
    "docsUrl": "https://www.desktopaccountingapi.com/docs/errors/#qbd_modal_dialog_open",
    "outcome": "applied",
    "param": "companyName"
  }
}

Headers

Daapi-Request-Id

string

Unique ID of this API call (req_...). Present on every response.

RateLimit-Limit

integer

Requests allowed per window for the project (all keys together).

RateLimit-Remaining

integer

Requests left in the current window, as counted by the edge location that served this call.

RateLimit-Reset

integer

Seconds until the current window resets.

Daapi-Should-Retry

string

Allowed values: true false

true when repeating the identical request can succeed. SDKs follow it instead of status-code heuristics.

Retry-After

integer

Seconds to wait before retrying, on 429 and on retryable 503 responses when a wait is known.

503

QuickBooks Desktop or the service is not available. Codes: SERVICE_UNAVAILABLE, INTEGRATION_CONNECTION_NOT_ACTIVE, QBD_CONNECTION_ERROR, QBD_CANNOT_START, QBD_STARTING, QBD_MODAL_DIALOG_OPEN, QBD_QUICKBOOKS_NOT_RESPONDING, QBD_WRONG_COMPANY_FILE_OPEN, QBD_COMPANY_FILE_NOT_FOUND, QBD_FILE_MODE_CONFLICT, QBD_ADMIN_REQUIRED, QBD_ACCESS_NOT_GRANTED, QBD_VERSION_UNSUPPORTED.

application/json

object

error

required

object

type

required

Error category. Use it to choose between retrying, fixing the request and asking the end user to act.

string

Allowed values: INVALID_REQUEST_ERROR AUTHENTICATION_ERROR PERMISSION_ERROR BILLING_ERROR RATE_LIMIT_ERROR INTEGRATION_CONNECTION_ERROR INTEGRATION_ERROR OUTCOME_UNKNOWN_ERROR INTERNAL_ERROR

code

required

Stable error code from the error catalog. New codes may be added; a code’s meaning never changes.

string

message

required

Developer-facing explanation. May include IDs and field paths; never includes secrets.

string

userFacingMessage

required

A message that is safe to show to the end user.

string

httpStatusCode

required

HTTP status of the response. null for codes that appear only on a request resource (REQUEST_EXPIRED, REQUEST_CANCELED).

integer | null

integrationCode

required

Native QuickBooks code when one exists: a qbXML statusCode ("3200"), an HRESULT ("0x80040414") or a Web Connector code.

string | null

requestId

required

The Daapi-Request-Id of this response. Include it when contacting support.

string

cause

required

Why this error happens.

string

fixes

required

Ordered actions that resolve the error, each with the responsible actor.

Array<object>

object

actor

required

Who can apply the fix.

string

Allowed values: developer end_user support

action

required

What to do.

string

docsUrl

required

Documentation section for this code.

string format: uri

retryable

required

Repeating the identical request (with the same Idempotency-Key for writes) can succeed without changes. Also sent as the Daapi-Should-Retry header.

boolean

outcome

required

string

Allowed values: applied not_applied pending unknown not_applicable

param

required

Request field, query parameter or header the error refers to, when known.

string | null

details

required

Code-specific details, documented per code in the error catalog.

object

key

additional properties

Example

{
  "error": {
    "type": "INVALID_REQUEST_ERROR",
    "code": "INVALID_JSON",
    "httpStatusCode": 503,
    "integrationCode": "0x80040414",
    "requestId": "req_01j9x4m6v4c8k2t7q0r5s3w1zd",
    "fixes": [
      {
        "actor": "developer"
      }
    ],
    "docsUrl": "https://www.desktopaccountingapi.com/docs/errors/#qbd_modal_dialog_open",
    "outcome": "applied",
    "param": "companyName"
  }
}

Headers

Daapi-Request-Id

string

Unique ID of this API call (req_...). Present on every response.

RateLimit-Limit

integer

Requests allowed per window for the project (all keys together).

RateLimit-Remaining

integer

Requests left in the current window, as counted by the edge location that served this call.

RateLimit-Reset

integer

Seconds until the current window resets.

Daapi-Should-Retry

string

Allowed values: true false

true when repeating the identical request can succeed. SDKs follow it instead of status-code heuristics.

Retry-After

integer

Seconds to wait before retrying, on 429 and on retryable 503 responses when a wait is known.

504

The request timed out. Codes: REQUEST_TIMEOUT_NOT_SENT, QBD_REQUEST_TIMEOUT.

application/json

object

error

required

object

type

required

Error category. Use it to choose between retrying, fixing the request and asking the end user to act.

string

Allowed values: INVALID_REQUEST_ERROR AUTHENTICATION_ERROR PERMISSION_ERROR BILLING_ERROR RATE_LIMIT_ERROR INTEGRATION_CONNECTION_ERROR INTEGRATION_ERROR OUTCOME_UNKNOWN_ERROR INTERNAL_ERROR

code

required

Stable error code from the error catalog. New codes may be added; a code’s meaning never changes.

string

message

required

Developer-facing explanation. May include IDs and field paths; never includes secrets.

string

userFacingMessage

required

A message that is safe to show to the end user.

string

httpStatusCode

required

HTTP status of the response. null for codes that appear only on a request resource (REQUEST_EXPIRED, REQUEST_CANCELED).

integer | null

integrationCode

required

Native QuickBooks code when one exists: a qbXML statusCode ("3200"), an HRESULT ("0x80040414") or a Web Connector code.

string | null

requestId

required

The Daapi-Request-Id of this response. Include it when contacting support.

string

cause

required

Why this error happens.

string

fixes

required

Ordered actions that resolve the error, each with the responsible actor.

Array<object>

object

actor

required

Who can apply the fix.

string

Allowed values: developer end_user support

action

required

What to do.

string

docsUrl

required

Documentation section for this code.

string format: uri

retryable

required

Repeating the identical request (with the same Idempotency-Key for writes) can succeed without changes. Also sent as the Daapi-Should-Retry header.

boolean

outcome

required

string

Allowed values: applied not_applied pending unknown not_applicable

param

required

Request field, query parameter or header the error refers to, when known.

string | null

details

required

Code-specific details, documented per code in the error catalog.

object

key

additional properties

Example

{
  "error": {
    "type": "INVALID_REQUEST_ERROR",
    "code": "INVALID_JSON",
    "httpStatusCode": 503,
    "integrationCode": "0x80040414",
    "requestId": "req_01j9x4m6v4c8k2t7q0r5s3w1zd",
    "fixes": [
      {
        "actor": "developer"
      }
    ],
    "docsUrl": "https://www.desktopaccountingapi.com/docs/errors/#qbd_modal_dialog_open",
    "outcome": "applied",
    "param": "companyName"
  }
}

Headers

Daapi-Request-Id

string

Unique ID of this API call (req_...). Present on every response.

RateLimit-Limit

integer

Requests allowed per window for the project (all keys together).

RateLimit-Remaining

integer

Requests left in the current window, as counted by the edge location that served this call.

RateLimit-Reset

integer

Seconds until the current window resets.

Daapi-Should-Retry

string

Allowed values: true false

true when repeating the identical request can succeed. SDKs follow it instead of status-code heuristics.

Retry-After

integer

Seconds to wait before retrying, on 429 and on retryable 503 responses when a wait is known.

Create a customer

Authorizations

Parameters

Header Parameters

Example

Example

Example

Example

Example

Request Bodyrequired

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Responses

201

Example

Headers

202

Example

Headers

400

Example

Headers

401

Example

Headers

402

Example

Headers

403

Example

Headers

404

Example

Headers

409

Example

Headers

413

Example

Headers

422

Example

Headers

429

Example

Headers

500

Example

Headers

502

Example

Headers

503

Example

Headers

504

Example

Headers

Request Body^required