Employees
Create, update, delete, and query QuickBooks Employees.
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 |
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. |