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.

The My Compensation page, at route /hr/me/compensation, lets employees view their total compensation statements.

​
Overview

The page shows total compensation statements filtered to sent and acknowledged statuses via useMyCompensationStatement. A year selector limits results to a specific statement year (current year plus five prior). Each statement is displayed as a card with a TotalCompensationStatementStatusBadge and a link to the detail page at /hr/me/compensation/:id. Loading and error states are shown with skeletons and alert UI.

​
Who it’s for

No explicit permission gate on this route.

​
Before you start

  • HR must have generated and sent a total compensation statement for you.
  • Statements will only appear once their status is sent or acknowledged.

​
Steps

  1. Go to HR → My HR → My Compensation (or navigate to /hr/me/compensation).
  2. Optionally filter by Year to narrow results.
  3. Select a statement card to view the full detail breakdown.

​
Key concepts

ConceptMeaning
Total compensation statementA document summarizing all components of compensation (SME: confirm components).
SentHR has distributed the statement to the employee.
AcknowledgedEmployee has reviewed and confirmed receipt of the statement.

Human Resources

Human Resources core overview.

Governance & parity

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/self-service-routes.tsx
  • src/cores/hr/self-service/pages/MyCompensationPage.tsx
  • src/cores/hr/compensation/hooks/useMyCompensationStatement.ts
  • src/cores/hr/compensation/components/TotalCompensationStatementStatusBadge.tsx