---
title: "List statutory withholding line items"
method: GET
path: "/statutory_withholding_line_items"
tags: ["Statutory Withholding Line Items"]
---

# List statutory withholding line items

`GET /statutory_withholding_line_items`

## Query parameters

- `pay_stub_id` string
- `payroll_id` string
- `payroll_status` union
  - 'approved' | 'draft' | 'failed' | 'paid' | 'partially_paid' | 'processing'
  - string[]
- `payroll_type` union
  - 'correction' | 'historical' | 'off_cycle' | 'regular'
  - string[]
- `payroll_period_start` object
- `payroll_period_end` object
- `payroll_pay_date` object
- `pay_schedule_id` string
- `work_assignment_id` string
- `employee_id` string
- `contractor_id` string
- `business_entity_id` string
- `has_business_preset` boolean
- `business_preset_id` string
- `include_types` union
  - 'cpp' | 'cpp_2' | 'ei' | 'federal_income_tax' | 'provincial_income_tax' | 'qpip' | 'qpp' | 'qpp_2' | 'territorial_income_tax' | 'uk_paye_income_tax'
  - string[]
- `exclude_types` union
  - 'cpp' | 'cpp_2' | 'ei' | 'federal_income_tax' | 'provincial_income_tax' | 'qpip' | 'qpp' | 'qpp_2' | 'territorial_income_tax' | 'uk_paye_income_tax'
  - string[]
- `external_ref` string
- `expand` 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 (`"statutory_withholding_line_item"`).
    - `data` StatutoryWithholdingLineItem
      - `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_system` boolean — Whether this line item was generated automatically by the payroll engine. System line items cannot be deleted.
      - `is_managed` boolean — Always `true`. Statutory withholding line items are fully managed by the payroll engine and cannot be created, updated, or 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 — The withholding amount calculated by the payroll engine. Read-only; set `custom_amount` to override.
      - `statutory_withholding_type` object — The type of statutory withholding for this line item.
        - `id` string — The unique identifier of the object in Nmbr.
        - `object` string — The type of the object in Nmbr (`"statutory_withholding_type"`).
        - `data` StatutoryWithholdingType
          - `type` string, nullable — The string identifier for this employee statutory withholding type.
          - `label` string, nullable — The human-readable display name for this employee statutory withholding type.
      - `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` object
        - `id` string — The unique identifier of the object in Nmbr.
        - `object` string — The type of the object in Nmbr (`"remittance_account"`).
      - `source_adjustment` unknown
      - `business_preset` object
        - `id` string — The unique identifier of the object in Nmbr.
        - `object` string — The type of the object in Nmbr (`"business_preset"`).
      - `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.
      - `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/revisions/01cd9c45a923/schema)