Skip to content

v0.8.0

Choose a tag to compare

@nmajor nmajor released this 13 Oct 15:52
· 5 commits to main since this release
  • A read that was sent, interrupted (for example when QuickBooks closed unexpectedly, HRESULT 0x80040402) and queued for its automatic retry now ends with QBD_READ_INTERRUPTED (502, details.reason, details.retry, details.firstSentAt) when the retry is not sent in time. It answered 504 REQUEST_TIMEOUT_NOT_SENT with sentAt: null. A request's sentAt is no longer reset to null by the retry.
  • New diagnosis cause quickbooks_closed_unexpectedly: QuickBooks returned an error instead of a result (0x80040402 when it crashed) and the Web Connector, still running with a stuck update lock, has not checked in since. It ranks above web_connector_closed. diagnosis.connector.lastSeenAt now counts the calls of a session that ended, not only the last check-in.
  • Breaking: qbd.unitOfMeasureSets.delete is removed. QuickBooks answered status 1000 and Intuit documents that a unit of measure set cannot be deleted; DELETE /v1/quickbooks-desktop/unit-of-measure-sets/{id} now answers 422 QBD_OPERATION_UNSUPPORTED with alternatives (make the set inactive in QuickBooks Desktop) and sends nothing.
  • Breaking: qbd.fixedAssetItems.create requires assetAccountId. QuickBooks rejects a fixed asset item without an asset account (status 3180), although the qbXML schema marks it optional.
  • Creating or updating a public custom field definition (ownerId "0") accepts only customer, vendor, employee and item in assignToObjects and removeFromObjects; other values answer 400 INVALID_PARAMETER before anything is sent. QuickBooks refused them with status 3351.
  • A QuickBooks status 3231 for a request that was alone in its message set carries details.onlyRequestInMessageSet: true and says no earlier request caused it. Lead requests and class merges have documented incompatibilities (status 3231 and 3500 on QuickBooks Enterprise 24).
  • Breaking: a list-object delete (qbd.<list>.delete, QuickBooks ListDel) no longer always answers deleted: true. QuickBooks Desktop can accept the delete and keep the object, inactive and readable by its ID (Enterprise 24 did this in every test). The API reads the object back in the same request: deleted is true only when QuickBooks no longer returns it; otherwise deleted is false, deactivated is true when it is now inactive, and isActive holds its state. The result types gain deactivated and isActive.
  • QBD_REQUEST_ERROR on a read (for example a payroll report QuickBooks refused with status 3262) has the end-user text "QuickBooks Desktop could not provide this information." It said "did not accept this change". errors.json documents readUserFacingMessage.
  • Breaking: custom field definition update and delete take the definition name as the path parameter definitionName (it was name).
  • Breaking: one fallback type per union. An item or entity of a kind this SDK does not model, whether QuickBooks returned a kind the API does not model (objectType qbd_unrecognized_item) or the API added a kind after this SDK version, is an UnrecognizedItem / UnrecognizedEntity with the shared fields plus qbxmlElement and fields; its objectType is a plain string. UnknownItem and UnknownEntity are gone.
  • Breaking: identical enums share one type, used on requests and responses alike, for example AssignToObject (also CustomFieldDefinition.assignToObjects), LeadStatus, ToDoType, ToDoPriority, ClearedStatus, BillingStatus, CustomFieldOperation, TransactionKind and Outcome. The per-operation names (LeadCreateInputStatus, CustomFieldDefinitionCreateInputAssignToObject, RequestListParamsStatu, ...) are gone.
  • Breaking: type renames: LeadContactsCreateInput / LeadContactsUpdateInput / LeadContacts are LeadContactCreateInput / LeadContactUpdateInput / LeadContact; DeletedCustomFieldDefinition is CustomFieldDefinitionDeleted; the result of transactions.updateClearedStatus is TransactionClearedStatus, whose clearedStatus is a ClearedStatus.
  • Breaking: to-do list parameters lose the name filters (a to-do has no name), and payrollWageItems.list no longer takes cursor (the list is never paginated; any cursor was refused).
  • IntegrationConnection (an end user's integrationConnections) carries endUserId, disabled and setupCompletedAt, like EndUserConnection, which has every IntegrationConnection field plus installs and companyFileMismatches.
  • The createdAt and updatedAt of every *Voided result are date-times.
  • CursorExpired's reason is a typed set (idle_timeout, session_ended, quickbooks_restarted, evicted, or a value added later). The cursor-expired error stays a subclass of the invalid-request error, because the API classifies CURSOR_EXPIRED as INVALID_REQUEST_ERROR; catch it first when you handle the two differently.
  • Breaking: confirm on deletes and merges is typed true and required, so a call without it does not compile.
  • TransactionCustomFieldValueInput extends CustomFieldValueInput, and CustomerMergeInput extends ListMergeInput.
  • New exported type CursorExpiredReason.
  • Breaking: a list-object delete's deleted and deactivated can be null: QuickBooks accepted the delete but reading the record back failed. The request then succeeds with outcome applied and a new QBD_DELETE_NOT_VERIFIED warning; do not send the delete again. A failed write the API verified as applied keeps outcome applied and is not retryable.
  • List-object delete results gain retainedBecause: multi_user_mode when QuickBooks kept the record because the company file was open in multi-user mode (it deletes in single-user mode).
  • New error code QBD_REQUIRES_SINGLE_USER_MODE (409, not retryable, outcome not_applied): merges and custom field definition deletes are refused before sending while the company file is open in multi-user mode, and custom field values QuickBooks refuses there (status 3180 or 3120) map to it. integrationConnections[].companyFile.fileMode (single_user / multi_user) shows the mode of the last session.
  • A lead request QuickBooks does not process (status 3231, even a plain lead list) answers 422 QBD_OPERATION_UNSUPPORTED with alternatives instead of QBD_REQUEST_ERROR.
  • qbd.vehicleMileage.delete reads the trip first: an unknown ID answers 404 QBD_OBJECT_NOT_FOUND; an existing trip answers 422 QBD_OPERATION_UNSUPPORTED (QuickBooks refuses the delete with status 3160 even on a fresh company file) without sending the delete.
  • The quickbooks_closed_unexpectedly diagnosis needs QuickBooks' "Unexpected error" (HRESULT 0x80040402) in a session the Web Connector never closed, and silence since its last contact; its steps first have the end user check that QuickBooks closed and no other application is updating.
  • Batches (qbd.batch) follow the same rules: a list-delete member reads the record back (deleted, deactivated, retainedBecause, and a QBD_DELETE_NOT_VERIFIED member warning when the read-back failed), a batch holding a merge or custom field definition delete is refused with 409 QBD_REQUIRES_SINGLE_USER_MODE in multi-user mode (details.index names the member), a lead member QuickBooks does not process is QBD_OPERATION_UNSUPPORTED, a vehicle mileage delete member is refused with 422 QBD_OPERATION_UNSUPPORTED, and batch delete and merge members require confirm like the typed calls.
  • Breaking: a batch member for custom field definition update or delete takes pathParams.definitionName (was pathParams.name), as the typed calls do.
  • A custom field definition delete reads the owner's definitions back in the same request: CustomFieldDefinitionDeleted gains deleted (true only when the definition is gone, false when QuickBooks kept it, null when the read-back failed with a QBD_DELETE_NOT_VERIFIED warning) and retainedBecause (multi_user_mode or unknown), on the typed call and as a batch member.
  • QBD_REQUIRES_SINGLE_USER_MODE now needs QuickBooks' own evidence: a custom field value refused with another 3180/3120 message keeps its code (for example not found, or QBD_TRANSIENT_ERROR for a record modified by another user); a generic data-extension refusal in multi-user mode keeps its code with details.possibleCause: multi_user_mode.
  • A batch member QuickBooks refused is not_applied in its result and its error, whatever other members did; a lead member under continueOnError after another member failed is QBD_OPERATION_UNSUPPORTED, not not_processed; the vehicle mileage refusal carries details.index.
  • New error code QBD_REAUTHORIZATION_REQUIRED (ErrorCode.QBD_REAUTHORIZATION_REQUIRED): 503, not retryable. QuickBooks answered the Web Connector with 0x80040435 and asks its Admin to reauthorize the application in Edit > Preferences > Integrated Applications; nothing was sent. It answered QBD_CONNECTION_ERROR. New diagnosis cause quickbooks_reauthorization_required.
  • A company file QuickBooks cannot reach at its stored location (0x80040408 for a path on a drive letter other than C:, usually a disconnected mapped network drive, or for the same path twice in a row) answers QBD_COMPANY_FILE_NOT_FOUND with details.reason path_unreachable, details.pathKind and details.refusals, and the new diagnosis cause company_file_not_found ranks first. It answered QBD_WRONG_COMPANY_FILE_OPEN ("a different company file is open").
  • A QuickBooks status 3170 whose message says the record is in use, locked or being edited answers 409 QBD_OBJECT_IN_USE with the record_in_use diagnosis (not retryable for a deletion). It answered 422 QBD_REQUEST_ERROR. QuickBooks does not lock every open record, so the documentation no longer promises that an open window blocks a change.
  • A payment item or job type name that is already in use answers 409 QBD_DUPLICATE_NAME with param name (QuickBooks status 3180). It answered 422 QBD_REQUEST_ERROR.
  • qbd.customFieldDefinitions.list without filters returns the public definitions (ownerId "0"); it returned none. ownerIds together with assignToObjects lists the definitions of those owners assigned to those record types, private ones included; the combination was refused.
  • Vehicle mileage createdAt and updatedAt are date-times: midnight UTC when QuickBooks reports only a date. They were plain dates, which the Java SDK could not parse.
  • A single request ends its Web Connector session as soon as QuickBooks answers it, so QuickBooks no longer counts the application as using the company file for 2 seconds afterwards; only a request sent within 30 seconds of another keeps the session open for the next one.

All versions: CHANGELOG.md.