The Employee object
An employee represents a person employed by the company. It stores personal information, employment details, and payroll data used for personnel management and payroll processing.
The employee's account number, which appears in the QuickBooks chart of accounts, reports, and graphs.
Note that if the "Use Account Numbers" preference is turned off in QuickBooks, the account number may not be visible in the user interface, but it can still be set and retrieved through the API.
Additional notes about this employee.
The employee's address.
If the company uses QuickBooks Payroll for this employee, this address must specify a complete address, including city, state, ZIP (or postal) code, and at least one line of the street address.
The adjusted service date for this employee, in ISO 8601 format (YYYY-MM-DD). This date accounts for previous employment periods or leaves that affect seniority.
The employee's alternate telephone number.
The employee's billing rate, used to override service item rates in time tracking transactions.
This employee's date of birth, in ISO 8601 format (YYYY-MM-DD).
The date and time when this employee was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.
Additional custom contact fields for this employee, such as phone numbers or email addresses.
The custom fields for the employee object, added as user-defined data extensions, not included in the standard QuickBooks object.
The employee's department. Found in the "employment job details" section of the employee's record in QuickBooks.
A description of this employee. Found in the "employment job details" section of the employee's record in QuickBooks.
A description of this employee's disability.
Indicates whether this employee is disabled.
disabled, non_disabled The employee's email address.
The employee's emergency contacts.
The employee's payroll information.
The employee type. This affects payroll taxes - a statutory employee is defined as an employee by statute. Note that owners/partners are typically on the "Other Names" list in QuickBooks, but if listed as an employee their type will be owner.
officer, owner, regular, statutory Indicates whether this employee is a part-time or full-time employee.
full_time, part_time This employee's ethnicity.
american_indian, asian, black, hawaiian, hispanic, white, two_or_more_races A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.
The employee's fax number.
The employee's first name.
This employee's gender.
male, female The date this employee was hired, in ISO 8601 format (YYYY-MM-DD).
Indicates whether this employee's I-9 is on file.
on_file, not_on_file The unique identifier assigned by QuickBooks to this employee. This ID is unique across all employees but not across different QuickBooks object types.
Indicates whether this employee is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.
The employee's job title.
Indicates whether this employee is a key employee.
key_employee, non_key_employee The employee's last name.
The employee's middle name.
This employee's military status if they are a U.S. veteran.
active, reserve The employee's mobile phone number.
The case-insensitive unique name of this employee, unique across all employees. A concatenation of the employee's firstName, middleName, and lastName fields.
NOTE: Employees do not have a fullName field because they are not hierarchical objects, which is why name is unique for them but not for objects that have parents.
A note or comment about this employee.
The type of object. This value is always "qbd_employee".
"qbd_employee"The original hire date for this employee, in ISO 8601 format (YYYY-MM-DD).
Indicates whether this employee is exempt from overtime pay. This classification is based on U.S. labor laws (FLSA).
exempt, non_exempt The employee's pager number.
The employee's pager PIN.
The employee's primary telephone number.
The name to use when printing this employee from QuickBooks. By default, this is the same as the name field.
The current QuickBooks-assigned revision number of this employee object, which changes each time the object is modified. When updating this object, you must provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.
The employee's formal salutation title that precedes their name, such as "Mr.", "Ms.", or "Dr.".
The employee's Social Security Number. The value can be with or without dashes.
NOTE: This field cannot be changed after the employee is created.
The employee's supervisor. Found in the "employment job details" section of the employee's record in QuickBooks.
The target bonus for this employee, represented as a decimal string. Found in the "employment job details" section of the employee's record in QuickBooks.
The date this employee's employment ended with the company, in ISO 8601 format (YYYY-MM-DD). This is also known as the released date or separation date.
The date and time when this employee was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.
Indicates whether this employee is a U.S. citizen.
citizen, non_citizen Indicates whether this employee is a U.S. veteran.
veteran, non_veteran The date this employee's work authorization expires, in ISO 8601 format (YYYY-MM-DD).