---
title: "List earning types"
method: GET
path: "/earning_types"
tags: ["Earning Types"]
---

# List earning types

`GET /earning_types`

## Query parameters

- `features` 'CA' | 'GB'
- `id` string
- `search` string

## Response `200`

OK

- object
  - `object` string — The type of the object in Nmbr (`"list"`).
  - `data` object[]
    - `id` string — The unique identifier of the object in Nmbr.
    - `object` string — The type of the object in Nmbr (`"earning_type"`).
    - `data` EarningType
      - `type` string, nullable — The string identifier for this earning type.
      - `label` string, nullable — The human-readable display name for this earning type.
      - `supported_payroll_types` object, nullable — A map of Payroll types to whether this earning type is available on that Payroll type.
        - `regular` boolean
        - `historical` boolean
        - `off_cycle` boolean
      - `features` LineItemTypeFeature[]
        - `type` 'eht' | 'income_tax' | 'insurable' | 'pensionable' | 'stat_payable' | 'vacationable' | 'wcb' — The payroll calculation this entry describes.
        - `label` string — Human-readable name for the payroll calculation.
        - `definitions` object[] — How this type affects the calculation, broken down by jurisdiction. Jurisdictions where it does not apply are omitted.
          - `jurisdiction` string — The jurisdiction this applies to (e.g. `ca_federal`, `ca_on`, `ca_qc`).
          - `effects` string[] — How this type affects the payroll calculation in this jurisdiction.
          - `help_text` string, nullable — Plain-language explanation of how this type affects the calculation in this jurisdiction.
          - `program_label` string, nullable — The program that applies in this jurisdiction, for calculations that use different programs by jurisdiction (e.g. CPP federally, QPP in Quebec; EI federally, QPIP in Quebec).
      - `form_mappings` LineItemFormMapping[]
        - `form` string — The form code (e.g. `t4`).
        - `form_label` string — Human-readable form name.
        - `mapping` array[] — The boxes on the form this type contributes to.
          - object[]
            - `name` string — The box or line identifier on the form.
            - `help_text` string, nullable — Plain-language explanation of the box, when available.

---

[API](https://skmtc.dev/nmbr/apis/nmbr-api.md) · [All operations](https://skmtc.dev/nmbr/apis/nmbr-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nmbr/nmbr-api/revisions/29c2d6ac7131/schema)