What you’ll use
Models - employer benefit, benefit, dependent, dependent benefitBefore you start
- The connector has synced, and the customer’s benefits module is in scope.
Steps
1
Read the plans the employer offers
benefit_plan_category to narrow to medical, dental and so on.Result: The plan catalog for this customer.2
Read enrollments
employee_id, employer_benefit_id, benefit_plan_category or coverage_tier.To reconcile these against a customer’s own totals, see Record counts.Result: Enrollment records linking employees to plans.3
Scope the period with the right date filter
A plan elected during open enrollment starts on election and becomes effective at the plan year boundary, so the two filters return different sets.Enrollments accumulate, so an unfiltered read returns the full history.Result: Records scoped to the period you mean.
4
Read dependents and their coverage separately
date_of_birth and relationship.Result: The dependents actually enrolled.Enrollment tells you the plan and the contribution, not the sum insured. For amounts, and for which people a plan covers, read benefit coverage - see Read benefit coverage.
Frequently Asked Questions
Benefits return nothing though the customer has enrollments
Benefits return nothing though the customer has enrollments
Benefits are frequently a separately licensed module with its own access grant, and several platforms return an empty set rather than an error. See Origin-system errors, then confirm the model is in scope for this connector.
Dependents exist but no dependent benefits
Dependents exist but no dependent benefits
Either they are not enrolled, or dependent coverage is not exposed on this integration. Check
raw_data on a dependent you know is covered - see Inspect raw data.Related
- Benefits - the four models and how they link
- Read benefit coverage - the amounts behind an enrollment
- Employee data - where dependents live