id
string
required

The unique identifier assigned by QuickBooks to this employee. This ID is unique across all employees but not across different QuickBooks object types.

objectType
string
required

The type of object. This value is always "qbd_employee".

Allowed value: "qbd_employee"
createdAt
string
required

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.

updatedAt
string
required

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.

revisionNumber
string
required

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.

name
string
required

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.

isActive
boolean
required

Indicates whether this employee is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

salutation
string | null
required

The employee's formal salutation title that precedes their name, such as "Mr.", "Ms.", or "Dr.".

firstName
string | null
required

The employee's first name.

middleName
string | null
required

The employee's middle name.

lastName
string | null
required

The employee's last name.

jobTitle
string | null
required

The employee's job title.

supervisor
object | null
required

The employee's supervisor. Found in the "employment job details" section of the employee's record in QuickBooks.

department
string | null
required

The employee's department. Found in the "employment job details" section of the employee's record in QuickBooks.

description
string | null
required

A description of this employee. Found in the "employment job details" section of the employee's record in QuickBooks.

targetBonus
string | null
required

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.

address
object | null
required

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.

printAs
string | null
required

The name to use when printing this employee from QuickBooks. By default, this is the same as the name field.

phone
string | null
required

The employee's primary telephone number.

mobile
string | null
required

The employee's mobile phone number.

pager
string | null
required

The employee's pager number.

pagerPin
string | null
required

The employee's pager PIN.

alternatePhone
string | null
required

The employee's alternate telephone number.

fax
string | null
required

The employee's fax number.

ssn
string | null
required

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.

email
string | null
required

The employee's email address.

customContactFields
object[]
required

Additional custom contact fields for this employee, such as phone numbers or email addresses.

emergencyContact
object | null
required

The employee's emergency contacts.

employeeType
enum<string> | null
required

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.

Available options:
officer,
owner,
regular,
statutory
employmentStatus
enum<string> | null
required

Indicates whether this employee is a part-time or full-time employee.

Available options:
full_time,
part_time
overtimeExemptStatus
enum<string> | null
required

Indicates whether this employee is exempt from overtime pay. This classification is based on U.S. labor laws (FLSA).

Available options:
exempt,
non_exempt
keyEmployeeStatus
enum<string> | null
required

Indicates whether this employee is a key employee.

Available options:
key_employee,
non_key_employee
gender
enum<string> | null
required

This employee's gender.

Available options:
male,
female
hiredDate
string | null
required

The date this employee was hired, in ISO 8601 format (YYYY-MM-DD).

originalHireDate
string | null
required

The original hire date for this employee, in ISO 8601 format (YYYY-MM-DD).

adjustedServiceDate
string | null
required

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.

terminationDate
string | null
required

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.

birthDate
string | null
required

This employee's date of birth, in ISO 8601 format (YYYY-MM-DD).

usCitizenshipStatus
enum<string> | null
required

Indicates whether this employee is a U.S. citizen.

Available options:
citizen,
non_citizen
ethnicity
enum<string> | null
required

This employee's ethnicity.

Available options:
american_indian,
asian,
black,
hawaiian,
hispanic,
white,
two_or_more_races
disabilityStatus
enum<string> | null
required

Indicates whether this employee is disabled.

Available options:
disabled,
non_disabled
disabilityDescription
string | null
required

A description of this employee's disability.

i9OnFileStatus
enum<string> | null
required

Indicates whether this employee's I-9 is on file.

Available options:
on_file,
not_on_file
workAuthorizationExpirationDate
string | null
required

The date this employee's work authorization expires, in ISO 8601 format (YYYY-MM-DD).

usVeteranStatus
enum<string> | null
required

Indicates whether this employee is a U.S. veteran.

Available options:
veteran,
non_veteran
militaryStatus
enum<string> | null
required

This employee's military status if they are a U.S. veteran.

Available options:
active,
reserve
accountNumber
string | null
required

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.

note
string | null
required

A note or comment about this employee.

additionalNotes
object[]
required

Additional notes about this employee.

billingRate
object | null
required

The employee's billing rate, used to override service item rates in time tracking transactions.

employeePayroll
object | null
required

The employee's payroll information.

externalId
string | null
required

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.

customFields
object[]
required

The custom fields for the employee object, added as user-defined data extensions, not included in the standard QuickBooks object.