Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update customer

update_customer
Read-onlyIdempotent

Changes a customer or job. Send its list_id, the edit_sequence QuickBooks last returned for it, and only the fields to change; the rest keep their values. If the customer changed since you read it, QuickBooks answers 3200 stale_edit_sequence with the customer as it stands in error.current: re-apply your change and retry with its edit_sequence.

The customer_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_customer"
  }
}

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.
notesNoNot supported.
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.
job_descNoA short job description for a sub-customer; used in reports.
print_asNo
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.
job_statusNo`job_status` Status information about a sub-customer; used in reports.
parent_refNoA reference to the list object that is one level above this one.
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.
bill_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).
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.
job_end_dateNoThe date on which work for a sub-customer was completed; used in reports.
job_type_refNoJob type can be used to separate jobs into any categories that are meaningful to the business. A `job_type_ref` aggregate refers to a job type on the JobType list.
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.
resale_numberNoThe customer’s resale number, if they have one. This number won’t affect reports or sales tax calculations.
sales_rep_refNoA sales representative must be on the Employee, Vendor, or Other Names list within QuickBooks. Sales representative’s names and initials appear on the Rep drop-down list on QuickBooks sales forms.
account_numberNoAccount numbers appear in the QuickBooks chart of accounts, Account fields, and reports and graphs.
job_start_dateNoThe date on which work for a sub-customer was started; used in reports.
delivery_methodNo
price_level_refNoPrice levels let you apply custom pricing rules for selected customers. Once assigned, QuickBooks uses those prices automatically on supported sales forms unless explicitly overridden.
ship_to_addressNo
credit_card_infoNoCustomer’s credit-card information.
customer_type_refNoCustomer types allow business owners to categorize customers in ways that are meaningful for their businesses.
sales_tax_countryNoThe country that sales tax is collected for.
item_sales_tax_refNoAn ItemSalesTax entry represents one tax rate paid to one tax agency. Use it when a transaction needs a single tax calculation. For multi-rate scenarios, use a sales-tax group instead.
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
additional_notes_modNo
additional_contact_refNo
job_projected_end_dateNoThe date on which work for a sub-customer is expected to be complete; used in reports.
tax_registration_numberNoThe tax registration number used in CA and UK.
is_statement_with_parentNo
preferred_delivery_methodNoPreference for how invoices are delivered.
preferred_payment_method_refNoRefers to a PaymentMethod object. In a request, if a `preferred_payment_method_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.

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/5.0
Behavior1/5

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

The annotations declare readOnlyHint=true, but the description explicitly says it "Changes a customer or job" and describes a retry-and-reapply mutation workflow. That is a direct contradiction of the declared read-only behavior and would mislead an agent about safety.

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

Conciseness4/5

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

The core procedure and the stale_edit_sequence recovery path are front-loaded and easy to act on. The 33-code error enumeration is long but scannable as an appendix, and the definition stays focused without redundant restatement of the title.

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 56-parameter mutation with an output schema, the description covers the required inputs, partial-update semantics, the concurrency retry loop, the wrapper alternative, and what the call returns (v2 request plus webhook payload shape). The remaining gap is that it says nothing about permissions or side effects of changing a customer, but overall it is close to complete.

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

Parameters4/5

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

With ~80% schema description coverage the baseline is 3, but the description adds real semantics beyond the schema: partial-update semantics ("the rest keep their values"), the role of edit_sequence as a concurrency token, acceptance of the customer_mod wrapper, and the request_id/qbXML passthrough. It does not attempt to explain the 56 fields, which the schema already covers.

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

Purpose3/5

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

The description opens with "Changes a customer or job," which is a vague verb and conflates a customer with a sub-customer (job), leaving the scope somewhat fuzzy. The follow-up sentences do make the operation concrete (send list_id + edit_sequence + only changed fields), but it never distinguishes itself from create_customer or the other update_* 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 implied through the mechanical recipe (send the id, the stored edit_sequence, and only the fields to change) and through the stale_edit_sequence retry loop, which is genuinely actionable guidance. However, it never states when to choose this over create_customer or when not to call it, and there are no prerequisites or permission notes.

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