# Employees

## Content



| **Name** | **Type** | **ReadOnly** | **Filterable** | **Description** |
| --- | --- | --- | --- | --- |
| Id [KEY\] | string | true | true | The Id of the employee. |
| SyncToken | string | false | false | The sync token. This must be specified when executing an update or delete. |
| MetaData\_CreateTime | datetime | true | true | The time the record was created. |
| MetaData\_LastUpdatedTime | datetime | true | true | The time the record was last updated. |
| Organization | boolean | false | false | This field indicates whether the entity represents an organization or a person. |
| Title | string | 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 | The employee number is in the directory of the employer. |
| GivenName | string | false | true | The given name or first name of the employee. |
| MiddleName | string | false | true | The middle name of the employee. The person can have zero or more middle names. |
| FamilyName | string | false | true | The family name or last name of the employee. |
| Suffix | string | false | false | The suffix of the name of the employee. |
| DisplayName | string | false | true | The name of the person or organization is displayed. This field is required. |
| PrintOnCheckName | string | false | false | The name of the employee as it should appear on a check. |
| Active | boolean | false | true | This field sets whether this entity is currently enabled for use. |
| Mobile\_FreeFormNumber | string | false | false | The mobile phone number. |
| PrimaryEmailAddr\_Address | string | false | false | The primary email address. |
| PrimaryAddr\_Id | string | false | false | The Id of the entity for the address, is mainly used for modifying the address. This value is assigned by the data service. |
| PrimaryAddr\_Line1 | string | false | false | The first line of the address. |
| PrimaryAddr\_Line2 | string | false | false | The second line of the address. |
| PrimaryAddr\_Line3 | string | false | false | Third line of the address. |
| PrimaryAddr\_Line4 | string | false | false | The fourth line of the address. |
| PrimaryAddr\_Line5 | string | false | false | The fifth line of the address. |
| PrimaryAddr\_City | string | false | false | City name. |
| PrimaryAddr\_Country | string | false | false | Country name. |
| PrimaryAddr\_CountrySubDivisionCode | string | false | false | Region within a country. The state name for the USA or the province name for Canada. |
| PrimaryAddr\_PostalCode | string | false | false | Postal code. The zip code for the USA and Canada. |
| PrimaryAddr\_Note | string | false | false | Note for the customer. |
| PrimaryAddr\_Lat | string | false | false | The latitude coordinate of the geocoded address. |
| PrimaryAddr\_Long | string | false | false | The longitude coordinate of the geocoded address. |
| SSN | string | 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 | This field indicates whether the employee is eligible for billable time. |
| BillRate | double | 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 | The hire date of the employee. |
| ReleasedDate | date | false | false | The release date of the employee. |
| BirthDate | date | false | false | The birth date of the employee. |
| Gender | string | false | false | The gender of the employee. To clear the gender value, set this field to Null in a full update request. |