Nic: Created page with "== Overview == The Xero '''Employees''' endpoint provides the list of employees. This endpoint only provides summary employee information. A..."

2023-12-15T05:14:23Z

Created page with "== Overview == The Xero '''Employees''' endpoint provides the list of employees. This endpoint only provides summary employee information. A..."

New page

== Overview ==

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

This endpoint only provides summary employee information. Additional endpoints exist to provide specific settings for each employee.
:[[Xero Payroll (UK) Endpoint: EmployeesEarningsRates|EmployeesEarningsRates]]
:[[Xero Payroll (UK) Endpoint: EmployeesLeaveBalances|EmployeesLeaveBalances]]
:[[Xero Payroll (UK) Endpoint: EmployeesLeaveTypes|EmployeesLeaveTypes]]
:[[Xero Payroll (UK) Endpoint: EmployeesOpeningBalances|EmployeesOpeningBalances]]
:[[Xero Payroll (UK) Endpoint: EmployeesPaymentMethods|EmployeesPaymentMethods]]
:[[Xero Payroll (UK) Endpoint: EmployeesPayTemplates|EmployeesPayTemplates]]
:[[Xero Payroll (UK) Endpoint: EmployeesTaxDetails|EmployeesTaxDetails]]

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

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

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

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

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

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

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

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

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

;isOffPayrollWorker
:A [[Field Type: Boolean|true/false field]] that indicates if the employee is an off-payroll worker or not.

;createdDateUTC
:A [[Field Type: DateTimeOffset|date time field]] that indicates the date-time this record was created.

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

== Address Fields ==

The [[#Fields|Address 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.

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

== Xero API ==

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

== Related Fields ==

:None

== Related Endpoints ==

:[[Xero Payroll (UK) Endpoint: EmployeesEarningsRates|EmployeesEarningsRates]]
:[[Xero Payroll (UK) Endpoint: EmployeesLeaveBalances|EmployeesLeaveBalances]]
:[[Xero Payroll (UK) Endpoint: EmployeesLeaveTypes|EmployeesLeaveTypes]]
:[[Xero Payroll (UK) Endpoint: EmployeesOpeningBalances|EmployeesOpeningBalances]]
:[[Xero Payroll (UK) Endpoint: EmployeesPaymentMethods|EmployeesPaymentMethods]]
:[[Xero Payroll (UK) Endpoint: EmployeesPayTemplates|EmployeesPayTemplates]]
:[[Xero Payroll (UK) Endpoint: EmployeesTaxDetails|EmployeesTaxDetails]]
:[[Xero Payroll (UK) Endpoint: PayrollCalendars|PayrollCalendars]]

== Related Topics ==

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

Xero Payroll (UK) Endpoint: Employees - Revision history

Nic: Created page with "== Overview == The Xero '''Employees''' endpoint provides the list of employees. This endpoint only provides summary employee information. A..."