Employee importer mapping for Advanced Workforce Management and Advanced Payroll
This article has been written for MYOB Advanced Workforce Management consultants. Some options may be unavailable to end users.
If you need more help with this topic, contact your MYOB Advanced Workforce Management partner. If MYOB support you directly, email businesssupport@myob.com.
Contents
Format all dates as YYYY-MM-DD.
This page applies to both MYOB Advanced Workforce Management and MYOB Advanced Employee Onboarding.
Fields common to AU and NZ
WFM Importer Field | Input Options | Mandatory | Advanced Field - Employee Importer | Comments - Employee Importer | Advanced Field - Onboarding/Update Employee |
|---|---|---|---|---|---|
firstName | Y | FirstNames | Employee Screen | firstName | |
middleName | MiddleName | Employee Screen | middleName | ||
lastName | Y | Last Name | Employee Screen | lastName | |
preferredName | n/a | Not used in ADVP
| |||
anotherName | n/a | Not used in ADVP
| |||
employmentType | "FullTime", "PartTime", "Casual"
| Y | Employee.EmployeeStatus.StatusType | Employee > EMPLOYMENT HISTORY Screen | employeeStatus (AU Only Enum Full_Time, Part_Time, Casual) |
locationId | Y | n/a | WFM fields only and needs PAM review and update | ||
positionId | Y | n/a | WFM fields only and needs PAM review and update | ||
Y | Employee Screen | ||||
mobile | Y | Cell Phone1 | Employee Screen | mobilePhone | |
alternatePhone | Cell Phone2 | Employee Screen | workPhone | ||
dateOfBirth | Y | Date of birth | Employee Screen | birthDate | |
gender | "Male", "Female", "X" (Not Specified or Gender Diverse) | Y | Gender | Employee Screen | gender (X, M, F) |
reference | Y | EmployeeID | e.g. EP000012 | reference | |
payRuleId | Y | WFM fields only and needs PAM review and update | |||
payLevelId | Y | WFM fields only and needs PAM review and update | |||
payAmount | Y | Standard rate | Employee > PAY DETAILS Screen | employeePayRate.hourlyRate | |
payBasis | "1" (per hour), "3" (per annum)
| Y | 1 Per hour | 1: Per hour 2: (not used) 3: Per annum 4: per month (not used for MYOB) | |
commencementDate | Y | Employeee.StartDate | Employee Screen | startDate | |
reportingToId | Y | Reports to | Needs to review if ReportingTo name matches to the right manager in WFM | ||
permissionGroupId | Y | Emplooyee Class | Employee Screen | ||
addressLine1 | Y | addressLine1 | Employee Screen | address1 | |
addressLine2 | addressLine2 | Employee Screen | address2 | ||
addressLine3 | n/a | Not used in ADVP | |||
addressCity | Y | City | Employee Screen | Address2 is blank then maps to Address 2 (NZ only) AU maps to City | |
addressState | "ACT", "NSW", "NT", "QLD", "SA", "TAS", "VIC", "WA" | Y | State for AU City for NZ | Employee Screen | NZ is City. AU State to State |
addressPostalCode | Y | Postal Code | Employee Screen | postCode | |
addressCountry | Y | Country | Employee Screen | countryCode (iso-3166 2 digit) | |
hoursPerDay | Y | HoursPerDay | Employee Pay Details screen | employeePayRate.hoursPerDay | |
daysPerWeek | Y | HoursPerYear/52/HoursPerDay | Employee Pay Details screen | employeePayRate.daysPerWeek | |
externalId | Y | Employee ID | e.g. EP000012 | reference | |
residencyStatus | "Citizen", "PermanentResident", "HasVisa" | Y | Only map to HasVisa if employee Residency is Working Holiday Maker | Employee > Taxation screen Advanced does not hold any visa or passport information | Not mapped |
bankAccountName | Y | Name On Account | Employee > Pay Distribution screen When exporting from MYOB Advanced People, the exporter only exports one balance account for a bank account even if there are multiple bank accounts | bankAccount[0].accountName | |
bankAccountNumber | Y | Account Name | Employee > Pay Distribution screen | bankAccount[0].accountNumber | |
bankBranch | Y | BSB Number | Employee > Pay Distribution screen, AU only | bankAccount | |
bankInstitutionName | TBD | PAM to review the institution based on BSB or bank account | Not mapped | ||
bankIsPrimay | Y | Y | Only balance bank account is used | bankAccount[0].primary | |
visaCountry | Y if filled in | AU | Only for WFM | visa.isWorkingHolidayMaker (AU Only) | |
visaDetails | Y if filled in | Unknown | Only for WFM - set to “Unknown” | Not mapped | |
visaIssueDate | Y if filled in | Default to employee start date | PAM to review and update | Not used in ADVP | |
visaExpiryDate | n/a | Only for WFM Visa (AU) | Not used in ADVP | ||
visaNumber | Y if filled in | Unknown | Only for WFM Visa (AU) - Set to “Unknown” | Not used in ADVP | |
visaTypeId | Y if filled in | Default to 21 - Other/Default in WFM | PAM to review and update | Not used in ADVP | |
visaIsWorkingHoliday | Y if filled in | Y | Only for WFM Visa (AU) - set to Yes | visa.isWorkingHolidayMaker (AU Only) |
NZ-only Fields
Field | Input Options | Mandatory | Advanced Field | Comments | Onboarding/Update Field |
|---|---|---|---|---|---|
NZSpecialTaxCode | "M", "M_SL", "ME", "ME_SL", "SB", SB_SL", S", "S_SL", "SH", "SH_SL", "ST", ST_SL", "SA", "SA_SL", "CAE", EDW", NSW", "STC", "STC_SL", "ND WT" | Y | TaxCode | Employee > Taxation Screen | taxationNZ.taxCode |
NZIrdNumber | Y | IRD Number | Employee > Taxation | taxationNZ.irdNumber | |
NZHasStudentLoan | True if has student loan Otherwise false | Employee > Taxation > Standard Student Loan
| taxationNZ.studentLoanRate :info: Can override if not default. Only if Tax code is contain SL | ||
NZAccEarnerLevyExemption | True if Rate is 0% Otherwise false | Employee > Employee Defaults> Acc rates
| taxationNZ.accEarnerLevyExempt | ||
NZStudentLoanRate | Repayment Rate | Employee > Taxation > Standard Student Loan | taxationNZ.studentLoadRate | ||
NZEsctRate | Esct Rate | Employee > Taxation | Not mapped | ||
NZKsEmployeeContribution | Y when (NZKsEnrolmentStatus IN (AutomaticallyEnroll, OptIn, AlreadyEnrolled)) | Employee contribution percent in StandardPay | Employee > StandardPay | kiwisaverDetails.employeeContributionRate | |
NZKsEnrolmentStatus | "AutomaticallyEnroll", "OptIn", "SavingsSuspension", "OptOut", "NotEnrolled", "Ineligible", "AlreadyEnrolled" | Y when |
| Employee > Kiwisaver | OptOut is not currently supported |
NZKsEmployerContribution | Y when (NZKsEnrolmentStatus IN (AutomaticallyEnroll, OptIn, AlreadyEnrolled)) | Employer contribution percent in StandardPay | Employee > StandardPay | kiwisaverDetails.employerContributionRate | |
NZKsIneligibilityReason | "NotACitizenOrPermanentResident:, "NotNormallyLivingInNewZealand", "18YearsOfAge" | Y when NZKsEnrolmentStatus == Ineligible | Empty | Employee > Kiwisaver PAM to review and update during import | Reason is not currently mapped |
NZKsLateOptOutReason | EmployeeKiwiSaverState.LateOptOutReason | Employee > Kiwisaver PAM to review and update during import | Opt out reason is not currently mapped
| ||
NZKsLateOptOutReasonOtherExplanation | EmployeeKiwiSaverState.OtherLateOptOutReason | Employee > Kiwisaver PAM to review and update during import | Opt out reason other is not currently mapped | ||
NZKsOptOutDate | Y when (NZKsEnrolmentStatus == OptOut) | Optout Date | Employee > Kiwisaver | Opt out Date is not currently mapped | |
NZKsSavingsSuspensionFromDate | Expiry Date in Employee Kiwisaver contribution in Standard pay item, and business date is after Expiry day | Employee > StandardPay | kiwisaverDetails.suspendedFrom | ||
NZKsSavingsSuspensionToDate | Effective Date in Employee Kiwisaver contribution in Standard pay item if any, and business date is before expiry day | Employee > StandardPay | kiwisaverDetails.suspendedTo | ||
NZSpecialTaxCodeRate | Tax@% | When tax code is STC, STC SL and WT | taxationNZ.taxCodeOverrideRate |
AU-only Fields
Field | Input Options | Mandatory | Advanced Field | Comments | Onboarding/Update Field |
|---|---|---|---|---|---|
AUTaxFileNumber | Y | Tax File Number(TFN) | Pay Details Screen | taxationAU.TaxFileNumber | |
AUTaxDeclaration |
| Y if No TFN provided | TFN declaration
| Pay Details Screen | taxationAU.taxDeclaration |
AUTaxPaidBasis |
| Y | ContractType
| Pay Details Screen | taxationAU.payBasis |
AUMedicareApplyLevySurcharge |
| Default to false if not set for MYOB | Levy Surcharge(MSL), true if declared | Pay Details Screen | medicareDetails.levySurchargeRate (true if supplied) |
AUMedicareLevySurchargeRate |
| Required if AUMedicareApplyLevySurcharge == true | Surcharge Rate | Pay Details Screen | medicareDetails.levySurchargeRate |
AUMedicareLevyExemption | None, Full, Half | Y |
| Pay Details Screen | medicareDetails.exemptionDetail (None, Full, Half) |
AUMedicareHasLevyReduction |
| Default to false if not set for MYOB | Levy Reduction, true if declared | Pay Details Screen | medicareDetails.hasLevyReduction |
AUMedicareHasSpouse |
| Default to false if not set for MYOB | Has a spouse, true if declared | Pay Details Screen | medicareDetails.hasSpouse |
AUMedicareIsLowIncomeEarner |
| Default to false if not set for MYOB | Low Income, true if declared | Pay Details Screen | medicareDetails.lowIncome |
AUMedicareHasDependentChildren |
| Default to false if not set for MYOB | Dependent Children, true if declared | Pay Details Screen | medicareDetails.numberOfDependents |
AUMedicareNumberOfDependentChildren |
| Required if AUMedicareHasDependentChildren === true | How Many? | Pay Details Screen | medicareDetails.numberOfDependents |
AUMedicareHasSignedDeclarationForm |
| not mapped | Not currently mapped | ||
AUMedicareDateFormSigned |
| Required if AUMedicareHasDependentChildren === true | not mapped | Not currently mapped | |
AUTitle | not mapped | Not currently mapped | |||
AUPreviousFamilyName |
| Previous Last Name | Pay Details Screen | taxationAU.previousFamilyName | |
AUAustraliaHomeAddress |
| not mapped | Not currently mapped | ||
AUIsAustralianForTaxPurposes | Yes, No | True if Residency is Australian | Pay Details Screen | taxationAU.isAUResidentForTaxPurposes | |
AUClaimSeniorPensionerTax | Yes, No | Claim Seniors tax offset, true if declared | Pay Details Screen | taxationAU.claimSeniorPensionTaxOffsetType (not none) | |
AUSeniorPensionerTaxReason | Single, | Required if AUClaimSeniorPensionerTax == true | Single Couple Illness-separated couple | Pay Details Screen | taxationAU.claimSeniorPensionTaxOffsetType |
AUClaimCarerTax |
| True if any of the question is declared
| Pay Details Screen | taxationAU.dependentSpouse/parentSpouseOrInvalidRelative/overseasForces | |
AUCarerTaxReason |
| Required if AUClaimCarerTax == true | Map to the declared AUClaimCarerTax answer above | Pay Details Screen | taxationAU.dependentSpouse/parentSpouseOrInvalidRelative/overseasForces |
AUHasHelpSslTsl |
| Help or TSL, true if any is declared | Pay Details Screen | taxationAU.hasHELPSSLTSL | |
AUHasFsDebt |
| Student Loan(SFSS) , true if declared | Pay Details Screen | taxationAU.hasHELPSSLTSL | |
AUHasWorkingHolidayVisa |
| True if Residency is Working Holiday Maker | Pay Details Screen | taxationAU.isWorkingHolidayMaker | |
AUClaimTaxFree |
| Claims Tax-free Threshold, true if declared | Pay Details Screen | taxationAU.claimedTaxFreeThreshold | |
AUEmployingEntityAbn |
| Australian Business Numbe | Pay Details Screen Only set if employee is contractor or labour hire | taxationAU.employeeEntityABN | |
AUZoneRebate | None, A, B, S | Claim zone/special tax offset, true if declared | Pay Details Screen PAM to review the zone rebate and map to zone A, B, or S based on the distance from the nearest town. For more information, see the ATO website | taxationAU.zoneRebate | |
AUSuperIsSelfManaged | True if self managed funds Otherwise false | Pay Details Screen If there are multiple super funds in standard pay, they all get returned, PAM to review and select one before import | superFunds[0].selfManaged | ||
AUSuperFundName | FundName | Employee > Standard Pay screen | superFunds[0].fundName | ||
AUSuperMemberRef | Member ID | Employee > Standard Pay screen | superFunds[0].memberRef | ||
AUSuperUSI | USI | Superannuation Funds screen | superFunds[0].usi | ||
AUSuperAccountName | Fund Name | Superannuation Funds screen | superFunds[0].accountName | ||
AUSuperBranch | BSB | Superannuation Funds screen | superFunds[0].branch | ||
AUSuperAccountNumber | AccountNumber | Superannuation Funds screen | superFunds[0].accountNNumber | ||
AUSuperABN | ABN | Superannuation Funds screen | superFunds[0].abn | ||
AUSuperESA | ESA | Superannuation Funds screen | superFunds[0].esa | ||
AUSuperFundEmail | TBD | Super Fund email is not stored in advanced, PAM to review and update | superFunds[0].fundEmail |