Employees

Creates a new Employee.

Changed on Nov 10, 2026

post/employees

Request

Base URL
https://api.iris.co.uk/hr/v2
Auth
OAuth 2
Client credentials
Token URLhttps://api.iris.co.uk/oauth2/v1/token
TypeScript
https://skmtc.dev/hrapi/apis/hr-api/docs/employees/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

DisplayIdstring nullable

The Display ID of the Employee.

If provided must be unqiue, If null then it will automatically be generated.

Cascade Source: [Employee].[DisplayEmployeeId]

TitleHonorificstring nullable

The Title of the Employee. E.g. Mr, Mrs, Miss.

Cascade Source: [Employee].[Title] translated through the TITLE system list.

FirstNamestring nullable required

The First Name of the Employee.

Cascade Source: [Employee].[Forename]

KnownAsstring nullable

The name the Employee is commonly known as.

Cascade Source: [Employee].[KnownAs]

OtherNamestring nullable

Any other name that the Employee has.

Cascade Source: [Employee].[OtherName]

LastNamestring nullable required

The Last Name, Surname or Family Name of the Employee.

Cascade Source: [Employee].[Surname]

CostCentrestring nullable

The Cost Centre assigned to the Employee.

Cascade Source: [Employee].[CostCentre]

NationalInsuranceNumberstring nullable

The National Insurance Number of the Employee.

Cascade Source: [Employee].[NationalInsuranceNo]

PayrollIdstring nullable

The Payroll ID of the Employee.

Cascade Source: [Employee].[PayrollId]

TaxCodestring nullable

The Tax Code of the Employee.

Cascade Source: [Employee].[TaxCode]

IncludeInPayrollboolean nullable

Indicates if the Employee should be included in Payroll.

Cascade Source: [Employee].[IncludeInPayroll]

EmploymentStartDatestring date-time nullable

The date the Employee started with their current Employer.

Cascade Source: [Employee].[EmployeeStartDate]

EmploymentLeftDatestring date-time nullable

The date the Employee left their current Employer.

Cascade Source: [Employee].[LeftDate]

ContinuousServiceDatestring date-time nullable

The date the Employee's continuous service should be applied from.

Cascade Source: [Employee].[ContServiceDate]

DateOfBirthstring date-time nullable

The Date of Birth of the Employee.

Cascade Source: [Employee].[DateOfBirth]

LastWorkingDatestring date-time nullable

The date of the last working date of the Employee.

Cascade Source: [Employee].[LeaverLastWorkDate]

Genderstring nullable

The Gender of the Employee.

Cascade Source: [Employee].[Sex] translated through the GENDER system list.

Ethnicitystring nullable

The Ethnicity of the Employee.

Cascade Source: [Employee].[EthnicOrigin] translated through the ETHNICTORIGIN system list.

Nationalitystring nullable

The Nationality of the Employee.

Cascade Source: [Employee].[Nationality] translated through the NATIONALITY system list.

Religionstring nullable

The Religion of the Employee.

Cascade Source: [Employee].[Religion] transalated through the RELIGION system list.

LeaverReasonstring nullable

The reason for the Employee to Leave.

Cascade Source: [Employee].[LeaverReason]

MaritalStatusstring nullable

The marrital status of the Employee.

Cascade Source: [Employee].[MaritalStatus] translated through the MARITALSTATUS system list.

GenderIdentitystring nullable

The Gender Identity of the Employee.

Cascade Source: [Employee].[GenderIdentity] translated through the GenderIdentity system list.

WindowsUsernamestring nullable

The Windows Username of the Employee.

Cascade Source: [Employee].[WindowsUsername]

Initialsstring nullable

The Initials of the Employee.

Cannot be updated once Employee is created to prevent breaking change to API functionality.

Cascade Source: [Employee].[Initials]

Response

idstring nullable

Changes

Nov 10, 2026638d402d3872 Revision changes
- warning
  the // request property's maxLength was set to 320 (media type: application/json;odata.metadata=minimal;odata.streaming=true)
- warning
  the // request property's maxLength was set to 320 (media type: application/json;odata.metadata=minimal;odata.streaming=false)
- warning
  the // request property's maxLength was set to 320 (media type: application/json;odata.metadata=minimal)
- warning
  the // request property's maxLength was set to 320 (media type: application/json;odata.metadata=full;odata.streaming=true)
- warning
  the // request property's maxLength was set to 320 (media type: application/json;odata.metadata=full;odata.streaming=false)
- warning
  the // request property's maxLength was set to 320 (media type: application/json;odata.metadata=full)
- warning
  the // request property's maxLength was set to 320 (media type: application/json;odata.metadata=none;odata.streaming=true)
- warning
  the // request property's maxLength was set to 320 (media type: application/json;odata.metadata=none;odata.streaming=false)
- warning
  the // request property's maxLength was set to 320 (media type: application/json;odata.metadata=none)
- warning
  the // request property's maxLength was set to 320 (media type: application/json;odata.streaming=true)
- warning
  the // request property's maxLength was set to 320 (media type: application/json;odata.streaming=false)
- warning
  the // request property's maxLength was set to 320 (media type: application/json)
- warning
  the // request property's maxLength was set to 320 (media type: application/xml)
- warning
  the // request property's maxLength was set to 320 (media type: application/json-patch+json)
- info
  the request property became nullable (media type: application/json;odata.metadata=minimal;odata.streaming=true)
- info
  the request property became nullable (media type: application/json;odata.metadata=minimal;odata.streaming=false)
- info
  the request property became nullable (media type: application/json;odata.metadata=minimal)
- info
  the request property became nullable (media type: application/json;odata.metadata=full;odata.streaming=true)
- info
  the request property became nullable (media type: application/json;odata.metadata=full;odata.streaming=false)
- info
  the request property became nullable (media type: application/json;odata.metadata=full)
- info
  the request property became nullable (media type: application/json;odata.metadata=none;odata.streaming=true)
- info
  the request property became nullable (media type: application/json;odata.metadata=none;odata.streaming=false)
- info
  the request property became nullable (media type: application/json;odata.metadata=none)
- info
  the request property became nullable (media type: application/json;odata.streaming=true)
- info
  the request property became nullable (media type: application/json;odata.streaming=false)
- info
  the request property became nullable (media type: application/json)
- info
  the request property became nullable (media type: application/xml)
- info
  the request property became nullable (media type: application/json-patch+json)
- info
  the request property became nullable (media type: application/json;odata.metadata=minimal;odata.streaming=true)
- info
  the request property became nullable (media type: application/json;odata.metadata=minimal;odata.streaming=false)
- info
  the request property became nullable (media type: application/json;odata.metadata=minimal)
- info
  the request property became nullable (media type: application/json;odata.metadata=full;odata.streaming=true)
- info
  the request property became nullable (media type: application/json;odata.metadata=full;odata.streaming=false)
- info
  the request property became nullable (media type: application/json;odata.metadata=full)
- info
  the request property became nullable (media type: application/json;odata.metadata=none;odata.streaming=true)
- info
  the request property became nullable (media type: application/json;odata.metadata=none;odata.streaming=false)
- info
  the request property became nullable (media type: application/json;odata.metadata=none)
- info
  the request property became nullable (media type: application/json;odata.streaming=true)
- info
  the request property became nullable (media type: application/json;odata.streaming=false)
- info
  the request property became nullable (media type: application/json)
- info
  the request property became nullable (media type: application/xml)
- info
  the request property became nullable (media type: application/json-patch+json)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json;odata.metadata=minimal;odata.streaming=true)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json;odata.metadata=minimal;odata.streaming=false)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json;odata.metadata=minimal)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json;odata.metadata=full;odata.streaming=true)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json;odata.metadata=full;odata.streaming=false)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json;odata.metadata=full)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json;odata.metadata=none;odata.streaming=true)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json;odata.metadata=none;odata.streaming=false)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json;odata.metadata=none)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json;odata.streaming=true)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json;odata.streaming=false)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/xml)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json-patch+json)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json;odata.metadata=minimal;odata.streaming=true)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json;odata.metadata=minimal;odata.streaming=false)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json;odata.metadata=minimal)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json;odata.metadata=full;odata.streaming=true)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json;odata.metadata=full;odata.streaming=false)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json;odata.metadata=full)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json;odata.metadata=none;odata.streaming=true)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json;odata.metadata=none;odata.streaming=false)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json;odata.metadata=none)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json;odata.streaming=true)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json;odata.streaming=false)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/xml)
- info
  the request property's minLength was decreased from 1 to 0 (media type: application/json-patch+json)
Oct 6, 20267a4734dbe370 Revision changes
- info
  media type application/json; version=2 was changed to application/json for the response status
- info
  media type application/json; version=2 was changed to application/json for the response status
- info
  media type application/json; version=2 was changed to application/json for the response status
- info
  media type application/json; version=2 was changed to application/json for the response status
- info
  media type application/json;odata.metadata=full; version=2 was changed to application/json;odata.metadata=full for the response status
- info
  media type application/json;odata.metadata=full; version=2 was changed to application/json;odata.metadata=full for the response status
- info
  media type application/json;odata.metadata=full; version=2 was changed to application/json;odata.metadata=full for the response status
- info
  media type application/json;odata.metadata=full; version=2 was changed to application/json;odata.metadata=full for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=false; version=2 was changed to application/json;odata.metadata=full;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=false; version=2 was changed to application/json;odata.metadata=full;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=false; version=2 was changed to application/json;odata.metadata=full;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=false; version=2 was changed to application/json;odata.metadata=full;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=true; version=2 was changed to application/json;odata.metadata=full;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=true; version=2 was changed to application/json;odata.metadata=full;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=true; version=2 was changed to application/json;odata.metadata=full;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=true; version=2 was changed to application/json;odata.metadata=full;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=minimal; version=2 was changed to application/json;odata.metadata=minimal for the response status
- info
  media type application/json;odata.metadata=minimal; version=2 was changed to application/json;odata.metadata=minimal for the response status
- info
  media type application/json;odata.metadata=minimal; version=2 was changed to application/json;odata.metadata=minimal for the response status
- info
  media type application/json;odata.metadata=minimal; version=2 was changed to application/json;odata.metadata=minimal for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=false; version=2 was changed to application/json;odata.metadata=minimal;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=false; version=2 was changed to application/json;odata.metadata=minimal;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=false; version=2 was changed to application/json;odata.metadata=minimal;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=false; version=2 was changed to application/json;odata.metadata=minimal;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=true; version=2 was changed to application/json;odata.metadata=minimal;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=true; version=2 was changed to application/json;odata.metadata=minimal;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=true; version=2 was changed to application/json;odata.metadata=minimal;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=true; version=2 was changed to application/json;odata.metadata=minimal;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=none; version=2 was changed to application/json;odata.metadata=none for the response status
- info
  media type application/json;odata.metadata=none; version=2 was changed to application/json;odata.metadata=none for the response status
- info
  media type application/json;odata.metadata=none; version=2 was changed to application/json;odata.metadata=none for the response status
- info
  media type application/json;odata.metadata=none; version=2 was changed to application/json;odata.metadata=none for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=false; version=2 was changed to application/json;odata.metadata=none;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=false; version=2 was changed to application/json;odata.metadata=none;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=false; version=2 was changed to application/json;odata.metadata=none;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=false; version=2 was changed to application/json;odata.metadata=none;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=true; version=2 was changed to application/json;odata.metadata=none;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=true; version=2 was changed to application/json;odata.metadata=none;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=true; version=2 was changed to application/json;odata.metadata=none;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=true; version=2 was changed to application/json;odata.metadata=none;odata.streaming=true for the response status
- info
  media type application/json;odata.streaming=false; version=2 was changed to application/json;odata.streaming=false for the response status
- info
  media type application/json;odata.streaming=false; version=2 was changed to application/json;odata.streaming=false for the response status
- info
  media type application/json;odata.streaming=false; version=2 was changed to application/json;odata.streaming=false for the response status
- info
  media type application/json;odata.streaming=false; version=2 was changed to application/json;odata.streaming=false for the response status
- info
  media type application/json;odata.streaming=true; version=2 was changed to application/json;odata.streaming=true for the response status
- info
  media type application/json;odata.streaming=true; version=2 was changed to application/json;odata.streaming=true for the response status
- info
  media type application/json;odata.streaming=true; version=2 was changed to application/json;odata.streaming=true for the response status
- info
  media type application/json;odata.streaming=true; version=2 was changed to application/json;odata.streaming=true for the response status
- info
  media type application/xml; version=2 was changed to application/xml for the response status
- info
  media type application/xml; version=2 was changed to application/xml for the response status
- info
  media type application/xml; version=2 was changed to application/xml for the response status
- info
  media type application/xml; version=2 was changed to application/xml for the response status
- info
  media type text/plain; version=2 was changed to text/plain for the response status
- info
  media type text/plain; version=2 was changed to text/plain for the response status
- info
  media type text/plain; version=2 was changed to text/plain for the response status
- info
  media type text/plain; version=2 was changed to text/plain for the response status

Operation history (4 revisions)

Creates a new Employee.

Request

Request body

Response 200OK

Changes

Response