Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Delete data event recovery info

delete_data_event_recovery_info
Read-onlyIdempotent

Deletes the data event recovery information for the given subscriber. An application would send a DataEventRecoveryInfoDel request after having recovered its data events. For details about the event-notification feature, see the chapter called “Event Notification” in the QB SDK Programmer’s Guide (PDF, 9.6 MB).

Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).

Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3150 missing_element, 3160 cannot_delete, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "subscriber_id": "<subscriber_id>"
    },
    "name": "delete_data_event_recovery_info"
  }
}

Input Schema

NameRequiredDescriptionDefault
request_idNoYour own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
subscriber_idYesA unique identifier that an application sets when it adds a subscription so that the application can later query or delete the subscription.

Output Schema

NameRequiredDescriptionDefault
urlYesReplace {connection_id} with the customer's connection.
bodyYesThe JSON body: the arguments you passed.
qbxmlNoThe qbXML it compiles to. Only with include_qbxml.
methodYes
headersYesSend with the request. Resent unchanged when no 201 came back, it answers with the request already queued.
webhookYesJSON Schema of the payload POSTed to webhook_url once QuickBooks answers, with this operation's response_json (data shape and status codes).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the annotations, the description discloses the two returned artifacts (the v2 request to send and the webhook payload QuickBooks answers in, plus response_json shape and status codes) and enumerates the full error surface (1030 unsupported_request through 3264 merchant_services_subscription_required). That is substantive workflow transparency. The one tension is that the leading verb "Deletes" sits oddly beside readOnlyHint=true / destructiveHint=false, though the note that the tool returns a request for the caller to send largely reconciles it as a compile-only operation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The purpose and precondition are correctly front-loaded, but the definition spends considerable length on a 16-code error list with no per-code meaning beyond "the call result explains each," and on a PDF link annotated with its file size. Useful content, but the tail dilutes rather than sharpens the definition.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema present, return-value detail is largely duplicative rather than required, and parameters are fully documented in the schema. Errors and the async request/webhook flow are covered, so an agent has enough to call correctly; only auth/permission prerequisites and repeat-call behavior are unstated despite the idempotent annotation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, and the schema already explains request_id, include_qbxml, and subscriber_id thoroughly, including the qbXML requestID mapping. The description adds only the phrase "for the given subscriber," adding no new meaning, so the baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific verb and resource ("Deletes the data event recovery information") and scopes it to "the given subscriber," plus explains the lifecycle trigger ("after having recovered its data events"). It does not name the sibling find_data_event_recovery_infos, so the reader must infer the read-vs-delete split from the tool name alone, but the resource is narrow and unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

"An application would send a DataEventRecoveryInfoDel request after having recovered its data events" gives a concrete precondition for calling, which is real when-to-use guidance for a delete of recovery state. No explicit when-not conditions or named alternatives are given, and there is no mention of what happens on a repeat call despite the idempotent annotation.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources