Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update to do

update_to_do
Read-onlyIdempotent

Builds a v2 to_do.update request.

The to_do_mod wrapper from qbXML is also accepted. 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, 3140 invalid_reference, 3150 missing_element, 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": {
      "edit_sequence": "<edit_sequence>",
      "list_id": "<list_id>"
    },
    "name": "update_to_do"
  }
}

Input Schema

NameRequiredDescriptionDefault
typeNoType may have one of the following values: Task [DEFAULT], Call, Fax, Email, Meeting, Appointment
notesNoAdditional information.
is_doneNoIf `is_done` is true, this “to do” task has been completed. The default value of `is_done` is false.
list_idYesQuickBooks' ID for the record. Used over `full_name` when both are sent.
lead_refNoThe lead list contains information about leads for a company. Choose at most one of: `customer_ref`, or `employee_ref`, or `lead_ref`, or `vendor_ref`.
priorityNoPriority may have one of the following values: Low [DEFAULT], Medium, High
is_activeNoIf `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
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`.
vendor_refNoA vendor is any person or company from whom a small business owner buys goods and services. (Banks and tax agencies usually are included on the vendor list.) Choose at most one of: `customer_ref`, or `employee_ref`, or `lead_ref`, or `vendor_ref`.
customer_refNo`customer_ref` identifies a customer or customer job. If both `full_name` and `list_id` are provided, `full_name` is ignored. In SalesReceipt and ReceivePayment, it identifies who receives credit. Choose at most one of: `customer_ref`, or `employee_ref`, or `lead_ref`, or `vendor_ref`.
employee_refNoThe employee list contains payroll information about each of the company’s employees. Choose at most one of: `customer_ref`, or `employee_ref`, or `lead_ref`, or `vendor_ref`.
edit_sequenceYes`edit_sequence` is a server-generated revision token. It changes each time the object is updated. To modify an existing object, you must send the current `edit_sequence`.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
reminder_dateNoThe date on which the contents of the Notes string will appear on the Reminder list within QuickBooks.
reminder_timeNoThe time on which the contents of the Notes string will appear on the Reminder list within QuickBooks.
include_ret_elementNo

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.6/5.0
Behavior4/5

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

The description resolves a genuine ambiguity that the annotations alone would raise: a tool named 'update' marked readOnlyHint=true, explained by the fact that it only compiles a request and returns a webhook payload shape instead of mutating state. It also discloses the round-trip mechanics (build request, answer arrives via webhook, status codes to handle). The extensive error-code enumeration adds an error taxonomy, though it partly overlaps the claim that 'the call result explains each'.

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 first two sentences are well front-loaded and dense with useful information. However, the 22-entry error-code list is bulky, partially redundant with the statement that 'the call result explains each', and dilutes an otherwise compact 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?

For a 16-parameter tool with an output schema and rich annotations, the definition covers the request/response mechanism, the wrapper alternative, and failure modes. The remaining gap is selection guidance relative to the create/find siblings, which an agent would have to infer from the name.

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 94%, so the schema already documents all 16 parameters including `edit_sequence`, the ref-object precedence rules, and `request_id`. The description adds only the note that the qbXML `to_do_mod` wrapper is accepted, which is a marginal semantic addition over the schema.

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 opening sentence gives a specific verb and resource: it 'builds a v2 to_do.update request' and accepts the qbXML `to_do_mod` wrapper. That is precise enough to separate it from create_to_do and find_to_dos, but the description never explicitly contrasts it with those siblings.

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

Usage Guidelines3/5

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

Usage is only implied by the operation name 'to_do.update' and the mention that a `to_do_mod` wrapper is accepted. There is no statement of when to choose this over create_to_do (new records) or find_to_dos (retrieval), and no prerequisite about needing the current `edit_sequence` stated at the description level.

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