> ## 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. # Retrieve an allowance line item ## OpenAPI ````yaml /spec/openapi.json get /allowance_line_items/{allowance_line_item} 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: /allowance_line_items/{allowance_line_item}: get: tags: - Allowance Line Items summary: Retrieve an allowance line item operationId: allowance-line-items-show parameters: - name: allowance_line_item in: path schema: type: string required: true - name: expand in: query schema: type: array items: type: string enum: - business_preset - custom_expense_accounting_code - custom_liability_accounting_code - custom_tag_assignment - expense_accounting_code - liability_accounting_code - managed_expense_accounting_code - managed_liability_accounting_code - managed_tag_assignment - pay_stub - recurrence - source_adjustment - tag_assignment - tag_assignment_amounts required: false responses: '200': description: OK content: application/json: schema: 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 (`"allowance_line_item"`). readOnly: true data: type: object allOf: - $ref: '#/components/schemas/AllowanceLineItem' anyOf: - type: object title: Default - type: object title: With pay_stub expanded properties: pay_stub: type: object properties: data: $ref: '#/components/schemas/PayStub' - type: object title: With recurrence expanded properties: recurrence: type: object properties: data: $ref: '#/components/schemas/Recurrence' - type: object title: With business_preset expanded properties: business_preset: type: object properties: data: $ref: '#/components/schemas/BusinessPreset' - type: object title: With source_adjustment expanded properties: source_adjustment: type: object properties: data: $ref: '#/components/schemas/SourceAdjustment' - type: object title: With expense_accounting_code expanded properties: expense_accounting_code: type: object properties: data: $ref: '#/components/schemas/ExpenseAccountingCode' - type: object title: With managed_expense_accounting_code expanded properties: managed_expense_accounting_code: type: object properties: data: $ref: >- #/components/schemas/ManagedExpenseAccountingCode - type: object title: With custom_expense_accounting_code expanded properties: custom_expense_accounting_code: type: object properties: data: $ref: >- #/components/schemas/CustomExpenseAccountingCode - type: object title: With liability_accounting_code expanded properties: liability_accounting_code: type: object properties: data: $ref: '#/components/schemas/LiabilityAccountingCode' - type: object title: With managed_liability_accounting_code expanded properties: managed_liability_accounting_code: type: object properties: data: $ref: >- #/components/schemas/ManagedLiabilityAccountingCode - type: object title: With custom_liability_accounting_code expanded properties: custom_liability_accounting_code: type: object properties: data: $ref: >- #/components/schemas/CustomLiabilityAccountingCode - 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' - type: object title: With managed_tag_assignment expanded properties: managed_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/ManagedTagAssignment' - type: object title: With custom_tag_assignment expanded properties: custom_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/CustomTagAssignment' - type: object title: With tag_assignment_amounts expanded properties: tag_assignment_amounts: type: object nullable: true 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. readOnly: true data: $ref: '#/components/schemas/TagAssignmentAmount' example: id: object: allowance_line_item data: pay_stub: id: object: pay_stub links: self: /pay_stubs/ line_item_type: allowance is_managed: false amount: 35 custom_amount: null managed_amount: 35 accrued_vacation_pay: 0 allowance_type: id: object: allowance_type data: type: automobile_and_motor_vehicle label: Vehicle allowance (taxable) links: self: /allowance_types/automobile_and_motor_vehicle recurrence: null title: null title_translations: null title_translated: 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 earned_on: null managed_earned_on: null custom_earned_on: null external_ref: null created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /allowance_line_items/ components: schemas: AllowanceLineItem: type: object title: Allowance 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 an Allowance 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 Allowance recurrence. Read-only; set `custom_amount` to override. nullable: true format: decimal accrued_vacation_pay: type: number description: >- The vacation pay accrued on this line item, calculated based on the Work Assignment's Vacation Pay Settings. nullable: true format: decimal allowance_type: type: object description: The type of allowance 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 (`"allowance_type"`). readOnly: true data: $ref: '#/components/schemas/AllowanceType' 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 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. earned_on: description: >- The effective earned-on date for this line item. Returns `custom_earned_on` if set, otherwise `managed_earned_on`. Read-only. managed_earned_on: type: string description: >- The earned-on date set by the system. Read-only; set `custom_earned_on` to override. nullable: true format: date custom_earned_on: type: string description: >- 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. nullable: true format: date 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 PayStub: type: object title: Pay Stub properties: payroll: 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 (`"payroll"`). readOnly: true 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 payment_method: type: string description: The payment method for this pay stub. enum: - direct_deposit - manual - pad - wire has_taxes_calculated: type: boolean description: >- Whether tax amounts have been calculated for this pay stub. When `false`, amounts in the `employee_summary` and `company_summary` may be incomplete. is_pending_tax_rates: type: boolean description: This attribute is deprecated and will be removed. deprecated: true employee_summary: type: object description: >- A summary of pay for the Employee associated with this pay stub. Both `employee_summary` and `contractor_summary` are always present. The summary that does not apply is empty rather than omitted, and its amounts may be `null` before summaries are calculated. For calculated summaries, the side with a non-null `net` is the populated summary. `*_ytd` fields contain year-to-date totals inclusive of this pay period. nullable: true properties: gross: type: number description: The sum of all earnings and allowances. nullable: true format: decimal subtractions: type: number description: The total of all deductions, taxes, and benefit contributions. nullable: true format: decimal reimbursements: type: number description: The total of non-taxable reimbursements. nullable: true format: decimal net: type: number description: The Employee net pay; when negative, a warning is included. nullable: true format: decimal gross_ytd: type: number nullable: true format: decimal subtractions_ytd: type: number nullable: true format: decimal reimbursements_ytd: type: number nullable: true format: decimal net_ytd: type: number nullable: true format: decimal contractor_summary: type: object description: >- A summary of pay for the Contractor associated with this pay stub. Always present. For calculated summaries, a non-null `contractor_summary.net` means the contractor summary is populated. `*_ytd` fields contain year-to-date totals inclusive of this pay period. nullable: true properties: gross: description: The sum of all earnings. reimbursements: description: The total of non-taxable reimbursements. net: description: The Contractor net pay. gross_ytd: type: number nullable: true format: decimal reimbursements_ytd: type: number nullable: true format: decimal net_ytd: type: number nullable: true format: decimal company_summary: type: object description: >- A summary of the company's obligations for this pay stub. `*_ytd` fields contain year-to-date totals inclusive of this pay period. nullable: true properties: taxes_and_contributions: type: number description: The employer share of statutory remittances (CPP and EI). nullable: true format: decimal benefits: type: number description: The total of employer benefit contributions. nullable: true format: decimal total: type: number description: The company's total obligations. nullable: true format: decimal taxes_and_contributions_ytd: type: number nullable: true format: decimal benefits_ytd: type: number nullable: true format: decimal total_ytd: type: number nullable: true format: decimal vacation_pay_balance: type: number description: >- The Employee's Vacation Pay balance as of the end of this pay period. `null` for Contractor pay stubs. nullable: true format: decimal liability: type: number description: >- The total amount owed by the company for this pay stub, including Employee or Contractor net pay, employer tax contributions, and employer benefit contributions. nullable: true format: decimal cash_requirement: type: number description: >- The total amount that will be debited from the company's account for this pay stub when the Payroll is approved. nullable: true format: decimal note: type: string description: An optional note on the pay stub, visible to the partner. nullable: true line_item_summary: type: object description: >- Totals grouped by line item category for this pay stub. Each category includes a `period` total for the current pay period and a `ytd` total for the calendar year to date. Categories: `earnings`, `statutory_withholdings`, `reimbursements`, `allowances`, `employee_benefits`, `employer_benefits`, `deductions`. nullable: true properties: earnings: type: object nullable: true properties: period: type: number nullable: true format: decimal period_managed: type: number nullable: true format: decimal period_unmanaged: type: number nullable: true format: decimal ytd: type: number nullable: true format: decimal statutory_withholdings: type: object nullable: true properties: period: type: number nullable: true format: decimal ytd: type: number nullable: true format: decimal reimbursements: type: object nullable: true properties: period: type: number nullable: true format: decimal ytd: type: number nullable: true format: decimal allowances: type: object nullable: true properties: period: type: number nullable: true format: decimal ytd: type: number nullable: true format: decimal benefits: type: object nullable: true properties: period: type: number nullable: true format: decimal ytd: type: number nullable: true format: decimal employee_benefits: type: object nullable: true properties: period: type: number nullable: true format: decimal ytd: type: number nullable: true format: decimal employer_benefits: type: object nullable: true properties: period: type: number nullable: true format: decimal ytd: type: number nullable: true format: decimal deductions: type: object nullable: true properties: period: type: number nullable: true format: decimal ytd: type: number nullable: true format: decimal is_stale: type: boolean description: >- Whether the pay stub's tax calculations are out of date. When `true`, `stale_since` indicates when the pay stub became stale. stale_since: type: string description: >- The timestamp at which the pay stub's tax calculations became stale and need to be recalculated. `null` if the pay stub is up to date. readOnly: true nullable: true format: dateTime warnings: type: object description: >- A collection of data validation warnings for this pay stub. Warnings indicate incomplete or potentially incorrect data and could prevent payroll processing. nullable: true properties: object: type: string nullable: true data: 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 apply_standard_tax_reductions: type: boolean description: >- When `true`, the standard tax reductions are applied to this pay stub's withholdings even in cases where they would otherwise be skipped to avoid applying them twice across related runs in the same period. In Canada these reductions are the employee's federal and provincial personal tax credits (their TD1 claim amounts) and the CPP/QPP basic exemption. Defaults to `false`, and has no effect where those reductions already apply. 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 Recurrence: type: object 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 SourceAdjustment: $ref: '#/components/schemas/Adjustment' ExpenseAccountingCode: $ref: '#/components/schemas/AccountingCode' ManagedExpenseAccountingCode: $ref: '#/components/schemas/AccountingCode' CustomExpenseAccountingCode: $ref: '#/components/schemas/AccountingCode' LiabilityAccountingCode: $ref: '#/components/schemas/AccountingCode' ManagedLiabilityAccountingCode: $ref: '#/components/schemas/AccountingCode' CustomLiabilityAccountingCode: $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' ManagedTagAssignment: 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' CustomTagAssignment: 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' TagAssignmentAmount: 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' AllowanceType: type: object title: Allowance Type properties: type: type: string description: The string identifier for this allowance type. nullable: true label: type: string description: The human-readable display name for this allowance type. 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 Adjustment: type: object title: Adjustment properties: source_line_item: 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 (`"earning_line_item"`). readOnly: true data: $ref: '#/components/schemas/LineItem' correction_line_item: 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 (`"earning_line_item"`). readOnly: true data: $ref: '#/components/schemas/LineItem' correction_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 type: type: string nullable: true maxLength: 255 subtype: type: string nullable: true maxLength: 255 expected_amount: type: number format: decimal admin_note: type: string 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 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 LineItem: type: object securitySchemes: CompanyToken: type: http scheme: bearer ````