Skip to content
Get started

Benefit Eligibility Policy

Get eligibility policy details
benefit_eligibility_policy.retrieve(strpolicy_id) -> BenefitEligibilityPolicy
get/v1/benefit-eligibility-policy/{policy_id}
ModelsExpand Collapse
class BenefitEligibilityPolicy:

Serializer for Benefit Eligibility Policy entity.

Eligibility policies define rules that determine which employees qualify for benefits.

id: str

Unique eligibility policy identifier with 'epol_' prefix

active: bool

Whether this policy is currently active

created_at: datetime

Timestamp when the policy was created

formatdate-time
effective_date: date

Date when this policy becomes effective

formatdate
employer_id: str

ID of the employer this policy belongs to (empr_*)

name: str

Display name for the eligibility policy

rules: List[Rule]

List of eligibility rules that must be satisfied

operator: str

Comparison operator (e.g., 'equals', 'greater_than', 'in')

rule_type: str

Type of eligibility rule (e.g., 'employment_status', 'hours_per_week', 'waiting_period')

value: object

Value to compare against (type depends on rule_type)

updated_at: datetime

Timestamp when the policy was last updated

formatdate-time
description: Optional[str]

Detailed description of the policy

replaced_policy_id: Optional[str]

ID of the policy this one replaces, if any (epol_*)