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 Tax Form Run Details page manages a single tax form run through its lifecycle, from item generation to distribution or e-filing. It is served at route /hr/payroll/tax-forms/runs/:runId.

​
Overview

The page loads run data via useTaxFormRunById, items via useTaxFormItems, and employer config via useEmployerTaxConfigByYear. It renders:
  • A status badge (TaxFormRunStatusBadge) and breadcrumb navigation.
  • FilingMethodRadio to select paper vs. e-file.
  • EFileStatusCard for e-file status and credential check.
  • W2PreviewCard for individual item previews.
  • Action buttons: generate items, finalize and distribute, delete run, create W-2 correction.
  • useGenerateW2Pdf for PDF download.
No RequirePermission guard is present on this specific route, but access should be limited to payroll administrators.

​
Who it’s for

No explicit RequirePermission on this route. The Tax Form Settings route (parent) requires HR_PERMISSIONS.PAYROLL_ADMIN (hr.payroll.admin). Confirm access controls with SME.

​
Before you start

  • Employer tax configuration for the relevant tax year must exist at /hr/payroll/tax-forms/settings.
  • E-file credentials must be configured before e-filing is available.

​
Steps

  1. Navigate to HR > Payroll > Tax Forms > Runs and click a run, or go to /hr/payroll/tax-forms/runs/:runId.
  2. Review the run summary (form type, tax year, period, status).
  3. If items have not been generated, click the generate action to create tax form line items.
  4. Select the Filing Method (paper or e-file).
  5. Review items and preview W-2 PDFs as needed.
  6. When ready, use the Finalize & Distribute action to send forms.
  7. For corrections, use Create W-2 Correction.

​
Key concepts

TermMeaning
Tax form runA batch execution for a specific form type, tax year, and period (e.g., W-2 annual run).
Filing methodPaper (manual distribution) or e-file (electronic submission).
E-file statusCurrent state of an electronic filing submission via the configured e-file credential.
W-2 correctionAn amended W-2 (W-2c) generated to correct a previously distributed form.

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/pages/TaxFormRunDetailPage.tsx
  • src/cores/hr/hooks/tax-forms/useTaxFormRuns.ts
  • src/cores/hr/hooks/tax-forms/useTaxFormItems.ts
  • src/cores/hr/hooks/tax-forms/useTaxFormRunMutation.ts