---
title: "List all paycodes"
method: GET
path: "/hris/{connection_id}/paycode"
tags: ["hris", "paycode"]
---

# List all paycodes

`GET /hris/{connection_id}/paycode`

## Request

- Base URL: `https://api.unified.to`
- URL: `https://api.unified.to/hris/{connection_id}/paycode`
- Auth: API key in header `authorization`

## Path parameters

- `connection_id` string, required

## Query parameters

- `limit` number
- `offset` number
- `updated_gte` string
- `sort` string
- `order` string
- `query` string
- `company_id` string
- `type` string
- `fields` string[]
- `raw` string

## Response `200`

Successful

- HrisPaycode[]
  - `id` string
  - `created_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `company_id` string: (reference to HrisCompany)
  - `name` string
  - `code` string: the payroll system's code for this item
  - `description` string
  - `type` 'EARNING' | 'DEDUCTION' | 'TAX' | 'CONTRIBUTION' | 'REIMBURSEMENT'
  - `detail_type` 'EARNING_SALARY' | 'EARNING_OVERTIME' | 'EARNING_TIP' | 'EARNING_BONUS' | 'EARNING_COMMISSION' | 'EARNING_ADJUSTMENT' | 'EARNING' | 'PRETAX_DEDUCTION' | 'PRETAX_DEDUCTION_HEALTH_INSURANCE' | 'PRETAX_DEDUCTION_RETIREMENT' | 'PRETAX_DEDUCTION_HRA' | 'TAX_FEDERAL' | 'TAX_REGION' | 'TAX_LOCAL' | 'POSTTAX_BENEFIT' | 'POSTTAX_GARNISHMENT' | 'REIMBURSEMENT' | 'EARNING_REGULAR' | 'EARNING_DOUBLE_OVERTIME' | 'EARNING_PTO' | 'EARNING_SICK' | 'EARNING_HOLIDAY' | 'EARNING_SEVERANCE' | 'EARNING_REIMBURSEMENT' | 'TAX_SOCIAL_SECURITY' | 'TAX_MEDICARE' | 'TAX_UNEMPLOYMENT' | 'TAX_EMPLOYER' | 'PRETAX_DEDUCTION_HSA' | 'PRETAX_DEDUCTION_FSA' | 'PRETAX_DEDUCTION_DEPENDENT_CARE' | 'PRETAX_DEDUCTION_COMMUTER' | 'PRETAX_DEDUCTION_DENTAL' | 'PRETAX_DEDUCTION_VISION' | 'POSTTAX_DEDUCTION' | 'POSTTAX_RETIREMENT_ROTH' | 'POSTTAX_LOAN_REPAYMENT' | 'EMPLOYER_CONTRIBUTION' | 'PENSION' | 'EARNING_CASH_IN_LIEU': the normalized payslip-line type this code produces
  - `is_pre_tax` boolean
  - `is_employer` boolean
  - `is_active` boolean
  - `metadata` HrisMetadata[]
    - `id` string
    - `value` union
      - object
      - string
      - number
      - boolean
      - union[]
        - union
          - object
          - string
          - number
          - boolean
    - `namespace` string
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
    - `extra_data` union
      - object
      - string
      - number
      - boolean
      - union[]
        - union
          - object
          - string
          - number
          - boolean
    - `slug` string
  - `raw` object

## Changes

- **2026-10-19** `39502239a975`: 2 info
  - added the enum value `metadata` to the property `items/` of the `query` request parameter `fields`
  - added the optional property `items/metadata` to the response with the `200` status
- **2026-10-11** `a29ffd62ac71`: 1 breaking
  - the response's body type changed from no type to `array` for status `200`
- **2026-10-09** `18cdc3570968`: 1 breaking
  - the response's body type changed from `array` to no type for status `200`
- **2026-10-08** `07678e2ad542`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/unified/apis/unified-to-api/changes/hris/:connection_id/paycode/get.md)

---

[API](https://skmtc.dev/unified/apis/unified-to-api.md) · [All operations](https://skmtc.dev/unified/apis/unified-to-api/llms.txt) · [OpenAPI document](https://skmtc.dev/unified/apis/unified-to-api/revisions/88a1fc7820d6?raw)
