Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Delete list

delete_list
Read-onlyIdempotent

You can only delete a list item from a QuickBooks company file if the file is open in single-user mode. If the file is open in multiuser mode, your application will receive an error. (This restriction doesn’t apply to deleting or voiding transaction objects.)

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": {
      "list_del_type": "<list_del_type>",
      "list_id": "<list_id>"
    },
    "name": "delete_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
list_idYesQuickBooks' ID for the record. Used over `full_name` when both are sent.
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.
list_del_typeYesThe type of list from which a list member is being deleted.

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?

Annotations declare readOnlyHint=true and destructiveHint=false, and the description supplies the reconciling detail — the tool compiles and returns a v2 request plus the webhook payload where the answer arrives, rather than executing the delete. It also discloses the single-user-mode precondition and enumerates 21 error codes, far beyond annotation coverage. It falls short of 5 because the read-only-vs-delete framing requires the agent to piece together sentence one and sentence two.

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 opening sentence is a conditional precondition rather than a purpose statement, and the enumerated error-code block occupies roughly half the text, much of it generic QuickBooks codes (invalid_amount, string_too_long) that are unlikely to occur on a delete. The return-shape sentence is valuable but buried mid-paragraph.

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 annotations, a full input schema, and an output schema covering response_json shape and status codes, the description need not explain returns — and it correctly just points at them. Preconditions and error taxonomy are covered; only the read-versus-delete distinction could be sharper.

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%, so the schema already documents list_id precedence over full_name, request_id echoing, include_qbxml debugging output, and the full list_del_type enum. The description adds only the general notion of a 'list item' being deleted, not parameter-specific meaning, so the baseline 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 does state a specific verb and resource ('delete a list item from a QuickBooks company file') and even distinguishes itself implicitly from transaction deletion ('This restriction doesn't apply to deleting or voiding transaction objects'). However, the tool's actual nature — it 'Returns the v2 request to send' rather than performing the deletion — is stated second, after a precondition sentence, so the core purpose is not front-loaded.

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?

Strong preconditions: the file must be open in single-user mode, and multiuser mode will produce an error. The parenthetical noting the restriction does not apply to transaction objects gives an implicit when-to-use-else signal toward transaction deletion tools, but no sibling is named outright and no guidance is given on choosing among alternative delete pathways.

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