---
title: "Onboarding XML structure (file)"
id: "onboarding-xml-structure-file"
project: "EHR User Guide"
url: "https://help.cloud5.com.au/articles/ehr-user-guide/onboarding-xml-structure-file"
updated: 2026-10-19T00:52:55Z
---

# Onboarding XML structure \(file\)

Here is an example of the complete onboarding XML structure on which the (detailed) data tables are based.


```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:onb="http://onboarding.service.ess.empower.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <onb:AddNewEmployees>
         <!--Optional:-->
         <Employees>
            <!--Zero or more repetitions:-->
            <Employee>
               <!--Optional:-->
               <PersonalDetails>
                  <!--Optional:-->
                  <EmployeeCode></EmployeeCode>
                  <!--Optional:-->
                  <ReEmploy></ReEmploy>
                  <!--Optional:-->
                  <Name>
                     <!--Optional:-->
                     <Surname></Surname>
                     <!--Optional:-->
                     <GivenNames></GivenNames>
                     <!--Optional:-->
                     <Title></Title>
                     <!--Optional:-->
                     <PreferredName></PreferredName>
                  </Name>
                  <!--Optional:-->
                  <BirthDate></BirthDate>
                  <!--Optional:-->
                  <Gender></Gender>
                  <!--Optional:-->
                  <StatusCode></StatusCode>
                  <!--Optional:-->
                  <StatusDate></StatusDate>
                  <!--Optional:-->
                  <CountryOfOrigin></CountryOfOrigin>
                  <!--Optional:-->
                  <ResidencyOrCitizenship></ResidencyOrCitizenship>
                  <!--Optional:-->
                  <Nationality></Nationality>
                  <!--Optional:-->
                  <Ethnicity></Ethnicity>
                  <!--Optional:-->
                  <Indigenous></Indigenous>
                  <!--Optional:-->
                  <DisabilityCategory></DisabilityCategory>
                  <!--Optional:-->
                  <Honours></Honours>
                  <!--Optional:-->
                  <DateCommencedService></DateCommencedService>
                  <!--Optional:-->
                  <UserName></UserName>
                  <!--Optional:-->
                  <EssAccess></EssAccess>
                  <!--Optional:-->
                  <alternateTemplate></alternateTemplate>
                  <!--Optional:-->
                  <ExternalAdminUnit></ExternalAdminUnit>
                  <!--Optional:-->
                  <ReferenceNumber></ReferenceNumber>
                  <!--Optional:-->
                  <DateCommencedAgency></DateCommencedAgency>
                  <!--Optional:-->
                  <DatePermanent></DatePermanent>
                  <!--Optional:-->
                  <DateConfirmed></DateConfirmed>
                  <!--Optional:-->
                  <ProbationDate></ProbationDate>
                  <!--Optional:-->
                  <Narrative></Narrative>
                  <!--Optional:-->
                  <PrivatePhoneNumber></PrivatePhoneNumber>
                  <!--Optional:-->
                  <PrivateMobile></PrivateMobile>
                  <!--Optional:-->
                  <PrivateEmail></PrivateEmail>
                  <!--Optional:-->
                  <BusinessMobile></BusinessMobile>
                  <!--Optional:-->
                  <BusinessEmail></BusinessEmail>
                  <!--Optional:-->
                  <FreeField1></FreeField1>
                  <!--Optional:-->
                  <FreeField2></FreeField2>
                  <!--Optional:-->
                  <FreeField7></FreeField7>
                  <!--Optional:-->
                  <FreeField8></FreeField8>
                  <!--Optional:-->
                  <PrivateAddress>
                     <!--Optional:-->
                     <Address1></Address1>
                     <!--Optional:-->
                     <Address2></Address2>
                     <!--Optional:-->
                     <Suburb></Suburb>
                     <!--Optional:-->
                     <PostCode></PostCode>
                     <!--Optional:-->
                     <Country></Country>
                     <!--Optional:-->
                     <NewZealandOnly>
                        <!--Optional:-->
                        <TownOrCityOrMailtown></TownOrCityOrMailtown>
                        <!--Optional:-->
                        <PostCode></PostCode>
                     </NewZealandOnly>
                  </PrivateAddress>
                  <!--Optional:-->
                  <PostalAddress>
                     <!--Optional:-->
                     <Address1></Address1>
                     <!--Optional:-->
                     <Address2></Address2>
                     <!--Optional:-->
                     <Suburb></Suburb>
                     <!--Optional:-->
                     <PostCode></PostCode>
                     <!--Optional:-->
                     <Country></Country>
                     <!--Optional:-->
                     <NewZealandOnly>
                        <!--Optional:-->
                        <TownOrCityOrMailtown></TownOrCityOrMailtown>
                        <!--Optional:-->
                        <PostCode></PostCode>
                     </NewZealandOnly>
                  </PostalAddress>
                  <!--Optional:-->
                  <EmergencyContact1>
                     <!--Optional:-->
                     <Name></Name>
                     <!--Optional:-->
                     <Relationship></Relationship>
                     <!--Optional:-->
                     <Phone></Phone>
                     <!--Optional:-->
                     <WorkPhone></WorkPhone>
                     <!--Optional:-->
                     <Mobile></Mobile>
                     <!--Optional:-->
                     <Address>
                        <!--Optional:-->
                        <Address1></Address1>
                        <!--Optional:-->
                        <Address2></Address2>
                        <!--Optional:-->
                        <Suburb></Suburb>
                        <!--Optional:-->
                        <PostCode></PostCode>
                        <!--Optional:-->
                        <Country></Country>
                     </Address>
                  </EmergencyContact1>
                  <!--Optional:-->
                  <FreeField3></FreeField3>
                  <!--Optional:-->
                  <EmergencyContact2>
                     <!--Optional:-->
                     <Name></Name>
                     <!--Optional:-->
                     <Relationship></Relationship>
                     <!--Optional:-->
                     <Phone></Phone>
                     <!--Optional:-->
                     <WorkPhone></WorkPhone>
                     <!--Optional:-->
                     <Mobile></Mobile>
                     <!--Optional:-->
                     <Address>
                        <!--Optional:-->
                        <Address1></Address1>
                        <!--Optional:-->
                        <Address2></Address2>
                        <!--Optional:-->
                        <Suburb></Suburb>
                        <!--Optional:-->
                        <PostCode></PostCode>
                        <!--Optional:-->
                        <Country></Country>
                     </Address>
                  </EmergencyContact2>
                  <!--Optional:-->
                  <FreeField4></FreeField4>
                  <!--Optional:-->
                  <EmergencyContact3>
                     <!--Optional:-->
                     <Name></Name>
                     <!--Optional:-->
                     <Relationship></Relationship>
                     <!--Optional:-->
                     <Phone></Phone>
                     <!--Optional:-->
                     <WorkPhone></WorkPhone>
                     <!--Optional:-->
                     <Mobile></Mobile>
                     <!--Optional:-->
                     <Address>
                        <!--Optional:-->
                        <Address1></Address1>
                        <!--Optional:-->
                        <Address2></Address2>
                        <!--Optional:-->
                        <Suburb></Suburb>
                        <!--Optional:-->
                        <PostCode></PostCode>
                        <!--Optional:-->
                        <Country></Country>
                     </Address>
                  </EmergencyContact3>
                  <!--Optional:-->
                  <PreviousBmsId></PreviousBmsId>
                  <!--Optional:-->
                  <PreviousPayrollId></PreviousPayrollId>
                  <!--Optional:-->
                  <Religion></Religion>
                  <!--Optional:-->
                  <MainLanguageSpokenAtHome></MainLanguageSpokenAtHome>
                  <!--Optional:-->
                  <DisabilityType></DisabilityType>
                  <!--Optional:-->
                  <WorkplaceModification></WorkplaceModification>
                  <!--Optional:-->
                  <DateImplemented></DateImplemented>
                  <!--Optional:-->
                  <DateLastReviewed></DateLastReviewed>
                  <!--Optional:-->
                  <CarersResponsibility></CarersResponsibility>
                  <!--Optional:-->
                  <HighestQualificationLevel></HighestQualificationLevel>
                  <!--Optional:-->
                  <FieldOfStudy></FieldOfStudy>
                  <!--Optional:-->
                  <FreeField9></FreeField9>
                  <!--Optional:-->
                  <FreeField10></FreeField10>
                  <!--Optional:-->
                  <FreeField11></FreeField11>
                  <!--Optional:-->
                  <FreeField12></FreeField12>
                  <!--Optional:-->
                  <FreeField13></FreeField13>
                  <!--Optional:-->
                  <FreeField14></FreeField14>
<Gender Diversity>
    <GenderIdentity></GenderIdentity>
    <!--Optional:-->
    <AdditionalGenderIdentityInformation> </AdditionalGenderIdentityInformation>
    <!--Optional:-->
    <SexualOrientation></SexualOrientation>
    <!--Optional:-->
    <AdditionalSexualOrientationInformation> </AdditionalSexualOrientationInformation>
    <!--Optional:-->
    <Intersex></Intersex>
<Gender Diversity>
               </PersonalDetails>
               <!--Optional:-->
               <PositionAndRenumeration>
                  <!--Optional:-->
                  <Position></Position>
                  <!--Optional:-->
                  <PositionStartDate></PositionStartDate>
                  <!--Optional:-->
                  <PositionEndDate></PositionEndDate>
                  <!--Optional:-->
                  <Classification></Classification>
                  <!--Optional:-->
                  <AwardLevel></AwardLevel>
                  <!--Optional:-->
                  <CostCentre></CostCentre>
                  <!--Optional:-->
                  <AdminUnit></AdminUnit>
                  <!--Optional:-->
                  <ProgramActivityOrJobNumber></ProgramActivityOrJobNumber>
                  <!--Optional:-->
                  <Section></Section>
                  <!--Optional:-->
                  <Duties></Duties>
                  <!--Optional:-->
                  <Location></Location>
                  <!--Optional:-->
                  <Authority></Authority>
                  <!--Optional:-->
                  <EmployeeType></EmployeeType>
                  <!--Optional:-->
                  <EmploymentCondition></EmploymentCondition>
                  <!--Optional:-->
                  <ProbationPeriod></ProbationPeriod>
                  <!--Optional:-->
                  <WorkPattern></WorkPattern>
                  <!--Optional:-->
<PublicHoliday></PublicHoliday>
                  <!--Optional:-->
                  <ContractExpiryReason></ContractExpiryReason>
                  <!--Optional:-->
                  <ContractExpiryDate></ContractExpiryDate>
                  <!--Optional:-->
                  <ContractSigned></ContractSigned>
                  <!--Optional:-->
                  <UserField4></UserField4>
                  <!--Optional:-->
                  <UserField5></UserField5>
                  <!--Optional:-->
                  <Narrative></Narrative>
                  <!--Optional:-->
                  <PayBasis></PayBasis>
                  <!--Optional:-->
                  <HoursPerPeriod></HoursPerPeriod>
                  <!--Optional:-->
                  <HoursPerWeek></HoursPerWeek>
                  <!--Optional:-->
                  <FtePercentage></FtePercentage>
                  <!--Optional:-->
                  <BaseSalary></BaseSalary>
                  <!--Optional:-->
                  <HourlyRate></HourlyRate>
                  <!--Optional:-->
                  <VariationPercentage></VariationPercentage>
                  <!--Optional:-->
                  <VariationAmount></VariationAmount>
                  <!--Optional:-->
                  <SalaryMaintain></SalaryMaintain>
                  <!--Optional:-->
                  <SalaryBarrierLevel></SalaryBarrierLevel>
                  <!--Optional:-->
                  <NextIncrementDate></NextIncrementDate>
                  <!--Optional:-->
                  <AutoIncrement></AutoIncrement>
                  <!--Optional:-->
                  <PayByException></PayByException>
                  <!--Optional:-->
                  <Pay></Pay>
                  <!--Optional:-->
                  <PayStartDate></PayStartDate>
<!--Optional:-->
                  <RemunerationNarrative></RemunerationNarrative>
               </PositionAndRenumeration>
               <!--Optional:-->
               <SplitCostCodes>
                  <!--Zero or more repetitions:-->
                  <CostCode>
                     <CostCentre></CostCentre>
                     <Percentage></Percentage>
                  </CostCode>
                  <CostCode>
                     <CostCentre></CostCentre>
                     <Percentage></Percentage>
                  </CostCode>
               </SplitCostCodes>
               <!--Optional:-->
               <TaxAndDeclaration>
                  <!--Optional:-->
                  <TaxDetailsEffectiveFrom></TaxDetailsEffectiveFrom>
                  <!--Optional:-->
                  <PayrollCode></PayrollCode>
                  <!--Optional:-->
                  <AbnNumber></AbnNumber>
                  <!--Optional:-->
                  <AbnBranch></AbnBranch>
                  <!--Optional:-->
                  <PayMethod></PayMethod>
                  <!--Optional:-->
                  <PayLocation></PayLocation>
                  <!--Optional:-->
                  <TaxFileNumber></TaxFileNumber>
                  <!--Optional:-->
                  <DateDeclarationFormSigned></DateDeclarationFormSigned>
                  <!--Optional:-->
                  <PreviousName>
                     <!--Optional:-->
                     <Surname></Surname>
                     <!--Optional:-->
                     <FirstGiven></FirstGiven>
                     <!--Optional:-->
                     <SecondGiven></SecondGiven>
                  </PreviousName>
                  <!--Optional:-->
 <BasisOfPayment></BasisOfPayment>
                  <!--Optional:-->
                  <FamilyTaxOrSeniorTax></FamilyTaxOrSeniorTax>
                  <!--Optional:-->
                  <ZoneOrDependantOrSpecial></ZoneOrDependantOrSpecial>
                  <!--Optional:-->
                  <TaxOffsetAnnuityOrSuper></TaxOffsetAnnuityOrSuper>
                  <!--Optional:-->
                  <PayeeSignaturePresent></PayeeSignaturePresent>
                  <!--Optional:-->
                  <TaxScale></TaxScale>
                  <!--Optional:-->
                  <KiwiSaverStatus></KiwiSaverStatus>
                  <!--Optional:-->
                  <GenerateSTSL></GenerateSTSL>
                  <!--Optional:-->
                  <StpTaxTreatmentCode></StpTaxTreatmentCode>
                  <!--Optional:-->
                  <StpIncomeStream></StpIncomeStream>
                  <!--Optional:-->
                  <StpIncomeStreamCountryCode></StpIncomeStreamCountryCode>
                  <!--Optional:-->
                  <FlatTaxRate></FlatTaxRate>
                  <!--Optional:-->
                  <SchoolChristmasLeaveInAdvance></SchoolChristmasLeaveInAdvance>
                  <!--Optional:-->
                  <MedicareClaimed></MedicareClaimed>
                  <!--Optional:-->
                  <MedicareDependants></MedicareDependants>
                  <!--Optional:-->
                  <TaxRebateCode></TaxRebateCode>
                  <!--Optional:-->
                  <TaxZoneCode></TaxZoneCode>
                  <!--Optional:-->
                  <DependantOrZoneRebate></DependantOrZoneRebate>
                  <!--Optional:-->
                  <PercentageVariation></PercentageVariation>
                  <!--Optional:-->
                  <FromDate></FromDate>
                  <!--Optional:-->
                  <UptoDate></UptoDate>
                  <!--Optional:-->
                  <IrdTaxFileNumber></IrdTaxFileNumber>
                  <!--Optional:-->
                  <StandardStudentLoanCalc></StandardStudentLoanCalc>
                  <!--Optional:-->
                  <StudentLoanFlatPercent></StudentLoanFlatPercent>
                  <!--Optional:-->
                  <EmolumentRate></EmolumentRate>
                  <!--Optional:-->
                  <NonResident></NonResident>
                  <!--Optional:-->
                  <VoluntaryWithholdingRate></VoluntaryWithholdingRate>
               </TaxAndDeclaration>
               <!--Optional:-->
               <SuperFund>
                  <!--Optional:-->
                  <SuperFund></SuperFund>
                  <!--Optional:-->
                  <MembershipNumber></MembershipNumber>
                  <!--Optional:-->
                  <FundCategory></FundCategory>
                  <!--Optional:-->
                  <DateJoined></DateJoined>
               </SuperFund>
               <!--Optional:-->
               <RegularTransactions>
                  <!--Zero or more repetitions:-->
                  <Transaction>
                     <!--Optional:-->
                     <PaymentCode></PaymentCode>
                     <!--Optional:-->
                     <SequenceNumber></SequenceNumber>
                     <!--Optional:-->
                     <PriorityNumber></PriorityNumber>
                     <!--Optional:-->
                     <Amount></Amount>
                     <!--Optional:-->
                     <Percentage></Percentage>
                     <!--Optional:-->
                     <DateFrom></DateFrom>
                     <!--Optional:-->
                     <DateUpto></DateUpto>
                     <!--Optional:-->
                     <Limit></Limit>
                     <!--Optional:-->
                     <Reference></Reference>
  <!--Optional:-->
                     <AnnualAmount></AnnualAmount>
                     <!--Optional:-->
                     <CostCentre></CostCentre>
                     <!--Optional:-->
                     <Hours></Hours>
                     <!--Optional:-->
                     <ByEmployment></ByEmployment>
                     <!--Optional:-->
                     <SuperExemptionTest></SuperExemptionTest>
                  </Transaction>
               </RegularTransactions>
               <!--Optional:-->
               <PaymentInstruction>
                  <!--Optional:-->
                  <BsbNumber></BsbNumber>
                  <!--Optional:-->
                  <AccountNumber></AccountNumber>
                  <!--Optional:-->
                  <AccountName></AccountName>
                  <!--Optional:-->
                  <PaymentMethod></PaymentMethod>
                  <!--Optional:-->
                  <PaymentPriority></PaymentPriority>
                  <!--Optional:-->
                  <StandardAmount></StandardAmount>
               </PaymentInstruction>
               <!--Optional:-->
               <RegularAllowances>
                  <!--Zero or more repetitions:-->
                  <Allowance>
                     <!--Optional:-->
                     <PaymentCode></PaymentCode>
                     <!--Optional:-->
                     <DateFrom></DateFrom>
                     <!--Optional:-->
                     <DateUpto></DateUpto>
                     <!--Optional:-->
                     <RatePerHour></RatePerHour>
                     <!--Optional:-->
                     <RatePerPayPeriod></RatePerPayPeriod>
                     <!--Optional:-->
                     <RatePerYear></RatePerYear>
                     <!--Optional:-->
                     <FixedAmountPerPeriod></FixedAmountPerPeriod>
                     <!--Optional:-->
                     <UnitOfMeasure></UnitOfMeasure>
                     <!--Optional:-->
                     <TriggerElementCode></TriggerElementCode>
                     <!--Optional:-->
                     <CostCentre></CostCentre>
                     <!--Optional:-->
                     <Comment></Comment>
                  </Allowance>
               </RegularAllowances>
               <!--Optional:-->
               <Leave>
                  <!--Optional:-->
                  <NormalLeaveAllocations>
                     <!--Zero or more repetitions:-->
                     <NormalLeaveAllocation>
                        <!--Optional:-->
                        <LeaveType></LeaveType>
                        <!--Optional:-->
                        <LeaveCode></LeaveCode>
                        <!--Optional:-->
                        <LeaveReason></LeaveReason>
                        <!--Optional:-->
                        <WorkPattern></WorkPattern>
                        <!--Optional:-->
                        <PublicHolidayCalendar></PublicHolidayCalendar>
                        <!--Optional:-->
                        <IgnorePriorDeferrals></IgnorePriorDeferrals>
                        <!--Optional:-->
                        <LoadingHours></LoadingHours>
                        <!--Optional:-->
                        <StartDate></StartDate>
                        <!--Optional:-->
                        <LastAccrualDate></LastAccrualDate>
                        <!--Optional:-->
                        <LastAccrualDateAtSetUp></LastAccrualDateAtSetUp>
                        <!--Optional:-->
                        <TakeOnHours></TakeOnHours>
                     </NormalLeaveAllocation>
                  </NormalLeaveAllocations>
                  <!--Optional:-->
<LongServiceLeaveInDays>
                     <!--Optional:-->
                     <LeaveType></LeaveType>
                     <!--Optional:-->
                     <LeaveCode></LeaveCode>
                     <!--Optional:-->
                     <LeaveReasonCode></LeaveReasonCode>
                     <!--Optional:-->
                     <AccrueByHourPaid></AccrueByHourPaid>
                     <!--Optional:-->
                     <IgnorePriorDeferrals></IgnorePriorDeferrals>
                     <!--Optional:-->
                     <StartDate></StartDate>
                     <!--Optional:-->
                     <LastAccrualDate></LastAccrualDate>
                     <!--Optional:-->
                     <LastAccrualDateAtSetUp></LastAccrualDateAtSetUp>
                     <!--Optional:-->
                     <DayToAccrueOn></DayToAccrueOn>
                     <!--Optional:-->
                     <DayAndMonthToAccrueOn></DayAndMonthToAccrueOn>
                     <!--Optional:-->
                     <AccrualDate></AccrualDate>
                     <!--Optional:-->
                     <PercentageAccrued></PercentageAccrued>
                     <!--Optional:-->
                     <AmountAccruedAvailable></AmountAccruedAvailable>
                     <!--Optional:-->
                     <AmountAccruedNotAvailable></AmountAccruedNotAvailable>
                     <!--Optional:-->
                     <FullTimePercentage></FullTimePercentage>
                     <!--Optional:-->
                     <NumberOfCalendarDays></NumberOfCalendarDays>
                  </LongServiceLeaveInDays>
                  <!--Optional:-->
                  <LongServiceLeaveInHours>
                     <!--Optional:-->
                     <LeaveType></LeaveType>
                     <!--Optional:-->
                     <LeaveCode></LeaveCode>
                     <!--Optional:-->
                     <LeaveReason></LeaveReason>
                     <!--Optional:-->
                     <AccrueByHourPaid></AccrueByHourPaid>
                     <!--Optional:-->
                     <StartDate></StartDate>
                     <!--Optional:-->
                     <LastAccrualDate></LastAccrualDate>
                     <!--Optional:-->
                     <LastAccrualDateAtSetUp></LastAccrualDateAtSetUp>
                     <!--Optional:-->
                     <RuleEffectiveDate></RuleEffectiveDate>
                     <!--Optional:-->
                     <AccrualPerDay></AccrualPerDay>
                     <!--Optional:-->
                     <AccrualPerHour></AccrualPerHour>
                     <!--Optional:-->
                     <StandardHoursPerDay></StandardHoursPerDay>
                     <!--Optional:-->
                     <AccrualDate></AccrualDate>
                     <!--Optional:-->
                     <PercentAccrued></PercentAccrued>
                     <!--Optional:-->
                     <AverageFtePercentage></AverageFtePercentage>
                     <!--Optional:-->
                     <CurrentBalanceInHours></CurrentBalanceInHours>
                     <!--Optional:-->
                     <NonCurrentBalanceInHours></NonCurrentBalanceInHours>
                     <!--Optional:-->
                     <DaysInAccrualPeriod></DaysInAccrualPeriod>
                  </LongServiceLeaveInHours>
               </Leave>
               <!--Optional:-->
               <AdditionalDataTypes>
                  <!--Zero or more repetitions:-->
                  <AdditionalData>
                     <!--Optional:-->
                     <ParentDataType></ParentDataType>
                     <!--Optional:-->
                     <DataType></DataType>
                     <!--Optional:-->
                     <SequenceNumber></SequenceNumber>
                     <!--Optional:-->
                     <DataField1></DataField1>
                     <!--Optional:-->
                     <DataField2></DataField2>
                     <!--Optional:-->
                     <DataField3></DataField3>
                     <!--Optional:-->
                     <DataField4></DataField4>
                     <!--Optional:-->
                     <DataField5></DataField5>
                     <!--Optional:-->
                     <DataField6></DataField6>
                     <!--Optional:-->
                     <DataField7></DataField7>
                     <!--Optional:-->
                     <DataField8></DataField8>
                     <!--Optional:-->
                     <DataField9></DataField9>
                     <!--Optional:-->
                     <DataField10></DataField10>
                     <!--Optional:-->
                     <Highlight></Highlight>
                  </AdditionalData>
               </AdditionalDataTypes>
            </Employee>
         </Employees>
      </onb:AddNewEmployees>
   </soapenv:Body>
</soapenv:Envelope>


```


| Next topic<br><br>[Overtime code fields](/articles/ehr-user-guide/overtime-code-fields) |
| --- |

© 2023 Fusion5. All rights reserved.