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