Employees
Query, insert and update employees for a Xero organisation.
Table Specific Information
The Employees table allows you to SELECT, INSERT, and UPDATE employees for a Xero organization.
SELECT
The Xero API allows extensive filtering and ordering. You can define WHERE and ORDER BY clauses in a query to filter and order the results using any non-line-item column.
Note: The Xero API does not support filtering on line items or journal lines.
INSERT
To insert a single row, set the required fields. A new table object is created as a single entry. To insert a new employee record, the following fields are required: FirstName and LastName.
UPDATE
You can update any field that is not read-only.
Note: UPDATE operations will count as two operations against the Xero API. One is required to retrieve the existing record, and another to update the record with new data.
Columns
Name | Type | ReadOnly | Description |
EmployeeId [KEY] | String | True |
The unique identifier of the employee. This field is assigned by Xero. |
Status | String | False |
The status of the employee. Valid values are ACTIVE and DELETED. |
FirstName | String | False |
The first name of the employee. |
LastName | String | False |
The last name of the employee. |
ExternalLink_URL | String | False |
A URL to an external resource. |
ExternalLink_Description | String | False |
A description for the external link. |
UpdatedDateUTC | Datetime | True |
Timestamp of the last change to the employee record. |
TenantId | String | False |
The ID of the tenant to query instead of the connection tenant |