Employees

Columns

Name

Type

ReadOnly

References

Filterable

Sortable

Description

Id [KEY]

String

True

true

true

The Id of the employee.

SyncToken

String

True

false

false

Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online.

MetaData_CreateTime

Datetime

True

true

true

The time the record was created.

MetaData_LastUpdatedTime

Datetime

True

true

true

The time the record was last updated.

Organization

Boolean

False

false

false

This field indicates whether the entity represents an organization or a person.

Title

String

False

false

false

The title of the employee. The employee can have zero or more titles. This field supports all i18n locales.

EmployeeNumber

String

False

true

true

The employee number in the directory of the employer.

GivenName

String

False

true

true

The given name or first name of the employee.

MiddleName

String

False

true

true

The middle name of the employee. The person can have zero or more middle names.

FamilyName

String

False

true

true

The family name or last name of the employee.

Suffix

String

False

false

false

The suffix of the name of the employee.

DisplayName

String

False

true

false

The name of the person or organization as displayed. This field is required.

PrintOnCheckName

String

False

false

false

The name of the employee as it should appear on a check.

Active

Boolean

False

true

false

This field sets whether this entity is currently enabled for use.

Mobile_FreeFormNumber

String

False

false

false

The mobile phone number.

PrimaryEmailAddr_Address

String

False

false

false

The primary email address.

PrimaryAddr_Id

String

False

false

false

The Id of the entity for the address, mainly used for modifying the address. This value is assigned by the data service.

PrimaryAddr_Line1

String

False

false

false

First line of the address.

PrimaryAddr_Line2

String

False

false

false

Second line of the address.

PrimaryAddr_Line3

String

False

false

false

Third line of the address.

PrimaryAddr_Line4

String

False

false

false

Fourth line of the address.

PrimaryAddr_Line5

String

False

false

false

Fifth line of the address.

PrimaryAddr_City

String

False

false

false

City name.

PrimaryAddr_Country

String

False

false

false

Country name.

PrimaryAddr_CountrySubDivisionCode

String

False

false

false

Region within a country. The state name for the USA or the province name for Canada.

PrimaryAddr_PostalCode

String

False

false

false

Postal code. The zip code for the USA and Canada.

PrimaryAddr_Note

String

False

false

false

Note for the customer.

PrimaryAddr_Lat

String

False

false

false

The latitude coordinate of the geocoded address.

PrimaryAddr_Long

String

False

false

false

The longitude coordinate of the geocoded address.

SSN

String

False

false

false

The social security number (SSN) of the employee. If SSN is set, it is masked in the response with XXX-XX-XXXX. If XXX-XX-XXXX is sent in the create or update request, XXX-XX-XXXX is ignored and the old value is preserved.

BillableTime

Boolean

False

false

false

This field indicates whether the employee is eligible for billable time.

BillRate

Double

False

false

false

This field is available only if BillableTime is true. This field is not required, even if BillableTime is true.

HiredDate

Date

False

false

false

The hire date of the employee.

ReleasedDate

Date

False

false

false

The release date of the employee.

BirthDate

Date

False

false

false

The birth date of the employee.

Gender

String

False

false

false

The gender of the employee. To clear the gender value, set this field to Null in a full update request.

The allowed values are Male, Female.

Last updated