> ## 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.

# Payment Batches

> Browse all payment batches across payroll runs, filter by status, and drill into individual batch details.

The Payment Batches page lists all payment batches across payroll runs and is available at `/hr/payroll/payment-batches`.

## Overview

The Payment Batches page (`PaymentBatchesPage`, HR-PAY-03) shows a table of all payment batches with status indicators and payment method labels. Status values include: Pending, Submitted, Processing, Completed, Partial Failure, and Failed. Payment method labels include Plaid Transfer, NACHA File, and Manual. Clicking a batch number link navigates to the Payment Batch Detail page at `/hr/payroll/payment-batches/:id`.

## Who it's for

Access follows your organization's role and module configuration. ## Before you start

* Payment batches are generated as part of payroll runs. Review payroll runs at `/hr/payroll/runs` first.

## Steps

1. Navigate to `/hr/payroll/payment-batches`.
2. Review the table of batches, noting their status and payment method.
3. Click a batch number to open its detail view at `/hr/payroll/payment-batches/:id`.

## Key concepts

* **Payment Batch** — A grouped set of disbursements for a payroll run, sent via a specific payment method (Plaid Transfer, NACHA File, or Manual).
* **Batch Number** — A unique identifier for a payment batch within the system.
* **Batch Status** — The current processing state: Pending, Submitted, Processing, Completed, Partial Failure, or Failed.

## Viewing a payment batch

The Payment Batch Detail page at `/hr/payroll/payment-batches/:id` shows a specific batch's header and individual payment items. `PaymentBatchDetailPage` displays the batch number, method (`Plaid Transfer`, `NACHA File`, or `Manual`), status badge, and total amount. `PaymentBatchReview` renders the full batch detail. A data table lists individual payment items with employee name and number, bank account label, account type, status, return reason (if any), amount, and settled timestamp. A link to the check review sub-page (`/hr/payroll/payment-batches/:id/checks`) is available when applicable.

| Term                 | Meaning in code                                                                                                                                             |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `STATUS_CONFIG`      | Maps batch status values to display labels: `pending`, `submitted`, `processing`, `posted`, `settled`, `completed`, `returned`, `failed`, `partial_failure` |
| `METHOD_LABELS`      | `plaid_transfer`, `nacha_file`, `manual`                                                                                                                    |
| `PaymentBatchReview` | Component rendering the detailed batch review view                                                                                                          |

1. Navigate from `/hr/payroll/payment-batches` and click a batch row.
2. Review the batch summary: method, status, and total amount.
3. Scroll to the data table to review individual employee payment items, statuses, and amounts.
4. Check items with return reasons — these may require follow-up.

## Related

<Columns cols={2}>
  <Card title="Human Resources" icon="users" href="/hr/overview">
    Human Resources core overview.
  </Card>

  <Card title="Governance & parity" icon="scale-balanced" href="/governance/index" />
</Columns>

<Note>
  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.
</Note>

<Accordion title="Documentation sources">
  * src/routes/hr.tsx
  * src/cores/hr/pages/payroll/PaymentBatchesPage.tsx
  * src/cores/hr/pages/payroll/PaymentBatchDetailPage.tsx
  * src/cores/hr/hooks/payroll/usePaymentBatches.ts
</Accordion>