Create employer

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

post/v1/employers

Creates a new employer for the authenticated organization. Requires employer name, legal name, EIN, and address information. Returns the created employer with its assigned ID.

ParametersExpand Collapse

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

Employer 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

ein: String

Employer Identification Number (format: XX-XXXXXXX or XXXXXXXXX)

maxLength10

minLength9

legal_name: String

Legal business name

maxLength255

minLength1

name: String

Employer display name

maxLength255

minLength1

ReturnsExpand Collapse

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

Serializer for Employer entity in public API responses.

Matches EmployerEntity from company module domain.

id: String

Unique employer identifier with 'empr_' prefix

active: bool

Whether the employer is currently active in the system

created_at: Time

Timestamp when the employer was created

formatdate-time

legal_name: String

Legal business name for compliance and tax purposes

name: String

Display name of the employer

organization_id: String

ID of the parent organization (org_*)

updated_at: Time

Timestamp when the employer was last updated

formatdate-time

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

Nested address within EmployerSerializer.

city: String

City name

state: String

Two-letter state code (e.g., CA, NY)

street_1: String

Primary street address

zip_code: String

ZIP code (5 or 9 digit)

country: String

Country code (default: US)

street_2: String

Secondary street address (apt, suite, etc.)

ein: String

Employer Identification Number (masked in responses)

eligibility_policy_id: String

ID of the benefit eligibility policy (epol_*), if assigned

Create employer

require "vitable_connect_api"

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

employer = vitable_connect_api.employers.create(
  address: {city: "city", state: "xx", street_1: "street_1", zip_code: "zip_code"},
  ein: "xxxxxxxxx",
  legal_name: "x",
  name: "x"
)

puts(employer)

{
  "id": "id",
  "active": true,
  "created_at": "2019-12-27T18:11:19.117Z",
  "legal_name": "legal_name",
  "name": "name",
  "organization_id": "organization_id",
  "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"
  },
  "ein": "ein",
  "eligibility_policy_id": "eligibility_policy_id"
}

Returns Examples

{
  "id": "id",
  "active": true,
  "created_at": "2019-12-27T18:11:19.117Z",
  "legal_name": "legal_name",
  "name": "name",
  "organization_id": "organization_id",
  "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"
  },
  "ein": "ein",
  "eligibility_policy_id": "eligibility_policy_id"
}