Xero Payroll (New Zealand) Endpoint: Employees

Overview

The Xero Employees endpoint provides the list of employees.

This endpoint only provides summary employee information. Additional endpoints exist to provide specific settings for each employee.

EmployeesEarningsRates
EmployeesLeaveBalances
EmployeesLeaveTypes
EmployeesOpeningBalances
EmployeesPaymentMethods
EmployeesPayTemplates
EmployeesTaxDetails


Fields

The following fields are available for the Employees endpoint.

employeeID
A guid field that provides the id of the employee.
firstName
A text field that provides the first name of the employee.
lastName
A text field that provides the last name of the employee.
dateOfBirth
A date field that provides the date of birth of the employee.
gender
A text field that provides the gender of the employee.
address
A record field that provides the address details of the employee.
See Address Fields for more information.
email
A text field that provides the email address of the employee.
phoneNunber
A text field that provides the phone number of the employee.
startDate
A date field that provides the start date of the employee.
endDate
A date field that provides the termination date of the employee.
payrollCalendarID
A guid field that provides the payroll calendar id of the employee.
createdDateUTC
A date time field that indicates the date-time this record was created.
updatedDateUTC
A date time field that indicates the last time this record was updated.


Address Fields

The Address Fields include the following sub fields.

addressLine1
A text field that provides the first line of the address of the employee.
addressLine2
A text field that provides the second line of the address of the employee.
city
A text field that provides the city of the employee.
suburb
A text field that provides the state of the employee.
postCode
A text field that provides the post code of the employee.
country
A text field that provides the country of the employee.


Xero API

For a detailed run through of the endpoint, you can see the Xero API.


Related Fields

None


Related Endpoints

EmployeesEarningsRates
EmployeesLeaveBalances
EmployeesLeaveTypes
EmployeesOpeningBalances
EmployeesPaymentMethods
EmployeesPayTemplates
EmployeesTaxDetails
PayrollCalendars


Related Topics

Xero Payroll (New Zealand) Models
Xero Payroll (New Zealand) Endpoints