Employee in HRM(HcmEmployeeEntity)

Latest version of the JSON entity definition is available on GitHub.

Traits

Traits for this entity are listed below.

is.CDM.entityVersion

Parameter	Value	Data type	Explanation
versionNumber	"1.1"	string	semantic version number of the entity

is.application.releaseVersion

Parameter	Value	Data type	Explanation
releaseVersion	"10.0.13.0"	string	semantic version number of the application introducing this entity

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Employee	entity	a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
PersonnelNumber		HRM/HcmEmployeeEntity
Person		HRM/HcmEmployeeEntity
PartyNumber		HRM/HcmEmployeeEntity
KnownAs		HRM/HcmEmployeeEntity
LanguageId		HRM/HcmEmployeeEntity
Name		HRM/HcmEmployeeEntity
NameAlias		HRM/HcmEmployeeEntity
PhoneticFirstName		HRM/HcmEmployeeEntity
PhoneticLastName		HRM/HcmEmployeeEntity
PhoneticMiddleName		HRM/HcmEmployeeEntity
PrimaryAddressLocation		HRM/HcmEmployeeEntity
PrimaryContactEmail		HRM/HcmEmployeeEntity
PrimaryContactEmailDescription		HRM/HcmEmployeeEntity
PrimaryContactEmailIsIM		HRM/HcmEmployeeEntity
PrimaryContactEmailIsPrivate		HRM/HcmEmployeeEntity
PrimaryContactEmailPurpose		HRM/HcmEmployeeEntity
PrimaryContactFax		HRM/HcmEmployeeEntity
PrimaryContactFaxDescription		HRM/HcmEmployeeEntity
PrimaryContactFaxExtension		HRM/HcmEmployeeEntity
PrimaryContactFaxIsPrivate		HRM/HcmEmployeeEntity
PrimaryContactFaxPurpose		HRM/HcmEmployeeEntity
PrimaryContactPhone		HRM/HcmEmployeeEntity
PrimaryContactPhoneDescription		HRM/HcmEmployeeEntity
PrimaryContactPhoneExtension		HRM/HcmEmployeeEntity
PrimaryContactPhoneIsMobile		HRM/HcmEmployeeEntity
PrimaryContactPhoneIsPrivate		HRM/HcmEmployeeEntity
PrimaryContactPhonePurpose		HRM/HcmEmployeeEntity
PrimaryContactURL		HRM/HcmEmployeeEntity
PrimaryContactURLDescription		HRM/HcmEmployeeEntity
PrimaryContactURLIsPrivate		HRM/HcmEmployeeEntity
PrimaryContactURLPurpose		HRM/HcmEmployeeEntity
PrimaryContactFacebook		HRM/HcmEmployeeEntity
PrimaryContactFacebookDescription		HRM/HcmEmployeeEntity
PrimaryContactFacebookIsPrivate		HRM/HcmEmployeeEntity
PrimaryContactFacebookPurpose		HRM/HcmEmployeeEntity
PrimaryContactLinkedIn		HRM/HcmEmployeeEntity
PrimaryContactLinkedInDescription		HRM/HcmEmployeeEntity
PrimaryContactLinkedInIsPrivate		HRM/HcmEmployeeEntity
PrimaryContactLinkedInPurpose		HRM/HcmEmployeeEntity
PrimaryContactTwitter		HRM/HcmEmployeeEntity
PrimaryContactTwitterDescription		HRM/HcmEmployeeEntity
PrimaryContactTwitterIsPrivate		HRM/HcmEmployeeEntity
PrimaryContactTwitterPurpose		HRM/HcmEmployeeEntity
ProfessionalSuffix		HRM/HcmEmployeeEntity
ProfessionalTitle		HRM/HcmEmployeeEntity
PersonalTitle		HRM/HcmEmployeeEntity
PersonalSuffix		HRM/HcmEmployeeEntity
Title		HRM/HcmEmployeeEntity
TitleId		HRM/HcmEmployeeEntity
OriginalHireDateTime		HRM/HcmEmployeeEntity
SeniorityDate		HRM/HcmEmployeeEntity
AnniversaryDateTime		HRM/HcmEmployeeEntity
OfficeLocation		HRM/HcmEmployeeEntity
OfficeLocationId		HRM/HcmEmployeeEntity
SummaryValidFrom		HRM/HcmEmployeeEntity
SummaryValidTo		HRM/HcmEmployeeEntity
BirthDate		HRM/HcmEmployeeEntity
CitizenshipCountryRegion		HRM/HcmEmployeeEntity
NationalityCountryRegion		HRM/HcmEmployeeEntity
DeceasedDate		HRM/HcmEmployeeEntity
DisabledVerificationDate		HRM/HcmEmployeeEntity
Education		HRM/HcmEmployeeEntity
EthnicOrigin		HRM/HcmEmployeeEntity
EthnicOriginId		HRM/HcmEmployeeEntity
FatherBirthCountryRegion		HRM/HcmEmployeeEntity
Gender		HRM/HcmEmployeeEntity
IsDisabled		HRM/HcmEmployeeEntity
IsFulltimeStudent		HRM/HcmEmployeeEntity
MotherBirthCountryRegion		HRM/HcmEmployeeEntity
NativeLanguage		HRM/HcmEmployeeEntity
NativeLanguageId		HRM/HcmEmployeeEntity
PersonBirthCountryRegion		HRM/HcmEmployeeEntity
PersonBirthCity		HRM/HcmEmployeeEntity
IsDisabledVeteran		HRM/HcmEmployeeEntity
IsExpatriateRulingApplicable		HRM/HcmEmployeeEntity
ExpatriateRulingValidFrom		HRM/HcmEmployeeEntity
ExpatriateRulingValidTo		HRM/HcmEmployeeEntity
MaritalStatus		HRM/HcmEmployeeEntity
NumberOfDependents		HRM/HcmEmployeeEntity
MilitaryServiceStartDate		HRM/HcmEmployeeEntity
MilitaryServiceEndDate		HRM/HcmEmployeeEntity
VeteranStatus		HRM/HcmEmployeeEntity
VeteranStatusId		HRM/HcmEmployeeEntity
PersonDetailsValidFrom		HRM/HcmEmployeeEntity
PersonDetailsValidTo		HRM/HcmEmployeeEntity
AddressBooks		HRM/HcmEmployeeEntity
AddressCity		HRM/HcmEmployeeEntity
AddressCountryRegionId		HRM/HcmEmployeeEntity
AddressCountryRegionISOCode		HRM/HcmEmployeeEntity
AddressCounty		HRM/HcmEmployeeEntity
AddressDistrictName		HRM/HcmEmployeeEntity
AddressLocationId		HRM/HcmEmployeeEntity
AddressLocationRoles		HRM/HcmEmployeeEntity
AddressNameDescription		HRM/HcmEmployeeEntity
AddressState		HRM/HcmEmployeeEntity
AddressStreet		HRM/HcmEmployeeEntity
AddressZipCode		HRM/HcmEmployeeEntity
AddressValidFrom		HRM/HcmEmployeeEntity
AddressValidTo		HRM/HcmEmployeeEntity
FirstName		HRM/HcmEmployeeEntity
MiddleName		HRM/HcmEmployeeEntity
LastNamePrefix		HRM/HcmEmployeeEntity
LastName		HRM/HcmEmployeeEntity
NameValidFrom		HRM/HcmEmployeeEntity
NameValidTo		HRM/HcmEmployeeEntity
PartyType		HRM/HcmEmployeeEntity
NameSequenceDisplayAs		HRM/HcmEmployeeEntity
EmploymentStartDate		HRM/HcmEmployeeEntity
EmploymentEndDate		HRM/HcmEmployeeEntity
EmploymentLegalEntity		HRM/HcmEmployeeEntity
EmploymentLegalEntityId		HRM/HcmEmployeeEntity
RegulatoryEstablishment		HRM/HcmEmployeeEntity
RegulatoryEstablishmentId		HRM/HcmEmployeeEntity
StartDate		HRM/HcmEmployeeEntity
AdjustedWorkerStartDate		HRM/HcmEmployeeEntity
LastDateWorked		HRM/HcmEmployeeEntity
TerminationReason		HRM/HcmEmployeeEntity
TerminationReasonCodeId		HRM/HcmEmployeeEntity
TerminationDate		HRM/HcmEmployeeEntity
EmploymentNoticeEmployerQuantity		HRM/HcmEmployeeEntity
EmploymentNoticeEmployerUnit		HRM/HcmEmployeeEntity
EmploymentNoticeWorkerQuantity		HRM/HcmEmployeeEntity
EmploymentNoticeWorkerUnit		HRM/HcmEmployeeEntity
EmploymentDetailsEffective		HRM/HcmEmployeeEntity
EmploymentDetailsExpiration		HRM/HcmEmployeeEntity
PensionEnrollment		HRM/HcmEmployeeEntity
PensionStart		HRM/HcmEmployeeEntity
ProbationPeriod		HRM/HcmEmployeeEntity
RelocationReimbursement		HRM/HcmEmployeeEntity
EmployeeDetailsEffective		HRM/HcmEmployeeEntity
EmployeeDetailsExpiration		HRM/HcmEmployeeEntity
Dimension		HRM/HcmEmployeeEntity
DimensionDisplayValue		HRM/HcmEmployeeEntity
ElectronicLocationId		HRM/HcmEmployeeEntity
AllowRehire		HRM/HcmEmployeeEntity
WorksFromHome		HRM/HcmEmployeeEntity
CalendarId		HRM/HcmEmployeeEntity
CalendarDataAreaId		HRM/HcmEmployeeEntity
Relationship_TitleRelationshipId		HRM/HcmEmployeeEntity
Relationship_LanguageRelationshipId		HRM/HcmEmployeeEntity
Relationship_PersonRelationshipId		HRM/HcmEmployeeEntity
Relationship_EthnicOriginRelationshipId		HRM/HcmEmployeeEntity
Relationship_WorkerRelationshipId		HRM/HcmEmployeeEntity
Relationship_WorkCalendarRelationshipId		HRM/HcmEmployeeEntity

PersonnelNumber

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PersonnelNumber attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

Person

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the Person attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PartyNumber

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PartyNumber attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

KnownAs

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the KnownAs attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

LanguageId

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the LanguageId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

Name

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the Name attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

NameAlias

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the NameAlias attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PhoneticFirstName

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PhoneticFirstName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PhoneticLastName

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PhoneticLastName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PhoneticMiddleName

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PhoneticMiddleName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryAddressLocation

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryAddressLocation attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactEmail

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactEmail attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactEmailDescription

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactEmailDescription attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactEmailIsIM

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactEmailIsIM attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactEmailIsPrivate

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactEmailIsPrivate attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactEmailPurpose

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactEmailPurpose attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactFax

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactFax attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactFaxDescription

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactFaxDescription attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactFaxExtension

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactFaxExtension attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactFaxIsPrivate

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactFaxIsPrivate attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactFaxPurpose

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactFaxPurpose attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactPhone

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactPhone attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactPhoneDescription

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactPhoneDescription attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactPhoneExtension

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactPhoneExtension attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactPhoneIsMobile

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactPhoneIsMobile attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactPhoneIsPrivate

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactPhoneIsPrivate attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactPhonePurpose

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactPhonePurpose attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactURL

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactURL attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactURLDescription

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactURLDescription attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactURLIsPrivate

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactURLIsPrivate attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactURLPurpose

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactURLPurpose attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactFacebook

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactFacebook attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactFacebookDescription

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactFacebookDescription attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactFacebookIsPrivate

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactFacebookIsPrivate attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactFacebookPurpose

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactFacebookPurpose attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactLinkedIn

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactLinkedIn attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactLinkedInDescription

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactLinkedInDescription attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactLinkedInIsPrivate

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactLinkedInIsPrivate attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactLinkedInPurpose

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactLinkedInPurpose attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactTwitter

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactTwitter attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactTwitterDescription

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactTwitterDescription attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactTwitterIsPrivate

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactTwitterIsPrivate attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PrimaryContactTwitterPurpose

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PrimaryContactTwitterPurpose attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

ProfessionalSuffix

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the ProfessionalSuffix attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

ProfessionalTitle

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the ProfessionalTitle attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PersonalTitle

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PersonalTitle attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PersonalSuffix

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PersonalSuffix attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

Title

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the Title attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

TitleId

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the TitleId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

OriginalHireDateTime

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the OriginalHireDateTime attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

SeniorityDate

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the SeniorityDate attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

AnniversaryDateTime

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the AnniversaryDateTime attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

OfficeLocation

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the OfficeLocation attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

OfficeLocationId

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the OfficeLocationId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

SummaryValidFrom

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
displayName	Summary effective
dataFormat	string
isNullable	true

Traits

List of traits for the SummaryValidFrom attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Summary effective	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

SummaryValidTo

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
displayName	Summary expiration
dataFormat	string
isNullable	true

Traits

List of traits for the SummaryValidTo attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Summary expiration	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

BirthDate

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the BirthDate attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

CitizenshipCountryRegion

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the CitizenshipCountryRegion attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

NationalityCountryRegion

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the NationalityCountryRegion attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

DeceasedDate

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the DeceasedDate attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

DisabledVerificationDate

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the DisabledVerificationDate attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

Education

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the Education attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

EthnicOrigin

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the EthnicOrigin attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

EthnicOriginId

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the EthnicOriginId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

FatherBirthCountryRegion

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the FatherBirthCountryRegion attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

Gender

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the Gender attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

IsDisabled

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the IsDisabled attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

IsFulltimeStudent

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the IsFulltimeStudent attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

MotherBirthCountryRegion

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the MotherBirthCountryRegion attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

NativeLanguage

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the NativeLanguage attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

NativeLanguageId

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
displayName	Native language
dataFormat	string
isNullable	true

Traits

List of traits for the NativeLanguageId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Native language	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

PersonBirthCountryRegion

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PersonBirthCountryRegion attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PersonBirthCity

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PersonBirthCity attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

IsDisabledVeteran

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the IsDisabledVeteran attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

IsExpatriateRulingApplicable

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the IsExpatriateRulingApplicable attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

ExpatriateRulingValidFrom

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the ExpatriateRulingValidFrom attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

ExpatriateRulingValidTo

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the ExpatriateRulingValidTo attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

MaritalStatus

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the MaritalStatus attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

NumberOfDependents

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the NumberOfDependents attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

MilitaryServiceStartDate

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the MilitaryServiceStartDate attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

MilitaryServiceEndDate

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the MilitaryServiceEndDate attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

VeteranStatus

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the VeteranStatus attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

VeteranStatusId

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the VeteranStatusId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PersonDetailsValidFrom

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
displayName	Personal information effective
dataFormat	string
isNullable	true

Traits

List of traits for the PersonDetailsValidFrom attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Personal information effective	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

PersonDetailsValidTo

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
displayName	Personal information expiration
dataFormat	string
isNullable	true

Traits

List of traits for the PersonDetailsValidTo attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Personal information expiration	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

AddressBooks

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
displayName	Address books
dataFormat	string
isNullable	true

Traits

List of traits for the AddressBooks attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Address books	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

AddressCity

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the AddressCity attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

AddressCountryRegionId

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the AddressCountryRegionId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

AddressCountryRegionISOCode

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the AddressCountryRegionISOCode attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

AddressCounty

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the AddressCounty attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

AddressDistrictName

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the AddressDistrictName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

AddressLocationId

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the AddressLocationId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

AddressLocationRoles

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
displayName	Address purpose
dataFormat	string
isNullable	true

Traits

List of traits for the AddressLocationRoles attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Address purpose	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

AddressNameDescription

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
displayName	Address name or description
dataFormat	string
isNullable	true

Traits

List of traits for the AddressNameDescription attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Address name or description	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

AddressState

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the AddressState attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

AddressStreet

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the AddressStreet attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

AddressZipCode

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the AddressZipCode attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

AddressValidFrom

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
displayName	Address effective
dataFormat	string
isNullable	true

Traits

List of traits for the AddressValidFrom attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Address effective	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

AddressValidTo

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
displayName	Address expiration
dataFormat	string
isNullable	true

Traits

List of traits for the AddressValidTo attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Address expiration	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

FirstName

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the FirstName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

MiddleName

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the MiddleName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

LastNamePrefix

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the LastNamePrefix attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

LastName

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the LastName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

NameValidFrom

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
displayName	Name change effective
dataFormat	string
isNullable	true

Traits

List of traits for the NameValidFrom attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Name change effective	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

NameValidTo

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
displayName	Name change expiration
dataFormat	string
isNullable	true

Traits

List of traits for the NameValidTo attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Name change expiration	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

PartyType

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PartyType attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

NameSequenceDisplayAs

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the NameSequenceDisplayAs attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

EmploymentStartDate

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the EmploymentStartDate attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

EmploymentEndDate

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the EmploymentEndDate attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

EmploymentLegalEntity

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the EmploymentLegalEntity attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

EmploymentLegalEntityId

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the EmploymentLegalEntityId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

RegulatoryEstablishment

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the RegulatoryEstablishment attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

RegulatoryEstablishmentId

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the RegulatoryEstablishmentId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

StartDate

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the StartDate attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

AdjustedWorkerStartDate

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the AdjustedWorkerStartDate attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

LastDateWorked

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the LastDateWorked attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

TerminationReason

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the TerminationReason attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

TerminationReasonCodeId

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the TerminationReasonCodeId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

TerminationDate

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the TerminationDate attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

EmploymentNoticeEmployerQuantity

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the EmploymentNoticeEmployerQuantity attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

EmploymentNoticeEmployerUnit

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the EmploymentNoticeEmployerUnit attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

EmploymentNoticeWorkerQuantity

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the EmploymentNoticeWorkerQuantity attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

EmploymentNoticeWorkerUnit

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the EmploymentNoticeWorkerUnit attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

EmploymentDetailsEffective

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
displayName	Employment detail effective
dataFormat	string
isNullable	true

Traits

List of traits for the EmploymentDetailsEffective attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Employment detail effective	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

EmploymentDetailsExpiration

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
displayName	Employment detail expiraton
dataFormat	string
isNullable	true

Traits

List of traits for the EmploymentDetailsExpiration attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Employment detail expiraton	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

PensionEnrollment

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PensionEnrollment attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

PensionStart

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PensionStart attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

ProbationPeriod

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the ProbationPeriod attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

RelocationReimbursement

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the RelocationReimbursement attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

EmployeeDetailsEffective

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
displayName	Employee detail effective
dataFormat	string
isNullable	true

Traits

List of traits for the EmployeeDetailsEffective attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Employee detail effective	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

EmployeeDetailsExpiration

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
displayName	Employee detail expiration
dataFormat	string
isNullable	true

Traits

List of traits for the EmployeeDetailsExpiration attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Employee detail expiration	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

Dimension

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the Dimension attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

DimensionDisplayValue

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the DimensionDisplayValue attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

ElectronicLocationId

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the ElectronicLocationId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

AllowRehire

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the AllowRehire attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

WorksFromHome

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the WorksFromHome attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

CalendarId

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the CalendarId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

CalendarDataAreaId

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the CalendarDataAreaId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

Relationship_TitleRelationshipId

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_TitleRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	empty table	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_LanguageRelationshipId

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_LanguageRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	empty table	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_PersonRelationshipId

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_PersonRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	empty table	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_EthnicOriginRelationshipId

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_EthnicOriginRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	empty table	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_WorkerRelationshipId

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_WorkerRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	empty table	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_WorkCalendarRelationshipId

First included in: HRM/HcmEmployeeEntity (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_WorkCalendarRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	empty table	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array