Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update employee

update_employee
Read-onlyIdempotent

Modifies and existing employee.

The employee_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_employee"
  }
}

Input Schema

NameRequiredDescriptionDefault
faxNoFax number.
nameNoA concatenation of `first_name`, `middle_name`, and `last_name`.
emailNoE-mail address.
notesNoAdditional information.
pagerNoThe pager number.
phoneNoThe telephone number.
exemptNoExempt or Non-exempt status of the employee.
mobileNoMobile telephone number.
suffixNo
list_idYesQuickBooks' ID for the record. Used over `full_name` when both are sent.
on_fileNoIs the employee’s I-9 on file?
disabledNoIs employee disabled?
print_asNoBy default within QuickBooks, the `print_as` element is the same as the Name element.
alt_phoneNoA telephone number given as an alternative to Phone.
ethnicityNoEthnicity of employee from AmericianIndian, Asian, Black, Hawaiian, Hispanic, White, TwoOrMoreRaces.
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.
pager_pinNoA personal identification number for this employee’s pager.
birth_dateNoDate of birth.
departmentNoThe name of the department in the employment job details section.
first_nameNoThe first name of a customer, vendor, employee, or person on the “other names” list.
hired_dateNoAn employee’s date of hire.
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.
us_citizenNoIs employee a US citizen?
us_veteranNoIs employee a US veteran?
descriptionNoThe description details in the employment job details section.
middle_nameNoThe middle name of a customer, vendor, employee, or person on the “other names” list.
key_employeeNoIs employee a key or critical employee.
target_bonusNoThe target bonus amount in the employment job details section.
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`.
employee_typeNo`employee_type` can affect payroll taxes for an employee. A statutory employee is a person who is defined as an employee by statute.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
released_dateNoThe date on which this person’s employment with the company ended.
account_numberNoAccount numbers appear in the QuickBooks chart of accounts, Account fields, and reports and graphs.
supervisor_refNoThe name of a customer, vendor, employee, or person on the “other names” list in the employment job details section.
disability_descNoDescription of employee’s disablitily.
military_statusNoMilitary status if the employee is a US veteran.
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.
employee_addressNoIf an address request fails, some combination of address fields might be too long.
part_or_full_timeNoFull or Part time status of the employee.
emergency_contactsNoEmergency Contact information for the employee.
original_hire_dateNoOriginal hire date the employee was hired.
include_ret_elementNo
additional_notes_modNo
adjusted_service_dateNoAdjusted service date for the employee.
work_auth_expire_dateNoDate the employee’s work authorization expires.
additional_contact_refNo
employee_payroll_info_modNoPay information for this employee.

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

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

Annotations declare readOnlyHint=true and destructiveHint=false, yet the description's first sentence states the tool modifies an existing employee. Even accounting for the fact that the tool returns a compiled v2 request plus a webhook payload, the definition never reconciles this with the read-only annotation, so the agent cannot tell whether a write actually occurs. This is a direct annotation 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 opening sentence is front-loaded and efficient, and the return-shape sentence earns its place. However, roughly half the text is a 23-code error dump that is more reference table than guidance, and the definition spends no words on the higher-value questions (partial vs. full update, permission prerequisites).

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 50-parameter tool with an output schema and full annotation coverage, the description covers the important non-schema facts: it accepts a qbXML wrapper, it returns the v2 request to send plus the webhook payload for the answer, and it enumerates the error taxonomy. The gap is the absence of update semantics and of a warning that operations may fail on stale edit_sequence or locked records until the reader gets to the code 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 92%, so the schema already documents nearly all 50 parameters, including the required edit_sequence revision token and list_id precedence. The description adds nothing about individual fields, and notably omits whether sending a subset of fields merges or replaces existing values, which is the key semantic question for a large update payload.

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 description opens with a specific verb+resource ("Modifies an existing employee"), which is unambiguous despite the typo ("and existing"). It does not differentiate from the sibling update_employee_default or create_employee, leaving the agent to infer which tool applies.

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 mention of the sibling update_employee_default that an agent would need to choose between. The only usage-adjacent note is that the qbXML `employee_mod` wrapper is accepted, which is about input format rather than tool selection.

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