> ## 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.

# List deductions



## OpenAPI

````yaml /spec/openapi.json get /deductions
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:
  /deductions:
    get:
      tags:
        - Deductions
      summary: List deductions
      operationId: deductions-index
      parameters:
        - name: business_entity_id
          in: query
          schema:
            type: string
          required: false
        - name: pay_schedule_id
          in: query
          schema:
            type: string
          required: false
        - name: work_assignment_id
          in: query
          schema:
            type: string
          required: false
        - name: employee_id
          in: query
          schema:
            type: string
          required: false
        - name: has_business_preset
          in: query
          schema:
            type: boolean
          required: false
        - name: business_preset_id
          in: query
          schema:
            type: string
          required: false
        - name: include_types
          in: query
          schema:
            anyOf:
              - type: string
                enum:
                  - charitable_donation
                  - garnishment_order
                  - income_tax
                  - other_deduction
                  - union_dues
                  - union_dues_post_tax
              - type: array
                items:
                  type: string
                  enum:
                    - charitable_donation
                    - garnishment_order
                    - income_tax
                    - other_deduction
                    - union_dues
                    - union_dues_post_tax
          required: false
        - name: exclude_types
          in: query
          schema:
            anyOf:
              - type: string
                enum:
                  - charitable_donation
                  - garnishment_order
                  - income_tax
                  - other_deduction
                  - union_dues
                  - union_dues_post_tax
              - type: array
                items:
                  type: string
                  enum:
                    - charitable_donation
                    - garnishment_order
                    - income_tax
                    - other_deduction
                    - union_dues
                    - union_dues_post_tax
          required: false
        - name: effective_on
          in: query
          schema:
            type: string
            format: date
          required: false
        - name: not_effective_on
          in: query
          schema:
            type: string
            format: date
          required: false
        - name: effective_from
          in: query
          schema:
            type: object
          required: false
          description: >-
            Date filters support two formats:

            Exact Date Match: Provide a well-formatted date in `YYYY-MM-DD`
            format for an exact match. Example: `effective_from=2024-01-01`

            Use an array-like syntax to specify a range with one or more
            comparison operators:

            - `gt` (greater than)

            - `gte` (greater than or equal to)

            - `lte` (less than or equal to)

            - `lt` (less than)

            Example:
            `effective_from[gte]=2024-01-01&effective_from[lt]=2024-12-31`
        - name: effective_to
          in: query
          schema:
            type: object
          required: false
          description: >-
            Date filters support two formats:

            Exact Date Match: Provide a well-formatted date in `YYYY-MM-DD`
            format for an exact match. Example: `effective_to=2024-01-01`

            Use an array-like syntax to specify a range with one or more
            comparison operators:

            - `gt` (greater than)

            - `gte` (greater than or equal to)

            - `lte` (less than or equal to)

            - `lt` (less than)

            Example: `effective_to[gte]=2024-01-01&effective_to[lt]=2024-12-31`
        - name: external_ref
          in: query
          schema:
            type: string
          required: false
        - name: search_payee_names
          in: query
          schema:
            type: string
          required: false
        - name: sort
          in: query
          schema:
            type: string
            enum:
              - effective_from
              - effective_to
              - work_assignment.payee.default
              - work_assignment.payee.first_name
              - work_assignment.payee.last_name
          required: false
          description: >-
            Sort order is specified using the format 

            `sort=field[:direction][,field[:direction],...]` where `field` is
            the name of the field to sort by

            and `direction` is the optional sort direction (`asc` or `desc`).
        - name: tag_id
          in: query
          schema:
            type: string
          required: false
        - name: tag_group_id
          in: query
          schema:
            type: string
          required: false
        - name: expand
          in: query
          schema:
            type: array
            items:
              type: string
              enum:
                - business_preset
                - expense_accounting_code
                - liability_accounting_code
                - remittance_account
                - tag_assignment
                - work_assignment
          required: false
      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"`).
                          readOnly: true
                        data:
                          type: object
                          allOf:
                            - $ref: '#/components/schemas/Deduction'
                          anyOf:
                            - type: object
                              title: Default
                            - type: object
                              title: With work_assignment expanded
                              properties:
                                work_assignment:
                                  type: object
                                  properties:
                                    data:
                                      $ref: '#/components/schemas/WorkAssignment'
                            - type: object
                              title: With remittance_account expanded
                              properties:
                                remittance_account:
                                  type: object
                                  properties:
                                    data:
                                      $ref: '#/components/schemas/RemittanceAccount'
                            - type: object
                              title: With business_preset expanded
                              properties:
                                business_preset:
                                  type: object
                                  properties:
                                    data:
                                      $ref: '#/components/schemas/BusinessPreset'
                            - type: object
                              title: With expense_accounting_code expanded
                              properties:
                                expense_accounting_code:
                                  type: object
                                  properties:
                                    data:
                                      $ref: >-
                                        #/components/schemas/ExpenseAccountingCode
                            - type: object
                              title: With liability_accounting_code expanded
                              properties:
                                liability_accounting_code:
                                  type: object
                                  properties:
                                    data:
                                      $ref: >-
                                        #/components/schemas/LiabilityAccountingCode
                            - type: object
                              title: With tag_assignment expanded
                              properties:
                                tag_assignment:
                                  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.
                                      readOnly: true
                                    data:
                                      $ref: '#/components/schemas/TagAssignment'
              example:
                object: list
                data:
                  - id: <id>
                    object: deduction
                    data:
                      work_assignment:
                        id: <id>
                        object: work_assignment
                        links:
                          self: /work_assignments/<id>
                      frequency: per_month
                      date_basis: by_period_start_date
                      pay_period_cadence:
                        - 1
                      deduction_type:
                        id: <id>
                        object: deduction_type
                        data:
                          type: income_tax
                          label: Income tax debt
                          locale: en
                        links:
                          self: /deduction_types/income_tax
                      amount: 35
                      amount_type: fixed
                      income_basis: all_earnings
                      income_includes: []
                      income_subtractions: []
                      income_statutory_withholdings: none
                      income_exemption_amount: null
                      income_exemption_percent: null
                      effective_from: '2026-01-01'
                      effective_to: null
                      title: null
                      title_translations: null
                      title_translated: null
                      remittance_account: null
                      business_preset: null
                      expense_accounting_code: null
                      liability_accounting_code: null
                      external_ref: null
                      created_at: '2026-01-01T00:00:00.000000Z'
                      updated_at: '2026-01-01T00:00:00.000000Z'
                    links:
                      self: /deductions/<id>
                links:
                  first: /deductions?work_assignment_id=<id>&page=1
                  last: /deductions?work_assignment_id=<id>&page=1
                  prev: null
                  next: null
                meta:
                  current_page: 1
                  last_page: 1
                  per_page: 15
                  total: 1
                  has_more: false
components:
  schemas:
    Deduction:
      type: object
      title: Deduction
      properties:
        work_assignment:
          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 (`"work_assignment"`).
              readOnly: true
        frequency:
          type: string
          description: >-
            The frequency at which this deduction is applied to Pay Stubs. When
            `per_month`, the amount is distributed across selected Payrolls in
            the calendar month. `per_month` is only valid when `amount_type` is
            `fixed`; percent and per-hour deductions apply to every paycheque
            regardless of frequency.
          enum:
            - once
            - per_month
            - per_payroll
        date_basis:
          type: string
          description: >-
            Which payroll date determines the calendar month for the allocation.
            Applies only to fixed-amount `per_month` deductions.
          nullable: true
          enum:
            - by_pay_date
            - by_period_end_date
            - by_period_start_date
        pay_period_cadence:
          type: object
          description: >-
            Which pay periods within the month receive the allocation. An array
            of 1-based positions; `-1` is the final period. Applies only to
            fixed-amount `per_month` deductions.
          nullable: true
        deduction_type:
          type: object
          description: >-
            The type of deduction, which determines how it is categorized and
            remitted.
          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'
        amount:
          type: number
          description: >-
            The deduction amount per occurrence. When `amount_type` is
            `percentage`, this is interpreted as a percentage of the income
            basis rather than a fixed dollar amount.
          format: decimal
        amount_type:
          type: string
          description: >-
            Whether `amount` is a fixed dollar value (`fixed`) or a percentage
            of the income basis (`percentage`).
          enum:
            - fixed
            - fixed_per_hour
            - percent
        income_basis:
          type: string
          description: >-
            Determines the income used as the base for percentage-based
            deductions. `regular_earnings` includes only salary and wage
            earnings. `all_earnings` includes all earnings. `total_income`
            includes all earnings, taxable allowances, and taxable
            reimbursements. `none` doesn't include any line items, and can be
            used with `income_includes` for completely custom definitions of
            income.
          enum:
            - all_earnings
            - none
            - regular_earnings
            - total_income
        income_includes:
          type: object
          description: >-
            An optional list of specific earnings, allowances, and other line
            item types to include in the income calculation in addition to those
            included via `income_basis`.
          nullable: true
        income_subtractions:
          type: object
          description: >-
            An optional list of deductions and benefits to subtract from the
            income before the deduction amount is calculated.
          nullable: true
        income_statutory_withholdings:
          type: string
          description: >-
            Whether to subtract statutory withholdings (CPP, EI, income tax)
            from the income before the deduction amount is calculated.
          enum:
            - all
            - none
        income_exemption_amount:
          type: number
          description: >-
            A fixed dollar amount to exempt from the income before calculating
            the deduction.
          nullable: true
          format: decimal
        income_exemption_percent:
          type: number
          description: >-
            A percentage of the income to exempt before calculating the
            deduction amount.
          nullable: true
          format: decimal
        effective_from:
          type: string
          description: The date from which this deduction is applied to Pay Stubs.
          format: date
        effective_to:
          type: string
          description: >-
            The date after which this deduction is no longer applied. `null` if
            the deduction applies indefinitely.
          nullable: true
          format: date
        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: {}
        expense_accounting_code: {}
        liability_accounting_code: {}
        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
    WorkAssignment:
      type: object
      title: Work Assignment
      properties:
        title:
          type: string
          description: >-
            An optional label for this work assignment, used to distinguish
            between multiple work assignments for the same Employee or
            Contractor.
          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
        employee:
          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 (`"employee"`).
              readOnly: true
        pay_schedule:
          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_schedule"`).
              readOnly: true
        business_entity:
          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 (`"business_entity"`).
              readOnly: true
        current_tax_jurisdiction:
          type: string
          description: >-
            The current Province of Employment (POE) for the work assignment,
            derived from the `ca::province_of_employment` Tax Property on the
            work assignment or, if none is set, from the Business Entity.
          nullable: true
        is_primary:
          type: boolean
          description: >-
            When `true`, the standard tax reductions are applied to this work
            assignment's Pay Stubs. Only one work assignment per Employee per
            Business Entity may be primary. If none is explicitly set to
            primary, the earliest work assignment is treated as primary.
        accrued_vacation_pay:
          type: number
          description: This attribute is deprecated and will be removed.
          deprecated: true
          format: decimal
        paid_vacation_pay:
          type: number
          description: This attribute is deprecated and will be removed.
          deprecated: true
          format: decimal
        first_non_draft_period_start:
          type: string
          description: >-
            The start of the first pay period for which this work assignment has
            a non-draft Payroll. `null` if the work assignment has never
            appeared on an approved or paid Payroll.
          nullable: true
          format: date
        last_non_draft_period_end:
          type: string
          description: >-
            The end of the most recent pay period for which this work assignment
            has a non-draft Payroll. `null` if the work assignment has never
            appeared on an approved or paid Payroll.
          nullable: true
          format: date
        available_tax_properties:
          type: array
          description: >-
            A list of Tax Property template identifiers supported for this work
            assignment, based on its jurisdiction.
          nullable: true
          items:
            type: string
        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
        archived_at:
          type: string
          description: >-
            The date the work assignment was archived. Archiving ends the work
            assignment's participation in future Payrolls. The archive date must
            not fall before any active Pay Rate's effective period.
          readOnly: true
          nullable: true
          format: dateTime
        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
    RemittanceAccount:
      type: object
      title: Remittance Account
      properties:
        business_entity:
          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 (`"business_entity"`).
              readOnly: true
        source_tax_property:
          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 (`"tax_property"`).
              readOnly: true
        account_provider:
          type: string
          description: >-
            The authority to which remittances are made for this account. This
            is used to determine how to remit payments for this account.
            Employer Health Tax (EHT) and Workers' Compensation (WCB)
            authorities are limited to one account, per province, per business
            entity; creating a second for an authority that already has one is
            rejected.
          nullable: true
          enum:
            - ca_ab_workers_compensation
            - ca_bc_eht
            - ca_bc_workers_compensation
            - ca_cra
            - ca_mb_eht
            - ca_mb_workers_compensation
            - ca_nb_workers_compensation
            - ca_nl_eht
            - ca_nl_workers_compensation
            - ca_ns_workers_compensation
            - ca_nt_government
            - ca_nt_workers_compensation
            - ca_nu_government
            - ca_nu_workers_compensation
            - ca_on_eht
            - ca_on_workers_compensation
            - ca_pe_workers_compensation
            - ca_rq
            - ca_sk_workers_compensation
            - ca_yt_workers_compensation
        is_default:
          type: boolean
          description: >-
            When true, this account is used for auto-enrollment of new
            work-assignments, and work-assignments without an existing
            enrollment for this authority. Only one account per authority per
            business may be the default at a time.
        is_editable:
          type: boolean
          description: >-
            When false, the account's `account_identifier` cannot be updated.
            Becomes false once the account is used on a non-draft payroll and an
            `account_identifier` is set; returns to true when every referencing
            payroll is reverted to draft or deleted.
        is_deletable:
          type: boolean
          description: >-
            When false, the account cannot be deleted. Becomes false once the
            account is referenced by any non-draft payroll; returns to true when
            every referencing payroll is reverted to draft or deleted.
        category:
          type: string
          nullable: true
          enum:
            - ca_benefit_provider
            - ca_provincial_government
            - ca_tax_agency
            - ca_union
            - ca_workers_compensation
        label:
          type: string
          maxLength: 255
        label_translations:
          type: object
          description: Optional translations for the `label` property.
          allOf:
            - $ref: '#/components/schemas/Translations'
          nullable: true
        label_translated:
          type: string
          description: >-
            The translation of the `label` property for the request locale.
            Computed using the values in `label` and `label_translations` and
            the value of the request's `Accept-Language` header.
          readOnly: true
        account_identifier:
          type: string
          nullable: true
          maxLength: 255
        remitter_type:
          type: string
          description: >-
            The CRA remitter type for this account, which determines remittance
            due dates and reporting frequency. When null, falls back to the
            business entity's remitter type.
          nullable: true
          enum:
            - accelerated_threshold_1
            - accelerated_threshold_2
            - quarterly
            - regular
        remittance_management:
          type: string
          description: >-
            Whether remittances for this account are filed manually by the
            employer (`manual`) or handled automatically by Nmbr (`automatic`).
            Only accounts Nmbr can remit on your behalf (CRA, RQ, and Employer
            Health Tax authorities) may be set to `automatic`; all others are
            always `manual`.
          enum:
            - automatic
            - manual
        note:
          type: string
          nullable: true
        address_line_1:
          type: string
          nullable: true
          maxLength: 255
        address_line_2:
          type: string
          nullable: true
          maxLength: 255
        city:
          type: string
          nullable: true
          maxLength: 255
        administrative_area:
          type: string
          nullable: true
          maxLength: 255
        province_code:
          type: string
          nullable: true
        country_code:
          type: string
          nullable: true
          maxLength: 2
        postal_code:
          type: string
          nullable: true
          maxLength: 10
        has_payments:
          type: boolean
        current_enrollments_count:
          type: number
          nullable: true
          format: decimal
        pending_enrollments_count:
          type: number
          nullable: true
          format: decimal
        metadata:
          $ref: '#/components/schemas/RemittanceAccountMetadata'
        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
    BusinessPreset:
      type: object
      title: Business Preset
      properties:
        business_entity:
          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 (`"business_entity"`).
              readOnly: true
        name:
          type: string
          maxLength: 255
        name_translations:
          type: object
          description: Optional translations for the `name` property.
          allOf:
            - $ref: '#/components/schemas/Translations'
          nullable: true
        name_translated:
          type: string
          description: >-
            The translation of the `name` property for the request locale.
            Computed using the values in `name` and `name_translations` and the
            value of the request's `Accept-Language` header.
          readOnly: true
        title:
          type: string
          nullable: true
        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
        type:
          type: string
          maxLength: 255
        subtype:
          type: string
          nullable: true
          maxLength: 255
        remittance_account: {}
        is_managed:
          type: boolean
          description: >-
            If true, this is a default Business Preset and can not be deleted,
            `title` and `remittance_account` may be set.
        expense_accounting_code: {}
        liability_accounting_code: {}
        income_basis:
          type: string
          nullable: true
          enum:
            - all_earnings
            - none
            - regular_earnings
            - total_income
        income_includes:
          type: object
          nullable: true
        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
    ExpenseAccountingCode:
      $ref: '#/components/schemas/AccountingCode'
    LiabilityAccountingCode:
      $ref: '#/components/schemas/AccountingCode'
    TagAssignment:
      type: object
      properties:
        unit:
          type: string
          enum:
            - amount
            - hours
            - percentage
        tag_allocations:
          type: array
          items:
            type: object
            properties:
              tags:
                type: array
                items:
                  $ref: '#/components/schemas/Tag'
              value:
                type: number
                format: decimal
              expense_accounting_code:
                $ref: '#/components/schemas/AccountingCode'
              liability_accounting_code:
                $ref: '#/components/schemas/AccountingCode'
    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
    RemittanceAccountMetadata:
      type: object
      description: >-
        Additional data points for this account. The available fields depend on
        the account's `category`; `null` for categories that capture no
        metadata.
      anyOf:
        - type: object
          title: Workers’ compensation
          properties:
            last_payment_amount:
              type: string
              description: >-
                The last payment made to the board before Nmbr takes over
                remittance, in dollars (e.g. `"1250.00"`).
              nullable: true
              format: decimal
        - type: object
          description: >-
            Categories with no category-specific metadata. Omit the field or
            send `null`.
          title: Other categories
          nullable: true
      nullable: true
    AccountingCode:
      type: object
      title: Accounting Code
      properties:
        business_entity:
          type: object
          description: The Business Entity this accounting code belongs to.
          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 (`"business_entity"`).
              readOnly: true
        type:
          type: string
          description: The type of accounting code.
          enum:
            - bank
            - expense
            - liability
        code:
          type: string
          description: >-
            The accounting code identifier as it appears in the chart of
            accounts.
          nullable: true
          maxLength: 255
        title:
          type: string
          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
        description:
          type: string
          nullable: true
        description_translations:
          type: object
          description: Optional translations for the `description` property.
          allOf:
            - $ref: '#/components/schemas/Translations'
          nullable: true
        description_translated:
          type: string
          description: >-
            The translation of the `description` property for the request
            locale. Computed using the values in `description` and
            `description_translations` and the value of the request's
            `Accept-Language` header.
          readOnly: true
        mapping:
          type: object
          nullable: true
          properties:
            xero:
              type: boolean
            quickbooks:
              type: boolean
        fallback_mappings:
          type: object
          description: >-
            Line Item type/subtype pairs that default to this accounting code
            when no specific mapping is configured. Each entry contains `type`
            and `subtype`.
          nullable: true
        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
    Tag:
      type: object
      title: Tag
      properties:
        label:
          type: string
          maxLength: 255
        label_translations:
          type: object
          description: Optional translations for the `label` property.
          allOf:
            - $ref: '#/components/schemas/Translations'
          nullable: true
        label_translated:
          type: string
          description: >-
            The translation of the `label` property for the request locale.
            Computed using the values in `label` and `label_translations` and
            the value of the request's `Accept-Language` header.
          readOnly: true
        description:
          type: string
          nullable: true
        description_translations:
          type: object
          description: Optional translations for the `description` property.
          allOf:
            - $ref: '#/components/schemas/Translations'
          nullable: true
        description_translated:
          type: string
          description: >-
            The translation of the `description` property for the request
            locale. Computed using the values in `description` and
            `description_translations` and the value of the request's
            `Accept-Language` header.
          readOnly: true
        archived_at:
          type: string
          description: >-
            When set, the tag is archived and excluded from index listings by
            default.
          readOnly: true
          nullable: true
          format: dateTime
        is_deletable:
          type: boolean
          description: >-
            A tag may not be deleted while it is assigned to any active
            allocation.
        integrations:
          type: object
          description: >-
            Identifiers for this tag in external accounting integrations, used
            to sync tags imported from those systems.
          nullable: true
          properties:
            xero:
              type: object
              nullable: true
              properties:
                id:
                  type: string
                  description: The unique identifier of the object in Nmbr.
                  readOnly: true
                  maxLength: 32
            quickbooks:
              type: object
              nullable: true
              properties:
                id:
                  type: string
                  description: The unique identifier of the object in Nmbr.
                  readOnly: true
                  maxLength: 32
        tag_group:
          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 (`"tag_group"`).
              readOnly: true
        business_entity:
          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 (`"business_entity"`).
              readOnly: true
        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
    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

````