Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update other name

update_other_name
Read-onlyIdempotent

Modifies an existing other name.

The other_name_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, 3100 name_in_use, 3120 object_not_found, 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_other_name"
  }
}

Input Schema

NameRequiredDescriptionDefault
faxNoFax number.
nameNoName is the case-insensitive short name of a list object (without ancestors). It must be unique within its hierarchy scope.
emailNoE-mail address.
notesNoAdditional information.
phoneNoThe telephone number.
contactNoThe name of a contact person for a customer or vendor.
list_idYesQuickBooks' ID for the record. Used over `full_name` when both are sent.
alt_phoneNoA telephone number given as an alternative to Phone.
is_activeNoIf `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
last_nameNoThe last name of a customer, vendor, employee, or person on the “other names” list.
first_nameNoThe first name of a customer, vendor, employee, or person on the “other names” list.
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`.
salutationNoA formal reference, such as Mr. or Dr., that precedes a name.
alt_contactNoThe name of an alternate contact person for a vendor, customer, or “other name” entry.
middle_nameNoThe middle name of a customer, vendor, employee, or person on the “other names” list.
company_nameNoThe name of the QuickBooks user’s business, as specified in QuickBooks. `company_name` and Address are used on invoices, checks, and other forms.
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.
account_numberNoAccount numbers appear in the QuickBooks chart of accounts, Account fields, and reports and graphs.
other_name_addressNoIf an address request fails, some combination of address fields might be too long.
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

B3.1/5.0
Behavior3/5

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

The annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, and the description partially justifies that profile by saying only a request is compiled and returned along with the webhook payload location in response_json. That is genuine added context, but it sits in tension with the leading "Modifies" framing, and the 25-code error dump is exhaustive without explaining which codes an agent should actually branch on (3200 stale_edit_sequence, 3100 name_in_use, 3175 in_use being the ones that matter).

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 error enumeration consumes well over half the text and crowds out the two facts an agent actually needs (that the tool returns a request to send, and where the answer arrives). The lead sentence is front-loaded but misleading before the second sentence corrects it, and the code list would be far more useful collapsed to the handful of recoverable errors.

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

Completeness3/5

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

An output schema exists, so return shape need not be described and the description partly duplicates it anyway. What is missing for a 21-parameter mutation-style tool using a request/webhook round-trip is the surrounding workflow: how to submit the returned v2 request, whether the call itself is safe to retry before the webhook lands, and any permission requirements despite 3220/3260/3261 appearing in the error list.

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 95% across 21 parameters including a nested address object, so the schema already carries nearly all parameter meaning. The description adds only indirect hints through the error list — 3200 implies edit_sequence freshness matters and 3100 implies name uniqueness — which is a marginal contribution on top of a self-documenting 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 lead sentence gives a specific verb and resource ("Modifies an existing other name") that clearly separates it from create_other_name and find_other_names, and the second sentence adds the important nuance that it emits a qbXML-backed v2 request rather than mutating directly. The verb "Modifies" is slightly at odds with that request-builder framing, so the purpose is clear but not perfectly precise.

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

Usage Guidelines2/5

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

Nothing states when to pick this over create_other_name, find_other_names, or update_item_other_charge, and there is no guidance on prerequisites such as reading the record first to obtain a current edit_sequence. It also never explains what the caller is supposed to do with the returned v2 request or how to correlate the inbound webhook, which is the real usage question for this tool.

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