Xero Payroll (Australia) Endpoint: Employees
Jump to navigation
Jump to search
Overview
The Xero Employees endpoint provides the list of employees.
This endpoint only provides summary employee information.
You can also integrate with EmployeesExpanded which provides more detailed information.
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.
- MiddleNames
- A text field that provides the middle name of the employee.
- LastName
- A text field that provides the last name of the employee.
- A text field that provides the email address of the employee.
- Phone
- A text field that provides the phone number of the employee.
- Mobile
- A text field that provides the mobile phone number of the employee.
- Status
- A 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.
- DateOfBirth
- A date field that provides the date of birth of the employee.
- Gender
- A text field that provides the gender of the employee.
- EmployeeGroupName
- A text field that provides the employee group name of the employee.
- StartDate
- A date field that provides the start date of the employee.
- TerminationDate
- A date field that provides the end date of the termination date of the employee.
- OrdinaryEarningsRateID
- A guid field that provides the earnings rate id used for ordinary wages.
- PayrollCalendarID
- A guid field that provides the payroll calendar id of the employee.
- UpdatedDateUTC
- A date time field that indicates the last time this record was updated.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
- None
Related Endpoints