POST
/
unified
/
hris
/
employees
curl --request POST \
  --url https://api.stackone.com/unified/hris/employees \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data '{
  "first_name": "Isaac",
  "last_name": "Newton",
  "name": "Isaac Newton",
  "display_name": "Sir Isaac Newton",
  "avatar_url": "https://example.com/avatar.png",
  "personal_email": "isaac.newton@example.com",
  "personal_phone_number": "+1234567890",
  "work_email": "newton@example.com",
  "work_phone_number": "+1234567890",
  "job_id": "R-6789",
  "job_title": "Physicist",
  "department_id": "3093",
  "team_id": "2913",
  "department": "Physics",
  "manager_id": "67890",
  "gender": "male",
  "preferred_language": "eng",
  "ethnicity": "white",
  "date_of_birth": "1990-01-01T00:00:00.000Z",
  "birthday": "2021-01-01T00:00:00Z",
  "marital_status": "single",
  "avatar": "https://example.com/avatar.png",
  "hire_date": "2021-01-01T00:00:00.000Z",
  "start_date": "2021-01-01T00:00:00.000Z",
  "employment_type": "permanent",
  "employment_contract_type": "full_time",
  "employment_status": "active",
  "termination_date": "2021-01-01T00:00:00Z",
  "company_name": "Example Corp",
  "company_id": "1234567890",
  "citizenships": [
    {
      "value": "US",
      "source_value": "<string>"
    }
  ],
  "employments": [
    {
      "unified_custom_fields": {
        "my_project_custom_field_1": "REF-1236",
        "my_project_custom_field_2": "some other value"
      },
      "job_title": "Software Engineer",
      "pay_rate": "40.00",
      "pay_period": "monthly",
      "pay_frequency": "hourly",
      "pay_currency": "USD",
      "effective_date": "2021-01-01T01:01:01.000Z",
      "end_date": "2021-01-01T01:01:01.000Z",
      "grade": {
        "id": "1687-3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "name": "1687-4",
        "description": "Mid-level employee demonstrating proficiency and autonomy."
      },
      "employment_type": "permanent",
      "employment_contract_type": "full_time",
      "work_time": {
        "duration": "P0Y0M0DT8H0M0S",
        "duration_unit": "month"
      },
      "payroll_code": "PC1",
      "job_id": "5290"
    }
  ],
  "employment": {
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "job_title": "Software Engineer",
    "pay_rate": "40.00",
    "pay_period": "monthly",
    "pay_frequency": "hourly",
    "pay_currency": "USD",
    "end_date": "2021-01-01T01:01:01.000Z",
    "grade": {
      "id": "1687-3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "1687-4",
      "description": "Mid-level employee demonstrating proficiency and autonomy."
    },
    "employment_type": "permanent",
    "employment_contract_type": "full_time",
    "work_time": {
      "duration": "P0Y0M0DT8H0M0S",
      "duration_unit": "month"
    },
    "payroll_code": "PC1",
    "passthrough": {
      "other_known_names": "John Doe"
    },
    "effective_date": "2021-01-01T00:00:00.000Z"
  },
  "custom_fields": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "Training Completion Status",
      "value": "Completed",
      "value_id": "value_456",
      "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
    }
  ],
  "benefits": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "Health Insurance",
      "benefit_type": {
        "value": "retirement_savings",
        "source_value": "<string>"
      },
      "provider": "Aetna",
      "description": "Health insurance for employees",
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z"
    }
  ],
  "employee_number": "125",
  "national_identity_number": {
    "value": "123456789",
    "type": {
      "value": "ssn",
      "source_value": "<string>"
    },
    "country": {
      "value": "US",
      "source_value": "<string>"
    }
  },
  "national_identity_numbers": [
    {
      "value": "123456789",
      "type": {
        "value": "ssn",
        "source_value": "<string>"
      },
      "country": {
        "value": "US",
        "source_value": "<string>"
      }
    }
  ],
  "home_location": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "name": "Woolsthorpe Manor",
    "phone_number": "+44 1476 860 364",
    "street_1": "Water Lane",
    "street_2": "Woolsthorpe by Colsterworth",
    "city": "Grantham",
    "zip_code": "NG33 5NR",
    "country": {
      "value": "US",
      "source_value": "<string>"
    },
    "passthrough": {
      "other_known_names": "John Doe"
    },
    "state": "GB-LIN"
  },
  "work_location": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "name": "Woolsthorpe Manor",
    "phone_number": "+44 1476 860 364",
    "street_1": "Water Lane",
    "street_2": "Woolsthorpe by Colsterworth",
    "city": "Grantham",
    "zip_code": "NG33 5NR",
    "country": {
      "value": "US",
      "source_value": "<string>"
    },
    "passthrough": {
      "other_known_names": "John Doe"
    },
    "state": "GB-LIN"
  },
  "cost_centers": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "R&D",
      "distribution_percentage": 100
    }
  ],
  "passthrough": {
    "other_known_names": "John Doe"
  }
}'
{
  "statusCode": 201,
  "message": "Record created successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z",
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
  }
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id
string
required

The account identifier

Body

application/json

Response

201
application/json

The employee was created successfully.

The response is of type object.