Skip to main content

V8 Employee Import to V9 User Import Field Mapping

Below is the list of fields that are required and recommended. Fields with no comment are optional.

Field Name V9Field Name V8API Field TypeDescriptionRequired/Optional/ ESS Configured
externalId
IntExternal Payroll Identity IdOptional
username
stringUsername to allow the user to loginRequired
employeeCode
stringWhen empty it is set equal to usernameESS Configured
name
stringName of the userESS Configured
surname
stringSurname of the userESS Configured
emailAddress
stringEmail for most notifications in the system e.g. Password resetESS Configured
alternateEmailAddress
stringEmail for reportingESS Configured
idNumber
stringId Number of the userESS Configured
passportNumber
stringPassport number of the userESS Configured
mobileNumber
stringMobile number preferably with country codeESS Configured
workNumber
stringWork number preferably with country codeESS Configured
homeNumber
stringHome number preferably with country codeESS Configured
middleName
stringMiddel name of userESS Configured
initials
stringInitials of user ESS Configured
title
stringTitle of userESS Configured
knownAs
stringName the user is known asESS Configured
homeLanguage
string
ESS Configured
gender
string
ESS Configured
race
string
ESS Configured
citizenship
string
ESS Configured
maritalStatus
string
ESS Configured
birthDay
stringDate of birth of the userESS Configured
disability
stringA single disability for the userESS Configured
residentialUnitNumber
string
Optional
residentialComplexName
string
Optional
residentialStreetNumber
string
Optional
residentialStreetName
string
Optional
residentialSuburbDistrict
string
Optional
residentialCityTown
string
Optional
residentialCountry
string
Required when any residential field supplied
residentialProvince
string
Required when any residential field supplied
residentialPostalCode
string
Optional
residentialAsPostal
string
Optional
postalUnitNumber
string
Optional
postalComplexName
string
Optional
postalStreetNumber
string
Optional
postalStreetName
string
Optional
postalSuburbDistrict
string
Optional
postalCityTown
string
Optional
postalCountry
string
Required when any postal field supplied
postalProvince
string
Required when any postal field supplied
postalCode
string
Optional
jobExternalId
intThe payroll job idOptional
jobTitle
stringName of the job Optional
jobCode
stringCode of the jobOptional
occupationalCategory
stringOccupation Category of the jobOptional
occupationalLevel
stringOccupational Level of the job within the categoryOptional
jobOfoCode
stringOFO code of the jobOptional
jobGrade
stringGrade of the jobOptional
gradingType
stringGrading used for the jobOptional
positionExternalId
intThe payroll position IdOptional
positionTitle
stringPosition NameOptional
positionCode
stringPosition CodeOptional
appointmentType
stringHow the user is appointed in the positionOptional
startDate
stringStart date in the positionOptional
endDate
stringEnd date in the position, when empty the user is not terminatedOptional
reasonForTermination
stringThe reason the users employment has been endedOptional
startDateInGroup
stringThe start date in the groupOptional
startDateInCompany
stringThe start date in the company within the groupOptional
orgLevel1_externalId
IntOrg unit Id on payrollOptional
orgLevel1_name
string
Required
orgLevel1_code
stringUnique code per ruleset for org unitOptional
orgLevel1_workLocationName
string
Optional
orgLevel2_externalId
IntOrg unit Id on payrollOptional
orgLevel2_name
string
Optional
orgLevel2_code
stringUnique code per ruleset for org unitOptional
orgLevel2_workLocationName
string
Optional
orgLevel3_externalId
IntOrg unit Id on payrollOptional
orgLevel3_name
string
Optional
orgLevel3_code
stringUnique code per ruleset for org unitOptional
orgLevel3_workLocationName
string
Optional
orgLevel4_externalId
IntOrg unit Id on payrollOptional
orgLevel4_name
string
Optional
orgLevel4_code
stringUnique code per ruleset for org unitOptional
orgLevel4_workLocationName
string
Optional
orgLevel5_externalId
IntOrg unit Id on payrollOptional
orgLevel5_name
string
Optional
orgLevel5_code
stringUnique code per ruleset for org unitOptional
orgLevel5_workLocationName
string
Optional
orgLevel6_externalId
IntOrg unit Id on payrollOptional
orgLevel6_name
string
Optional
orgLevel6_code
stringUnique code per ruleset for org unitOptional
orgLevel6_workLocationName
string
Optional
orgLevel7_externalId
IntOrg unit Id on payrollOptional
orgLevel7_name
string
Optional
orgLevel7_code
stringUnique code per ruleset for org unitOptional
orgLevel7_workLocationName
string
Optional
orgLevel8_externalId
IntOrg unit Id on payrollOptional
orgLevel8_name
string
Optional
orgLevel8_code
stringUnique code per ruleset for org unitOptional
orgLevel8_workLocationName
string
Optional
orgLevel9_externalId
IntOrg unit Id on payrollOptional
orgLevel9_name
string
Optional
orgLevel9_code
stringUnique code per ruleset for org unitOptional
orgLevel9_workLocationName
string
Optional
lineManagerUsername
stringThe username of the manager, existing in the system or part of the API bodyOptional
performanceManagerUsername
stringThe username of the manager, existing in the system or part of the API bodyOptional
departmentManagerUsername
stringThe username of the manager, existing in the system or part of the API bodyOptional
trainingManagerUsername
stringThe username of the manager, existing in the system or part of the API bodyOptional
pdpFirstApproverUsername
stringThe username of the manager, existing in the system or part of the API bodyOptional
pdpSecondApproverUsername
stringThe username of the manager, existing in the system or part of the API bodyOptional
leaveManagerUsername
stringThe username of the manager, existing in the system or part of the API bodyOptional
salaryReviewManagerUsername
stringThe username of the manager, existing in the system or part of the API bodyOptional
talentManagementManagerUsername
stringThe username of the manager, existing in the system or part of the API bodyOptional
secondaryReportingManagerUsername
stringThe username of the manager, existing in the system or part of the API bodyOptional
lineManagerOnceRemovedUsername
stringThe username of the manager, existing in the system or part of the API bodyOptional
workflowOriginatorUsername
stringThe username of the manager, existing in the system or part of the API bodyOptional
financeManagerUsername
stringThe username of the manager, existing in the system or part of the API bodyOptional
financeOfficerUsername
stringThe username of the manager, existing in the system or part of the API bodyOptional
hrOfficerUsername
stringThe username of the manager, existing in the system or part of the API bodyOptional
hrRecruitmentOfficerUsername
stringThe username of the manager, existing in the system or part of the API bodyOptional
businessUnitHrManagerUsername
stringThe username of the manager, existing in the system or part of the API bodyOptional
secondaryJobRequisitionApproverUsername
stringThe username of the manager, existing in the system or part of the API bodyOptional
leaveManagerAlternateApproverUsername
stringThe username of the manager, existing in the system or part of the API bodyOptional
customField001-customField020
stringAny value that needs to be stored against the user for which an explicit field does not existOptional