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

# Earning Types

> Admin catalog for managing payroll earning type definitions used across the organization.

The Earning Types page manages the organization's catalog of payroll earning type definitions — the Encore source the Proliant code-mapping registry resolves `earning` code values from. It is available at route `/hr/settings/payroll/earning-types`.

## Overview

The page lists earning types fetched by `useEarningTypes`, filterable by search text and category. An "Include Inactive" toggle controls whether deactivated types are shown. Each row shows the type name, code, category badge, and active status. Users with `hr.earning_types.manage` can add new types via the **+** button (opens the earning type form dialog), edit existing types, and deactivate types. Actions are surfaced in a dropdown menu per row.

## Who it's for

Viewing requires `hr.earning_types.view`. Manage actions (add, edit, deactivate) are gated by `hr.earning_types.manage` at the component level. Both permissions are granted to the same payroll-admin role set as the deduction-type permissions.

## Before you start

* Earning type definitions are reference/configuration data, not PHI.
* Define earning types before mapping Proliant earning codes — see [AI-assisted Proliant code mapping](/hr/proliant-ai-code-mapping).
* Consult your payroll administrator before creating or editing earning types.

## Steps

<Steps>
  <Step title="Open Earning Types">
    Navigate to **HR → Settings → Payroll → Earning Types**, or go directly to `/hr/settings/payroll/earning-types`.
  </Step>

  <Step title="Search and filter">
    Use the search box to find a type by name or code. Use the Category filter to narrow by regular, overtime, bonus, commission, reimbursement, or other. Toggle **Include Inactive** to show deactivated types.
  </Step>

  <Step title="Add an earning type (if permitted)">
    Select **+** to open the form dialog. Enter a name, an uppercase code (letters, numbers, and underscores only — for example `REG`, `OT_15`, `BONUS_ANNUAL`), a category, and an optional description.
  </Step>

  <Step title="Edit or deactivate (if permitted)">
    Use the row dropdown menu to edit a type or deactivate it. Deactivated types are hidden unless **Include Inactive** is on.
  </Step>
</Steps>

## Key concepts

* **Categories** — `regular`, `overtime`, `bonus`, `commission`, `reimbursement`, `other`. The category badge variant varies by category.
* **Code format** — Uppercase letters, numbers, and underscores only (regex `^[A-Z0-9_]+$`), maximum 20 characters. Codes must be unique within an organization.
* **Inactive types** — Deactivated types are hidden by default but remain available to historical records and can be shown with the **Include Inactive** toggle.
* **Proliant mapping source** — The Mapping Target Registry resolves the Proliant `earning` family from this table. Once you have one or more active earning types, the `earning` family appears in the Code mappings tab with a constrained dropdown of your Encore earning types and is eligible for AI suggestions.

## Related

<Columns cols={2}>
  <Card title="Deduction Types" icon="sack-dollar" href="/hr/deduction-types">
    Manage payroll deduction type definitions.
  </Card>

  <Card title="AI-assisted Proliant code mapping" icon="sparkles" href="/hr/proliant-ai-code-mapping">
    Map Proliant earning codes to your Encore earning types.
  </Card>
</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>