Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update sales rep

update_sales_rep
Read-onlyIdempotent

Modifies a sales rep record.

The sales_rep_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_sales_rep"
  }
}

Input Schema

NameRequiredDescriptionDefault
initialNoThe initials of a sales representative’s name.
list_idYesQuickBooks' ID for the record. Used over `full_name` when both are sent.
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`.
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.
include_ret_elementNo
sales_rep_entity_refNoRefers to the sales representative’s full information on the Employee, Vendor, or OtherName list.

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 opens with "Modifies a sales rep record," a write operation, while the annotations declare readOnlyHint=true and destructiveHint=false. An agent trusting the annotations would treat a mutating call as a safe read. The otherwise useful disclosure (v2 request plus webhook payload, and a list of 18 error codes such as 3200 stale_edit_sequence and 3176 locked) cannot offset a safety-flag contradiction.

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 purpose is front-loaded in one clean sentence, but nearly half the text is a dense 18-item error-code list that is explicitly deferred to "the call result explains each," so it consumes space without conveying actionable meaning. The response-mechanics sentence is valuable; the code dump is low-density.

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 an 8-parameter mutation with a nested sales_rep_entity_ref, the description covers the response mechanics (compiled v2 request and webhook payload) and failure modes, which is reasonable given an output schema exists. It omits what the update actually does to unspecified fields and never addresses the annotation mismatch, leaving a real gap for a write tool.

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 88%, so the schema already explains edit_sequence, list_id precedence over full_name, include_qbxml, and include_ret_element. The description adds nothing parameter-specific beyond noting the qbXML wrapper name, so the baseline of 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?

"Modifies a sales rep record" gives a specific verb (modifies) and resource (sales rep), which cleanly separates it from the create_sales_rep sibling. It stops short of naming any sibling explicitly, so an agent must infer that create_sales_rep is the alternative for new records.

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 when-to-use guidance: nothing says to call this only for existing records, what the edit_sequence prerequisite means in practice, or which sibling to use instead for creation or lookup. The only quasi-guidance is the note that the qbXML `sales_rep_mod` wrapper is accepted, which is an input-format detail rather than a usage rule.

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