# List sales orders
Source: https://www.desktopaccountingapi.com/docs/api/reference/operations/qbdsalesorderslist/

`GET https://api.desktopaccountingapi.com/v1/quickbooks-desktop/sales-orders`

Operation ID: `qbd.salesOrders.list`. Tag: Sales orders.

Returns the sales orders that match your filters. Results are paged: pass `nextCursor` as `cursor` until `hasMore` is false. A cursor lives only inside the current QuickBooks session, so request the next page promptly; an expired cursor returns `410 CURSOR_EXPIRED`. See [Pagination](https://www.desktopaccountingapi.com/docs/guides/pagination/).

Authentication: `Authorization: Bearer <secret key>`.

## Query parameters

- `ids` (array of string): Return only the sales orders with these QuickBooks IDs. Cannot be combined with refNumbers, updatedAfter, updatedBefore, transactionDateFrom, transactionDateTo, transactionDateMacro, customerIds, refNumberStartsWith, refNumberContains, refNumberEndsWith, refNumberFrom, refNumberTo, currencyIds. Returns every match in one page (`nextCursor` is null); limit is ignored. 1–100 items.
- `refNumbers` (array of string): Return only sales orders with these reference numbers (case-insensitive). Cannot be combined with ids, updatedAfter, updatedBefore, transactionDateFrom, transactionDateTo, transactionDateMacro, customerIds, refNumberStartsWith, refNumberContains, refNumberEndsWith, refNumberFrom, refNumberTo, currencyIds. Returns every match in one page (`nextCursor` is null); limit is ignored. 1–100 items.
- `limit` (integer): Maximum number of sales orders per page, 1 to 150. Ignored with ids, refNumbers, which return every match in one page. 1 to 150; default `150`.
- `updatedAfter` (string): Return sales orders changed on or after this date or date-time (QuickBooks local time unless an offset is given). Cannot be combined with ids, refNumbers, transactionDateFrom, transactionDateTo, transactionDateMacro. example `2026-10-05T09:14:03-07:00`.
- `updatedBefore` (string): Return sales orders changed on or before this date or date-time (QuickBooks local time unless an offset is given). Cannot be combined with ids, refNumbers, transactionDateFrom, transactionDateTo, transactionDateMacro. example `2026-10-05T09:14:03-07:00`.
- `transactionDateFrom` (string (date)): Return sales orders dated on or after this date (YYYY-MM-DD). Cannot be combined with ids, refNumbers, updatedAfter, updatedBefore, transactionDateMacro.
- `transactionDateTo` (string (date)): Return sales orders dated on or before this date (YYYY-MM-DD). Cannot be combined with ids, refNumbers, updatedAfter, updatedBefore, transactionDateMacro.
- `transactionDateMacro` (string): Relative date range such as this_month, used instead of explicit dates. Cannot be combined with ids, refNumbers, updatedAfter, updatedBefore, transactionDateFrom, transactionDateTo. one of `all`, `today`, `this_week`, `this_week_to_date`, `this_month`, `this_month_to_date`, `this_calendar_quarter`, `this_calendar_quarter_to_date`, `this_fiscal_quarter`, `this_fiscal_quarter_to_date`, `this_calendar_year`, `this_calendar_year_to_date`, `this_fiscal_year`, `this_fiscal_year_to_date`, `yesterday`, `last_week`, `last_week_to_date`, `last_month`, `last_month_to_date`, `last_calendar_quarter`, `last_calendar_quarter_to_date`, `last_fiscal_quarter`, `last_fiscal_quarter_to_date`, `last_calendar_year`, `last_calendar_year_to_date`, `last_fiscal_year`, `last_fiscal_year_to_date`, `next_week`, `next_four_weeks`, `next_month`, `next_calendar_quarter`, `next_calendar_year`, `next_fiscal_quarter`, `next_fiscal_year`.
- `customerIds` (array of string): Return only sales orders linked to these customer IDs. Cannot be combined with ids, refNumbers. 1–100 items.
- `refNumberStartsWith` (string): Return sales orders whose reference number starts with this text (case-insensitive). Cannot be combined with ids, refNumbers, refNumberFrom, refNumberTo.
- `refNumberContains` (string): Return sales orders whose reference number contains this text (case-insensitive). Cannot be combined with ids, refNumbers, refNumberFrom, refNumberTo.
- `refNumberEndsWith` (string): Return sales orders whose reference number ends with this text (case-insensitive). Cannot be combined with ids, refNumbers, refNumberFrom, refNumberTo.
- `refNumberFrom` (string): Return sales orders whose reference number sorts at or after this value. Cannot be combined with ids, refNumbers, refNumberStartsWith, refNumberContains, refNumberEndsWith.
- `refNumberTo` (string): Return sales orders whose reference number sorts at or before this value. Cannot be combined with ids, refNumbers, refNumberStartsWith, refNumberContains, refNumberEndsWith.
- `currencyIds` (array of string): Return only sales orders in these currency IDs. Cannot be combined with ids, refNumbers. 1–100 items.
- `includeLineItems` (boolean): Whether to include line items on each sales order. Defaults to true. default `true`.
- `includeLinkedTransactions` (boolean): Whether to include transactions linked to each sales order, such as payments. default `false`.
- `cursor` (string): Cursor from the previous page's nextCursor. Send it with no other filters to fetch the next page.

## Headers

- `Daapi-End-User-Id` (string, required): 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): 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`). 1 to 300; example `90`.
- `Prefer` (string): Send `respond-async` to get `202 Accepted` with a request resource immediately instead of waiting for QuickBooks. always `"respond-async"`; example `respond-async`.
- `Daapi-Queue-Ttl-Seconds` (integer): Async only: the latest time, in seconds from now (10 to 86400), the request may still be sent to QuickBooks. Default 3600. 10 to 86400; example `3600`.

## Responses

### 200

A list of sales orders.

Body (application/json): object (QbdSalesOrderList).

- `objectType` (string, required): Always `list`. one of `list`.
- `url` (string, required): The endpoint that produced this list. one of `/v1/quickbooks-desktop/sales-orders`.
- `data` (array of object (QbdSalesOrder), required): Objects on this page.
  - `id` (string, required): QuickBooks-assigned ID of this sales order.
  - `objectType` (string, required): Type of this object. one of `qbd_sales_order`.
  - `createdAt` (string (date-time), required): When this sales order was created, as an ISO 8601 date-time with the QuickBooks computer's UTC offset. example `2026-10-05T09:14:03-07:00`.
  - `updatedAt` (string (date-time), required): When this sales order was last changed, as an ISO 8601 date-time with the QuickBooks computer's UTC offset. example `2026-10-05T09:14:03-07:00`.
  - `revisionNumber` (string, required): Current revision of this sales order. Send it unchanged when updating; a stale value is rejected.
  - `transactionNumber` (integer, nullable, required): Sequential transaction number QuickBooks assigns internally.
  - `customer` (object (QbdReference), nullable, required): The customer for this sales order.
    - `id` (string, nullable, required): QuickBooks ID of the referenced object.
    - `fullName` (string, nullable, required): Full name of the referenced object at the time of the response.
  - `class` (object (QbdReference), nullable, required): The class for this sales order.
    - `id` (string, nullable, required): QuickBooks ID of the referenced object.
    - `fullName` (string, nullable, required): Full name of the referenced object at the time of the response.
  - `documentTemplate` (object (QbdReference), nullable, required): The document template for this sales order.
    - `id` (string, nullable, required): QuickBooks ID of the referenced object.
    - `fullName` (string, nullable, required): Full name of the referenced object at the time of the response.
  - `transactionDate` (string (date), nullable, required): Date of this sales order (YYYY-MM-DD). example `2026-10-05`.
  - `refNumber` (string, nullable, required): Reference number of this sales order, such as an invoice or check number. Case-sensitive.
  - `billingAddress` (object (QbdAddress), nullable, required): Billing address for this sales order.
    - `line1` (string, nullable, required): First address line.
    - `line2` (string, nullable, required): Second address line.
    - `line3` (string, nullable, required): Third address line.
    - `line4` (string, nullable, required): Fourth address line.
    - `line5` (string, nullable, required): Fifth address line.
    - `city` (string, nullable, required): City or locality.
    - `state` (string, nullable, required): State, province or region.
    - `postalCode` (string, nullable, required): Postal or ZIP code.
    - `country` (string, nullable, required): Country.
    - `note` (string, nullable, required): Note for this address.
  - `shippingAddress` (object (QbdAddress), nullable, required): Shipping address for this sales order.
    - `line1` (string, nullable, required): First address line.
    - `line2` (string, nullable, required): Second address line.
    - `line3` (string, nullable, required): Third address line.
    - `line4` (string, nullable, required): Fourth address line.
    - `line5` (string, nullable, required): Fifth address line.
    - `city` (string, nullable, required): City or locality.
    - `state` (string, nullable, required): State, province or region.
    - `postalCode` (string, nullable, required): Postal or ZIP code.
    - `country` (string, nullable, required): Country.
    - `note` (string, nullable, required): Note for this address.
  - `purchaseOrderNumber` (string, nullable, required): Purchase order number of this sales order.
  - `terms` (object (QbdReference), nullable, required): The terms for this sales order.
    - `id` (string, nullable, required): QuickBooks ID of the referenced object.
    - `fullName` (string, nullable, required): Full name of the referenced object at the time of the response.
  - `dueDate` (string (date), nullable, required): Date payment of this sales order is due (YYYY-MM-DD). example `2026-10-05`.
  - `salesRepresentative` (object (QbdReference), nullable, required): The sales representative for this sales order.
    - `id` (string, nullable, required): QuickBooks ID of the referenced object.
    - `fullName` (string, nullable, required): Full name of the referenced object at the time of the response.
  - `shipmentOrigin` (string, nullable, required): Shipment origin of this sales order.
  - `shippingDate` (string (date), nullable, required): Date the goods on this sales order were or will be shipped (YYYY-MM-DD). example `2026-10-05`.
  - `shippingMethod` (object (QbdReference), nullable, required): The shipping method for this sales order.
    - `id` (string, nullable, required): QuickBooks ID of the referenced object.
    - `fullName` (string, nullable, required): Full name of the referenced object at the time of the response.
  - `subtotal` (string, nullable, required): Total of all lines before sales tax, as a decimal string. example `1250.00`.
  - `salesTaxItem` (object (QbdReference), nullable, required): The sales tax item for this sales order.
    - `id` (string, nullable, required): QuickBooks ID of the referenced object.
    - `fullName` (string, nullable, required): Full name of the referenced object at the time of the response.
  - `salesTaxPercentage` (string, nullable, required): Sales tax rate applied, as a percentage. Percentage as a decimal string: "7.5" means 7.5 %. example `7.5`.
  - `salesTaxTotal` (string, nullable, required): Total sales tax, as a decimal string. example `1250.00`.
  - `totalAmount` (string, nullable, required): Total amount of this sales order as a decimal string. example `1250.00`.
  - `currency` (object (QbdReference), nullable, required): Currency of this sales order.
    - `id` (string, nullable, required): QuickBooks ID of the referenced object.
    - `fullName` (string, nullable, required): Full name of the referenced object at the time of the response.
  - `exchangeRate` (number, nullable, required): Exchange rate from this sales order's currency to the home currency.
  - `totalAmountInHomeCurrency` (string, nullable, required): Total amount in home currency of this sales order. Decimal string with up to 2 decimal places. example `1250.00`.
  - `isManuallyClosed` (boolean, nullable, required): Whether this sales order is manually closed.
  - `isFullyInvoiced` (boolean, nullable, required): Whether this sales order is fully invoiced.
  - `memo` (string, nullable, required): Internal memo for this sales order; shown in reports, not on printed forms.
  - `customerMessage` (object (QbdReference), nullable, required): The customer message for this sales order.
    - `id` (string, nullable, required): QuickBooks ID of the referenced object.
    - `fullName` (string, nullable, required): Full name of the referenced object at the time of the response.
  - `isQueuedForPrint` (boolean, nullable, required): Whether this sales order is in the queue of forms to print.
  - `isQueuedForEmail` (boolean, nullable, required): Whether this sales order is in the queue of forms to email.
  - `salesTaxCode` (object (QbdReference), nullable, required): The sales tax code for this sales order.
    - `id` (string, nullable, required): QuickBooks ID of the referenced object.
    - `fullName` (string, nullable, required): Full name of the referenced object at the time of the response.
  - `otherCustomField` (string, nullable, required): Built-in "Other" text field on this sales order.
  - `externalId` (string (uuid), nullable, required): Your own UUID for this sales order, stored by QuickBooks so you can match records with your system.
  - `linkedTransactions` (array of object (QbdLinkedTransaction), required): Transactions linked to this sales order, such as payments applied to it.
    - `id` (string, nullable, required): QuickBooks-assigned ID of this linked transaction.
    - `objectType` (string, required): Type of this object. one of `qbd_linked_transaction`.
    - `transactionType` (string, nullable, required): Transaction type of this linked transaction. one of `ar_refund_credit_card`, `bill`, `bill_payment_check`, `bill_payment_credit_card`, `build_assembly`, `charge`, `check`, `credit_card_charge`, `credit_card_credit`, `credit_memo`, `deposit`, `estimate`, `inventory_adjustment`, `invoice`, `item_receipt`, `journal_entry`, `liability_adjustment`, `paycheck`, `payroll_liability_check`, `purchase_order`, `receive_payment`, `sales_order`, `sales_receipt`, `sales_tax_payment_check`, `transfer`, `vendor_credit`, `ytd_adjustment` (open: accept unknown values).
    - `transactionDate` (string (date), nullable, required): Date of this linked transaction (YYYY-MM-DD). example `2026-10-05`.
    - `refNumber` (string, nullable, required): Reference number of this linked transaction, such as an invoice or check number. Case-sensitive.
    - `linkType` (string, nullable, required): Link type of this linked transaction. one of `amount`, `quantity` (open: accept unknown values).
    - `amount` (string, nullable, required): Amount as a decimal string. example `1250.00`.
  - `lines` (array of object (QbdSalesOrderLine), required): Line items of this sales order.
    - `id` (string, nullable, required): QuickBooks-assigned ID of this sales order line.
    - `objectType` (string, required): Type of this object. one of `qbd_sales_order_line`.
    - `item` (object (QbdReference), nullable, required): The item for this sales order line.
    - `description` (string, nullable, required): Description of this sales order line.
    - `quantity` (number, nullable, required): Quantity of the item.
    - `unitOfMeasure` (string, nullable, required): Unit of measure for the quantity.
    - `overrideUnitOfMeasureSet` (object (QbdReference), nullable, required): Unit of measure set that overrides the item default on this line.
    - `rate` (string, nullable, required): Price per unit, as a decimal string. example `19.99`.
    - `ratePercent` (string, nullable, required): Price as a percentage, for percentage-based items. Percentage as a decimal string: "7.5" means 7.5 %. example `7.5`.
    - `class` (object (QbdReference), nullable, required): The class for this sales order line.
    - `amount` (string, nullable, required): Amount as a decimal string. example `1250.00`.
    - `inventorySite` (object (QbdReference), nullable, required): The inventory site for this sales order line.
    - `inventorySiteLocation` (object (QbdReference), nullable, required): The inventory site location for this sales order line.
    - `serialNumber` (string, nullable, required): Serial number of this sales order line.
    - `lotNumber` (string, nullable, required): Lot number of this sales order line.
    - `expirationDate` (string, nullable, required): Expiration date of this sales order line.
    - `salesTaxCode` (object (QbdReference), nullable, required): The sales tax code for this sales order line.
    - `quantityInvoiced` (number, nullable, required): Quantity invoiced of this sales order line.
    - `isManuallyClosed` (boolean, nullable, required): Whether this sales order line is manually closed.
    - `otherCustomField1` (string, nullable, required): Built-in "Other 1" text field on this sales order line.
    - `otherCustomField2` (string, nullable, required): Built-in "Other 2" text field on this sales order line.
    - `customFields` (array of object (QbdCustomField), required): Custom field values QuickBooks stores on this sales order line.
  - `lineGroups` (array of object (QbdSalesOrderLineGroup), required): Group lines of this sales order: each expands an item group into its component lines.
    - `id` (string, nullable, required): QuickBooks-assigned ID of this sales order line group.
    - `objectType` (string, required): Type of this object. one of `qbd_sales_order_line_group`.
    - `itemGroup` (object (QbdReference), nullable, required): The item group for this sales order line group.
    - `description` (string, nullable, required): Description of this sales order line group.
    - `quantity` (number, nullable, required): Quantity of the item.
    - `unitOfMeasure` (string, nullable, required): Unit of measure for the quantity.
    - `overrideUnitOfMeasureSet` (object (QbdReference), nullable, required): Unit of measure set that overrides the item default on this line.
    - `shouldPrintItemsInGroup` (boolean, nullable, required): Whether to print items in group.
    - `totalAmount` (string, nullable, required): Total amount of this sales order line group as a decimal string. example `1250.00`.
    - `lines` (array of object (QbdSalesOrderLine), required): Line items of this sales order line group.
    - `customFields` (array of object (QbdCustomField), required): Custom field values QuickBooks stores on this sales order line group.
  - `customFields` (array of object (QbdCustomField), required): Custom field values QuickBooks stores on this sales order.
    - `ownerId` (string, nullable, required): Owner of the custom field: "0" for public fields shown in the QuickBooks UI.
    - `name` (string, nullable, required): Name of this custom field, unique within its parent level.
    - `type` (string, nullable, required): Type. one of `amount_type`, `date_time_type`, `integer_type`, `percent_type`, `price_type`, `quantity_type`, `string_1024_type`, `string_255_type` (open: accept unknown values).
    - `value` (string, nullable, required): Value.
  - `fulfillmentStatus` (string, nullable, required): Fulfillment status of this sales order. one of `status_blank=-1`, `status_open=0`, `status_sent_for_pick`, `status_partially_sent_for_pick`, `status_pick_in_progress`, `status_partial_pick_in_progress`, `status_partially_picked`, `status_picked`, `status_partially_invoiced`, `status_invoiced`, `status_not_picked`, `status_sent_for_receive=20`, `status_partially_sent_for_receive`, `status_receive_in_progress`, `status_partial_receive_in_progress`, `status_partially_received`, `status_received`, `status_receipt_created`, `status_partial_receipt_created`, `status_not_received`, `status_sent_for_pack=40`, `status_partially_sent_for_pack`, `status_pack_in_progress`, `status_partial_packin_progress`, `status_partially_packed`, `status_packed`, `status_notpacked`, `status_sent_for_xpack=50`, `status_sent_for_ship=60`, `status_partially_sent_for_ship`, `status_ship_in_progress`, `status_partial_ship_in_progress`, `status_partially_shipped`, `status_status_shipped`, `status_not_shipped`, `status_complete=100` (open: accept unknown values).
  - `shippingDetails` (object (QbdShippingDetail), nullable, required): Shipping details details for this sales order.
    - `shippingDetailsLine` (array of object (QbdShippingDetailsLine), required): Shipping details line entries for this shipping details.
  - `salesChannelName` (string, nullable, required): Sales channel name of this sales order. one of `blank`, `ecommerce` (open: accept unknown values).
  - `salesStoreName` (string, nullable, required): Sales store name of this sales order.
  - `salesStoreType` (string, nullable, required): Sales store type of this sales order.
- `nextCursor` (string, nullable, required): Cursor for the next page, or null on the last page.
- `hasMore` (boolean, required): Whether more pages remain.
- `remainingCount` (integer, nullable, required): Records left after this page, as reported by QuickBooks.
- `cursorExpiresAt` (string (date-time), nullable, required): Estimated deadline for requesting the next page (UTC).

### 202

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

Body (application/json): object (Request).

- `id` (string, required): Unique identifier for the request. example `req_01j9x4m6v4c8k2t7q0r5s3w1zd`.
- `objectType` (string, required): Always `request`. one of `request`.
- `createdAt` (string (date-time), required): When the request was received. UTC, ISO 8601 with milliseconds. example `2026-10-05T16:03:59.002Z`.
- `projectId` (string, required): Unique identifier for the project. example `proj_01j9x4m6v4c8k2t7q0r5s3w1zf`.
- `endUserId` (string, required): Unique identifier for the end user. example `eu_01j9x4m6v4c8k2t7q0r5s3w1zb`.
- `connectionId` (string, nullable, 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). example `conn_01j9x4m6v4c8k2t7q0r5s3w1zc`.
- `operationId` (string, required): The API operation, for example `endUsers.passthrough` or `qbd.healthCheck`. example `qbd.healthCheck`.
- `method` (string, required): HTTP method of the original call. example `GET`.
- `path` (string, required): Path of the original call. example `/v1/quickbooks-desktop/health-check`.
- `mode` (string, required): `sync` when the caller waited for the result. one of `sync`, `async` (open: accept unknown values).
- `status` (string, 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. one of `queued`, `waiting_for_connection`, `sent`, `succeeded`, `failed`, `canceled`, `outcome_unknown` (open: accept unknown values).
- `outcome` (string, 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). one of `applied`, `not_applied`, `pending`, `unknown`, `not_applicable` (open: accept unknown values).
- `sentAt` (string, nullable, required): When the request was handed to the Web Connector. UTC, ISO 8601.
- `completedAt` (string, nullable, required): When the request reached a final status. UTC, ISO 8601.
- `durationMs` (integer, nullable, required): Milliseconds from creation to completion.
- `idempotencyKeyPresent` (boolean, required): Whether the call sent an Idempotency-Key.
- `previousRequestId` (string, nullable, required): An earlier request with the same Idempotency-Key that ended before reaching QuickBooks.
- `waitingReason` (string, nullable, 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. one of `awaiting_check_in`, `behind_other_requests`, `opening_company_file`, `quickbooks_starting`, `connector_offline`, `quickbooks_unavailable`, `quickbooks_not_responding`, `write_recovery_pending`, `null` (open: accept unknown values).
- `queuePosition` (integer, nullable, required): Position in this connection's queue (1 = next), while queued.
- `queueTtlExpiresAt` (string, nullable, required): Async requests only: the latest time the request may still be sent. UTC, ISO 8601.
- `timings` (object, required): Where the time went.
  - `queuedMs` (integer, nullable, required): Milliseconds from creation until the request was sent to QuickBooks.
  - `quickbooksMs` (integer, nullable, required): Milliseconds from sending until QuickBooks answered.
  - `totalMs` (integer, nullable, required): Milliseconds from creation to completion.
- `quickbooks` (object, required): Native QuickBooks details.
  - `qbxmlVersion` (string, nullable, required): qbXML version used.
  - `messageSetId` (string, nullable, required): qbXML `newMessageSetID` sent with a write.
  - `statusCode` (integer, nullable, required): qbXML statusCode of the first response element.
  - `statusSeverity` (string, nullable, required): qbXML statusSeverity (`Info`, `Warn` or `Error`).
- `warnings` (array of object (RequestWarning), 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.
  - `code` (string, 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. one of `QBD_WARNING`, `QBD_VALUE_UNREADABLE`, `QBD_MARKUP_REPAIRED` (open: accept unknown values).
  - `statusCode` (integer, nullable, required): qbXML statusCode of a QuickBooks warning; null for warnings about the response data.
  - `message` (string, required): What happened, including the text QuickBooks sent for unreadable values.
  - `path` (string, nullable, required): Where in `result` the affected value is, such as `data[2].lines[0].amount`; null for QuickBooks warning statuses.
- `recovered` (boolean, required): `true` when an `outcome_unknown` write was resolved by asking QuickBooks for its stored result.
- `timeline` (array of object (RequestTimelineEntry), required): Lifecycle steps in order.
  - `at` (string (date-time), required): When the step happened. UTC, ISO 8601 with milliseconds. example `2026-10-05T16:03:59.002Z`.
  - `status` (string, required): Step, usually a status (`queued`, `waiting`, `sent`, `succeeded`, `diagnosed`, ...).
  - `detail` (string, nullable, required): Extra detail, for example the waiting reason or diagnosis cause.
  - `elapsedMs` (integer, required): Milliseconds since the request was created.
- `diagnosis` (object (RequestDiagnosis), nullable, required): Probable causes while the request waits or runs long, and for requests that timed out or expired before they were sent; `null` otherwise.
  - `at` (string (date-time), required): When the diagnosis was made. UTC, ISO 8601 with milliseconds. example `2026-10-05T16:03:59.002Z`.
  - `summary` (string, required): The most likely cause in one line. example `QuickBooks Desktop probably has a dialog window open.`.
  - `connector` (object, required): What the server observed about the end user's Web Connector.
    - `lastSeenAt` (string, nullable, required): Last sign of the Web Connector (a check-in or a call inside a session). UTC, ISO 8601.
    - `lastCheckInAt` (string, nullable, required): Last Web Connector check-in. UTC, ISO 8601.
    - `checkInIntervalSeconds` (integer, nullable, required): Typical interval between recent check-ins, in seconds.
    - `silentForSeconds` (integer, nullable, required): Seconds since `lastSeenAt`.
    - `sessionOpen` (boolean, required): Whether a Web Connector session is open now.
    - `sessionOpenedAt` (string, nullable, required): When the open session started. UTC, ISO 8601.
    - `quickbooksAnswered` (boolean, nullable, required): Whether QuickBooks answered the open session; `null` without a session.
    - `silentSessions` (integer, required): Recent consecutive sessions in which QuickBooks never answered.
    - `lastConnectionErrorCode` (string, nullable, required): Error code of the latest QuickBooks connection error, while it persists.
  - `probableCauses` (array of object (DiagnosisCause), required): Probable causes, most likely first.
    - `code` (string, required): Stable cause code. New codes may be added. one of `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` (open: accept unknown values); example `quickbooks_modal_dialog`.
    - `likelihood` (string, required): How strongly the observations point at this cause. one of `high`, `medium`, `low` (open: accept unknown values).
    - `summary` (string, required): One-line description of the cause.
    - `explanation` (string, required): What the server observed and why it points at this cause.
    - `fixes` (array of object (ErrorFix), required): Actions that resolve the cause, each with the responsible actor.
    - `details` (object, required): Cause-specific observations, for example `connectionErrorCode` or `silentForMs`.
    - `docsUrl` (string (uri), required): Troubleshooting section for this cause.
- `error` (object (Error), nullable, required): The error, when the request failed, was canceled, timed out or has an unknown outcome.
  - `type` (string, required): Error category. Use it to choose between retrying, fixing the request and asking the end user to act. one of `INVALID_REQUEST_ERROR`, `AUTHENTICATION_ERROR`, `PERMISSION_ERROR`, `BILLING_ERROR`, `RATE_LIMIT_ERROR`, `INTEGRATION_CONNECTION_ERROR`, `INTEGRATION_ERROR`, `OUTCOME_UNKNOWN_ERROR`, `INTERNAL_ERROR` (open: accept unknown values).
  - `code` (string, required): Stable error code from the error catalog. New codes may be added; a code's meaning never changes. one of `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` (open: accept unknown values); example `QBD_MODAL_DIALOG_OPEN`.
  - `message` (string, required): Developer-facing explanation. May include IDs and field paths; never includes secrets.
  - `userFacingMessage` (string, required): A message that is safe to show to the end user.
  - `httpStatusCode` (integer, nullable, required): HTTP status of the response. `null` for codes that appear only on a request resource (`REQUEST_EXPIRED`, `REQUEST_CANCELED`). example `503`.
  - `integrationCode` (string, nullable, required): Native QuickBooks code when one exists: a qbXML statusCode (`"3200"`), an HRESULT (`"0x80040414"`) or a Web Connector code. example `0x80040414`.
  - `requestId` (string, required): The `Daapi-Request-Id` of this response. Include it when contacting support. example `req_01j9x4m6v4c8k2t7q0r5s3w1zd`.
  - `cause` (string, required): Why this error happens.
  - `fixes` (array of object (ErrorFix), required): Ordered actions that resolve the error, each with the responsible actor.
    - `actor` (string, required): Who can apply the fix. one of `developer`, `end_user`, `support` (open: accept unknown values).
    - `action` (string, required): What to do.
  - `docsUrl` (string (uri), required): Documentation section for this code. example `https://www.desktopaccountingapi.com/docs/errors/#qbd_modal_dialog_open`.
  - `retryable` (boolean, required): Repeating the identical request (with the same Idempotency-Key for writes) can succeed without changes. Also sent as the `Daapi-Should-Retry` header.
  - `outcome` (string, 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). one of `applied`, `not_applied`, `pending`, `unknown`, `not_applicable` (open: accept unknown values).
  - `param` (string, nullable, required): Request field, query parameter or header the error refers to, when known. example `companyName`.
  - `details` (object, required): Code-specific details, documented per code in the error catalog.
- `result` (any): The response body the original call returned (or would have returned) on success; `null` otherwise.
- `resultExpired` (boolean, required): `true` when the result existed but is past the payload retention period (15 days, or 24 hours with payload capture off).

### Errors

Every error body is the error object described at https://www.desktopaccountingapi.com/docs/errors/.

- `400`: The request is invalid. Codes: `UNKNOWN_HEADER`, `END_USER_ID_MISSING`, `INVALID_PARAMETER`, `UNKNOWN_PARAMETER`, `CURSOR_INVALID`, `CURSOR_PARAMS_MISMATCH`.
- `401`: The API key is missing or invalid. Codes: `API_KEY_MISSING`, `API_KEY_INVALID`.
- `402`: Billing blocks production data requests. Codes: `BILLING_REQUIRED`, `PAYMENT_FAILED`.
- `403`: The operation is not permitted. Codes: `INTEGRATION_CONNECTION_DISABLED`, `PERMISSION_DENIED`, `QBD_INSUFFICIENT_PERMISSION`.
- `404`: The object does not exist in this project. Codes: `RESOURCE_MISSING`.
- `409`: The request conflicts with the current state. Codes: `INTEGRATION_CONNECTION_NOT_SET_UP`, `QBD_COMPANY_FILE_MISMATCH`.
- `410`: The cursor expired. Codes: `CURSOR_EXPIRED`.
- `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`, `QBD_RESPONSE_TOO_LARGE`.
- `429`: Too many requests. Codes: `RATE_LIMITED`, `CONNECTION_QUEUE_FULL`.
- `500`: Unexpected server error. Codes: `INTERNAL_ERROR`.
- `502`: The result could not be confirmed. Codes: `QBD_READ_INTERRUPTED`.
- `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`.
- `504`: The request timed out. Codes: `REQUEST_TIMEOUT_NOT_SENT`, `QBD_REQUEST_TIMEOUT`.