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.

Checks (Check Batch Review) is available at route /hr/payroll/payment-batches/:id/checks, guarded by hr.payment_checks.manage.

​
Overview

The Check Batch Review page (CheckBatchReviewPage / CheckBatchReviewContent) wraps its content in a RequirePermission for hr.payment_checks.manage. It loads the parent batch detail and the list of checks for the batch. A GenerateChecksToolbar component provides generation actions. Checks are displayed in a data table with check number, employee name, amount, status badge (pending, generated, sent_to_vendor, printed, voided), and a void action gated by PermissionGate. Skeleton rows (1-5) are shown during loading.

​
Who it’s for

hr.payment_checks.manage — payroll administrators with check management permission.

​
Before you start

  • A payment batch of check type must exist.
  • hr.payment_checks.manage permission required.
  • Navigate from /hr/payroll/payment-batches/:id.

​
Steps

1

Open batch checks

Navigate from a payment batch detail page and click the checks link, or navigate directly to /hr/payroll/payment-batches/:id/checks.
2

Generate checks

Use GenerateChecksToolbar to generate check records for the batch.
3

Review check table

Verify check number, employee, amount, and status for each item.
4

Void if needed

Use the void action on individual checks as needed (requires hr.payment_checks.manage).

​
Key concepts

TermMeaning in code
PaymentCheckRowType for individual check items in the table
Check statuspending, generated, sent_to_vendor, printed, voided
GenerateChecksToolbarToolbar for triggering check generation for the batch
useVoidPaymentCheckMutation hook for voiding a check

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/pages/payroll/CheckBatchReviewPage.tsx
  • src/cores/hr/hooks/payroll/usePaymentChecks.ts
  • src/cores/hr/hooks/payroll/usePaymentCheckMutation.ts