View source for Xero Payroll (Australia) Endpoint: EmployeesExpanded

== Overview ==

The Xero '''EmployeesExpanded''' [[Xero Payroll (Australia) Endpoints|endpoint]] provides the list of employees.

This endpoint provides all detailed information for employees.

You can also integrate with [[Xero Payroll (Australia) Endpoint: Employees|Employees]] which provides more summarised information and may perform better but doesn't have access to all fields.


== Fields ==

The following fields are available for the EmployeesExpanded endpoint.

;EmployeeID
:A [[Field Type: GUID|guid field]] that provides the id of the employee.

;FirstName
:A [[Field Type: Text|text field]] that provides the first name of the employee.

;MiddleNames
:A [[Field Type: Text|text field]] that provides the middle name of the employee.

;LastName
:A [[Field Type: Text|text field]] that provides the last name of the employee.

;HomeAddress
:A [[Field Type: Record|record field]] that provides the home address details of the employee.
:See [[#HomeAddress Fields|HomeAddress Fields]] for more information.

;DateOfBirth
:A [[Field Type: Date|date field]] that provides the date of birth of the employee.

;Gender
:A [[Field Type: Text|text field]] that provides the gender of the employee.

;Email
:A [[Field Type: Text|text field]] that provides the email address of the employee.

;Phone
:A [[Field Type: Text|text field]] that provides the phone number of the employee.

;Mobile
:A [[Field Type: Text|text field]] that provides the mobile phone number of the employee.

;TwitterUserName
:A [[Field Type: Text|text field]] that provides the twitter user name of the employee.

;JobTitle
:A [[Field Type: Text|text field]] that provides the job title of the employee.

;Classification
:A [[Field Type: Text|text field]] that provides the classification of the employee.

;EmployeeGroupName
:A [[Field Type: Text|text field]] that provides the employee group name of the employee.

;StartDate
:A [[Field Type: Date|date field]] that provides the start date of the employee.

;TerminationDate
:A [[Field Type: Date|date field]] that provides the end date of the termination date of the employee.

;TerminationReason
:A [[Field Type: Text|text field]] that provides the termination reason code of the employee.
:Possible values are:
:* '''V''': This indicates the employee resigned, retired, or abandonned employment.
:* '''I''': This indicates the employee resigned due to medical condition that prevents the continuation of employment, such as for illness, ill-health, medical unfitness or total permanent disability.
:* '''D''': This indicates the employee is deceased.
:* '''R''': This indicates the employee was made redundant due to a genuine redundancy or approved early retirement scheme.
:* '''F''': This indicates the employee was terminated due to dismissal, inability to perform the required work, misconduct or inefficiency.
:* '''C''': This indicates the employee was termminated due to natural conclusion of a limited employment relationship such as contract/engagement duration or task completion, seasonal work completion, or to cease casuals that are no longer required.
:* '''T''': This indicates the employee was transfered across payroll systems, moved  temporarily to another employer (machinery of government for public servants), transferred to another business, moved to outsourcing arrangements or other such technical activities.

;Status
:A [[Field Type: Text|text field]] that provides the status of the employee.
:Possible values are:
:* '''ACTIVE''': Indicates the employee is active.
:* '''TERMINATED: Indicates the employee has been terminated.

;OrdinaryEarningsRateID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (Australia) Endpoint: PayItemsEarningsRates|earnings rate id]] used for ordinary wages.

;PayrollCalendarID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (Australia) Endpoint: PayrollCalendars|payroll calendar id]] of the employee.

;IsAuthorisedToApproveLeave
:A [[Field Type: Boolean|true/false field]] that indicates if the employee is authorised to approve leave.

;IsAuthorisedToApproveTimesheets
:A [[Field Type: Boolean|true/false field]] that indicates if the employee is authorised to approve timsheets.

;TaxDeclaration
:A [[Field Type: Record|record field]] that provides additional tax declaration fields.
:See [[#TaxDeclaration Fields|TaxDeclaration Fields]] for more information.

;BankAccounts
:A [[Field Type: Table|table field]] that provides bank account details.
:See [[#BankAccounts Fields|BankAccounts Fields]] for more information.

;SuperMemberships
:A [[Field Type: Table|table field]] that provides superannuation membership details.
:See [[#SuperMemberships Fields|SuperMemberships Fields]] for more information.

;PayTemplate
:A [[Field Type: Record|record field]] that provides the pay template.
:See [[#PayTemplate Fields|PayTemplate Fields]] for more information.

;OpeningBalances
:A [[Field Type: Record|record field]] that provides opening balances
:See [[#OpeningBalances Fields|OpeningBalances Fields]] for more information.

;LeaveBalances
:A [[Field Type: Record|record field]] that provides closing leave balances as at the end of time.
:See [[#LeaveBalances Fields|LeaveBalances Fields]] for more information.

;UpdatedDateUTC
:A [[Field Type: DateTimeOffset|date time field]] that indicates the last time this record was updated.


== HomeAddress Fields ==

The [[#Fields|HomeAddress Fields]] include the following sub fields.

;AddressLine1
:A [[Field Type: Text|text field]] that provides the first line of the address of the employee.

;AddressLine2
:A [[Field Type: Text|text field]] that provides the second line of the address of the employee.

;City
:A [[Field Type: Text|text field]] that provides the city of the employee.

;Region
:A [[Field Type: Text|text field]] that provides the state of the employee.

;PostalCode
:A [[Field Type: Text|text field]] that provides the post code of the employee.

;Country
:A [[Field Type: Text|text field]] that provides the country of the employee.


== TaxDeclaration Fields ==

The [[#Fields|TaxDeclaration Fields]] include the following sub fields.

;EmploymentBasis
:A [[Field Type: Text|text field]] that provides the employment basis of the employee.
:Possible values are:
:* '''FULLTIME'''
:* '''PARTTIME'''
:* '''CASUAL'''
:* '''LABOURHIRE'''
:* '''SUPERINCOMESTREAM'''

;ResidencyStatus
:A [[Field Type: Text|text field]] that provides the residency status of the employee.
:Possible values are:
:* '''AUSTRALIANRESIDENT''': Indicates the employee is an Australian resident for tax purposes. 
:* '''FOREIGNRESIDENT''': Indicates the employee is a foreign resident for tax purposes. 
:* '''WORKINGHOLIDAYMAKER''': Indicates the employee is a working holiday maker for tax purposes. 

;TFNExemptionType
:A [[Field Type: Text|text field]] that provides the residency status of the employee.
:Possible values are:
:* '''NOTQUOTED''': Indicates the employee has not provided a TFN.
:* '''PENDING''': Indicates the employee has made a separate application or Enquiry to the ATO for a new or existing TFN.
:* '''PENSIONER''': Indicates the employee is claiming that they are in receipt of a pension, benefit or allowance.
:* '''UNDER18''': Indicates the employee is claiming an exemption as they are under the age of 18 and do not earn enough to pay tax.

;TaxFileNumber
:A [[Field Type: Text|text field]] that provides the tax file number of the employee.

;AustralianResidentForTaxPurposes
:A [[Field Type: Boolean|true/false field]] that indicates if the employee is a resident for tax purposes.
:This field will be set to '''true''' if '''ResidencyStatus''' is set to '''AustralianResidentForTaxPurposes'''.  Otherwise, it will be set to '''false'''.

;TaxFreeThresholdClaimed
:A [[Field Type: Boolean|true/false field]] that indicates if the employee is claiming the tax free threshold for this employer.

;HasHELPDebt
:A [[Field Type: Boolean|true/false field]] that indicates if the employee has a HELP or HECS debt.
:This field is deprecated and only provided for backwards compatibility reason.

;HasSFSSDebt
:A [[Field Type: Boolean|true/false field]] that indicates if the employee has a SFSS or financial supplement debt.
:This field is deprecated and only provided for backwards compatibility reason.

;HasTradeSupportLoanDebt
:A [[Field Type: Boolean|true/false field]] that indicates if the employee has a trade support loan.
:This field is deprecated and only provided for backwards compatibility reason.

;HasStudentStartupLoan
:A [[Field Type: Boolean|true/false field]] that indicates if the employee has a student startup loan.
:This field is deprecated and only provided for backwards compatibility reason.

;HasLoanOrStudentDebt
:A [[Field Type: Boolean|true/false field]] that indicates if the employee has one of the following loans.
:* Higher Education Loan Program (HELP/HECS)
:* VET Student Loan (VSL)
:* Financial Supplement (FS)
:* Student Start-up Loan (SSL)
:* Trade Support Loan (TSL).

;EligibleToReceiveLeaveLoading
:A [[Field Type: Boolean|true/false field]] that indicates if the employee is eligible to receive an additional percentage on top of ordinary earnings when they take leave (typically 17.5%).

;IncludeLeaveLoadingInSGC
:A [[Field Type: Boolean|true/false field]] that indicates leave loading is included in superannuation guarantee contribution.

;TaxOffsetEstimatedAmount
:A [[Field Type: Decimal|decimal field]] that provides the tax offset estimated amount.

;UpwardVariationTaxWithholdingAmount
:A [[Field Type: Decimal|decimal field]] that provides the additional tax amount if the employee elected to have additional tax withheld.

;ApprovedWithholdingVariationPercentage
:A [[Field Type: Decimal|decimal field]] that provides the approved withholding variation percentage.


== BankAccounts Fields ==

The [[#Fields|BankAccounts Fields]] include the following sub fields.

;BSB
:A [[Field Type: Text|text field]] that provides the BSB of the employee.

;AccountNumber
:A [[Field Type: Text|text field]] that provides the bank account number of the employee.

;AccountName
:A [[Field Type: Text|text field]] that provides the bank account name of the employee.

;StatementText
:A [[Field Type: Text|text field]] that provides the text to include on statement for the employee.

;Remainder
:A [[Field Type: Boolean|true/false field]] that indicates if the balance remaining of any payments will be distributed to this bank account.

;Amount
:A [[Field Type: Decimal|decimal field]] that provides a fixed amount that will be applied to this bank account first.


== SuperMemberships Fields ==

The [[#Fields|SuperMemberships Fields]] include the following sub fields.

;SuperMembershipID
:A [[Field Type: GUID|guid field]] that provides the super membership ID.

;SuperFundID
:A [[Field Type: GUID|guid field]] that provides the super fund ID.
:This field can be linked to the [[Xero Payroll (Australia) Endpoint: SuperFunds|SuperFunds]] endpoint.

;EmployeeNumber
:A [[Field Type: Text|text field]] that provides the employee numnber for the super fund.


== PayTemplate Fields ==

The [[#Fields|PayTemplate Fields]] include the following sub fields.

;EarningsLines
:A [[Field Type: Table|table field]] that provides earning lines for this emplopyee.
:See [[#PayTemplate.EarningsLines Fields|PayTemplate.EarningsLines Fields]] for more information.

;DeductionLines
:A [[Field Type: Table|table field]] that provides deduction lines for this emplopyee.
:See [[#PayTemplate.DeductionLines Fields|PayTemplate.DeductionLines Fields]] for more information.

;SuperLines
:A [[Field Type: Table|table field]] that provides superannuation lines for this emplopyee.
:See [[#PayTemplate.SuperLines Fields|PayTemplate.SuperLines Fields]] for more information.

;ReimbursementLines
:A [[Field Type: Table|table field]] that provides reimbursement lines for this emplopyee.
:See [[#PayTemplate.ReimbursementLines Fields|PayTemplate.ReimbursementLines Fields]] for more information.

;LeaveLines
:A [[Field Type: Table|table field]] that provides leave lines for this emplopyee.
:See [[#PayTemplate.LeaveLines Fields|PayTemplate.LeaveLines Fields]] for more information.


== PayTemplate.EarningsLines Fields ==

The [[#PayTemplate Fields|PayTemplate.EarningsLines Fields]] include the following sub fields.

;EarningsRateID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (Australia) Endpoint: PayItemsEarningsRates|earnings rate id]] associated with this pay template line.

;CalculationType
:A [[Field Type: Text|text field]] that indicates the calculation type of this earnings line.
:Possible values are:
:* '''USEEARNINGSRATE''': Indicates it uses the rate per unit recorded for the earnings rate under Settings
:* '''ENTEREARNINGSRATE''': Indicates it uses the rate per unit is be added manually to the earnings line
:* '''ANNUALSALARY''': Indicates it uses the employee receives a fixed annual salary amount.

;AnnualSalary
:A [[Field Type: Decimal|decimal field]] that provides the provides the annual salary of the employee.

;NumberOfUnitsPerWeek
:A [[Field Type: Decimal|decimal field]] that provides the number of hours worked per week for this earnings rate.

;RatePerUnit
:A [[Field Type: Decimal|decimal field]] that provides the hourly rate for this earning rate.

;NormalNumberOfUnits
:A [[Field Type: Decimal|decimal field]] that provides the normal number of hours worked.

;FixedAmount
:A [[Field Type: Decimal|decimal field]] that provides the fixed amount of hours worked.


== PayTemplate.DeductionLines Fields ==

The [[#PayTemplate Fields|PayTemplate.DeductionLines Fields]] include the following sub fields.

;DeductionTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (Australia) Endpoint: PayItemsDeductionTypes|pay item deduction type id]] associated with this pay template line.

;CalculationType
:A [[Field Type: Text|text field]] that provides the calculation type.
:Possible values are:
:* '''FIXEDAMOUNT'''
:* '''PRETAX'''
:* '''POSTTAX'''

;Percentage
:A [[Field Type: Decimal|decimal field]] that provides the percentage rate if applicable.

;Amount
:A [[Field Type: Decimal|decimal field]] that provides the amount of this pay template line.


== PayTemplate.SuperLines Fields ==

The [[#PayTemplate Fields|PayTemplate.SuperLines Fields]] include the following sub fields.

;SuperMembershipID
:A [[Field Type: GUID|guid field]] that provides the id of the super membership fund.

;ContributionType
:A [[Field Type: Text|text field]] that provides the type of contribution.
:Possible values are:
:* '''SGC''': Indicates this is a mandatory contribution.
'''SALARYSACRIFICE''': Indicates this is a pre-tax reportable employer superannuation contribution, which is displayed separately on payment summaries
'''EMPLOYERADDITIONAL''': Indicates this is a additional employer superannuation contribution, which is displayed as RESC on payment summaries
'''EMPLOYEE''': Indicates this is a post-tax employee superannuation contribution

;CalculationType
:A [[Field Type: Text|text field]] that provides the type of contribution.
:Possible values are:
:* '''FIXEDAMOUNT''': Indicates the super contribution is a fixed amount.
:* '''PERCENTAGEOFEARNINGS''': Indicates the super contribution is a calculated as a percentage of earnings.
:* '''STATUTORY''': Indicates the super contribution is a calculated as the statutory rate.

;ExpenseAccountCode
:A [[Field Type: Text|text field]] that provides the expense account code for this pay template line.
:This field links with the [[Xero Accounting Endpoint: Accounts|Accounts]] endpoint of the  [[Xero Accounting Models|Xero Accounting Model]].

;LiabilityAccountCode
:A [[Field Type: Text|text field]] that provides the liability account code for this pay template line.
:This field links with the [[Xero Accounting Endpoint: Accounts|Accounts]] endpoint of the  [[Xero Accounting Models|Xero Accounting Model]].

;MinimumMonthlyEarnings
:A [[Field Type: Decimal|decimal field]] that provides the minimum monthly earnings required to quality.

;Percentage
:A [[Field Type: Decimal|decimal field]] that provides the percentage rate used to calculate the amount (if applicable).

;Amount
:A [[Field Type: Decimal|decimal field]] that provides the amount.


== PayTemplate.ReimbursementLines Fields ==

The [[#PayTemplate Fields|PayTemplate.ReimbursementLines Fields]] include the following sub fields.

;ReimbursementTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (Australia) Endpoint: PayItemsReimbursementTypes|pay item reimbursement type id]] associated with this pay template line.

;Description
:A [[Field Type: Text|text field]] that provides the description for this pay template line.

;Amount
:A [[Field Type: Decimal|decimal field]] that provides the amount of this pay template line.


== PayTemplate.LeaveLines Fields ==

The [[#PayTemplate Fields|PayTemplate.LeaveLines Fields]] include the following sub fields.

;LeaveTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (Australia) Endpoint: PayItemsLeaveTypes|pay item leave type id]] associated with this pay template line.

;Description
:A [[Field Type: Text|text field]] that provides calculation method.
:Possible values are:
:* '''NOCALCULATIONREQUIRED''': Indicates no leave will be accrued. Manual leave accruals can be done on the payslip if required.
:* '''FIXEDAMOUNTEACHPERIOD''': Indicates leave accrues a fixed amount of leave each pay period based on annual entitlement.
:* '''ENTERRATEINPAYTEMPLATE''': Indicates leave will be entered manually.
:* '''BASEDONORDINARYEARNINGS''': Indicates leave will accrue a relative amount of leave on the number of hours an employee works in the pay period.

;AnnualNumberOfUnits
:A [[Field Type: Decimal|decimal field]] that provides the total number of units applicable per year for this pay template line.

;FullTimeNumberOfUnitsPerPeriod
:A [[Field Type: Decimal|decimal field]] that provides the number of units applicable per pay period for this pay template line.

;NumberOfUnits
:A [[Field Type: Decimal|decimal field]] that provides the number of units for this pay template line.

;EntitlementFinalPayPayoutType
:A [[Field Type: Text|text field]] that indicates how leave balances will be paid out on termination.
:Possible values are:
:* '''NOTPAIDOUT'''
:* '''PAIDOUT'''

;EmploymentTerminationPaymentType
:A [[Field Type: Text|text field]] that indicates how leave balances will be paid out on termination.
:This field will be set to '''O'''' if '''EntitlementFinalPayPayoutType''' is set to '''PAIDOUT'''

;IncludeSuperannuationGuaranteeContribution
:A [[Field Type: Boolean|true/false field]] that indicates if ETP leave earnings are subject to superannuation guarantee contribution (SGC).


== OpeningBalances Fields ==

The [[#Fields|OpeningBalances Fields]] include the following sub fields.

;OpeningBalanceDate
:A [[Field Type: Date|date field]] that provides the as-at-date used to calculate the opening balances.

;Tax
:A [[Field Type: Decimal|decimal field]] that provides the opening balance tax amount.

;EarningsLines
:A [[Field Type: Table|table field]] that provides the opening balance for earning lines for this emplopyee.
:See [[#OpeningBalances.EarningsLines Fields|OpeningBalances.EarningsLines Fields]] for more information.

;DeductionLines
:A [[Field Type: Table|table field]] that provides the opening balance for deduction lines for this emplopyee.
:See [[#OpeningBalances.DeductionLines Fields|OpeningBalances.DeductionLines Fields]] for more information.

;SuperLines
:A [[Field Type: Table|table field]] that provides the opening balance for superannuation lines for this emplopyee.
:See [[#OpeningBalances.SuperLines Fields|OpeningBalances.SuperLines Fields]] for more information.

;ReimbursementLines
:A [[Field Type: Table|table field]] that provides the opening balance for reimbursement lines for this emplopyee.
:See [[#OpeningBalances.ReimbursementLines Fields|OpeningBalances.ReimbursementLines Fields]] for more information.

;LeaveLines
:A [[Field Type: Table|table field]] that provides the opening balance for leave lines for this emplopyee.
:See [[#OpeningBalances.LeaveLines Fields|OpeningBalances.LeaveLines Fields]] for more information.


== OpeningBalances.EarningsLines Fields ==

The [[#Fields|OpeningBalances.EarningsLines Fields]] include the following sub fields.

;EarningsRateID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (Australia) Endpoint: PayItemsEarningsRates|earnings rate id]] associated with this opening balance.

;Amount
:A [[Field Type: Decimal|decimal field]] that provides the amount.


== OpeningBalances.DeductionLines Fields ==

The [[#Fields|OpeningBalances.DeductionLines Fields]] include the following sub fields.

;DeductionTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (Australia) Endpoint: PayItemsDeductionTypes|deduction type id]] associated with this opening balance.

;Amount
:A [[Field Type: Decimal|decimal field]] that provides the amount.


== OpeningBalances.SuperLines Fields ==

The [[#Fields|OpeningBalances.SuperLines Fields]] include the following sub fields.

;SuperMembershipID
:A [[Field Type: GUID|guid field]] that provides the super membership id associated with this opening balance.

;ContributionType
:A [[Field Type: Text|text field]] that provides the type of contribution.
:Possible values are:
:* '''SGC''': Indicates this is a mandatory contribution.
'''SALARYSACRIFICE''': Indicates this is a pre-tax reportable employer superannuation contribution, which is displayed separately on payment summaries
'''EMPLOYERADDITIONAL''': Indicates this is a additional employer superannuation contribution, which is displayed as RESC on payment summaries
'''EMPLOYEE''': Indicates this is a post-tax employee superannuation contribution

;Amount
:A [[Field Type: Decimal|decimal field]] that provides the amount.

== OpeningBalances.ReimbursementLines Fields ==

The [[#Fields|OpeningBalances.ReimbursementLines Fields]] include the following sub fields.

;ReimbursementTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (Australia) Endpoint: PayItemsReimbursementTypes|reimbursement type id]] associated with this opening balance.

;Amount
:A [[Field Type: Decimal|decimal field]] that provides the amount.

== OpeningBalances.LeaveLines Fields ==

The [[#Fields|OpeningBalances.LeaveLines Fields]] include the following sub fields.

;LeaveTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (Australia) Endpoint: PayItemsLeaveTypes|leave type id]] associated with this opening balance.

;Amount
:A [[Field Type: Decimal|decimal field]] that provides the amount.


== LeaveBalances Fields ==

The [[#Fields|LeaveBalances Fields]] include the following sub fields.

;LeaveTypeID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Payroll (Australia) Endpoint: PayItemsLeaveTypes|leave type id]] associated with this balance.

;LeaveName
:A [[Field Type: Text|text field]] that provides the name of the pay item leave.

;TypeOfUnits
:A [[Field Type: Text|text field]] that provides the type of units of the pay item leave.

;NumberOfUnits
:A [[Field Type: Decimal|decimal field]] that provides the number of units accrued.


== Xero API ==

For a detailed run through of the endpoint, you can see the [https://developer.xero.com/documentation/api/payrollau/employees Xero API].


== Related Fields ==

:None


== Related Endpoints ==

:[[Xero Payroll (Australia) Endpoint: EmployeesExpanded|EmployeesExpanded]]
:[[Xero Payroll (Australia) Endpoint: PayItems|PayItems]]
:[[Xero Payroll (Australia) Endpoint: PayItemsDeductionTypes|PayItemsDeductionTypes]]
:[[Xero Payroll (Australia) Endpoint: PayItemsEarningsRates|PayItemsEarningsRates]]
:[[Xero Payroll (Australia) Endpoint: PayItemsLeaveTypes|PayItemsLeaveTypes]]
:[[Xero Payroll (Australia) Endpoint: PayItemsReimbursementTypes|PayItemsReimbursementTypes]]
:[[Xero Payroll (Australia) Endpoint: PayrollCalendars|PayrollCalendars]]
:[[Xero Payroll (Australia) Endpoint: SuperFunds|SuperFunds]]


== Related Topics ==

:[[Xero Payroll (Australia) Models]]
:[[Xero Payroll (Australia) Endpoints]]