> ## 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 a pay stub ## OpenAPI ````yaml /spec/openapi.json get /pay_stubs/{pay_stub} 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: /pay_stubs/{pay_stub}: get: tags: - Pay Stubs summary: Retrieve a pay stub operationId: pay-stubs-show parameters: - name: pay_stub in: path schema: type: string required: true - name: expand in: query schema: type: array items: type: string enum: - allowance_line_items - deduction_line_items - earning_line_items - employee_benefit_line_items - employer_benefit_line_items - employer_statutory_withholding_line_items - payroll - reimbursement_line_items - statutory_withholding_line_items - work_assignment 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 (`"pay_stub"`). readOnly: true data: type: object allOf: - $ref: '#/components/schemas/PayStub' anyOf: - type: object title: Default - type: object title: With payroll expanded properties: payroll: type: object properties: data: $ref: '#/components/schemas/Payroll' - type: object title: With work_assignment expanded properties: work_assignment: type: object properties: data: $ref: '#/components/schemas/WorkAssignment' - type: object title: With earning_line_items expanded properties: earning_line_items: 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/EarningLineItem' - type: object title: With statutory_withholding_line_items expanded properties: statutory_withholding_line_items: 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/StatutoryWithholdingLineItem - type: object title: >- With employer_statutory_withholding_line_items expanded properties: employer_statutory_withholding_line_items: 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/EmployerStatutoryWithholdingLineItem - type: object title: With allowance_line_items expanded properties: allowance_line_items: 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/AllowanceLineItem' - type: object title: With reimbursement_line_items expanded properties: reimbursement_line_items: 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/ReimbursementLineItem - type: object title: With employee_benefit_line_items expanded properties: employee_benefit_line_items: 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/EmployeeBenefitLineItem - type: object title: With employer_benefit_line_items expanded properties: employer_benefit_line_items: 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/EmployerBenefitLineItem - type: object title: With deduction_line_items expanded properties: deduction_line_items: 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/DeductionLineItem' example: id: object: pay_stub data: payroll: id: object: payroll links: self: /payrolls/ work_assignment: id: object: work_assignment links: self: /work_assignments/ payment_method: direct_deposit has_taxes_calculated: true is_pending_tax_rates: false employee_summary: gross: 0 subtractions: 0 reimbursements: 0 net: 0 gross_ytd: 0 subtractions_ytd: 0 reimbursements_ytd: 0 net_ytd: 0 contractor_summary: gross: null reimbursements: null net: null gross_ytd: 0 reimbursements_ytd: 0 net_ytd: 0 company_summary: taxes_and_contributions: 0 benefits: 0 total: 0 taxes_and_contributions_ytd: 0 benefits_ytd: 0 total_ytd: 0 vacation_pay_balance: 0 liability: 0 cash_requirement: 0 note: A PayStub Note line_item_summary: earnings: period: 0 period_managed: 0 period_unmanaged: 0 ytd: 0 statutory_withholdings: period: 0 ytd: 0 reimbursements: period: 0 ytd: 0 allowances: period: 0 ytd: 0 benefits: period: 0 ytd: 0 employee_benefits: period: 0 ytd: 0 employer_benefits: period: 0 ytd: 0 deductions: period: 0 ytd: 0 is_stale: false stale_since: null warnings: object: list data: [] external_ref: null apply_standard_tax_reductions: false created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /pay_stubs/ components: schemas: 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 Payroll: type: object title: Payroll 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 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 type: type: string description: >- The type of payroll. `regular` payrolls are generated automatically on the Pay Schedule. `off_cycle` Payrolls are created manually against a source regular payroll. `historical` and `correction` payrolls are used to record or correct prior periods. enum: - correction - historical - off_cycle - regular period_number: type: integer description: >- The sequential number of this pay period within the calendar year of its `pay_date`, counting only regular payrolls. `null` for off-cycle, historical, and correction payrolls. nullable: true period_label: type: string description: A human-readable label for this pay period. nullable: true period_start: type: string description: The start date of the pay period. format: date period_end: type: string description: The end date of the pay period. format: date pay_date: type: string description: The date on which Employees and Contractors are paid. format: date original_pay_date: type: string description: >- For payrolls on a custom-frequency Pay Schedule, the originally scheduled pay date before any movement for weekends or bank holidays. Used for year-to-date calculations and tax year assignment. nullable: true format: date debit_date: type: string description: >- The expected date the company's account will be debited the `cash_requirement` amount. nullable: true approval_due_at: type: string description: >- The date and time, in UTC, by which the payroll must be approved to be processed on time. readOnly: true nullable: true format: dateTime regular_periods_count: type: integer description: >- The total number of regular pay periods in this Pay Schedule whose `pay_date` falls in the same calendar year as this payroll's `pay_date`. Used for year-to-date calculations. nullable: true is_impacted_by_weekend_or_holiday: type: boolean description: >- Whether `pay_date` or `approval_due_at` has been moved to avoid falling on a weekend or bank holiday. is_blocked_by_draft: type: boolean description: >- Whether this payroll is blocked from being approved because an earlier payroll on the same Pay Schedule is still in draft status. note: type: string description: An optional note on the payroll, visible to the partner. nullable: true employee_summary: type: object description: A summary of pay across all Employees in this payroll. nullable: true properties: gross: description: The sum of all earnings and allowances. subtractions: description: The total of all deductions, taxes, and benefit contributions. reimbursements: description: The total of non-taxable reimbursements. net: description: The Employee net pay; when negative, a warning is included. contractor_summary: type: object description: A summary of pay across all Contractors in this payroll. nullable: true properties: gross: description: The sum of all earnings. reimbursements: description: The total of non-taxable reimbursements. net: description: The Contractor net pay. company_summary: type: object description: A summary of the company's obligations in this payroll. nullable: true properties: taxes_and_contributions: description: The employer share of statutory remittances (CPP and EI). benefits: description: The total of employer benefit contributions. total: description: The company's total obligations. liability: type: number description: >- The total amount owed by the company for this payroll, including Employee and 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 when this payroll is approved. nullable: true format: decimal status: type: string description: The current status of the payroll. enum: - approved - draft - failed - paid - partially_paid - processing approved_at: type: string description: The date on which the payroll was approved. nullable: true format: date is_stale: type: boolean description: >- Whether the payroll's tax calculations are out of date. When `true`, `stale_since` indicates when the payroll became stale. stale_since: type: string description: >- The timestamp at which the payroll's tax calculations became stale and need to be recalculated. `null` if the payroll is up to date. readOnly: true nullable: true format: dateTime source_payroll: {} warnings: type: object description: >- A collection of data validation warnings for this payroll. 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 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 EarningLineItem: type: object title: Earning 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 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 Earning or Pay Rate. Read-only; set `custom_amount` to override. format: decimal is_managed: type: boolean description: >- Whether this line item was generated by an Earning or Pay Rate recurrence and calculated automatically. When `true`, only `custom_amount` and `custom_hours` can be modified and the line item cannot be deleted. line_item_type: type: string nullable: true earning_type: type: object description: The type of earning 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 (`"earning_type"`). readOnly: true data: $ref: '#/components/schemas/EarningType' hours: type: number description: >- The effective hours for this line item. Returns `custom_hours` if set, otherwise `managed_hours`. `null` if neither is set. Read-only. nullable: true format: decimal managed_hours: type: number description: >- The default hours from the linked Pay Rate. Read-only; set `custom_hours` to override. nullable: true format: decimal custom_hours: type: number description: >- An override for `managed_hours`. When set, `hours` reflects this value instead of `managed_hours`. Can be used to prorate the dollar amount on salary line items. 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 recurrence: {} pay_rate: {} overtime_rate: {} 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 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. business_preset: {} source_adjustment: {} 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 StatutoryWithholdingLineItem: type: object title: Statutory Withholding 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_system: type: boolean description: >- Whether this line item was generated automatically by the payroll engine. System line items cannot be deleted. is_managed: type: boolean description: >- Always `true`. Statutory withholding line items are fully managed by the payroll engine and cannot be created, updated, or 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 withholding amount calculated by the payroll engine. Read-only; set `custom_amount` to override. format: decimal statutory_withholding_type: type: object description: The type of statutory withholding 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 (`"statutory_withholding_type"`). readOnly: true data: $ref: '#/components/schemas/StatutoryWithholdingType' 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: 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 (`"remittance_account"`). readOnly: true source_adjustment: {} business_preset: 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_preset"`). readOnly: true 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. 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 EmployerStatutoryWithholdingLineItem: type: object title: Employer Statutory Withholding 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_system: type: boolean description: >- Whether this line item was generated automatically by the payroll engine. is_managed: type: boolean description: >- Always `true`. Employer statutory withholding line items are fully managed by the payroll engine and cannot be created, updated, or 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 withholding amount calculated by the payroll engine. Read-only; set `custom_amount` to override. format: decimal employer_statutory_withholding_type: type: object description: The type of employer statutory withholding 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 (`"employer_statutory_withholding_type"`). readOnly: true data: $ref: '#/components/schemas/EmployerStatutoryWithholdingType' 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: 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 (`"remittance_account"`). readOnly: true source_adjustment: {} business_preset: 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_preset"`). readOnly: true 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. 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 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 ReimbursementLineItem: type: object title: Reimbursement 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 Reimbursement 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 Reimbursement 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 reimbursement_type: type: object description: The type of reimbursement 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 (`"reimbursement_type"`). readOnly: true data: $ref: '#/components/schemas/ReimbursementType' 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 EmployeeBenefitLineItem: type: object title: Employee Benefit 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 Employee Benefit 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 Employee Benefit recurrence. Read-only; set `custom_amount` to override. nullable: true format: decimal employee_benefit_type: type: object description: The type of Employee Benefit 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 (`"employee_benefit_type"`). readOnly: true data: $ref: '#/components/schemas/EmployeeBenefitType' 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_id: type: string nullable: true maxLength: 32 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 EmployerBenefitLineItem: type: object title: Employer Benefit 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 Employer Benefit 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 Employer Benefit recurrence. Read-only; set `custom_amount` to override. nullable: true format: decimal employer_benefit_type: type: object description: The type of Employer Benefit 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 (`"employer_benefit_type"`). readOnly: true data: $ref: '#/components/schemas/EmployerBenefitType' 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_id: type: string nullable: true maxLength: 32 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 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 Translations: type: object nullable: true properties: en: type: string maxLength: 255 fr: type: string maxLength: 255 EarningType: type: object title: Earning Type properties: type: type: string description: The string identifier for this earning type. nullable: true label: type: string description: The human-readable display name for this earning type. nullable: true supported_payroll_types: type: object description: >- A map of Payroll types to whether this earning type is available on that Payroll type. nullable: true properties: regular: type: boolean historical: type: boolean off_cycle: type: boolean features: type: array items: $ref: '#/components/schemas/LineItemTypeFeature' form_mappings: type: array items: $ref: '#/components/schemas/LineItemFormMapping' StatutoryWithholdingType: type: object title: Statutory Withholding Type properties: type: type: string description: The string identifier for this employee statutory withholding type. nullable: true label: type: string description: >- The human-readable display name for this employee statutory withholding type. nullable: true EmployerStatutoryWithholdingType: type: object title: Employer Statutory Withholding Type properties: type: type: string description: The string identifier for this employer statutory withholding type. nullable: true label: type: string description: >- The human-readable display name for this employer statutory withholding type. nullable: true 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' ReimbursementType: type: object title: Reimbursement Type properties: type: type: string description: The string identifier for this reimbursement type. nullable: true label: type: string description: The human-readable display name for this reimbursement type. nullable: true features: type: array items: $ref: '#/components/schemas/LineItemTypeFeature' form_mappings: type: array items: $ref: '#/components/schemas/LineItemFormMapping' EmployeeBenefitType: type: object title: Employee Benefit Type properties: type: type: string description: The string identifier for this employee benefit type. nullable: true label: type: string description: The human-readable display name for this employee benefit type. nullable: true features: type: array items: $ref: '#/components/schemas/LineItemTypeFeature' form_mappings: type: array items: $ref: '#/components/schemas/LineItemFormMapping' EmployerBenefitType: type: object title: Employer Benefit Type properties: type: type: string description: The string identifier for this employer benefit type. nullable: true label: type: string description: The human-readable display name for this employer benefit type. nullable: true features: type: array items: $ref: '#/components/schemas/LineItemTypeFeature' form_mappings: type: array items: $ref: '#/components/schemas/LineItemFormMapping' 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' 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 ````