Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update employee default

update_employee_default
Read-onlyIdempotent

Builds a v2 employee_default.update request.

The employee_default_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

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "update_employee_default"
  }
}

Input Schema

NameRequiredDescriptionDefault
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`.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
include_ret_elementNo
employee_default_payroll_info_modNo

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.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotent=true and destructiveHint=false, which is consistent with a tool that only assembles a request. The description adds real value by stating what is returned (the v2 request plus the webhook payload shape for response_json) and by enumerating the error codes to handle. However, it omits how the update behaves semantically, e.g. whether omitted fields are left untouched or cleared.

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 sentences are well front-loaded and explain the build-then-send flow efficiently. The bulk of the text is a 23-item error-code dump that the description itself says 'the call result explains each', which is costly noise for a tool-selection decision.

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-value detail is not strictly required, and the webhook/send-next context is a genuine addition. What is missing for a complex update tool is the mutation semantics (full vs partial update) and required context such as which employee the defaults apply to.

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

Parameters2/5

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

Schema coverage is 50% and the parameter tree is deeply nested (payroll info, earnings/non-earnings, tax info), yet the description says nothing about those fields. The mention of an '`employee_default_mod` wrapper' does not even match the schema property name `employee_default_payroll_info_mod`, so it adds ambiguity rather than meaning. Nearly all param semantics rest on the schema alone.

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 first sentence states a specific verb and resource ('builds a v2 employee_default.update request'), and it usefully clarifies that the tool constructs a request rather than executing the update. It never distinguishes this from the sibling update_employee, so an agent must infer the split between updating an employee record and updating that employee's payroll defaults.

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 explicit when-to-use or when-not-to-use guidance, and no prerequisite or alternative is named among the many update_* siblings. The only usage-adjacent information is implicit: you must send the returned request yourself and await the webhook answer.

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