Employers
List employers
Create employer
Get employer
Update employer
Submit census sync
List employees
Update employer settings
List HRIS providers
Get an employer's HRIS connection
List an employer's benefit plan years
Get one of an employer's benefit plan years
List a benefit plan year's enrollments
List an employer's billing invoices
Get an employer invoice's PDF download link
Retrieve Payroll Access Setup
Submit Payroll Access Setup
List an employer's payroll-deduction statements
Ensure Payroll Integration Email
ModelsExpand Collapse
EmployerResponse { data } Response containing a single employer resource.
Response containing a single employer resource.
EmployerListResponse { active, address, benefit_families, 13 more } One employer row of the organization’s book (list projection).
Carries the enriched/computed columns (enrollment roll-up, benefit-family tags, HRIS connection,
benefit-lifecycle stage) alongside the flat CRM fields of the underlying employer (legal name,
EIN, contact, address, timestamps) for parity with the legacy Employer contract.
One employer row of the organization’s book (list projection).
Carries the enriched/computed columns (enrollment roll-up, benefit-family tags, HRIS connection,
benefit-lifecycle stage) alongside the flat CRM fields of the underlying employer (legal name,
EIN, contact, address, timestamps) for parity with the legacy Employer contract.
address: { address_line_1, address_line_2, city, 2 more } Shared read serializer for a postal address on public API responses.
One definition for the address block every public resource emits (employer, employee, …), so the
5-field shape isn’t hand-rolled per endpoint. Read-only: it renders an already-built address
value object (e.g. AddressDVO) whose attributes map 1:1 to these fields.
Shared read serializer for a postal address on public API responses.
One definition for the address block every public resource emits (employer, employee, …), so the
5-field shape isn’t hand-rolled per endpoint. Read-only: it renders an already-built address
value object (e.g. AddressDVO) whose attributes map 1:1 to these fields.
Distinct benefit-family tags across the employer’s active benefits (e.g. MEC, ICHRA, VPC).
hris_status: { provider, provider_label, status } HRIS connection, or null when the employer has none.
HRIS connection, or null when the employer has none.
EmployerListBenefitPlanYearsResponse { data }
data: array of { benefit_id, benefit_plan_year_id, carrier, 15 more }
family: "mec" or "mvp" or "ichra" or 3 more
mec - Mecmvp - Mvpichra - Ichravpc - Vpcdental - Dentalvision - Vision
mec- Mecmvp- Mvpichra- Ichravpc- Vpcdental- Dentalvision- Vision
Displayed networks: [“multi”] for ICHRA, otherwise the plan year’s distinct network names.
Monthly premium in cents; only for an ICHRA benefit with effective coverage.
EmployerRetrieveBenefitPlanYearResponse { data } Response containing a single employer benefit plan year resource.
Response containing a single employer benefit plan year resource.
data: { benefit_id, benefit_plan_year_id, carrier, 17 more } One plan year, detail view.
Standalone (no shared base) so the exact detail payload is readable in one place; the list
serializer is a separate class even where fields overlap. Detail carries the SPD link and omits
the list-only is_current flag.
One plan year, detail view.
Standalone (no shared base) so the exact detail payload is readable in one place; the list
serializer is a separate class even where fields overlap. Detail carries the SPD link and omits
the list-only is_current flag.
contribution_strategy: { contribution_tiers, ichra_contribution_classes } How the plan year prices contributions: exactly one collection is populated, determined by the
plan year’s family (ICHRA vs tier-priced).
How the plan year prices contributions: exactly one collection is populated, determined by the
plan year’s family (ICHRA vs tier-priced).
contribution_tiers: array of { benefit_plan_id, benefit_plan_name, benefit_plan_tier_name, 5 more } Coverage tiers and their costs; empty for ICHRA benefits.
Coverage tiers and their costs; empty for ICHRA benefits.
ichra_contribution_classes: array of { amount_in_cents, compensation, contribution_class_id, 6 more } ICHRA contribution classes; empty for tier-priced benefits.
ICHRA contribution classes; empty for tier-priced benefits.
compensation: "Unspecified" or "Salary" or "Hourly"
Unspecified - UnspecifiedSalary - SalaryHourly - Hourly
Unspecified- UnspecifiedSalary- SalaryHourly- Hourly
employment: "Unspecified" or "Full Time" or "Part Time" or 2 more
Unspecified - UnspecifiedFull Time - Full TimePart Time - Part TimeTemporary - TemporarySeasonal - Seasonal
Unspecified- UnspecifiedFull Time- Full TimePart Time- Part TimeTemporary- TemporarySeasonal- Seasonal
family_status: "Unspecified" or "EE" or "ES" or 2 more
Unspecified - UnspecifiedEE - EEES - ESEC - ECEF - EF
Unspecified- UnspecifiedEE- EEES- ESEC- ECEF- EF
eligibility_policy: { rules, termination_n_months, termination_rule, waiting_period } The plan year’s active eligibility policy. Mirrors the internal PlanYearEligibilityPolicyDTO
but exposes only the public subset (no raw ids, active_in, or timestamps).
The plan year’s active eligibility policy. Mirrors the internal PlanYearEligibilityPolicyDTO
but exposes only the public subset (no raw ids, active_in, or timestamps).
rules: array of { compensation_type, eligible_geographical_location, employee_class } Eligibility rules; never empty for a valid policy.
Eligibility rules; never empty for a valid policy.
Months of continued coverage; set only when termination_rule is END_OF_N_MONTHS.
family: "mec" or "mvp" or "ichra" or 3 more
mec - Mecmvp - Mvpichra - Ichravpc - Vpcdental - Dentalvision - Vision
mec- Mecmvp- Mvpichra- Ichravpc- Vpcdental- Dentalvision- Vision
Displayed networks: [“multi”] for ICHRA, otherwise the plan year’s distinct network names.
Monthly premium in cents; only for an ICHRA benefit with effective coverage.
EmployerListBenefitPlanYearEnrollmentsResponse { carrier, dependent_count, election_status, 11 more }
The carrier for this enrollment: the individual-market carrier for an ICHRA plan, otherwise the benefit’s own. Null when the benefit has no carrier.
Dependents covered under this enrollment today. Counts the same dependents premium_in_cents is priced for, so a dependent whose termination is dated in the future still counts.
election_status: "Enrolled" or "Waived" or "Pending" or "Expired"
Enrolled - EnrolledWaived - WaivedPending - PendingExpired - Expired
Enrolled- EnrolledWaived- WaivedPending- PendingExpired- Expired
What the employee is deducted monthly, in cents: premium_in_cents less employer_contribution_in_cents, floored at zero. Null when unanswered/waived.
Your own reference id for this employee, as you supplied it. Null when you have not set one.
Our id for this person’s employment with this employer (empl_<...>). A person who leaves and is rehired has two.
The employer’s monthly share of premium_in_cents, in cents. Null when unanswered/waived.
policy_status: "Coverage Upcoming" or "Coverage Effective" or "Coverage Ended" or "Cancelled"
Coverage Upcoming - Coverage UpcomingCoverage Effective - Coverage EffectiveCoverage Ended - Coverage EndedCancelled - Cancelled
Coverage Upcoming- Coverage UpcomingCoverage Effective- Coverage EffectiveCoverage Ended- Coverage EndedCancelled- Cancelled
EmployerListPayrollDeductionStatementsResponse { csv_file_url, deduction_frequency, deduction_frequency_label, 6 more } One payroll-deduction statement row.
Reads a :class:PayrollDeductionStatementDTO by attribute: the statement_id character field renders the
prefixed id via str(), and the date/datetime fields emit ISO-8601 strings.
One payroll-deduction statement row.
Reads a :class:PayrollDeductionStatementDTO by attribute: the statement_id character field renders the
prefixed id via str(), and the date/datetime fields emit ISO-8601 strings.