Create employee

employers.employees.create(employer_id, **kwargs) -> Employee { id, active, created_at, 7 more }

post/v1/employers/{employer_id}/employees

Creates a new employee for a specific employer. Requires personal information (name, DOB, SSN) and employment details (start date). Note: SSN can only be specified at creation time and cannot be updated later. Returns the created employee with assigned ID.

ParametersExpand Collapse

employer_id: String

date_of_birth: Date

Date of birth (YYYY-MM-DD)

formatdate

email: String

Email address

formatemail

first_name: String

Employee's legal first name

maxLength100

minLength1

last_name: String

Employee's legal last name

maxLength100

minLength1

sex: Sex

Male - Male
Female - Female
Other - Other
Unknown - Unknown

Accepts one of the following:

:Male

:Female

:Other

:Unknown

ssn: String

Social Security Number (XXX-XX-XXXX or XXXXXXXXX). Only accepted on create.

maxLength11

minLength9

start_date: Date

Employment start/hire date

formatdate

address: { city, state, street_1, 3 more}

Employee's residential address

city: String

City name

state: String

Two-letter state code

maxLength2

minLength2

street_1: String

Primary street address

zip_code: String

ZIP code

country: String

Country code

street_2: String

Secondary street address

employee_class: EmployeeClass

Full Time - Full Time
Part Time - Part Time
Temporary - Temporary
Intern - Intern
Seasonal - Seasonal
Individual Contractor - Individual Contractor

Accepts one of the following:

:"Full Time"

:"Part Time"

:Temporary

:Intern

:Seasonal

:"Individual Contractor"

gender: String

Gender identity

phone: String

Phone number

suffix: String

Name suffix (Jr., Sr., III)

maxLength10

ReturnsExpand Collapse

class Employee { id, active, created_at, 7 more }

Serializer for Employee entity in public API responses.

Note: Employee is in the company module but exposed via account public API. Contains nested MemberEntity with personal identity information.

id: String

Unique employee identifier with 'empl_' prefix

active: bool

Whether the employee is currently active

created_at: Time

Timestamp when the employee was created

formatdate-time

employer_id: String

ID of the employer this employee works for (empr_*)

member: { id, date_of_birth, first_name, 6 more}

Nested member entity containing personal identity information.

Matches MemberEntity from account module domain.

id: String

Unique member identifier with 'mbr_' prefix

date_of_birth: Date

Member's date of birth (YYYY-MM-DD)

formatdate

first_name: String

Member's legal first name

last_name: String

Member's legal last name

sex: Sex

Male - Male
Female - Female
Other - Other
Unknown - Unknown

Accepts one of the following:

:Male

:Female

:Other

:Unknown

email: String

Email address for communications

formatemail

gender: String

Gender identity, if provided

phone: String

Phone number

suffix: String

Name suffix (e.g., Jr., Sr., III)

start_date: Date

Employee's start/hire date with the employer

formatdate

updated_at: Time

Timestamp when the employee was last updated

formatdate-time

address: { city, state, street_1, 3 more}

Nested address for employee.

city: String

City name

state: String

Two-letter state code

street_1: String

Primary street address

zip_code: String

ZIP code

country: String

Country code

street_2: String

Secondary street address

employee_class: EmployeeClass

Full Time - Full Time
Part Time - Part Time
Temporary - Temporary
Intern - Intern
Seasonal - Seasonal
Individual Contractor - Individual Contractor

Accepts one of the following:

:"Full Time"

:"Part Time"

:Temporary

:Intern

:Seasonal

:"Individual Contractor"

termination_date: Date

Employee's termination date, if terminated

formatdate

Create employee

require "vitable_connect_api"

vitable_connect_api = VitableConnectAPI::Client.new(
  api_key: "My API Key",
  environment: "environment_1" # defaults to "production"
)

employee = vitable_connect_api.employers.employees.create(
  "empr_abc123def456",
  date_of_birth: "2019-12-27",
  email: "dev@stainless.com",
  first_name: "x",
  last_name: "x",
  sex: :Male,
  ssn: "xxxxxxxxx",
  start_date: "2019-12-27"
)

puts(employee)

{
  "id": "id",
  "active": true,
  "created_at": "2019-12-27T18:11:19.117Z",
  "employer_id": "employer_id",
  "member": {
    "id": "id",
    "date_of_birth": "2019-12-27",
    "first_name": "first_name",
    "last_name": "last_name",
    "sex": "Male",
    "email": "dev@stainless.com",
    "gender": "gender",
    "phone": "phone",
    "suffix": "suffix"
  },
  "start_date": "2019-12-27",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "address": {
    "city": "city",
    "state": "state",
    "street_1": "street_1",
    "zip_code": "zip_code",
    "country": "country",
    "street_2": "street_2"
  },
  "employee_class": "Full Time",
  "termination_date": "2019-12-27"
}

Returns Examples

{
  "id": "id",
  "active": true,
  "created_at": "2019-12-27T18:11:19.117Z",
  "employer_id": "employer_id",
  "member": {
    "id": "id",
    "date_of_birth": "2019-12-27",
    "first_name": "first_name",
    "last_name": "last_name",
    "sex": "Male",
    "email": "dev@stainless.com",
    "gender": "gender",
    "phone": "phone",
    "suffix": "suffix"
  },
  "start_date": "2019-12-27",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "address": {
    "city": "city",
    "state": "state",
    "street_1": "street_1",
    "zip_code": "zip_code",
    "country": "country",
    "street_2": "street_2"
  },
  "employee_class": "Full Time",
  "termination_date": "2019-12-27"
}