Data foundation entities

This article details each entity and all of the fields that it contains, with mentions of mandatory fields within each entity. You must populate the entities with the data from your HRIS system to be able to import your data into the beqom Pay Suite data foundation and start using the platform.

This is a warning message.

The entity file names as well as the field names within the files are case-sensitive. Using the incorrect case will result in a failure of the ingestion attempt. Make sure you respect the case outlined in this document.

Migrating to the latest version

Additional variations are now available for each record in the following entities:

• IndividualPayRange:

  • Min/max pairing: PayRangeMin - PayRangeMax, BenchmarkRangeMin - BenchmarkRangeMax

  • Range ordering: Min < Max for both PayRange and BenchmarkRange

  • The Currency field is now required if any amount field is used

• PayScale:

  • Min/max pairing: PayRangeMin - PayRangeMax

  • Range ordering: Min < Max

  • The PayRangeCurrency field is now required if any amount field is used

• The following new entities and enums are now available:

  • ContractedCompensation

  • PaidCompensation

  • AmountSource

This is an note/information message.

The CompensationHistory entity is still available but beqom recommend that the data is migrated to ContractedCompensation and PaidCompensation as soon as possible. After the migration, the entity is no longer available.

For any new implementation, the ContractedCompensation and the PaidCompensation entities should be used immediately.

Overview

The Pay Suite data foundation is comprised of seventeen entities (17) and thirty-five (35) enums. The following table lists the seventeen entities of the data foundation, with their effective dating type and their unique key(s):

List of data foundation enums

Entities marked with * are in the process of being deprecated and should not be used for new data implementations. For more information, see Legacy entities.

Entity name	Effective dating	Unique key(s)	Reference
Worker	None	ExternalId	Worker entity details
Employment	Effective Date	WorkerExternalId	Employment entity details
Organization	None	ExternalId	Organization entity details
CompensationElement	None	ExternalId	CompensationElement entity details
CompensationHistory*	Effective Range	Currency CompensationElementExternalId	CompensationHistory entity details
Demographics	Effective Date	WorkerExternalId	Demographics entity details
PayScale	None	ExternalId	PayScale entity details
CostCenter	None	ExternalId	CostCenter entity details
JobArchitecture	None	ExternalId	JobArchitecture entity details
Absence	Effective Range	WorkerExternalId AbsenceType	Absence entity details
PerformanceRatingScales	None	ExternalId	PerformanceRatingScales entity details
PerformanceReviewRating	Effective Range	WorkerExternalId	PerformanceReviewRating entity details
LegalEntity	None	ExternalId	LegalEntity entity details
IndividualPayRange	Effective Date	WorkerExternalId	IndividualPayRange entity details
GoalAchievement*	Effective Range	WorkerExternalId GoalId GoalPlanTypeAssignmentExternalId	GoalAchievement entity details
GoalPlan	None	ExternalId	GoalPlan entity details
GoalPlanTypeAssignment*	None	ExternalId	GoalPlanTypeAssignment entity details
Goal	None	ExternalId	Goal entity details
GoalPlanGoalAssignment	None	ExternalId	GoalPlanGoalAssignment entity details
GoalAchievementNew	Effective range	WorkerExternalId GoalExternalId GoalPlanExternalId	GoalAchievementNew entity details
ContractedCompensation	Effective date	WorkerExternalId	ContractedCompensation entity details
PaidCompensation	Effective range	WorkerExternalId	PaidCompensation entity details

This is a miscellaneous message.

You can view a visual representation of the Data Foundation here:

(missing or bad snippet)

Legacy entities

The following table lists legacy entities in the Data Foundation. These entities should not be used for any new implementation. They are however still supported for backward compatibility purposes.

Entity name	Replaced by	Impact
CompensationHistory	ContractedCompensation PaidCompensation	Passport > Documents Salary + bonus Compensation history drawer Analytics Hub
GoalAchievement	GoalAchievementNew	Bonuses Integration of the Performance Management module with the Data Foundation
GoalPlanTypeAssignment

Worker entity details

The following table describes the fields contained in the Worker entity.

This is an note/information message.

The Worker entity file must be present at each data upload AND must contain data at each upload, for the fields marked as mandatory in the below table.

Worker entity details

Field name	Data type	Required	Description	Data example
ExternalId	String	Yes	Unique identifier of the worker. Usually, it is the employee ID.	000123, ABCDEF
LastName	String	Yes	Last name of the worker.	Smith (for a worker named John Richard Smith West II)
SecondaryLastName	String	No	Additional last name of the worker.	West (for a worker named John Richard Smith West II)
FirstName	String	Yes	First name of the worker.	John (for a worker named John Richard Smith West II)
MiddleName	String	No	Middle name of the worker, if any.	Richard (for a worker named John Richard Smith West II)
PreferredName	String	No	Name by which the worker preferred to be called. Can be a nickname.	Johnny (for a worker named John Richard Smith West II)
HonorificPrefix	String	No	Name prefix to be used for the worker.	Mr, Mrs, Dr, Sir
HonorificSuffix	String	No	Name suffix to be used for the worker.	II (for a worker named John Richard Smith West II)
Pronoun	String	No	Preferred pronoun of the worker.	She/her, he/him, etc.
FirstNameLatin	String	No	First name of the worker in Latin alphabet, if the name of the worker is not in Latin alphabet.
FirstNamePreferredLatin	String	No	Name by which the worker prefers to be called, in Latin alphabet, if the name of the worker is not in Latin alphabet.
LastNameLatin	String	No	Last name of the worker in Latin alphabet, if the name of the worker is not in Latin alphabet.
SecondaryLastNameLatin	String	No	Additional last name of the worker in Latin alphabet, if the name of the worker is not in Latin alphabet.
MiddleNameLatin	String	No	Middle name of the worker in Latin alphabet, if the name of the worker is not in Latin alphabet.
FullNameLatin	String	No	Full name of the worker in Latin alphabet, if the name of the worker is not in Latin alphabet.
PrivateEmail	String	No	Personal email address of the worker. Corresponds to the home/primary address for the User service.	[e-mail]
WorkEmail	String	Yes	Professional email address of the worker. The professional email address must be provided in a valid email format and must be unique.	[e-mail]
WorkPhone	String	No	Professional phone number of the worker.
PrivatePhone	String	No	Personal phone number of worker. Corresponds to the home/primary phone number for the User service.
PreferredLanguage	ISO enum	No	Preferred language of the worker. The language cannot be updated later for the User service. It must be updated by the user in the platform. If not set during data upload, the default language is used, without impact on the user record.
Proficiency	Enum	No	Proficiency of the worker in the preferred language. Proficiency is a customizable enum.
Language2	ISO enum	No	Second language of the worker.
Proficiency2	Enum	No	Proficiency of the worker in the second language. Proficiency is a customizable enum.
Language3	ISO enum	No	Third language of the worker.
Proficiency3	Enum	No	Proficiency of the worker in the third language. Proficiency is a customizable enum.
WorkMailingAddress	String	No	Professional physical mailing address of the worker.	Company Name 15 Street, New York, USA 10001
WorkStreetAddress	String	No	Full street component of the professional address of the worker; multi-line extended street address information.	3rd Floor Company Name Building 15 Street
WorkPostalCode	String	No	Postal code of the professional address of the worker.	10001
WorkTownCity	String	No	City of the professional address of the worker.	New York
WorkRegionState	String	No	Region/state of the professional address of the worker.	New York
WorkCountry	ISO enum	No	Country of the professional address of the worker. Code of the relevant country in the Country enum.
Timezone	ISO enum	No	Time zone in which the worker is located. The time zone cannot be updated later for the User service. It must be updated by the user in the platform. If not set during data upload, the default time zone is used, without impact on the user record.
PrivateMailingAddress	String	No	Personal address of the worker. Home/primary value for the User service.	3rd Street Santa Monica California 90001
PrivateStreetAddress	String	No	Full street component of the personal address of the worker; multi-line extended street address information. Home/primary value for the User service.	Apart 5a 3rd Street
PrivatePostalCode	String	No	Postal code of the personal address of the worker. Home/primary value for the User service.	90001
PrivateTownCity	String	No	City of the personal address of the worker. Home/primary value for the User service.	Santa Monica
PrivateRegionStatePrivateRegionState	String	No	Region/state of the personal address of the worker. Home/primary value for the User service.	California
PrivateCountry	Enum	No	Country of the personal address of the worker. This is an note/information message. Corresponds to the Location field in the population settings of Performance Management. Code of the relevant country in the Country enum.
PhotoId	String	No	ID of the personnel photo of the worker.
ProvisionUserAccount	Boolean	Yes	Indicates whether the user is currently active in the system.
UserName	String	Yes	User name of the worker in the system. This value must be unique.
ProvisionActiveWorker	Boolean	Yes	Indicates whether the worker is currently active.
PerformanceEligibility	Boolean	Yes	Indicates whether the worker is eligible for performance review.
WorkRegion	String	No	Indicates the region in which the worker works.

This is an note/information message.

During IAM synchronization, when the user record is generated, the time zone and the language are set to default time zone and language for the user. In other words, this means that the Timezone and PreferredLanguage fields of the Worker entity are not linked to the behavior of the user settings in the application.

This is a tip message.

You can find an upload file template for the Workerentity attached to this article under the name Worker.csv.

Employment entity details

The following table describes the fields contained in the Employment entity.

This is an note/information message.

The Employment entity file must be present at each data upload and must contain data at each upload, for the fields marked as mandatory in the below table.

Employment entity details

Field name	Data type	Required	Description	Data example
WorkerExternalId	String	Yes	Unique identifier of the worker. ExternalId value of the worker in the Worker entity.	000123, ABCDEF
StartDateInCompany	Date	No	Start date of the employment in the company.	2010-02-01
DateProbationEnds	Date	No	End date of the probation period.	2010-05-01
DateOfDeath	Date	No	Date of death of the worker.
DateRetired	Date	No	Date at which the worker retired.
DateRehire	Date	No	Date at which the worker was rehired.
DateFirstHire	Date	No	Date at which the worker was first hired, if they were rehired.
startDateInJob	Date	No	Date at which the worker started their current position.
DateTermination	Date	No	Date at which the worker left the company.
OrganizationExternalId	String	Yes	Unique ID of the organization to which the worker is associated. Value of the ExternalId field for the relevant record in the Organization entity. Determines the OrganizationItem for the user in IAM service.
LegalEntityExternalId	String	No	Unique ID of the legal entity to which the worker is associated. Value of the ExternalId field for the relevant record in the LegalEntity entity.
CostCenterExternalId	String	No	Unique ID of the cost center to which the worker is attached. Value of the ExternalId field for the relevant record in the CostCenter entity
JobArchitectureExternalId	String	No	Unique ID of the job architecture to which the worker is attached. Value of the ExternalId field for the relevant record in the JobArchitecture entity.
LineManagerId	String	No	Unique ID of the line manager of the worker. Value of the ExternalId field for the relevant manager in the Worker entity Determines who the user reports to in the IAM service.
MatrixManagerId	String	No	Unique ID of the matrix manager of the worker. Value of the ExternalId field for the matrix manager in the Worker entity.
CommunicationManagerId	String	No	Unique ID of the communication manager of the worker. Value of the ExternalId field for the communication manager in the Worker entity.
CompensationManagerId	String	No	Unique ID of the compensation manager of the worker. Value of the ExternalId field for the compensation manager in the Worker entity.
HrBusinessPartnerId	String	No	Unique ID of the HR business partner associated with the worker. Value of the ExternalId field for the HR business partner in the Worker entity.
HomeCountry	ISO enum	No	Country of origin of the worker. Code of the relevant country in the Country ISO enum.
HomeCountryCurrency	ISO enum	No	Currency associated with the country of origin of the worker. Code of the relevant currency in the Currency ISO enum.
PreferredCurrency	Enum	No	Currency in which the worker prefers to be paid. Code of the relevant currency in the Currency ISO enum.
EmploymentStatus	Enum	No	Employment status of the worker within the company. Code of the relevant employment status in the EmploymentStatus enum. To synchronize with the User service, the value used here must be one of the following: EMPLOYEE CONTRACTOR EXPATRIATE APPRENTICE INTERN TRAINEE TEMPORARY THIRDPARTY
ContractType	Enum	No	Type of contract under which the worker is employed. Code of the relevant contract type in the ContractType enum.
ChangeJobReason	String	No	Reason for which the worker changed jobs within the organization.
Fte	Number	No	Full-time equivalent.
WeeklyWorkingHours	Number	No	Number of weekly hours worked by the worker.
ContractWorkingHours	Number	No	Contractual number of weekly working hours for the worker.
MaterialRiskTaker	Boolean	No	Indicates whether the worker's professional activities have a material impact on the risk profile of the company.
GlobalMobilityFlag	String	No	Indicates whether the worker is part of a mobility plan within the organization.
GlobalMobilityId	String	No	Unique mobility ID for the worker.
HostCountryCostCenterExternalId	String	No	ID of the cost center related to the host country if the worker is part of a mobility plan. Value of the ExternalId field for the relevant cost center in the CostCenter entity.
HostCountryLegalEntityExternalId	String	No	ID of the legal entity related to the host country if the worker is part of a mobility plan.
HostAssignmentJobArchitectureExternalId	String	No	ID of the level in the job architecture that the worker occupies in the host country. Value of the ExternalId field for the relevant job architecture in the JobArchitectureExternalId entity.
HostAssignmentStartDate	Date	No	Date at which the worker started their assignment in the country.
HostAssignmentEndDate	Date	No	Date at which the worker ended their assignment in the host country.
HostCountry	ISO enum	No	Country in which the worker is working if the worker is part of a mobility plan. Code of the relevant country in the Country ISO enum.
HostCountryCurrency	ISO enum	No	Currency of the country in which the worker is worker if they are part of a mobility plan.
HostPreferredCurrency	ISO enum	No	Currency in which workers should be paid in the host country.
EffectiveDate	Date	Yes	Date from which the current situation of the worker is effective. Because of the use of the effective date, the entity can contain multiple records for a single worker based on any changes in their personal or professional situation.

This is a tip message.

You can find an upload file template for the EmploymentStatus entity attached to this article under the name employment.csv.

Organization entity details

The following table describes the fields contained in the Organization entity.

This is an note/information message.

The Organization entity file must be present at each data upload and must contain data at each upload, for the fields marked as mandatory in the below table.

Organization entity details

Field name	Data type	Mandatory	Description	Data example
ExternalId	String	Yes	Unique identifier of the organization. This value is mandatory and must be unique.
OrganizationName	String	Yes	Name of the organization.
Active	Boolean	Yes	Indicates whether the organization is active.
ParentOrganizationId	String	No	ID of the parent organization of the organization, if any.
OrganizationCountry	ISO enum	No	Country in which the organization is located. Code of the relevant country in the Country ISO enum.
OrganizationType	Enum	No	Type of the organization.

This is a tip message.

You can find an upload file template for the Organization entity attached to this article under the name organization.csv.

CompensationElement entity details

The following table describes the fields contained in the CompensationElement entity.

This is an note/information message.

The CompensationElement entity file must be present at each data upload. However, it does not have to contain data.

If it does indeed contain data, the fields marked as mandatory must contain data.

CompensationElement entity details

Field name	Data type	Mandatory	Description	Data example
ExternalId	String	Yes	Unique identifier of the compensation element.
CompensationElementName	String	Yes	Name of the compensation element.
CompensationElementParentId	String	No	Parent ID of the compensation element.
CompensationElementIsRecurring	Boolean	No	Defines whether the compensation element corresponds to recurring compensation type.
CompensationElementFrequency	Enum	No	Indicates the frequency of the at which the compensation element is paid to worker. Code of the relevant frequency in the CompensationElementFrequency enum.
CompensationElementType	Enum	No	Indicates the type of compensation element. Code of the relevant compensation element type in the CompensationElementType enum.
CompensationElementBasis	String	No
CompensationElementIsTarget	Boolean	No
CompensationElementIsCash	Boolean	No
CompensationElementIsTaxible	Boolean	No
CompensationElementIsActive	Boolean	No
CompensationElementCountry	ISO enum	No	Country to which the compensation element is applicable. Code of the relevant country in the Country ISO enum.

This is a tip message.

You can find an upload file template for the CompensationElement entity attached to this article under the name CompensationElement.csv.

CompensationHistory entity details

The following table describes the fields contained in the CompensationHistory entity.

This is a warning message.

This entity should not be used for any new implementations. It is still available as of now for backward compatibility purposes and it will be removed in a future version.

It is replaced by the following entities: ContractedCompensation and PaidCompensation.

This is an note/information message.

The CompensationHistory entity file must be present at each data upload. However, it does not have to contain data.

If it does indeed contain data, the fields marked as mandatory must contain data.

CompensationHistory entity details

Field name	Data type	Mandatory	Description	Data example
Currency	String	Yes	Unique identifier of the worker in the Worker entity.
CompensationElementExternalId	String	Yes	External ID of the compensation element in the CompensationElement entity.
WorkerExternalId	ISO enum	No	Currency in which the compensation record is valued. Code of the relevant currency in the Currency ISO enum. Mandatory if either ContractedAmount or ActualizedAmount is present.
ContractedAmount	Decimal	No	Annual amount corresponding to the compensation record.
ActualizedAmount	Decimal	No	Actual amount corresponding to the compensation record. Differs from the annual amount because of the date range.
CompensationReason	String	No
MobilityId	String	No
Percentage	Decimal	No
Unit	String	No	Measurement unit applicable to a specific compensation component, such as hours for hourly wages, shares for equity awards, or a flat amount for allowances.
Value	Decimal	No
EffectiveRangeStartDate	Date	Yes	Start date of the compensation record. Because the start and end dates define a range, there can be several records per worker.
EffectiveRangeEndDate	Date	Yes	End date of the compensation record.

Demographics entity details

The following table describes the fields contained in the Demographics entity.

This is an note/information message.

The DemographicsDemographics entity file must be present at each data upload. However, it does not have to contain data.

If it does indeed contain data, the fields marked as mandatory must contain data.

Demographics entity details

Field name	Data type	Mandatory	Description	Data example
WorkerExternalId	String	Yes	Unique ID of the worker in the Worker entity.
Birthday	Date	No	Date of birth of the worker.
Gender	Enum	No	Gender of the worker. Code of the relevant gender in the Gender ISO enum.
MaritalStatus	Enum	No	Marital status of the worker. Code of the relevant marital status in the MaritalStatus enum.
Religion	Enum	No	Religion of the worker. Code of the relevant religion in the Religion enum.
PoliticalAffiliation	Enum	No	Political affiliation of the worker. Code of the relevant political affiliation in the PoliticalAffiliation enum.
EducationLevel	Enum	No	Education level of the worker. Code of the relevant education level in the EducationLevel enum.
Ethnicity	Enum	No	Ethnicity of the worker. Code of the relevant ethnicity in the Ethnicity enum.
Nationality1	Enum	No	First nationality of the worker. Code of the relevant nationality in the Nationality enum.
Nationality2	Enum	No	Second nationality of the worker. Code of the relevant nationality in the Nationality enum.

This is a tip message.

You can find an upload file template for the Demographics entity attached to this article under the name Demographics.csv.

PayScale entity details

The following table describes the fields contained in the PayScale entity.

This is an note/information message.

The PayScale entity file must be present at each data upload. However, it does not have to contain data.

If it does indeed contain data, the fields marked as mandatory must contain data.

PayScale entity details

Field name	Data type	Mandatory	Description	Data example
ExternalId	String	Yes	External ID of the pay scale.
PaySchedule	String	Yes
PayScaleType	Enum	No	Type of the pay scale. Code of the relevant pay scale type in the PayScaleType enum.
PayScaleArea	Enum	No	Area to which the pay scale applies. Code of the relevant pay scale area in the PayScaleArea enum.
PayScaleGroup	Enum	No	Group to which the pay scale belongs. Code of the relevant pay scale group in the PayScaleGroup enum.
PayScaleLevel	Enum	No	Level of the pay scale. Code of the relevant pay scale level in the PayScaleLevel enum.
PayScaleLocalGrade	Enum	No	Local grade of the pay scale. Code of the relevant pay scale local grade in the PayScaleLocalGrade enum.
PayScaleGlobalGrade	Enum	No	Global grade of the pay scale. Code of the relevant pay scale global grade in the PayScaleGlobalGrade enum.
PayGrade	Enum	No	Pay grade corresponding to the pay scale. Code of the relevant pay grade in the PayGrade enum.
GradeWidth	Decimal	No	Salary range (grade width) for the specific pay grade.
PayRangeCurrency	ISO enum	No	Currency in which the pay range is valued. Code of the relevant currency in the Currency ISO enum. Required if any amount field is present (PayRangeMin, PayRangeMid or PayRangeMax).
PayRangeMin	Decimal	No	Minimum value of the pay range. If a value is present in this field, a value must also be present in PayRangeMax. Additionally, the value in this field must be smaller than the value in PayRangeMax.
PayRangeMid	Decimal	No	Mid value for the pay range.
PayRangeMax	Decimal	No	Maximum value for the pay range. If a value is present in this field, a value must also be present in PayRangeMin. Additionally, the value in this field must be smaller than the value in PayRangeMin.

This is a tip message.

You can find an upload file template for the PayScale entity attached to this article under the name PayScale.csv.

CostCenter entity details

The following table describes the fields contained in the CostCenter entity.

This is an note/information message.

The CostCenter entity file must be present at each data upload. However, it does not have to contain data.

If it does indeed contain data, the fields marked as mandatory must contain data.

CostCenter entity details

Field name	Data type	Mandatory	Description	Data example
ExternalId	String	Yes	ID of the cost center.
CostCenterName	String	Yes	Name of the cost center.
CostCenterParentId	String	No	Parent ID of the cost center.
CostCenterFte	Number	No
CostCenterValue	Number	No
CostCenterCurrency	ISO enum	No	Currency used by the cost center. Code of the relevant currency in the Currency ISO enum.

This is a tip message.

You can find an upload file template for the CostCenter entity attached to this article under the name CostCenter.csv.

JobArchitecture entity details

The following table describes the fields contained in the JobArchitecture entity.

This is an note/information message.

The JobArchitecture entity file must be present at each data upload. However, it does not have to contain data.

If it does indeed contain data, the fields marked as mandatory must contain data.

JobArchitecture entity details

Field name	Data type	Mandatory	Description	Data example
ExternalId	String	Yes	Unique ID of the job record.
PayScaleExternalId	String	No	ID of the pay scale corresponding to the job. ExternalId value of the relevant pay scale in the PayScale entity.
JobFamily	Enum	No	Family of the job. Code of the relevant family in the JobFamily enum.
JobFunction	Enum	No	Function of the job. Code of the relevant job function in the JobFunction enum.
JobCategory	Enum	No	Category of the job. Code of the relevant job category in the JobCategory enum.
JobLevel	Enum	No	Level of the job. Code of the relevant job level in the JobLevel enum. For proper synchronization of the data, JobLevel must be maximum 3 characters.
JobTitle	String	No	Title of the job. Used when provisioning users in the User service.
JobDescription	String	No	Description of the job.
JobEvaluationPoints	Decimal	No
JobAlternativeId	String	No	Alternative ID for the job.

This is a tip message.

You can find an upload file template for the JobArchitecture entity attached to this article under the name JobArchitecture .csv.

Absence entity details

The following table describes the fields contained in the Absence entity.

This is an note/information message.

The Absence entity file must be present at each data upload. However, it does not have to contain data.

If it does indeed contain data, the fields marked as mandatory must contain data.

Absence entity details

Field name	Data type	Mandatory	Description	Data example
WorkerExternalId	String	Yes	ID of the worker concerned by the absence. ExternalId of the worker in the Worker entity.
AbsenceType	Enum	Yes	Type of the absence. Code of the absence type in the AbsenceType enum.	Sickness
AbsenceReason	String	No	Reason for the absence.
AbsenceDays	Decimal	No	Number of days of absence.
AbsenceInWorkingDays	Decimal	No	Number of working days of absence.
AbsenceProrataFactor	Decimal	No	Prorata factor applied to the absence.
EffectiveRangeStartDate	Date	Yes	Start date of the absence.
EffectiveRangeEndDate	Date	Yes	End date of the absence.

This is a tip message.

You can find an upload file template for the Absence entity attached to this article under the name Absence.csv.

PerformanceRatingScales entity details

The following table describes the fields contained in the PerformanceRatingScales entity.

This is an note/information message.

The PerformanceRatingScales entity file must be present at each data upload. However, it does not have to contain data.

If it does indeed contain data, the fields marked as mandatory must contain data.

PerformanceRatingScales entity details

Field name	Data type	Mandatory	Description	Data example
ExternalId	String	Yes	Unique ID of the performance rating scale record.
PerformanceRatingScale	Enum	No	Performance rating scale for the performance record. Code of the relevant performance rating scale in the PerformanceRatingScale enum.
PerformanceRatingId	String	No
PerformanceRatingLabel	String	No
PerformanceRatingOrder	Integer	No
PerformanceReportingOrder	Integer	No

This is a tip message.

You can find an upload file template for the PerformanceRatingScales entity attached to this article under the name PerformanceRatingScales.csv.

PerformanceReviewRating entity details

The following table describes the fields contained in the PerformanceReviewRating entity.

This is an note/information message.

The PerformanceReviewRating entity file must be present at each data upload. However, it does not have to contain data.

If it does indeed contain data, the fields marked as mandatory must contain data.

PerformanceReviewRating entity details

Field name	Data type	Mandatory	Description	Data example
WorkerExternalId	String	Yes	ID of the worker whom the record concerns. ExternalId value of the worker in the Worker entity.
PerformanceRatingScalesExternalId	String	Yes	ID of the performance rating scale. Code of the relevant performance rating scale in the PerformanceRatingScales entity.
PerformanceRatingType	Enum	Yes	Type of performance rating. Code of the performance rating type in the PerformanceRatingType enum.
PerformanceReviewType	Enum	No	Type of performance review. Code of the relevant performance review type in the PerformanceReviewType enum.
PerformanceRatingScore	Decimal	No	Performance rating value.
PerformanceReviewTemplateId	String	No	Unique ID of the relevant performance review template.
PerformanceReviewTemplateName	String	No	Name of the relevant performance review template.
EffectiveRangeStartDate	Date	Yes	Start date of the performance review period.
EffectiveRangeEndDate	Date	Yes	End date of the performance review period.

This is a tip message.

You can find an upload file template for the PerformanceReviewRating entity attached to this article under the name PerformanceReviewRating.csv.

LegalEntity entity details

The following table describes the fields contained in the LegalEntity entity.

This is an note/information message.

The LegalEntity entity file must be present at each data upload. However, it does not have to contain data.

If it does indeed contain data, the fields marked as mandatory must contain data.

LegalEntity entity details

Field name	Data type	Mandatory	Description	Data example
ExternalId	String	Yes	Unique ID of the performance rating scale record.
LegalEntityName	String	Yes	Name of the legal entity.
LegalEntityParentId	String	No	Parent ID of the legal entity.

This is a tip message.

You can find an upload file template for the LegalEntity entity attached to this article under the name LegalEntity.csv.

IndividualPayRange entity details

The following table describes the fields contained in the IndividualPayRange entity.

This is an note/information message.

The IndividualPayRange entity file must be present at each data upload. However, it does not have to contain data.

If it does indeed contain data, the fields marked as mandatory must contain data.

IndividualPayRange entity details

Field name	Data type	Mandatory	Description	Data example
WorkerExternalId	String	Yes	ID of the worker concerned by the pay range. ExternalId value in the Worker entity.
PayRangeMin	Decimal	No	Minimum value of the pay range. If a value is present in this field, a value must also be provided in the field PayRangeMax. In addition, the value of PayRangeMin must be smaller than the value of PayRangeMax.
PayRangeMax	Decimal	No	Maximal value of the pay range. If a value is present in this field, a value must also be provided in the field PayRangeMin. In addition, the value of PayRangeMax must be larger than the value of PayRangeMin.
PayRangeMid	Decimal	No	Mid value of the pay range.
Currency	ISO enum	No	Currency of the pay range. Code of the relevant currency in the Currency ISO enum. This field is required if any value is provided in the amount fields (PayRangeMin, PayRangeMax, BenchmarkRangeMin or BenchmarkRangeMax).
LocalGrade	Enum	No	Local grade of the worker. Code of the relevant local grade in the as defined in the IndividualPayRangeLocalGrade enum.
GlobalGrade	Enum	No	Global grade of the worker. Code of the relevant global grade in the as defined in the IndividualPayRangeGlobalGrade enum.
BenchmarkRangeMin	Decimal	No	Minimum benchmark value for the pay range. If a value is present in this field, a value must also be provided in the field BenchmarkRangeMax. In addition, the value of BenchmarkRangeMin must be smaller than the value of BenchmarkRangeMax.
BenchmarkRangeMid	Decimal	No	Medium benchmark value for the pay range.
BenchmarkRangeMax	Decimal	No	Maximum benchmark value for the pay range. If a value is present in this field, a value must also be provided in the field BenchmarkRangeMin. In addition, the value of BenchmarkRangeMax must be larger than the value of BenchmarkRangeMin.
EffectiveDate	Date	Yes	Effective date of the pay range.

This is a tip message.

You can find an upload file template for the IndividualPayRange entity attached to this article under the name IndividualPayRange.csv.

GoalAchievement entity details

The following table describes the fields contained in the GoalAchievement entity.

This is a warning message.

This entity should not be used for any new implementations. It is still available as of now for backward compatibility purposes and it will be removed in a future version.

It is replaced by the following entity: GoalAchievementNew.

EffectiveRangeStartDate entity details

Field name	Data type	Mandatory	Description	Data example
WorkerExternalId	String	Yes	External ID of the worker concerned by the goal. ExternalId value in the Worker entity.
GoalPlanTypeAssignmentExternalId	String	Yes	External ID of the goal plan type assignment. Value of the ExternalId field in the GoalPlanTypeAssignment entity.
GoalId	String	Yes	ID of the goal.
GoalName	String	Yes	Name of the goal.
GoalWeightWithinGoalType	String	Yes	Weight of the goal.
GoalTarget	Number	No	Target metric of the goal.
GoalResult	Number	No	Result of the goal.
GoalAchievementPercentage	Number	Yes	Achievement percentage of the goal.
EffectiveRangeStartDate	Date	Yes	Start date of the effective range for the goal.
EffectiveRangeEndDate	Date	Yes	End date of the effective range for the goal.

GoalPlan entity details

The following table describes the fields contained in the GoalPlan entity.

This is an note/information message.

The GoalPlan entity file must be present at each data upload. However, it does not have to contain data.

If it does indeed contain data, the fields marked as mandatory must contain data.

GoalPlan entity details

Field name	Data type	Mandatory	Description	Data example
ExternalId	String	Yes	External ID of the goal plan.
Name	String	Yes	Name of the goal plan.
StartDate	Date	No	Start date of the goal plan.
EndDate	Date	No	End date of the goal plan.

This is a tip message.

You can find an upload file template for the GoalPlan entity attached to this article under the name GoalPlan.csv.

GoalPlanTypeAssignment entity details

The following table describes the fields contained in the GoalPlanTypeAssignment entity.

This is a warning message.

This entity should not be used for any new implementations. It is still available as of now for backward compatibility purposes and it will be removed in a future version.

It is replaced by the following entity: GoalAchievementNew.

GoalPlanTypeAssignment entity details

Field name	Data type	Mandatory	Description	Data example
ExternalId	String	Yes	External ID of the goal plan type assignment.
GoalType	Enum	Yes	Goal type as defined in the GoalType enum.
GoalPlanExternalId	String	Yes	External ID of the goal plan. Corresponds to the ExternalId field of the GoalPlan entity.
GoalTypeWeight	Number	Yes	Weight of the goal type in the goal plan.

Goal entity details

The following table describes the fields contained in the Goal entity.

This is an note/information message.

The Goal entity file must be present at each data upload. However, it does not have to contain data.

If it does indeed contain data, the fields marked as mandatory must contain data.

Goal entity details

Field name	Data type	Mandatory	Description	Data example
ExternalId	String	Yes	External ID of the goal.
Name	String	Yes	Name of the goal.
GoalUnit	Enum	Yes	Unit used to measure the goal. Code of the relevant unit in the GoalUnit enum.
GoalUnit	Boolean	Yes	Indicates whether or not the goal the an individual goal.
GoalType	Enum	No	Type of the goal. Code of the relevant goal in the GoalType enum.

This is a tip message.

You can find an upload file template for the Goal entity attached to this article under the name Goal.csv.

GoalPlanGoalAssigment entity details

The following table describes the fields contained in the GoalPlanGoalAssignment entity.

This is an note/information message.

The GoalPlanGoalAssignment entity file must be present at each data upload. However, it does not have to contain data.

If it does indeed contain data, the fields marked as mandatory must contain data.

GoalPlanGoalAssignment entity details

Field name	Data type	Mandatory	Description	Data example
ExternalId	String	Yes	Unique identifier of the goal plan.
GoalPlanExternalId	Entity ref	Yes	External ID of the goal plan. Corresponds to the ExternalId field in the GoalPlan entity.
GoalExternalId	Entity ref	Yes	Unique identifier of the goal. Corresponds to the ExternalId field in the Goal entity.

This is a tip message.

You can find an upload file template for the GoalPlanGoalAssignment entity attached to this article under the name GoalPlanGoalAssignment.csv.

GoalAchievementNew entity details

The following table describes the fields contained in the GoalAchievementNew entity.

This is an note/information message.

The GoalAchievementNew entity file must be present at each data upload. However, it does not have to contain data.

If it does indeed contain data, the fields marked as mandatory must contain data.

GoalAchievementNew entity details

Field name	Data type	Mandatory	Description	Data example
WorkerExternalId	Entity ref	Yes	Unique identifier of the worker. ExternalId value in the Worker entity.
GoalExternalId	Entity ref	Yes	Unique identifier of the goal. ExternalId value in the Goal entity.
GoalPlanExternalId	Entity ref	Yes	Unique identifier of the goal plan. ExternalId value in the GoalType entity.
GoalWeight	Number	Yes	Weight of the goal.
GoalTypeWeight	Number	No	Weight of the goal type.
GoalTarget	Number	No	Target of the goal.
GoalResult	Number	No	Result of the goal.
GoalAchievementPercentage	Number	No	Percentage of achievement of the goal.
EffectiveRangeStartDate	Date	Yes	Start date of the effective range for the goal.
EffectiveRangeEndDate	Date	Yes	End date of the effective range for the goal.

This is a tip message.

You can find an upload file template for the GoalAchievementNew entity attached to this article under the name GoalAchievementNew.csv.

ContractedCompensation entity details

The following table describes the fields contained in the ContractedCompensation entity.

This is an note/information message.

The ContractedCompensation entity file must be present at each data upload. However, it does not have to contain data.

If it does indeed contain data, the fields marked as mandatory must contain data.

ContractedCompensation entity details

Field name	Data type	Mandatory	Description	Data example
WorkerExternalId	String (entity ref)	Yes	Unique identifier of the worker. ExternalId value in the Worker entity.
CompensationElementExternalId	String (entity ref)	Yes	Unique identifier of the compensation element. Corresponds to the value of the ExternalId field in the CompensationElement entity.
AmountSource	Enum	No	Source of the contracted amount. Corresponds to the code of the amount source in the AmountSource enum.
Currency	Enum	No	Currency used for the contracted salary. Code of the relevant currency in the Currency enum.
ContractedAmount	Decimal	No	Actual figure of the contracted salary.
Percentage	Decimal	No	Percentage of the contracted compensation.
PercentageReferenceCompensationElementExternalId	String (entity ref)	No	Unique identifier of the compensation element. Corresponds to the value of the ExternalId field in the CompensationElement entity.
CompensationReason	String	No	Motive of the compensation.
EffectiveDate	Date	Yes	Effective date of the contracted compensation.

This is a tip message.

You can find an upload file template for the ContractedCompensation entity attached to this article under the name ContractedCompensation.csv.

PaidCompensation entity details

The following table describes the fields contained in the PaidCompensation entity.

This is an note/information message.

The PaidCompensation entity file must be present at each data upload. However, it does not have to contain data.

If it does indeed contain data, the fields marked as mandatory must contain data.

PaidCompensation entity details

Field name	Data type	Mandatory	Description	Data example
WorkerExternalId	String (entity ref)	Yes	Unique identifier of the worker. ExternalId value in the Worker entity.
CompensationElementExternalId	String (entity ref)	Yes	Unique identifier of the compensation element. Corresponds to the value of the ExternalId field in the CompensationElement entity.
Currency	Enum	No	Currency used for the contracted salary. Code of the relevant currency in the Currency enum.
PaidAmount	Decimal	No	Amount actually paid to the worker.
PaymentDate	Date	No	Date at which the amount was transferred to the worker.
DerivedFromCompensationElementExternalId	String (entity reference)	No	Unique identifier of the compensation element. Corresponds to the value of the ExternalId field in the CompensationElement entity.
CompensationReason	String	No	Motive of the compensation.
EffectiveRangeStartDate	Date	Yes	Start date of the compensation period.
EffectiveRangeEndDate	Date	Yes	End date of the compensation period.

This is a tip message.

You can find an upload file template for the PaidCompensation entity attached to this article under the name PaidCompensation.csv.

Going further

• Data integration principles
• Working with enums
• Data upload instructions