Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt

Use this file to discover all available pages before exploring further.

Benefits Statements is available at route /hr/benefits/statements, guarded by hr.benefits.admin.

​
Overview

The Benefits Statements admin page (BenefitsStatementsPage) provides a form for generating a benefits statement PDF for a selected employee and year. The admin selects an active employee from a searchable dropdown, a statement year (current year or two prior years), and optionally a letterhead template. Clicking Generate Statement triggers useBenefitsStatementPdf to produce a PDF. An info card lists the contents: employee information, active enrollments with coverage levels, monthly employee/employer contributions, year-to-date totals, covered dependents, and total benefit value.

​
Who it’s for

hr.benefits.admin — HR benefits administrators only.

​
Before you start

  • hr.benefits.admin permission required.
  • At least one active employee must exist in the system.

​
Steps

1

Open Benefits Statements

Navigate to /hr/benefits/statements.
2

Select employee

Choose an active employee from the dropdown.
3

Select year

Choose the statement year.
4

Optionally select letterhead

Pick a letterhead template for branding, or leave blank.
5

Generate

Click Generate Statement to produce the PDF.

​
Key concepts

TermMeaning in code
useBenefitsStatementPdfHook that invokes PDF generation for the selected employee and date range
useOrgLetterheadsHook providing available letterhead templates from @/platform/templates

Human Resources

Human Resources core overview.

Governance & parity

Documentation coverage and governance.
This page documents shipped product behavior. It is not medical, legal, or billing advice. Verify against your organization’s policies and applicable regulations before using it for clinical, compliance, or billing decisions. Protected health information (PHI) shown in the product is governed by your tenant’s access controls and is never exposed in this documentation.
  • src/routes/hr.tsx
  • src/routes/hr/benefits-routes.tsx
  • src/cores/hr/benefits/pages/admin/BenefitsStatementsPage.tsx
  • src/cores/hr/benefits/hooks/useBenefitsStatementPdf.ts