View source for Xero Payroll (Australia) Endpoint: Employees

== Overview ==

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

This endpoint only provides summary employee information.

You can also integrate with [[Xero Payroll (Australia) Endpoint: EmployeesExpanded|EmployeesExpanded]] which provides more detailed information. 


== Fields ==

The following fields are available for the Employees 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.

;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.

;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.

;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.

;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.

;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.

;UpdatedDateUTC
:A [[Field Type: DateTimeOffset|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 [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: PayItemsEarningsRates|PayItemsEarningsRates]]
:[[Xero Payroll (Australia) Endpoint: PayrollCalendars|PayrollCalendars]]



== Related Topics ==

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