---
title: "Retrieve a deduction line item"
method: GET
path: "/deduction_line_items/{deduction_line_item}"
tags: ["Deduction Line Items"]
---

# Retrieve a deduction line item

`GET /deduction_line_items/{deduction_line_item}`

## Path parameters

- `deduction_line_item` string, required

## Query parameters

- `expand` string[]

## Response `200`

OK

- object
  - `id` string — The unique identifier of the object in Nmbr.
  - `object` string — The type of the object in Nmbr (`"deduction_line_item"`).
  - `data` DeductionLineItem
    - `pay_stub` object
      - `id` string — The unique identifier of the object in Nmbr.
      - `object` string — The type of the object in Nmbr (`"pay_stub"`).
    - `line_item_type` string, nullable
    - `is_managed` boolean — Whether this line item was generated by a Deduction recurrence and calculated automatically. When `true`, only `custom_amount` can be modified and the line item cannot be deleted.
    - `amount` number, nullable — The effective amount for this line item. Returns `custom_amount` if set, otherwise `managed_amount`. Read-only.
    - `custom_amount` number, nullable — An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`.
    - `managed_amount` number, nullable — The amount calculated by the system or set by the linked Deduction recurrence. Read-only; set `custom_amount` to override.
    - `deduction_type` object — The type of deduction for this line item.
      - `id` string — The unique identifier of the object in Nmbr.
      - `object` string — The type of the object in Nmbr (`"deduction_type"`).
      - `data` DeductionType
        - `type` string, nullable — The string identifier for this deduction type.
        - `label` string, nullable — The human-readable display name for this deduction type.
        - `locale` string, nullable
        - `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[]
              - …
    - `recurrence` unknown
    - `title` string, nullable
    - `title_translations` Translations, nullable
      - `en` string
      - `fr` string
    - `title_translated` string — The translation of the `title` property for the request locale. Computed using the values in `title` and `title_translations` and the value of the request's `Accept-Language` header.
    - `remittance_account` unknown
    - `business_preset` unknown
    - `source_adjustment` unknown
    - `expense_accounting_code` unknown
    - `managed_expense_accounting_code` unknown
    - `custom_expense_accounting_code` unknown
    - `liability_accounting_code` unknown
    - `managed_liability_accounting_code` unknown
    - `custom_liability_accounting_code` unknown
    - `component_settings` object, nullable — Settings specific to the Nmbr component.
      - `attributes_locked` boolean — Whether the line item is locked and cannot be edited in the component.
    - `external_ref` string, nullable — A reference to the object in an external system, e.g. the primary key of the object in your application's database. Nmbr doesn't use, validate, parse, or require this value to be unique - it simply stores it for your reference.
    - `created_at` string, dateTime — The date and time the object was created in Nmbr.
    - `updated_at` string, dateTime — The date and time the object was last updated in Nmbr.

---

[API](https://skmtc.net/nmbr/apis/nmbr-api.md) · [All operations](https://skmtc.net/nmbr/apis/nmbr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nmbr/nmbr-api/versions/01cd9c45a923/schema)