Update an employee

Authorizations

bearerAuth

Path Parameters

id

required

QuickBooks ID of the employee.

string

>= 1 characters <= 36 characters

Example

80000001-1234567890

QuickBooks ID of the employee.

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 updating an employee.

object

revisionNumber

required

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

string

<= 16 characters

isActive

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

boolean

salutation

Salutation such as Mr. or Dr.

string | null

<= 15 characters

firstName

First name.

string | null

<= 25 characters

middleName

Middle name or initial.

string | null

<= 5 characters

lastName

Last name.

string | null

<= 25 characters

jobTitle

Job title.

string | null

<= 41 characters

supervisorId

ID of the supervisor for this employee.

string

>= 1 characters <= 36 characters

Example

80000001-1234567890

department

Department of this employee.

string | null

<= 31 characters

description

Description of this employee.

string | null

<= 64 characters

targetBonus

Target bonus of this employee. Decimal string with up to 2 decimal places.

string

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

Example

1250.00

address

Address details for this employee.

object

line1

First address line.

string | null

<= 41 characters

line2

Second address line.

string | null

<= 41 characters

city

City or locality.

string | null

<= 31 characters

state

State, province or region.

string | null

<= 21 characters

postalCode

Postal or ZIP code.

string | null

<= 13 characters

printAs

Print as of this employee.

string | null

<= 41 characters

phone

Main phone number.

string | null

<= 21 characters

mobile

Mobile of this employee.

string | null

<= 21 characters

pager

Pager of this employee.

string | null

<= 21 characters

pagerPin

Pager pin of this employee.

string | null

<= 10 characters

alternatePhone

Alternate phone number.

string | null

<= 21 characters

fax

Fax number.

string | null

<= 21 characters

email

Email address.

string | null

<= 1023 characters

customContactFields

Custom contact fields entries for this employee.

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

emergencyContact

Emergency contact details for this employee.

object

primaryContact

Primary contact details for this emergency contacts.

object

name

required

Name of this primary contact, unique within its parent level.

string

<= 40 characters

value

required

Value.

string

<= 255 characters

relation

Relation of this primary contact.

string

Allowed values: spouse partner mother father sister brother son daughter friend other

secondaryContact

Secondary contact details for this emergency contacts.

object

name

required

Name of this secondary contact, unique within its parent level.

string

<= 40 characters

value

required

Value.

string

<= 255 characters

relation

Relation of this secondary contact.

string

Allowed values: spouse partner mother father sister brother son daughter friend other

employeeType

Employee type of this employee.

string

Allowed values: officer owner regular statutory

employmentStatus

Employment status of this employee.

string

Allowed values: part_time full_time

overtimeExemptStatus

Overtime exempt status of this employee.

string

Allowed values: exempt non_exempt

keyEmployeeStatus

Key employee status of this employee.

string

Allowed values: key_employee non_key_employee

hiredDate

Hired date (YYYY-MM-DD).

string format: date

Example

2026-10-05

originalHireDate

Original hire date (YYYY-MM-DD).

string format: date

Example

2026-10-05

adjustedServiceDate

Adjusted service date (YYYY-MM-DD).

string format: date

Example

2026-10-05

terminationDate

Termination date (YYYY-MM-DD).

string format: date

Example

2026-10-05

birthDate

Birth date (YYYY-MM-DD).

string format: date

Example

2026-10-05

usCitizenshipStatus

Us citizenship status of this employee.

string

Allowed values: citizen non_citizen

ethnicity

Ethnicity of this employee.

string

Allowed values: american_indian asian black hawaiian hispanic white two_or_more_races

disabilityStatus

Disability status of this employee.

string

Allowed values: disabled non_disabled

disabilityDescription

Disability description of this employee.

string | null

<= 25 characters

i9OnFileStatus

I9 on file status of this employee.

string

Allowed values: on_file not_on_file

workAuthorizationExpirationDate

Work authorization expiration date (YYYY-MM-DD).

string format: date

Example

2026-10-05

usVeteranStatus

Us veteran status of this employee.

string

Allowed values: veteran non_veteran

militaryStatus

Military status of this employee.

string

Allowed values: active reserve

accountNumber

Account number for this employee.

string | null

<= 99 characters

note

Note for this employee.

string | null

<= 4095 characters

additionalNotes

Additional notes entries for this employee.

Array<object>

Fields for updating an additional notes.

object

id

required

QuickBooks-assigned ID of this additional notes. Use “-1” to add a new line.

integer

note

required

Note for this additional notes.

string

<= 4095 characters

billingRateId

ID of the billing rate for this employee.

string

>= 1 characters <= 36 characters

Example

80000001-1234567890

employeePayroll

Employee payroll details for this employee.

object

payPeriod

Pay period of this employee payroll info.

string

Allowed values: daily weekly biweekly semimonthly monthly quarterly yearly

classId

ID of the class for this employee payroll info.

string

>= 1 characters <= 36 characters

Example

80000001-1234567890

deleteAllEarnings

Delete all earnings of this employee payroll info. Cannot be combined with earnings.

boolean

earnings

Earnings entries for this employee payroll info. Cannot be combined with deleteAllEarnings.

Array<object>

Fields for creating an earnings.

object

payrollWageItemId

required

ID of the payroll wage item for this earnings.

string

>= 1 characters <= 36 characters

Example

80000001-1234567890

rate

Price per unit, as a decimal string. Cannot be combined with ratePercent.

string

/^-?\d{1,10}(\.\d{1,5})?$/

Example

19.99

ratePercent

Price as a percentage, for percentage-based items. Percentage as a decimal string: “7.5” means 7.5 %. Cannot be combined with rate.

string

/^-?\d{1,10}(\.\d{1,5})?$/

Example

7.5

useTimeDataToCreatePaychecks

Use time data to create paychecks of this employee payroll info.

string

Allowed values: not_set uses_time_data does_not_use_time_data

sickHours

Sick hours details for this employee payroll info.

object

hoursAvailable

Hours available of this sick hours.

string

/^[+-]?PT(\d+H)?(\d+M)?(\d+S)?$/

Example

PT1H30M

accrualPeriod

Accrual period of this sick hours.

string

Allowed values: accrues_annually accrues_hourly accrues_per_paycheck

hoursAccruedPerPeriod

Hours accrued per period of this sick hours.

string

/^[+-]?PT(\d+H)?(\d+M)?(\d+S)?$/

Example

PT1H30M

maximumHours

Maximum hours of this sick hours.

string

/^[+-]?PT(\d+H)?(\d+M)?(\d+S)?$/

Example

PT1H30M

resetsHoursEachYear

Whether resets hours each year.

boolean

hoursUsed

Hours used of this sick hours.

string

/^[+-]?PT(\d+H)?(\d+M)?(\d+S)?$/

Example

PT1H30M

accrualStartDate

Accrual start date (YYYY-MM-DD).

string format: date

Example

2026-10-05

vacationHours

Vacation hours details for this employee payroll info.

object

hoursAvailable

Hours available of this vacation hours.

string

/^[+-]?PT(\d+H)?(\d+M)?(\d+S)?$/

Example

PT1H30M

accrualPeriod

Accrual period of this vacation hours.

string

Allowed values: accrues_annually accrues_hourly accrues_per_paycheck

hoursAccruedPerPeriod

Hours accrued per period of this vacation hours.

string

/^[+-]?PT(\d+H)?(\d+M)?(\d+S)?$/

Example

PT1H30M

maximumHours

Maximum hours of this vacation hours.

string

/^[+-]?PT(\d+H)?(\d+M)?(\d+S)?$/

Example

PT1H30M

resetsHoursEachYear

Whether resets hours each year.

boolean

hoursUsed

Hours used of this vacation hours.

string

/^[+-]?PT(\d+H)?(\d+M)?(\d+S)?$/

Example

PT1H30M

accrualStartDate

Accrual start date (YYYY-MM-DD).

string format: date

Example

2026-10-05

200

The updated employee.

application/json

Employee as stored in QuickBooks Desktop.

object

id

required

QuickBooks-assigned ID of this employee.

string

objectType

required

Type of this object.

string

Allowed values: qbd_employee

createdAt

required

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

string format: date-time

updatedAt

required

When this employee 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 employee. Send it unchanged when updating; a stale value is rejected.

string

name

required

Name of this employee, unique within its parent level.

string | null

isActive

required

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

boolean | 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

supervisor

required

Any of:

object
null

Reference to another QuickBooks object.

object

id

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

department

required

Department of this employee.

string | null

description

required

Description of this employee.

string | null

targetBonus

required

Target bonus of this employee. Decimal string with up to 2 decimal places.

string | null

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

address

required

Any of:

object
null

Employee address as stored in QuickBooks Desktop.

object

line1

required

First address line.

string | null

line2

required

Second 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

printAs

required

Print as of this employee.

string | null

phone

required

Main phone number.

string | null

mobile

required

Mobile of this employee.

string | null

pager

required

Pager of this employee.

string | null

pagerPin

required

Pager pin of this employee.

string | null

alternatePhone

required

Alternate phone number.

string | null

fax

required

Fax number.

string | null

ssn

required

Ssn of this employee.

string | null

email

required

Email address.

string | null

customContactFields

required

Custom contact fields entries for this employee.

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

emergencyContact

required

Any of:

object
null

Emergency contacts as stored in QuickBooks Desktop.

object

primaryContact

required

Any of:

object
null

Primary contact as stored in QuickBooks Desktop.

object

name

required

Name of this primary contact, unique within its parent level.

string | null

value

required

Value.

string | null

relation

required

Relation of this primary contact.

string | null

Allowed values: spouse partner mother father sister brother son daughter friend other

secondaryContact

required

Any of:

object
null

Secondary contact as stored in QuickBooks Desktop.

object

name

required

Name of this secondary contact, unique within its parent level.

string | null

value

required

Value.

string | null

relation

required

Relation of this secondary contact.

string | null

Allowed values: spouse partner mother father sister brother son daughter friend other

employeeType

required

Employee type of this employee.

string | null

Allowed values: officer owner regular statutory

employmentStatus

required

Employment status of this employee.

string | null

Allowed values: part_time full_time

overtimeExemptStatus

required

Overtime exempt status of this employee.

string | null

Allowed values: exempt non_exempt

keyEmployeeStatus

required

Key employee status of this employee.

string | null

Allowed values: key_employee non_key_employee

gender

required

Gender of this employee.

string | null

Allowed values: male female

hiredDate

required

Hired date (YYYY-MM-DD).

string | null format: date

originalHireDate

required

Original hire date (YYYY-MM-DD).

string | null format: date

adjustedServiceDate

required

Adjusted service date (YYYY-MM-DD).

string | null format: date

terminationDate

required

Termination date (YYYY-MM-DD).

string | null format: date

birthDate

required

Birth date (YYYY-MM-DD).

string | null format: date

usCitizenshipStatus

required

Us citizenship status of this employee.

string | null

Allowed values: citizen non_citizen

ethnicity

required

Ethnicity of this employee.

string | null

Allowed values: american_indian asian black hawaiian hispanic white two_or_more_races

disabilityStatus

required

Disability status of this employee.

string | null

Allowed values: disabled non_disabled

disabilityDescription

required

Disability description of this employee.

string | null

i9OnFileStatus

required

I9 on file status of this employee.

string | null

Allowed values: on_file not_on_file

workAuthorizationExpirationDate

required

Work authorization expiration date (YYYY-MM-DD).

string | null format: date

usVeteranStatus

required

Us veteran status of this employee.

string | null

Allowed values: veteran non_veteran

militaryStatus

required

Military status of this employee.

string | null

Allowed values: active reserve

accountNumber

required

Account number for this employee.

string | null

note

required

Note for this employee.

string | null

additionalNotes

required

Additional notes entries for this employee.

Array<object>

Additional notes as stored in QuickBooks Desktop.

object

id

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

billingRate

required

Any of:

object
null

Reference to another QuickBooks object.

object

id

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

employeePayroll

required

Any of:

object
null

Employee payroll info as stored in QuickBooks Desktop.

object

payPeriod

required

Pay period of this employee payroll info.

string | null

Allowed values: daily weekly biweekly semimonthly monthly quarterly yearly

class

required

Any of:

object
null

Reference to another QuickBooks object.

object

id

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

deleteAllEarnings

required

Delete all earnings of this employee payroll info.

boolean | null

earnings

required

Earnings entries for this employee payroll info.

Array<object>

Earnings as stored in QuickBooks Desktop.

object

payrollWageItem

required

Any of:

object
null

Reference to another QuickBooks object.

object

id

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

rate

required

Price per unit, as a decimal string.

string | null

ratePercent

required

Price as a percentage, for percentage-based items. Percentage as a decimal string: “7.5” means 7.5 %.

string | null

useTimeDataToCreatePaychecks

required

Use time data to create paychecks of this employee payroll info.

string | null

Allowed values: not_set uses_time_data does_not_use_time_data

sickHours

required

Any of:

object
null

Sick hours as stored in QuickBooks Desktop.

object

hoursAvailable

required

Hours available of this sick hours.

string | null

accrualPeriod

required

Accrual period of this sick hours.

string | null

Allowed values: accrues_annually accrues_hourly accrues_per_paycheck

hoursAccruedPerPeriod

required

Hours accrued per period of this sick hours.

string | null

maximumHours

required

Maximum hours of this sick hours.

string | null

resetsHoursEachYear

required

Whether resets hours each year.

boolean | null

hoursUsed

required

Hours used of this sick hours.

string | null

accrualStartDate

required

Accrual start date (YYYY-MM-DD).

string | null format: date

vacationHours

required

Any of:

object
null

Vacation hours as stored in QuickBooks Desktop.

object

hoursAvailable

required

Hours available of this vacation hours.

string | null

accrualPeriod

required

Accrual period of this vacation hours.

string | null

Allowed values: accrues_annually accrues_hourly accrues_per_paycheck

hoursAccruedPerPeriod

required

Hours accrued per period of this vacation hours.

string | null

maximumHours

required

Maximum hours of this vacation hours.

string | null

resetsHoursEachYear

required

Whether resets hours each year.

boolean | null

hoursUsed

required

Hours used of this vacation hours.

string | null

accrualStartDate

required

Accrual start date (YYYY-MM-DD).

string | null format: date

externalId

required

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

string | null format: uuid

customFields

required

Custom field values QuickBooks stores on this employee.

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_employee",
  "createdAt": "2026-10-05T09:14:03-07:00",
  "updatedAt": "2026-10-05T09:14:03-07:00",
  "targetBonus": "1250.00",
  "emergencyContact": {
    "primaryContact": {
      "relation": "spouse"
    },
    "secondaryContact": {
      "relation": "spouse"
    }
  },
  "employeeType": "officer",
  "employmentStatus": "part_time",
  "overtimeExemptStatus": "exempt",
  "keyEmployeeStatus": "key_employee",
  "gender": "male",
  "hiredDate": "2026-10-05",
  "originalHireDate": "2026-10-05",
  "adjustedServiceDate": "2026-10-05",
  "terminationDate": "2026-10-05",
  "birthDate": "2026-10-05",
  "usCitizenshipStatus": "citizen",
  "ethnicity": "american_indian",
  "disabilityStatus": "disabled",
  "i9OnFileStatus": "on_file",
  "workAuthorizationExpirationDate": "2026-10-05",
  "usVeteranStatus": "veteran",
  "militaryStatus": "active",
  "additionalNotes": [
    {
      "date": "2026-10-05"
    }
  ],
  "employeePayroll": {
    "payPeriod": "daily",
    "earnings": [
      {
        "rate": "19.99",
        "ratePercent": "7.5"
      }
    ],
    "useTimeDataToCreatePaychecks": "not_set",
    "sickHours": {
      "accrualPeriod": "accrues_annually",
      "accrualStartDate": "2026-10-05"
    },
    "vacationHours": {
      "accrualPeriod": "accrues_annually",
      "accrualStartDate": "2026-10-05"
    }
  },
  "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

id

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

at

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

at

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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, QBD_OBJECT_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

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

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

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, QBD_REVISION_NUMBER_STALE.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

Update an employee

Authorizations

Parameters

Path Parameters

Example

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

Example

Example

Example

Example

Example

Example

Responses

200

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

Request Body^required