> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nmbr.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Show bulk delete scope for deduction line items



## OpenAPI

````yaml /spec/openapi.json post /deduction_line_items/bulk/delete/scope
openapi: 3.0.0
info:
  title: Nmbr API
  description: API to interact with Nmbr Payroll
  version: 1.0.0
servers:
  - url: https://sandbox.nmbr.co/services/payroll
security:
  - CompanyToken: []
tags:
  - name: Accounting Codes
  - name: Accounting Code Rules
  - name: Adjustments
  - name: Allowances
  - name: Allowance Line Items
  - name: Allowance Types
  - name: Async Tasks
  - name: Bank Accounts
  - name: Business Entities
  - name: Business Entity Verifications
  - name: Business Entity ROE Authorizations
  - name: Business Presets
  - name: Calculations
  - name: Companies
  - name: Contractors
  - name: Deductions
  - name: Deduction Line Items
  - name: Deduction Types
  - name: Earnings
  - name: Earning Line Items
  - name: Earning Types
  - name: Effective Tax Properties
  - name: Employees
  - name: Employee Benefits
  - name: Employee Benefit Line Items
  - name: Employee Benefit Types
  - name: Employer Benefits
  - name: Employer Benefit Line Items
  - name: Employer Benefit Types
  - name: Employer Statutory Withholding Line Items
  - name: Employer Statutory Withholding Types
  - name: Forms
  - name: Form Batches
  - name: Form Types
  - name: Holidays
  - name: Integrations
  - name: Journal Entries
  - name: Overtime Rates
  - name: Partners
  - name: Pay Rates
  - name: Pay Schedules
  - name: Pay Splits
  - name: Pay Stubs
  - name: Payments
  - name: Payrolls
  - name: Reimbursements
  - name: Reimbursement Line Items
  - name: Reimbursement Types
  - name: Remittance Accounts
  - name: Remittance Account Enrollments
  - name: Reports
  - name: Statutory Withholding Line Items
  - name: Statutory Withholding Types
  - name: Tags
  - name: Tag Groups
  - name: Tax Properties
  - name: Tax Property Templates
  - name: Tokens
  - name: Usage Records
  - name: Usage Summaries
  - name: Vacation Pay
  - name: Vacation Pay Settings
  - name: Webhooks
  - name: Work Assignments
paths:
  /deduction_line_items/bulk/delete/scope:
    post:
      tags:
        - Deduction Line Items
      summary: Show bulk delete scope for deduction line items
      operationId: deduction-line-items-bulk-delete-scope
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    payroll_id:
                      type: string
                    pay_stubs:
                      type: object
                      properties:
                        exclude:
                          type: object
                          properties:
                            ids:
                              type: array
                              items:
                                type: string
                            payee_type:
                              type: string
                              enum:
                                - contractor
                                - employee
                            work_assignment_ids:
                              type: array
                              items:
                                type: string
                    has_business_preset:
                      type: boolean
                    business_presets:
                      type: object
                      properties:
                        include:
                          type: object
                          properties:
                            ids:
                              type: array
                              items:
                                type: string
                                nullable: true
                        exclude:
                          type: object
                          properties:
                            ids:
                              type: array
                              items:
                                type: string
                                nullable: true
                    expense_accounting_codes:
                      type: object
                      properties:
                        include:
                          type: object
                          properties:
                            ids:
                              type: array
                              items:
                                type: string
                                nullable: true
                        exclude:
                          type: object
                          properties:
                            ids:
                              type: array
                              items:
                                type: string
                                nullable: true
                    liability_accounting_codes:
                      type: object
                      properties:
                        include:
                          type: object
                          properties:
                            ids:
                              type: array
                              items:
                                type: string
                                nullable: true
                        exclude:
                          type: object
                          properties:
                            ids:
                              type: array
                              items:
                                type: string
                                nullable: true
                    subtypes:
                      type: object
                      properties:
                        include:
                          type: array
                          items:
                            type: string
                        exclude:
                          type: array
                          items:
                            type: string
                    ids:
                      type: object
                      properties:
                        include:
                          type: array
                          items:
                            type: string
                        exclude:
                          type: array
                          items:
                            type: string
                - type: object
                  required:
                    - payroll_id
                    - pay_stubs
            example:
              payroll_id: <id>
              pay_stubs:
                include: all
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    description: The type of the object in Nmbr (`"list"`).
                    readOnly: true
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: The unique identifier of the object in Nmbr.
                          readOnly: true
                        object:
                          type: string
                          description: >-
                            The type of the object in Nmbr
                            (`"deduction_line_item"`).
                          readOnly: true
                        data:
                          $ref: '#/components/schemas/DeductionLineItem'
              example:
                object: list
                data:
                  - id: <id>
                    object: deduction_line_item
                    data:
                      pay_stub:
                        id: <id>
                        object: pay_stub
                        links:
                          self: /pay_stubs/<id>
                      line_item_type: deduction
                      is_managed: false
                      amount: 35
                      custom_amount: null
                      managed_amount: 35
                      deduction_type:
                        id: <id>
                        object: deduction_type
                        data:
                          type: income_tax
                          label: Income tax debt
                          locale: en
                        links:
                          self: /deduction_types/income_tax
                      recurrence: null
                      title: null
                      title_translations: null
                      title_translated: null
                      remittance_account: null
                      business_preset: null
                      source_adjustment: null
                      expense_accounting_code: null
                      managed_expense_accounting_code: null
                      custom_expense_accounting_code: null
                      liability_accounting_code: null
                      managed_liability_accounting_code: null
                      custom_liability_accounting_code: null
                      component_settings:
                        attributes_locked: false
                      external_ref: null
                      created_at: '2026-01-01T00:00:00.000000Z'
                      updated_at: '2026-01-01T00:00:00.000000Z'
                    links:
                      self: /deduction_line_items/<id>
                links:
                  first: >-
                    http://localhost/deduction_line_items/bulk/delete/scope?page=1
                  last: >-
                    http://localhost/deduction_line_items/bulk/delete/scope?page=1
                  prev: null
                  next: null
                meta:
                  current_page: 1
                  last_page: 1
                  per_page: 15
                  total: 1
                  has_more: false
components:
  schemas:
    DeductionLineItem:
      type: object
      title: Deduction Line Item
      properties:
        pay_stub:
          type: object
          properties:
            id:
              type: string
              description: The unique identifier of the object in Nmbr.
              readOnly: true
            object:
              type: string
              description: The type of the object in Nmbr (`"pay_stub"`).
              readOnly: true
        line_item_type:
          type: string
          nullable: true
        is_managed:
          type: boolean
          description: >-
            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:
          type: number
          description: >-
            The effective amount for this line item. Returns `custom_amount` if
            set, otherwise `managed_amount`. Read-only.
          nullable: true
          format: decimal
        custom_amount:
          type: number
          description: >-
            An override for `managed_amount`. When set, `amount` reflects this
            value instead of `managed_amount`.
          nullable: true
          format: decimal
        managed_amount:
          type: number
          description: >-
            The amount calculated by the system or set by the linked Deduction
            recurrence. Read-only; set `custom_amount` to override.
          nullable: true
          format: decimal
        deduction_type:
          type: object
          description: The type of deduction for this line item.
          properties:
            id:
              type: string
              description: The unique identifier of the object in Nmbr.
              readOnly: true
            object:
              type: string
              description: The type of the object in Nmbr (`"deduction_type"`).
              readOnly: true
            data:
              $ref: '#/components/schemas/DeductionType'
        recurrence: {}
        title:
          type: string
          nullable: true
          maxLength: 255
        title_translations:
          type: object
          description: Optional translations for the `title` property.
          allOf:
            - $ref: '#/components/schemas/Translations'
          nullable: true
        title_translated:
          type: string
          description: >-
            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.
          readOnly: true
        remittance_account: {}
        business_preset: {}
        source_adjustment: {}
        expense_accounting_code:
          description: >-
            The effective expense accounting code. Returns the user-set value if
            present, otherwise the system-derived value. Writes to this field
            set the user override.
        managed_expense_accounting_code:
          description: >-
            The expense accounting code derived by the system from accounting
            code rules and presets. Read-only.
        custom_expense_accounting_code:
          description: >-
            User-set expense accounting code that overrides the system-derived
            value.
        liability_accounting_code:
          description: >-
            The effective liability accounting code. Returns the user-set value
            if present, otherwise the system-derived value. Writes to this field
            set the user override.
        managed_liability_accounting_code:
          description: >-
            The liability accounting code derived by the system from accounting
            code rules and presets. Read-only.
        custom_liability_accounting_code:
          description: >-
            User-set liability accounting code that overrides the system-derived
            value.
        component_settings:
          type: object
          description: Settings specific to the Nmbr component.
          nullable: true
          properties:
            attributes_locked:
              type: boolean
              description: >-
                Whether the line item is locked and cannot be edited in the
                component.
        external_ref:
          type: string
          description: >-
            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.
          nullable: true
          maxLength: 255
        created_at:
          type: string
          description: The date and time the object was created in Nmbr.
          readOnly: true
          format: dateTime
        updated_at:
          type: string
          description: The date and time the object was last updated in Nmbr.
          readOnly: true
          format: dateTime
    DeductionType:
      type: object
      title: Deduction Type
      properties:
        type:
          type: string
          description: The string identifier for this deduction type.
          nullable: true
        label:
          type: string
          description: The human-readable display name for this deduction type.
          nullable: true
        locale:
          type: string
          nullable: true
        features:
          type: array
          items:
            $ref: '#/components/schemas/LineItemTypeFeature'
        form_mappings:
          type: array
          items:
            $ref: '#/components/schemas/LineItemFormMapping'
    Translations:
      type: object
      nullable: true
      properties:
        en:
          type: string
          maxLength: 255
        fr:
          type: string
          maxLength: 255
    LineItemTypeFeature:
      type: object
      description: >-
        How this line item type affects a single payroll calculation, such as
        income tax or CPP. See [Line item type
        features](https://docs.nmbr.co/guides/payroll-fundamentals/line-item-type-features)
        for further details.
      properties:
        type:
          type: string
          description: The payroll calculation this entry describes.
          enum:
            - eht
            - income_tax
            - insurable
            - pensionable
            - vacationable
            - wcb
        label:
          type: string
          description: Human-readable name for the payroll calculation.
        definitions:
          type: array
          description: >-
            How this type affects the calculation, broken down by jurisdiction.
            Jurisdictions where it does not apply are omitted.
          items:
            type: object
            properties:
              jurisdiction:
                type: string
                description: >-
                  The jurisdiction this applies to (e.g. `ca_federal`, `ca_on`,
                  `ca_qc`).
              effects:
                type: array
                description: >-
                  How this type affects the payroll calculation in this
                  jurisdiction.
                items:
                  type: string
                  enum:
                    - accrues_vacation_pay
                    - reduces_base
                    - tax_credit
                    - withholding
              help_text:
                type: string
                description: >-
                  Plain-language explanation of how this type affects the
                  calculation in this jurisdiction.
                nullable: true
              program_label:
                type: string
                description: >-
                  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).
                nullable: true
    LineItemFormMapping:
      type: object
      description: The year-end tax form boxes this line item type maps to.
      properties:
        form:
          type: string
          description: The form code (e.g. `t4`).
        form_label:
          type: string
          description: Human-readable form name.
        mapping:
          type: array
          description: The boxes on the form this type contributes to.
          items:
            type: array
            items:
              type: object
              properties:
                name:
                  type: string
                  description: The box or line identifier on the form.
                help_text:
                  type: string
                  description: Plain-language explanation of the box, when available.
                  nullable: true
  securitySchemes:
    CompanyToken:
      type: http
      scheme: bearer

````