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 Statements (admin) is available at route /hr/compensation/statements. No explicit permission gate on this route.

​
Overview

The Total Compensation Statement List page (TotalCompensationStatementListPage) provides an admin view for managing all employee compensation statements. It includes year filtering (current year and two prior years), a tabbed list/summary view, and a data table with columns for employee name/number, statement year, status badge (TotalCompensationStatementStatusBadge), total compensation value, and row actions (view, send, delete with confirmation). A Generate Statements dialog allows bulk statement generation for a selected year. Statements can be sent to employees via a send action. The delete action triggers a confirmation dialog before removal.

​
Who it’s for

No explicit permission gate on this route — part of the Compensation Management module.

​
Before you start

  • Employee and compensation data must exist to generate statements.

​
Steps

1

Open Compensation Statements

Navigate to /hr/compensation/statements.
2

Filter by year

Select the desired statement year from the filter.
3

Generate statements

Click the generate button to open the generation dialog and create statements for the selected year.
4

Send to employees

Use the send action on individual statements to distribute them.
5

Delete if needed

Use the delete action with confirmation to remove a statement.

​
Key concepts

TermMeaning in code
TotalCompensationStatementFiltersFilter shape including statementYear
TotalCompensationStatementStatusBadgeVisual status indicator component
useTotalCompensationStatementMutationHook for send, delete, and generate operations

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/cores/hr/compensation/pages/TotalCompensationStatementListPage.tsx
  • src/cores/hr/compensation/hooks/useTotalCompensationStatementList.ts
  • src/cores/hr/compensation/hooks/useTotalCompensationStatementMutation.ts