HR Partner · Schema

Employee

HRHRISHuman ResourcesEmployee RecordsLeave ManagementRecruitmentApplicant TrackingOnboardingPerformance ManagementTimesheetsExpense ManagementDocument LibraryeSignatureSaaSAustralia

Properties

Name Type Description
id string Internal HR Partner employee id.
code string Customer-controlled employee code; the primary key for upserts.
first_names string Employee given names.
last_name string Employee family name.
full_name string Concatenated display name.
date_of_birth string
gender_identity string
department string
location string
position string
employment_status string
email string
started_at string
finished_at string
avatar string
can_logon boolean
portal_username string
custom_data object
tags array
View JSON Schema on GitHub

JSON Schema

hr-partner-employee-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Employee",
  "type": "object",
  "properties": {
    "id": { "type": "string", "description": "Internal HR Partner employee id." },
    "code": { "type": "string", "description": "Customer-controlled employee code; the primary key for upserts." },
    "first_names": { "type": "string", "description": "Employee given names." },
    "last_name": { "type": "string", "description": "Employee family name." },
    "full_name": { "type": "string", "description": "Concatenated display name." },
    "date_of_birth": { "type": "string", "format": "date" },
    "gender_identity": { "type": "string" },
    "department": { "type": "string" },
    "location": { "type": "string" },
    "position": { "type": "string" },
    "employment_status": { "type": "string" },
    "email": { "type": "string", "format": "email" },
    "started_at": { "type": "string", "format": "date" },
    "finished_at": { "type": "string", "format": "date" },
    "avatar": { "type": "string", "format": "uri" },
    "can_logon": { "type": "boolean" },
    "portal_username": { "type": "string" },
    "custom_data": { "type": "object" },
    "tags": { "type": "array", "items": { "type": "string" } }
  },
  "required": ["code"]
}