---
title: "Update an allowance line item"
method: PUT
path: "/allowance_line_items/{allowance_line_item}"
tags: ["Allowance Line Items"]
---

# Update an allowance line item

`PUT /allowance_line_items/{allowance_line_item}`

## Path parameters

- `allowance_line_item` string, required

## Request body

- object
  - `business_preset_id` string — Writing may be blocked when entity is managed by a parent resource Editing is prevented when `is_editable` is false
  - `allowance_type` 'automobile_and_motor_vehicle' | 'cell_phone_allowance' | 'child_care_expenses' | 'child_eduction_non_taxable' | 'child_eduction_taxable' | 'clothing_non_taxable' | 'clothing_taxable' | 'education_and_professional_development' | 'housing_allowance_cash' | 'internet_allowance' | 'meals_taxable' | 'moving_allowance_non_taxable' | 'moving_allowance_taxable' | 'municipal_officers_expense' | 'non_taxable_allowance' | 'overtime_meals_non_taxable' | 'parking_allowance' | 'professional_membership' | 'professional_membership_dues_taxable' | 'social_event_allowance' | 'taxable_cash_allowance' | 'tools_allowance' | 'transit_pass' | 'travelling_allowance_non_taxable' | 'travelling_allowance_taxable' | 'utilities_allowance' | 'vehicle_allowance_non_taxable' — The type of allowance for this line item. Writing may be blocked when entity is managed by a parent resource Editing is prevented when `is_editable` is false
  - `custom_amount` number — An override for `managed_amount`. When set, `amount` reflects this value instead of `managed_amount`. Editing is prevented when `is_editable` is false
  - `accrued_vacation_pay` number — The vacation pay accrued on this line item, calculated based on the Work Assignment's Vacation Pay Settings.
  - `title` string, nullable — Writing may be blocked when entity is managed by a parent resource Editing is prevented when `is_editable` is false
  - `title_translations` Translations, nullable
    - `en` string
    - `fr` string
  - `expense_accounting_code_id` string — Editing is prevented when `is_editable` is false
  - `custom_expense_accounting_code_id` string — Editing is prevented when `is_editable` is false
  - `liability_accounting_code_id` string — Editing is prevented when `is_editable` is false
  - `custom_liability_accounting_code_id` string — Editing is prevented when `is_editable` is false
  - `component_settings` object
    - `attributes_locked` boolean
  - `custom_earned_on` string, date — Editing is prevented when `is_editable` is false
  - `external_ref` string
  - `custom_tag_assignment` object
    - `unit` 'amount' | 'percentage'
    - `is_component_locked` boolean
    - `tag_allocations` object[]
      - `tags` string[]
      - `value` number

## Response `200`

OK

- object
  - `id` string — The unique identifier of the object in Nmbr.
  - `object` string — The type of the object in Nmbr (`"allowance_line_item"`).
  - `data` AllowanceLineItem
    - `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 an Allowance 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 Allowance recurrence. Read-only; set `custom_amount` to override.
    - `accrued_vacation_pay` number, nullable — The vacation pay accrued on this line item, calculated based on the Work Assignment's Vacation Pay Settings.
    - `allowance_type` object — The type of allowance for this line item.
      - `id` string — The unique identifier of the object in Nmbr.
      - `object` string — The type of the object in Nmbr (`"allowance_type"`).
      - `data` AllowanceType
        - `type` string, nullable — The string identifier for this allowance type.
        - `label` string, nullable — The human-readable display name for this allowance type.
        - `features` LineItemTypeFeature[]
          - `type` 'eht' | 'income_tax' | 'insurable' | 'pensionable' | '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.
    - `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.
    - `earned_on` unknown
    - `managed_earned_on` string, date, nullable — The earned-on date set by the system. Read-only; set `custom_earned_on` to override.
    - `custom_earned_on` string, date, nullable — An override for `managed_earned_on`. When set, `earned_on` reflects this value instead of `managed_earned_on`. Must fall within the payroll's pay period.
    - `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/a0c7a815860f/schema)