Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update vendor

update_vendor
Read-onlyIdempotent

Modifies a vendor.

The vendor_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, 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_vendor"
  }
}

Input Schema

NameRequiredDescriptionDefault
ccNoEmail address that would be carbon copied or CC.
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 about this vendor.
pagerNo
phoneNoThe telephone number.
mobileNo
suffixNo
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.
class_refNoUse classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks.
is_activeNoIf `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true.
job_titleNoThe job title of a customer, vendor, employee, or person on the “other names” list.
last_nameNoThe last name of a customer, vendor, employee, or person on the “other names” list.
terms_refNoRefers to the payment terms associated with this entity. (This will be an item on the DateDrivenTerms or StandardTerms 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.
contacts_modNo
credit_limitNoSet and returned as a positive number that indicates a customer’s or vendor’s credit limit. If no value has been defined, there is no credit limit.
currency_refNoA currency record defines how QuickBooks stores and displays a currency. Built-in currency name/code values are fixed; formatting and active status can vary by settings and workflow.
ship_addressNoThis aggregate supports at most five address lines. You can provide a structured address (Addr1-Addr3 plus City/State/`postal_code`/etc.) or use block mode (Addr1-Addr5 only).
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.
is_tax_on_taxNoFor vendor in CA or UK, is there tax charged on top of tax.
name_on_checkNoThe vendor’s name as it will appear on checks sent to the vendor. (Corresponds in the QuickBooks user interface to the “Print on Check as” field of the Edit Vendor and New Vendor windows.)
account_numberNoAccount numbers appear in the QuickBooks chart of accounts, Account fields, and reports and graphs.
vendor_addressNoIf an address request fails, some combination of address fields might be too long.
vendor_type_refNoVendor types allow business owners to categorize vendors in ways that are meaningful for their businesses.
billing_rate_refNoBilling rates are used to override the service item rate in a time transaction (TimeTrackingAdd) based on the employee or vendor performing the work.
reporting_periodNoVendor reporting period for CA or UK. This can be monthly or quarterly.
vendor_tax_identNoA character string that identifies a vendor.
sales_tax_countryNoThe country that sales tax is collected for.
sales_tax_code_refNo`sales_tax_code_ref` points to the sales-tax code used for an item or customer context. QuickBooks includes default TAX and NON codes, and a code can be deleted only when nothing references it.
include_ret_elementNo
is_sales_tax_agencyNoIndicates whether the entity is a sales tax agency.
prefill_account_refNo
additional_notes_modNo
sales_tax_return_refNoSales tax return information.
additional_contact_refNo
is_tax_tracked_on_salesNoThis flag is used for CA or UK and whether tax is tracked on sales.
tax_registration_numberNoThe tax registration number used in CA and UK.
tax_on_sales_account_refNoAccount used for taxes on sales in CA or UK.
is_vendor_eligible_for1099NoIf `is_vendor_eligible_for1099` is set to true, `vendor_tax_ident` and `vendor_address` are required in a vendor add request message. Otherwise, `vendor_tax_ident` and `vendor_address` are optional.
is_tax_tracked_on_purchasesNoThis flag is used for CA or UK and whether tax is tracked on purchases.
tax_on_purchases_account_refNoAccount used for taxes on purchases in CA or UK.

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

C2.7/5.0
Behavior1/5

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

The description says the tool "Modifies a vendor" and returns the request to send, while the annotations declare `readOnlyHint: true` and `destructiveHint: false`. That is a direct contradiction about whether this operation writes data. The extra context (webhook response shape, request_id echo, enumerated error codes) is genuinely useful, but the conflicting read/write signal is disqualifying for an agent deciding whether it is safe to call.

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 purpose sentence is properly front-loaded and the return-shape note is compact. The bulk of the text is a ~20-entry error-code dump that, without grouping or priority, reads as a wall of enumeration rather than task-relevant guidance; the most actionable codes (cannot_modify, locked, stale_edit_sequence) are buried mid-list.

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?

For a 51-parameter mutation with an output schema present, the description correctly covers the two things the schema cannot: the webhook delivery path and the failure taxonomy. It omits the concurrency contract (send current `edit_sequence`) and the partial-vs-full update semantics, which matter a lot at this parameter count.

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 84% across 51 parameters, so the schema itself already explains nearly every field (including `edit_sequence`, `list_id`, and the address aggregates). The description adds only the note that the qbXML `vendor_mod` wrapper is accepted, which is a small semantic addition; there is no guidance on which of the many optional fields to send or how partial updates behave.

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?

"Modifies a vendor" is a specific verb plus resource, and the description adds that the qbXML `vendor_mod` wrapper is accepted and that the call returns a v2 request plus a webhook response shape. It stops short of distinguishing itself from siblings like `create_vendor`, `update_vendor_credit`, or the other `update_*` tools, so an agent gets the action but not the boundary.

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?

There is no statement of when to use this versus `create_vendor` (new record) or `update_vendor_credit`, and no prerequisites such as needing the current `edit_sequence` before modifying. The agent is left to infer the workflow entirely from the schema's required fields and the error-code list.

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