StackOne · Schema

HrisCreateEmployeeRequestDto

IntegrationsiPaaS

Properties

Name	Type	Description
personal_email	string	The employee personal email
hire_date	string	The employee hire date
job_title	string	The employee job title
work_email	string	The employee work email
avatar	object	The employee avatar
manager_id	string	The employee manager ID
start_date	string	The employee start date
ethnicity	object	The employee ethnicity
employment_contract_type	object	The employment work schedule type (e.g., full-time, part-time)
employment_type	object	The employee employment type
work_location	object	The employee work location
tenure	string	The employee tenure
first_name	string	The employee first name
company_name	string	The employee company name
employments	array	The employee employments
work_phone_number	string	The employee work phone number
department	string	The employee department
avatar_url	string	The employee avatar Url
birthday	string	The employee birthday
name	string	The employee name
employment_status	object	The employee employment status
gender	object	The employee gender
home_location	object	The employee home location
termination_date	string	The employee termination date
date_of_birth	string	The employee date_of_birth
personal_phone_number	string	The employee personal phone number
display_name	string	The employee display name
work_anniversary	string	The employee work anniversary
last_name	string	The employee last name
marital_status	object	The employee marital status
custom_fields	array	The employee custom fields

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HrisCreateEmployeeRequestDto",
  "title": "HrisCreateEmployeeRequestDto",
  "type": "object",
  "properties": {
    "personal_email": {
      "type": "string",
      "description": "The employee personal email",
      "example": "[email protected]"
    },
    "hire_date": {
      "type": "string",
      "description": "The employee hire date",
      "example": "2022-01-01"
    },
    "job_title": {
      "type": "string",
      "description": "The employee job title",
      "example": "Physicist"
    },
    "work_email": {
      "type": "string",
      "description": "The employee work email",
      "example": "[email protected]"
    },
    "avatar": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Image"
        }
      ],
      "description": "The employee avatar",
      "example": "https://example.com/avatar.png"
    },
    "manager_id": {
      "type": "string",
      "description": "The employee manager ID",
      "example": "67890"
    },
    "start_date": {
      "type": "string",
      "description": "The employee start date",
      "example": "2022-01-01"
    },
    "ethnicity": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EthnicityEnum"
        }
      ],
      "description": "The employee ethnicity",
      "example": "white"
    },
    "employment_contract_type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EmploymentScheduleTypeEnum"
        }
      ],
      "description": "The employment work schedule type (e.g., full-time, part-time)",
      "example": "full_time"
    },
    "employment_type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EmploymentTypeEnum"
        }
      ],
      "description": "The employee employment type",
      "example": "full_time"
    },
    "work_location": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HrisLocationsCreateRequestDto"
        }
      ],
      "description": "The employee work location"
    },
    "tenure": {
      "type": "string",
      "description": "The employee tenure",
      "example": 2
    },
    "first_name": {
      "type": "string",
      "description": "The employee first name",
      "example": "Issac"
    },
    "company_name": {
      "type": "string",
      "description": "The employee company name",
      "example": "Example Corp"
    },
    "employments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Employment"
      },
      "description": "The employee employments"
    },
    "work_phone_number": {
      "type": "string",
      "description": "The employee work phone number",
      "example": "+1234567890"
    },
    "department": {
      "type": "string",
      "description": "The employee department",
      "example": "Physics"
    },
    "avatar_url": {
      "type": "string",
      "description": "The employee avatar Url",
      "example": "https://example.com/avatar.png"
    },
    "birthday": {
      "type": "string",
      "description": "The employee birthday",
      "example": "2023-06-14T00:00:00Z"
    },
    "name": {
      "type": "string",
      "description": "The employee name",
      "example": "Issac Newton"
    },
    "employment_status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EmploymentStatusEnum"
        }
      ],
      "description": "The employee employment status",
      "example": "active"
    },
    "gender": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GenderEnum"
        }
      ],
      "description": "The employee gender",
      "example": "male"
    },
    "home_location": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HrisLocationsCreateRequestDto"
        }
      ],
      "description": "The employee home location"
    },
    "termination_date": {
      "type": "string",
      "description": "The employee termination date",
      "example": "2023-06-14T00:00:00Z"
    },
    "date_of_birth": {
      "type": "string",
      "description": "The employee date_of_birth",
      "example": "1990-01-01"
    },
    "personal_phone_number": {
      "type": "string",
      "description": "The employee personal phone number",
      "example": "+1234567890"
    },
    "display_name": {
      "type": "string",
      "description": "The employee display name",
      "example": "Sir Issac Newton"
    },
    "work_anniversary": {
      "type": "string",
      "description": "The employee work anniversary",
      "example": "2022-06-14T00:00:00Z"
    },
    "last_name": {
      "type": "string",
      "description": "The employee last name",
      "example": "Newton"
    },
    "marital_status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MaritalStatusEnum"
        }
      ],
      "description": "The employee marital status",
      "example": "single"
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EmployeeCustomFields"
      },
      "description": "The employee custom fields"
    }
  }
}