Update employee
update_employeeModifies 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
| Name | Required | Description | Default |
|---|---|---|---|
| fax | No | Fax number. | |
| name | No | A concatenation of `first_name`, `middle_name`, and `last_name`. | |
| No | E-mail address. | ||
| notes | No | Additional information. | |
| pager | No | The pager number. | |
| phone | No | The telephone number. | |
| exempt | No | Exempt or Non-exempt status of the employee. | |
| mobile | No | Mobile telephone number. | |
| suffix | No | ||
| list_id | Yes | QuickBooks' ID for the record. Used over `full_name` when both are sent. | |
| on_file | No | Is the employee’s I-9 on file? | |
| disabled | No | Is employee disabled? | |
| print_as | No | By default within QuickBooks, the `print_as` element is the same as the Name element. | |
| alt_phone | No | A telephone number given as an alternative to Phone. | |
| ethnicity | No | Ethnicity of employee from AmericianIndian, Asian, Black, Hawaiian, Hispanic, White, TwoOrMoreRaces. | |
| is_active | No | If `is_active` is true, this object is currently enabled for use by QuickBooks. The default value is true. | |
| job_title | No | The job title of a customer, vendor, employee, or person on the “other names” list. | |
| last_name | No | The last name of a customer, vendor, employee, or person on the “other names” list. | |
| pager_pin | No | A personal identification number for this employee’s pager. | |
| birth_date | No | Date of birth. | |
| department | No | The name of the department in the employment job details section. | |
| first_name | No | The first name of a customer, vendor, employee, or person on the “other names” list. | |
| hired_date | No | An employee’s date of hire. | |
| request_id | No | Your 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`. | |
| salutation | No | A formal reference, such as Mr. or Dr., that precedes a name. | |
| us_citizen | No | Is employee a US citizen? | |
| us_veteran | No | Is employee a US veteran? | |
| description | No | The description details in the employment job details section. | |
| middle_name | No | The middle name of a customer, vendor, employee, or person on the “other names” list. | |
| key_employee | No | Is employee a key or critical employee. | |
| target_bonus | No | The target bonus amount in the employment job details section. | |
| edit_sequence | Yes | `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_type | No | `employee_type` can affect payroll taxes for an employee. A statutory employee is a person who is defined as an employee by statute. | |
| include_qbxml | No | Also return the qbXML this compiles to, for debugging. Not part of the v2 request. | |
| released_date | No | The date on which this person’s employment with the company ended. | |
| account_number | No | Account numbers appear in the QuickBooks chart of accounts, Account fields, and reports and graphs. | |
| supervisor_ref | No | The name of a customer, vendor, employee, or person on the “other names” list in the employment job details section. | |
| disability_desc | No | Description of employee’s disablitily. | |
| military_status | No | Military status if the employee is a US veteran. | |
| billing_rate_ref | No | Billing rates are used to override the service item rate in a time transaction (TimeTrackingAdd) based on the employee or vendor performing the work. | |
| employee_address | No | If an address request fails, some combination of address fields might be too long. | |
| part_or_full_time | No | Full or Part time status of the employee. | |
| emergency_contacts | No | Emergency Contact information for the employee. | |
| original_hire_date | No | Original hire date the employee was hired. | |
| include_ret_element | No | ||
| additional_notes_mod | No | ||
| adjusted_service_date | No | Adjusted service date for the employee. | |
| work_auth_expire_date | No | Date the employee’s work authorization expires. | |
| additional_contact_ref | No | ||
| employee_payroll_info_mod | No | Pay information for this employee. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Replace {connection_id} with the customer's connection. | |
| body | Yes | The JSON body: the arguments you passed. | |
| qbxml | No | The qbXML it compiles to. Only with include_qbxml. | |
| method | Yes | ||
| headers | Yes | Send with the request. Resent unchanged when no 201 came back, it answers with the request already queued. | |
| webhook | Yes | JSON Schema of the payload POSTed to webhook_url once QuickBooks answers, with this operation's response_json (data shape and status codes). |