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 Statement Details page displays the full contents of a single total compensation statement, including a compensation breakdown chart and individual component cards. It is served at route /hr/compensation/statements/:id.

​
Overview

The page loads statement data via useTotalCompensationStatementDetail using the :id path parameter. It renders component cards for each compensation category with formatted currency values and percentage-of-total figures, a CompensationBreakdownChart, a status badge, and a PDF download button backed by useCompensationStatementPdf. This page is part of the HR-15 Compensation Management feature.

​
Who it’s for

No explicit permission gate on this route. Access control is expected to be enforced via the statements list page and RLS at the database level.

​
Before you start

  • A total compensation statement must be created before it can be viewed.
  • PDF generation requires the statement to have data; empty statements may not produce a valid PDF.

​
Steps

  1. Navigate to HR > Compensation > Statements and click a statement row, or navigate directly to /hr/compensation/statements/:id.
  2. Review the Compensation Breakdown Chart for a visual distribution of compensation components.
  3. Examine individual component cards (each shows amount and percentage of total).
  4. Check the status badge to confirm the statement’s current state.
  5. Click the Download PDF button to export the statement.

​
Key concepts

TermMeaning
Total compensationCombined value of all compensation components included in the statement. SME: confirm component definitions.
Statement statusLifecycle status of the statement (e.g., draft, finalized). SME: confirm valid statuses.
Compensation breakdown chartPie/bar visualization of component percentages rendered by CompensationBreakdownChart.

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