Employees

Stores employee records for payroll and HR functions, including contact details, hire dates, and status that are used in time tracking and expense reporting.

Table Specific Information

Select

All filterable columns support the following operators:

=
!=
>=
<=
>
<
IN
LIKE
CONTAINS

The driver processes other filters client-side within the driver.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	Specifies the unique identifier (Id) of the employee.
SyncToken	String	True		False	False	Specifies the version number that is used to lock the employee object for use by one application at a time. When an application modifies an object, its sync token is incremented. Attempts to modify an object with an older sync token fail.
MetaData_CreateTime	Datetime	True		True	True	Specifies the date and time when the employee record was created in the source domain.
MetaData_LastUpdatedTime	Datetime	True		True	True	Specifies the date and time when the employee record was last updated in the source domain.
Organization	Boolean	False		False	False	Indicates whether the entity represents an organization or a person.
Title	String	False		False	False	Specifies the title of the employee. The employee can have zero or more titles. This field supports all international locales.
EmployeeNumber	String	False		False	False	Specifies the employee number in the employer's directory.
GivenName	String	False		True	True	Specifies the given name or first name of the employee.
MiddleName	String	False		True	True	Specifies the middle name of the employee. The employee can have zero or more middle names.
FamilyName	String	False		True	True	Specifies the family name or last name of the employee.
Suffix	String	False		False	False	Specifies the suffix of the employee's name.
DisplayName	String	False		True	False	Specifies the name of the person or organization as displayed. This field is required.
PrintOnCheckName	String	False		False	False	Specifies the name of the employee as it should appear on a check.
Active	Boolean	False		True	False	Indicates whether the employee entity is currently enabled for use.
Mobile_FreeFormNumber	String	False		False	False	Specifies the mobile phone number of the employee.
PrimaryEmailAddr_Address	String	False		False	False	Specifies the primary email address of the employee.
PrimaryAddr_Id	String	False		False	False	Specifies the unique Id of the entity for the primary address, mainly used for modifying the address.
PrimaryAddr_Line1	String	False		False	False	Specifies the first line of the primary address.
PrimaryAddr_Line2	String	False		False	False	Specifies the second line of the primary address.
PrimaryAddr_Line3	String	False		False	False	Specifies the third line of the primary address.
PrimaryAddr_Line4	String	False		False	False	Specifies the fourth line of the primary address.
PrimaryAddr_Line5	String	False		False	False	Specifies the fifth line of the primary address.
PrimaryAddr_City	String	False		False	False	Specifies the city name of the primary address.
PrimaryAddr_Country	String	False		False	False	Specifies the country name of the primary address.
PrimaryAddr_CountrySubDivisionCode	String	False		False	False	Specifies the region within the country of the primary address. This field represents the state name for the USA or the province name for Canada.
PrimaryAddr_PostalCode	String	False		False	False	Specifies the postal code of the primary address. This field represents the ZIP code for the USA and the postal code for Canada.
PrimaryAddr_Lat	String	False		False	False	Specifies the latitude coordinate of the geocoded primary address.
PrimaryAddr_Long	String	False		False	False	Specifies the longitude coordinate of the geocoded primary address.
SSN	String	False		False	False	Specifies the Social Security Number (SSN) of the employee. When returned in a response, the SSN is masked with XXX-XX-XXXX. If XXX-XX-XXXX is sent in a create or update request, it is ignored and the old value is preserved.
BillableTime	Boolean	False		False	False	Indicates whether the employee is eligible for billable time.
BillRate	Double	False		False	False	Specifies the employee's billing rate. This field is available only when the BillableTime attribute is true and is not required, even when BillableTime is true.
HiredDate	Date	False		False	False	Specifies the hire date of the employee.
ReleasedDate	Date	False		False	False	Specifies the release date of the employee.
BirthDate	Date	False		False	False	Specifies the birth date of the employee.
Gender	String	False		False	False	Specifies 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.
CostRate	Decimal	False		False	False	Specifies the pay rate of the employee.
PrimaryPhoneFreeFormNumber	String	False		False	False	Specifies the primary telephone number of the employee in free form.
V4IDPseudonym	String	True		False	False	Specifies the internal employee reference number. This field is for internal use only.

MCP Server for QuickBooks Online

Employees

Table Specific Information

Select

Columns