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 V9 | Field Name V8 | API Field Type | Description | Required/Optional/ ESS Configured |
externalId | Int | External Payroll Identity Id | Optional | |
username | string | Username to allow the user to login | Required | |
employeeCode | string | When empty it is set equal to username | ESS Configured | |
name | string | Name of the user | ESS Configured | |
surname | string | Surname of the user | ESS Configured | |
emailAddress | string | Email for most notifications in the system e.g. Password reset | ESS Configured | |
alternateEmailAddress | string | Email for reporting | ESS Configured | |
idNumber | string | Id Number of the user | ESS Configured | |
passportNumber | string | Passport number of the user | ESS Configured | |
mobileNumber | string | Mobile number preferably with country code | ESS Configured | |
workNumber | string | Work number preferably with country code | ESS Configured | |
homeNumber | string | Home number preferably with country code | ESS Configured | |
middleName | string | Middel name of user | ESS Configured | |
initials | string | Initials of user | ESS Configured | |
title | string | Title of user | ESS Configured | |
knownAs | string | Name the user is known as | ESS Configured | |
homeLanguage | string | ESS Configured | ||
gender | string | ESS Configured | ||
race | string | ESS Configured | ||
citizenship | string | ESS Configured | ||
maritalStatus | string | ESS Configured | ||
birthDay | string | Date of birth of the user | ESS Configured | |
disability | string | A single disability for the user | ESS 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 | int | The payroll job id | Optional | |
jobTitle | string | Name of the job | Optional | |
jobCode | string | Code of the job | Optional | |
occupationalCategory | string | Occupation Category of the job | Optional | |
occupationalLevel | string | Occupational Level of the job within the category | Optional | |
jobOfoCode | string | OFO code of the job | Optional | |
jobGrade | string | Grade of the job | Optional | |
gradingType | string | Grading used for the job | Optional | |
positionExternalId | int | The payroll position Id | Optional | |
positionTitle | string | Position Name | Optional | |
positionCode | string | Position Code | Optional | |
appointmentType | string | How the user is appointed in the position | Optional | |
startDate | string | Start date in the position | Optional | |
endDate | string | End date in the position, when empty the user is not terminated | Optional | |
reasonForTermination | string | The reason the users employment has been ended | Optional | |
startDateInGroup | string | The start date in the group | Optional | |
startDateInCompany | string | The start date in the company within the group | Optional | |
orgLevel1_externalId | Int | Org unit Id on payroll | Optional | |
orgLevel1_name | string | Required | ||
orgLevel1_code | string | Unique code per ruleset for org unit | Optional | |
orgLevel1_workLocationName | string | Optional | ||
orgLevel2_externalId | Int | Org unit Id on payroll | Optional | |
orgLevel2_name | string | Optional | ||
orgLevel2_code | string | Unique code per ruleset for org unit | Optional | |
orgLevel2_workLocationName | string | Optional | ||
orgLevel3_externalId | Int | Org unit Id on payroll | Optional | |
orgLevel3_name | string | Optional | ||
orgLevel3_code | string | Unique code per ruleset for org unit | Optional | |
orgLevel3_workLocationName | string | Optional | ||
orgLevel4_externalId | Int | Org unit Id on payroll | Optional | |
orgLevel4_name | string | Optional | ||
orgLevel4_code | string | Unique code per ruleset for org unit | Optional | |
orgLevel4_workLocationName | string | Optional | ||
orgLevel5_externalId | Int | Org unit Id on payroll | Optional | |
orgLevel5_name | string | Optional | ||
orgLevel5_code | string | Unique code per ruleset for org unit | Optional | |
orgLevel5_workLocationName | string | Optional | ||
orgLevel6_externalId | Int | Org unit Id on payroll | Optional | |
orgLevel6_name | string | Optional | ||
orgLevel6_code | string | Unique code per ruleset for org unit | Optional | |
orgLevel6_workLocationName | string | Optional | ||
orgLevel7_externalId | Int | Org unit Id on payroll | Optional | |
orgLevel7_name | string | Optional | ||
orgLevel7_code | string | Unique code per ruleset for org unit | Optional | |
orgLevel7_workLocationName | string | Optional | ||
orgLevel8_externalId | Int | Org unit Id on payroll | Optional | |
orgLevel8_name | string | Optional | ||
orgLevel8_code | string | Unique code per ruleset for org unit | Optional | |
orgLevel8_workLocationName | string | Optional | ||
orgLevel9_externalId | Int | Org unit Id on payroll | Optional | |
orgLevel9_name | string | Optional | ||
orgLevel9_code | string | Unique code per ruleset for org unit | Optional | |
orgLevel9_workLocationName | string | Optional | ||
lineManagerUsername | string | The username of the manager, existing in the system or part of the API body | Optional | |
performanceManagerUsername | string | The username of the manager, existing in the system or part of the API body | Optional | |
departmentManagerUsername | string | The username of the manager, existing in the system or part of the API body | Optional | |
trainingManagerUsername | string | The username of the manager, existing in the system or part of the API body | Optional | |
pdpFirstApproverUsername | string | The username of the manager, existing in the system or part of the API body | Optional | |
pdpSecondApproverUsername | string | The username of the manager, existing in the system or part of the API body | Optional | |
leaveManagerUsername | string | The username of the manager, existing in the system or part of the API body | Optional | |
salaryReviewManagerUsername | string | The username of the manager, existing in the system or part of the API body | Optional | |
talentManagementManagerUsername | string | The username of the manager, existing in the system or part of the API body | Optional | |
secondaryReportingManagerUsername | string | The username of the manager, existing in the system or part of the API body | Optional | |
lineManagerOnceRemovedUsername | string | The username of the manager, existing in the system or part of the API body | Optional | |
workflowOriginatorUsername | string | The username of the manager, existing in the system or part of the API body | Optional | |
financeManagerUsername | string | The username of the manager, existing in the system or part of the API body | Optional | |
financeOfficerUsername | string | The username of the manager, existing in the system or part of the API body | Optional | |
hrOfficerUsername | string | The username of the manager, existing in the system or part of the API body | Optional | |
hrRecruitmentOfficerUsername | string | The username of the manager, existing in the system or part of the API body | Optional | |
businessUnitHrManagerUsername | string | The username of the manager, existing in the system or part of the API body | Optional | |
secondaryJobRequisitionApproverUsername | string | The username of the manager, existing in the system or part of the API body | Optional | |
leaveManagerAlternateApproverUsername | string | The username of the manager, existing in the system or part of the API body | Optional | |
customField001-customField020 | string | Any value that needs to be stored against the user for which an explicit field does not exist | Optional |