Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference
Employers

Create eligibility policy

employers.create_benefit_eligibility_policy(stremployer_id, EmployerCreateBenefitEligibilityPolicyParams**kwargs) -> BenefitEligibilityPolicyResponse
POST/v1/employers/{employer_id}/benefit-eligibility-policies

Creates a benefit eligibility policy for the specified employer.

ParametersExpand Collapse
employer_id: str

Unique employer identifier (empr_*)

classification: str

Which employee classifications are eligible. One of: full_time, part_time, all

waiting_period: str

Waiting period before eligibility. One of: first_of_following_month, 30_days, 60_days, none

ReturnsExpand Collapse
class BenefitEligibilityPolicyResponse: …

Response containing a single benefit eligibility policy resource.

id: str
active: bool
classification: str
created_at: datetime
formatdate-time
employer_id: str
updated_at: datetime
formatdate-time
waiting_period: str

Create eligibility policy

import os
from vitable_connect import VitableConnect

client = VitableConnect(
    api_key=os.environ.get("VITABLE_CONNECT_API_KEY"),  # This is the default and can be omitted
)
benefit_eligibility_policy_response = client.employers.create_benefit_eligibility_policy(
    employer_id="empr_abc123def456",
    classification="classification",
    waiting_period="waiting_period",
)
print(benefit_eligibility_policy_response.data)
{
  "data": {
    "id": "id",
    "active": true,
    "classification": "classification",
    "created_at": "2019-12-27T18:11:19.117Z",
    "employer_id": "employer_id",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "waiting_period": "waiting_period"
  }
}
Returns Examples
{
  "data": {
    "id": "id",
    "active": true,
    "classification": "classification",
    "created_at": "2019-12-27T18:11:19.117Z",
    "employer_id": "employer_id",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "waiting_period": "waiting_period"
  }
}