PayrollAu
Searches payroll employees
get/Employees
Query parameters
wherestring
Filter by an any element
orderstring
Order by an any element
pageinteger
e.g. page=1 – Up to 100 employees will be returned in a single API call
Headers
If-Modified-Sincestring date-time
Only records created or modified since this timestamp will be returned
Response
search results matching criteria
Example response
{
"Employees": [
{
"FirstName": "Karen",
"LastName": "Jones",
"DateOfBirth": "/Date(322560000000+0000)/",
"HomeAddress": {
"AddressLine1": "123 Main St",
"AddressLine2": "Apt 4",
"City": "St. Kilda",
"Region": "VIC",
"Country": "AUSTRALIA"
},
"StartDate": "/Date(320284900000+0000)/",
"Title": "Mrs",
"MiddleNames": "Adena",
"Email": "developer@me.com",
"Gender": "F",
"Phone": "415-555-1212",
"Mobile": "415-234-5678",
"TwitterUserName": "xeroapi",
"IsAuthorisedToApproveTimesheets": true,
"JobTitle": "Manager",
"OrdinaryEarningsRateID": "5gj1e5cc-9835-40d5-bb18-09fdb118db9c",
"PayrollCalendarID": "2ee8e5cc-9835-40d5-bb18-09fdb118db9c",
"EmployeeGroupName": "marketing",
"EmployeeID": "4ff1e5cc-9835-40d5-bb18-09fdb118db9c",
"TerminationDate": "/Date(1584662400000+0000)/",
"TerminationReason": "F",
"BankAccounts": [
{
"StatementText": "Salary",
"AccountName": "James Lebron Savings",
"Amount": 200
}
],
"PayTemplate": {
"EarningsLines": [
{
"EarningsRateID": "72e962d1-fcac-4083-8a71-742bb3e7ae14",
"AnnualSalary": 40000,
"NumberOfUnitsPerWeek": 38,
"RatePerUnit": 38,
"NormalNumberOfUnits": 38,
"Amount": 38,
"NumberOfUnits": 2.5,
"FixedAmount": 2.5
}
],
"DeductionLines": [
{
"DeductionTypeID": "59cd9d04-4521-4cc3-93ac-7841651ff407",
"Amount": 10,
"Percentage": 10,
"NumberOfUnits": 10
}
],
"SuperLines": [
{
"SuperMembershipID": "4333d5cd-53a5-4c31-98e5-a8b4e5676b0b",
"MinimumMonthlyEarnings": 450,
"Percentage": 9,
"Amount": 10
}
],
"ReimbursementLines": [
{
"ReimbursementTypeID": "bd246b96-c637-4767-81cf-851ba8fa93c2",
"Amount": 10,
"Description": "For the taxi"
}
],
"LeaveLines": [
{
"LeaveTypeID": "742998cb-7584-4ecf-aa88-d694f59c50f9",
"IncludeSuperannuationGuaranteeContribution": true,
"IsQualifyingEarnings": true,
"NumberOfUnits": 2.5,
"AnnualNumberOfUnits": 2.5,
"FullTimeNumberOfUnitsPerPeriod": 2.5
}
]
},
"OpeningBalances": {
"OpeningBalanceDate": "/Date(322560000000+0000)/",
"Tax": "4333d5cd-53a5-4c31-98e5-a8b4e5676b0b",
"EarningsLines": [
{
"EarningsRateID": "72e962d1-fcac-4083-8a71-742bb3e7ae14",
"AnnualSalary": 40000,
"NumberOfUnitsPerWeek": 38,
"RatePerUnit": 38,
"NormalNumberOfUnits": 38,
"Amount": 38,
"NumberOfUnits": 2.5,
"FixedAmount": 2.5
}
],
"DeductionLines": [
{
"DeductionTypeID": "59cd9d04-4521-4cc3-93ac-7841651ff407",
"Amount": 10,
"Percentage": 10,
"NumberOfUnits": 10
}
],
"SuperLines": [
{
"SuperMembershipID": "4333d5cd-53a5-4c31-98e5-a8b4e5676b0b",
"MinimumMonthlyEarnings": 450,
"Percentage": 9,
"Amount": 10
}
],
"ReimbursementLines": [
{
"ReimbursementTypeID": "bd246b96-c637-4767-81cf-851ba8fa93c2",
"Amount": 10,
"Description": "For the taxi"
}
],
"LeaveLines": [
{
"LeaveTypeID": "742998cb-7584-4ecf-aa88-d694f59c50f9",
"NumberOfUnits": 2.5
}
],
"PaidLeaveEarningsLines": [
{
"LeaveTypeID": "742998cb-7584-4ecf-aa88-d694f59c50f9",
"Amount": 500,
"SGCAppliedLeaveLoadingAmount": 50,
"SGCExemptedLeaveLoadingAmount": 60,
"ResetSTPCategorisation": true
}
]
},
"TaxDeclaration": {
"EmployeeID": "123 Main St",
"AustralianResidentForTaxPurposes": true,
"TaxOffsetEstimatedAmount": 100,
"UpwardVariationTaxWithholdingAmount": 50,
"ApprovedWithholdingVariationPercentage": 75,
"HasStudentStartupLoan": true,
"HasLoanOrStudentDebt": true,
"UpdatedDateUTC": "/Date(1583967733054+0000)/",
"IncludeLeaveLoadingInQualifyingEarnings": true
},
"CountryOfResidence": "AU",
"IsSTP2Qualified": true,
"LeaveBalances": [
{
"LeaveName": "Annual Leave",
"LeaveTypeID": "544d9292-4329-4512-bfff-a9f15236d776",
"NumberOfUnits": 81.2602,
"TypeOfUnits": "Hours"
}
],
"SuperMemberships": [
{
"SuperMembershipID": "4333d5cd-53a5-4c31-98e5-a8b4e5676b0b",
"SuperFundID": "2187a42b-639a-45cb-9eed-cd4ae488306a"
}
],
"UpdatedDateUTC": "/Date(1583967733054+0000)/"
}
]
}