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.

Compensation Statement (employee self-service) is available at route /hr/me/compensation/:id. No explicit permission gate on this route.

​
Overview

The My Compensation Statement Detail page (MyCompensationStatementDetailPage) shows a single compensation statement identified by :id. It displays a TotalCompensationStatementStatusBadge, a CompensationBreakdownChart (pie chart of compensation components), and individual compensation component cards showing amounts and percentages of total. Two action buttons are available: Acknowledge (calls acknowledgeStatement.mutateAsync) and Download PDF (calls generateStatementPdf). The breadcrumb updates to ” Statement” via useEntityBreadcrumb. The statement year is surfaced from statement.statement_year.

​
Who it’s for

No explicit permission gate on this route — employee self-service. Accessible from the self-service route /hr/me/compensation.

​
Before you start

  • A total compensation statement must have been generated and shared by HR for the employee.

​
Steps

1

Open compensation statement

Navigate to /hr/me/compensation and click a statement, or navigate directly to /hr/me/compensation/:id.
2

Review breakdown

Examine the CompensationBreakdownChart and individual component amounts.
3

Acknowledge

Click Acknowledge to confirm you have reviewed the statement.
4

Download PDF

Click Download PDF to generate and download the statement document.

​
Key concepts

TermMeaning in code
statement_yearThe year covered by the compensation statement
TotalCompensationStatementStatusStatus type from @/cores/hr/compensation/types
CompensationBreakdownChartPie chart visualizing compensation component proportions
acknowledgeStatementMutation marking the statement as employee-acknowledged

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/self-service-routes.tsx
  • src/cores/hr/self-service/pages/MyCompensationStatementDetailPage.tsx
  • src/cores/hr/compensation/hooks/useTotalCompensationStatementDetail.ts
  • src/cores/hr/compensation/hooks/useCompensationStatementPdf.ts