> ## Documentation Index > Fetch the complete documentation index at: https://docs.nmbr.co/llms.txt > Use this file to discover all available pages before exploring further. # List business presets ## OpenAPI ````yaml /spec/openapi.json get /business_presets 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: /business_presets: get: tags: - Business Presets summary: List business presets operationId: business-presets-index parameters: - name: business_entity_id in: query schema: type: string required: true - name: type in: query schema: type: string enum: - allowance - deduction - earning - employee_benefit - employer_benefit - employer_statutory_withholding - reimbursement - statutory_withholding required: false - name: subtype in: query schema: type: string required: false - name: sort in: query schema: type: string enum: - name - subtype - subtype.label - title - type - type.label required: false description: >- Sort order is specified using the format `sort=field[:direction][,field[:direction],...]` where `field` is the name of the field to sort by and `direction` is the optional sort direction (`asc` or `desc`). - name: include_managed in: query schema: type: boolean required: false - name: external_ref in: query schema: type: string required: false - name: expand in: query schema: type: array items: type: string enum: - allowances - business_entity - deductions - earnings - employee_benefits - employer_benefits - expense_accounting_code - liability_accounting_code - pay_rates - reimbursements - remittance_account required: false responses: '200': description: OK content: application/json: schema: type: object properties: object: type: string description: The type of the object in Nmbr (`"list"`). readOnly: true data: type: array items: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: >- The type of the object in Nmbr (`"business_preset"`). readOnly: true data: type: object allOf: - $ref: '#/components/schemas/BusinessPreset' anyOf: - type: object title: Default - type: object title: With business_entity expanded properties: business_entity: type: object properties: data: $ref: '#/components/schemas/BusinessEntity' - type: object title: With remittance_account expanded properties: remittance_account: type: object properties: data: $ref: '#/components/schemas/RemittanceAccount' - type: object title: With earnings expanded properties: earnings: 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/Earning' - type: object title: With allowances expanded properties: allowances: 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/Allowance' - type: object title: With employee_benefits expanded properties: employee_benefits: 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/EmployeeBenefit' - type: object title: With employer_benefits expanded properties: employer_benefits: 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/EmployerBenefit' - type: object title: With deductions expanded properties: deductions: 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/Deduction' - type: object title: With reimbursements expanded properties: reimbursements: 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/Reimbursement' - type: object title: With pay_rates expanded properties: pay_rates: 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/PayRate' - type: object title: With expense_accounting_code expanded properties: expense_accounting_code: type: object properties: data: $ref: >- #/components/schemas/ExpenseAccountingCode - type: object title: With liability_accounting_code expanded properties: liability_accounting_code: type: object properties: data: $ref: >- #/components/schemas/LiabilityAccountingCode example: object: list data: - id: object: business_preset data: business_entity: id: object: business_entity links: self: /business_entities/ name: Business Preset 08a620c8-1d8a-3f0c-9475-963b2e8a0d49 name_translations: null name_translated: Business Preset 08a620c8-1d8a-3f0c-9475-963b2e8a0d49 title: Business Preset title_translations: null title_translated: Business Preset type: earning subtype: null remittance_account: null is_managed: false expense_accounting_code: null liability_accounting_code: null income_basis: null income_includes: [] external_ref: null created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /business_presets/ links: first: /business_presets?business_entity_id=&page=1 last: /business_presets?business_entity_id=&page=1 prev: null next: null meta: current_page: 1 last_page: 1 per_page: 15 total: 1 has_more: false components: schemas: 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 BusinessEntity: type: object title: Business Entity properties: business_number: type: string description: >- The Canada Revenue Agency (CRA) Business Number (BN) for this business entity, used to identify the business for payroll tax remittances. nullable: true maxLength: 255 name: type: string description: The business entity's operating or trade name. maxLength: 255 legal_name: type: string description: The business entity's registered legal name. nullable: true maxLength: 255 legal_registration_number: type: string description: The provincial business registration number. nullable: true maxLength: 255 address_line_1: type: string description: >- The first line of the business entity's mailing address. Canada Revenue Agency forms (T4, RL-1) truncate this to the length those forms allow. nullable: true maxLength: 255 address_line_2: type: string description: >- The second line of the business entity's mailing address. Canada Revenue Agency forms (T4, RL-1) truncate this to the length those forms allow. nullable: true maxLength: 255 city: type: string description: The city of the business entity's mailing address. nullable: true maxLength: 255 in_preview: type: boolean description: >- When `true`, the business entity is in preview mode. In preview mode, Payrolls can be run and approved but no real money movement occurs. administrative_area: type: string description: >- The region of the business entity's mailing address — the province, state, or county, depending on the country. For Canadian business entities this is the province. nullable: true maxLength: 255 province_code: type: string description: >- This attribute is deprecated and will be removed. A deprecated alias of `administrative_area` that mirrors its value. Use `administrative_area` instead. nullable: true deprecated: true country_code: type: string description: The country code for the business entity's mailing address. nullable: true maxLength: 2 postal_code: type: string description: The postal code for the business entity's mailing address. nullable: true maxLength: 255 contact_name: type: string description: The name of the primary contact at the business entity. nullable: true maxLength: 255 contact_email: type: string description: The email address of the primary contact at the business entity. nullable: true maxLength: 255 contact_area_code: type: string description: The area code for the primary contact's phone number. nullable: true maxLength: 255 contact_phone_number: type: string description: The primary contact's phone number, excluding area code. nullable: true maxLength: 255 contact_extension: type: string description: The extension for the primary contact's phone number. nullable: true maxLength: 255 pay_day_movement_setting: type: string description: >- The business entity-level setting for how pay dates are adjusted when they fall on a weekend or bank holiday. If set to `inherit`, the Company's setting is used. enum: - inherit - next_business_day - previous_business_day vacation_pay_formula_setting: type: string description: >- The formula used to calculate vacation pay for Employees in this business entity. enum: - pay_date - period_end - period_start remitter_type: type: string description: >- The Canada Revenue Agency (CRA) remitter type, which determines the frequency of payroll tax remittances to the CRA. nullable: true enum: - accelerated_threshold_1 - accelerated_threshold_2 - quarterly - regular status: type: string description: >- The business entity's current status. A business entity must reach `approved` status before live Payrolls can be processed. enum: - approved - onboarding - suspended company: 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 (`"company"`). readOnly: true warnings: type: object description: >- A collection of data validation warnings for this business entity. Warnings indicate incomplete or potentially incorrect data and could prevent payroll processing. nullable: true properties: object: type: string nullable: true data: type: array nullable: true items: type: object properties: object: type: string nullable: true data: type: object nullable: true properties: namespace: type: string nullable: true type: 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 available_tax_properties: type: array description: >- A list of Tax Property template identifiers supported for this business entity, based on its jurisdiction. nullable: true items: type: string effective_processing_speed: type: string description: >- The resolved processing speed after applying inheritance from the Partner if `processing_speed` is `inherit`. nullable: true processing_speed: type: string description: >- The business entity-level processing speed setting. If set to `inherit`, the Partner's processing speed is used. enum: - five_day - four_day - inherit - one_day - three_day - two_day has_bank_accounts: type: boolean description: Whether this business entity has any Bank Accounts configured. has_pay_schedules: type: boolean description: Whether this business entity has any Pay Schedules configured. has_payrolls: type: boolean description: Whether this business entity has any Payrolls. current_tax_jurisdiction: type: string description: >- The current tax jurisdiction for the business entity, derived from its `ca::province_of_employment` Tax Property. nullable: true ca_settings: type: object description: >- Canada-specific settings for this business entity. Only present for business entities with a Canadian address. nullable: true properties: roe_submission_setting: type: string description: >- Indicates whether Record of Employment (ROE) submissions are managed by Nmbr (`managed`) or by the employer directly (`manual`). nullable: true accounting_settings: type: object description: >- Accounting-related settings for this business entity. New clients should read and write these through this object; the top-level `default_bank_accounting_code`, `default_payroll_payable_accounting_code`, `resolve_journal_entry_stat_withholdings`, and `primary_tag_group` fields are retained as aliases for backwards compatibility. nullable: true properties: default_bank_accounting_code: description: >- The Accounting Code used as the default bank account row when generating journal entries. default_payroll_payable_accounting_code: description: >- The Accounting Code used as the default payroll payable row when generating journal entries. resolve_journal_entry_stat_withholdings: type: boolean description: >- When `true`, statutory withholding line items (employee and employer) are split across tracking dimensions derived from their applicable source earnings. When `false`, each statutory withholding appears as a single unsplit row in journal entries. primary_tag_group: description: >- The Tag Group that drives default accounting-code resolution for line items. Setting this also flags the group as a journal entry dimension. block_approval_on_incomplete_journal_entries: type: boolean description: >- When `true`, payroll approval is blocked if any exportable journal entry row has no Accounting Code. block_approval_on_missing_export_identifiers: type: boolean description: >- When `true`, payroll approval is blocked if any exportable journal entry row has no Accounting Code OR has one that lacks the enabled integration's external identifier. default_bank_accounting_code: description: |- This attribute is deprecated and will be removed. Use `accounting_settings.default_bank_accounting_code`. deprecated: true default_payroll_payable_accounting_code: description: |- This attribute is deprecated and will be removed. Use `accounting_settings.default_payroll_payable_accounting_code`. deprecated: true preferred_locale: type: string description: >- The locale used for payroll communications sent to Employees and Contractors within this business entity. If not set, the Company's locale is used. nullable: true enum: - en - fr hold_funding_for_verification: type: boolean description: >- When `true`, funding payments will be automatically held after settlement for verification. Downstream payments (employee, CRA, RQ) will not be processed until the funding payment hold is released. resolve_journal_entry_stat_withholdings: type: boolean description: |- This attribute is deprecated and will be removed. Use `accounting_settings.resolve_journal_entry_stat_withholdings`. deprecated: true primary_tag_group: description: |- This attribute is deprecated and will be removed. Use `accounting_settings.primary_tag_group`. deprecated: 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 RemittanceAccount: type: object title: Remittance Account properties: business_entity: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"business_entity"`). readOnly: true source_tax_property: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"tax_property"`). readOnly: true account_provider: type: string description: >- The authority to which remittances are made for this account. This is used to determine how to remit payments for this account. Employer Health Tax (EHT) and Workers' Compensation (WCB) authorities are limited to one account, per province, per business entity; creating a second for an authority that already has one is rejected. nullable: true enum: - ca_ab_workers_compensation - ca_bc_eht - ca_bc_workers_compensation - ca_cra - ca_mb_eht - ca_mb_workers_compensation - ca_nb_workers_compensation - ca_nl_eht - ca_nl_workers_compensation - ca_ns_workers_compensation - ca_nt_government - ca_nt_workers_compensation - ca_nu_government - ca_nu_workers_compensation - ca_on_eht - ca_on_workers_compensation - ca_pe_workers_compensation - ca_rq - ca_sk_workers_compensation - ca_yt_workers_compensation is_default: type: boolean description: >- When true, this account is used for auto-enrollment of new work-assignments, and work-assignments without an existing enrollment for this authority. Only one account per authority per business may be the default at a time. is_editable: type: boolean description: >- When false, the account's `account_identifier` cannot be updated. Becomes false once the account is used on a non-draft payroll and an `account_identifier` is set; returns to true when every referencing payroll is reverted to draft or deleted. is_deletable: type: boolean description: >- When false, the account cannot be deleted. Becomes false once the account is referenced by any non-draft payroll; returns to true when every referencing payroll is reverted to draft or deleted. category: type: string nullable: true enum: - ca_benefit_provider - ca_provincial_government - ca_tax_agency - ca_union - ca_workers_compensation label: type: string maxLength: 255 label_translations: type: object description: Optional translations for the `label` property. allOf: - $ref: '#/components/schemas/Translations' nullable: true label_translated: type: string description: >- The translation of the `label` property for the request locale. Computed using the values in `label` and `label_translations` and the value of the request's `Accept-Language` header. readOnly: true account_identifier: type: string nullable: true maxLength: 255 remitter_type: type: string description: >- The CRA remitter type for this account, which determines remittance due dates and reporting frequency. When null, falls back to the business entity's remitter type. nullable: true enum: - accelerated_threshold_1 - accelerated_threshold_2 - quarterly - regular remittance_management: type: string description: >- Whether remittances for this account are filed manually by the employer (`manual`) or handled automatically by Nmbr (`automatic`). Only accounts Nmbr can remit on your behalf (CRA, RQ, and Employer Health Tax authorities) may be set to `automatic`; all others are always `manual`. enum: - automatic - manual note: type: string nullable: true address_line_1: type: string nullable: true maxLength: 255 address_line_2: type: string nullable: true maxLength: 255 city: type: string nullable: true maxLength: 255 administrative_area: type: string nullable: true maxLength: 255 province_code: type: string nullable: true country_code: type: string nullable: true maxLength: 2 postal_code: type: string nullable: true maxLength: 10 has_payments: type: boolean current_enrollments_count: type: number nullable: true format: decimal pending_enrollments_count: type: number nullable: true format: decimal metadata: $ref: '#/components/schemas/RemittanceAccountMetadata' created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime Earning: type: object title: Earning properties: work_assignment: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"work_assignment"`). readOnly: true earning_type: type: object description: The type of earning, which determines how it is taxed. 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' 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 amount: type: number description: >- The monetary amount applied each time this earning is included on a Pay Stub. format: decimal frequency: type: string description: >- The frequency at which this earning is applied to Pay Stubs. When `per_month`, the amount is distributed evenly across all Payrolls in the calendar month. enum: - once - per_month - per_payroll date_basis: type: string description: >- Which payroll date determines the calendar month for the allocation. Applies only to `per_month` recurrences. nullable: true enum: - by_pay_date - by_period_end_date - by_period_start_date pay_period_cadence: type: object description: >- Which pay periods within the month receive the allocation. An array of 1-based positions; `-1` is the final period. Applies only to `per_month` recurrences. nullable: true effective_from: type: string description: The date from which this earning is applied to Pay Stubs. format: date effective_to: type: string description: >- The date after which this earning is no longer applied. `null` if the earning applies indefinitely. nullable: true format: date business_preset: {} expense_accounting_code: {} liability_accounting_code: {} external_ref: type: string description: >- A reference to the object in an external system, e.g. the primary key of the object in your application's database. Nmbr doesn't use, validate, parse, or require this value to be unique - it simply stores it for your reference. nullable: true maxLength: 255 created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime Allowance: type: object title: Allowance properties: work_assignment: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"work_assignment"`). readOnly: true allowance_type: type: object description: >- The type of allowance, which determines how it is taxed and reported on Pay Stubs. 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' 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 amount: type: number description: >- The monetary amount applied each time this allowance is included on a Pay Stub. format: decimal frequency: type: string description: >- The frequency at which this allowance is applied to Pay Stubs. When `per_month`, the amount is distributed evenly across all Payrolls in the calendar month. enum: - once - per_month - per_payroll date_basis: type: string description: >- Which payroll date determines the calendar month for the allocation. Applies only to `per_month` recurrences. nullable: true enum: - by_pay_date - by_period_end_date - by_period_start_date pay_period_cadence: type: object description: >- Which pay periods within the month receive the allocation. An array of 1-based positions; `-1` is the final period. Applies only to `per_month` recurrences. nullable: true effective_from: type: string description: The date from which this allowance is applied to Pay Stubs. format: date effective_to: type: string description: >- The date after which this allowance is no longer applied. `null` if the allowance applies indefinitely. nullable: true format: date business_preset: {} expense_accounting_code: {} liability_accounting_code: {} external_ref: type: string description: >- A reference to the object in an external system, e.g. the primary key of the object in your application's database. Nmbr doesn't use, validate, parse, or require this value to be unique - it simply stores it for your reference. nullable: true maxLength: 255 created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime EmployeeBenefit: type: object title: Employee Benefit properties: work_assignment: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"work_assignment"`). readOnly: true business_preset: {} employee_benefit_type: type: object description: >- The type of employee benefit, which determines how it is taxed and reported. 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' employer_benefit: {} 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 income_basis: type: string description: >- Determines the income used as the base for percentage-based benefit calculations. `regular_earnings` includes only salary and wage earnings. `all_earnings` includes all earnings. `total_income` includes all earnings, taxable allowances, and taxable reimbursements. `none` doesn't include any line items, and can be used with `income_includes` for completely custom definitions of income. enum: - all_earnings - none - regular_earnings - total_income income_includes: type: object description: >- An optional list of specific earnings, allowances, and other line item types to include in the income calculation in addition to those included via `income_basis`. nullable: true max_annual_contribution_basis: type: string description: >- Whether `max_annual_contribution` accumulates across pay periods or applies as a fixed per-period cap. enum: - all_line_items_of_type - this_benefit apply_sales_tax: type: boolean description: Whether provincial sales tax is applied to the benefit amount. remittance_account_id: type: string description: >- The remittance account to which collected benefit amounts are remitted. nullable: true maxLength: 32 remittance_account: {} amount: type: number description: >- The contribution amount per pay period. When `amount_type` is `percent`, this is interpreted as a percentage of the income basis (0-100); otherwise as a fixed dollar amount. format: decimal amount_type: type: string description: >- Whether `amount` is a fixed dollar value (`fixed`) or a percentage of the income basis (`percent`). enum: - fixed - percent coverage_multiplier: type: number description: >- A multiplier applied to the Employee's earnings to determine the benefit coverage amount, used for coverage-based benefits such as life insurance. format: decimal max_annual_contribution: type: number description: >- The maximum dollar amount that will be contributed in a calendar year. Contributions stop once this limit is reached. nullable: true format: decimal frequency: type: string description: >- The frequency at which this benefit is applied to Pay Stubs. When `per_month`, the amount is distributed across the selected Payrolls in the calendar month. `per_month` requires `amount_type` to be `fixed`. enum: - once - per_month - per_payroll date_basis: type: string description: >- Which payroll date determines the calendar month for the allocation. Applies only to `per_month` benefits. nullable: true enum: - by_pay_date - by_period_end_date - by_period_start_date pay_period_cadence: type: object description: >- Which pay periods within the month receive the allocation. An array of 1-based positions; `-1` is the final period. Applies only to `per_month` benefits. nullable: true effective_from: type: string description: The date from which this benefit is applied to Pay Stubs. format: date effective_to: type: string description: >- The date after which this benefit is no longer applied. `null` if the benefit applies indefinitely. nullable: true format: date expense_accounting_code: {} liability_accounting_code: {} external_ref: type: string description: >- A reference to the object in an external system, e.g. the primary key of the object in your application's database. Nmbr doesn't use, validate, parse, or require this value to be unique - it simply stores it for your reference. nullable: true maxLength: 255 created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime EmployerBenefit: type: object title: Employer Benefit properties: work_assignment: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"work_assignment"`). readOnly: true business_preset: {} employer_benefit_type: type: object description: >- The type of employer benefit, which determines how it is categorized and reported. 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' employee_benefit: {} 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 apply_sales_tax: type: boolean description: Whether provincial sales tax is applied to the benefit amount. income_basis: type: string description: >- Determines the income used as the base for percentage-based benefit calculations. `regular_earnings` includes only salary and wage earnings. `all_earnings` includes all earnings. `total_income` includes all earnings, taxable allowances, and taxable reimbursements. `none` doesn't include any line items, and can be used with `income_includes` for completely custom definitions of income. enum: - all_earnings - none - regular_earnings - total_income income_includes: type: object description: >- An optional list of specific earnings, allowances, and other line item types to include in the income calculation in addition to those included via `income_basis`. nullable: true remittance_account_id: type: string description: >- The remittance account to which collected benefit amounts are remitted. nullable: true maxLength: 32 remittance_account: {} amount: type: number description: >- The contribution amount per pay period. When `amount_type` is `percent`, this is interpreted as a percentage of the income basis (0-100); otherwise as a fixed dollar amount. format: decimal amount_type: type: string description: >- Whether `amount` is a fixed dollar value (`fixed`) or a percentage of the income basis (`percent`). enum: - fixed - percent coverage_multiplier: type: number description: >- A multiplier applied to the Employee's earnings to determine the benefit coverage amount, used for coverage-based benefits such as life insurance. format: decimal max_annual_contribution: type: number description: >- The maximum dollar amount that will be contributed in a calendar year. Contributions stop once this limit is reached. nullable: true format: decimal max_annual_contribution_basis: type: string description: >- Whether `max_annual_contribution` accumulates across pay periods or applies as a fixed per-period cap. enum: - all_line_items_of_type - this_benefit frequency: type: string description: >- The frequency at which this benefit is applied to Pay Stubs. When `per_month`, the amount is distributed across the selected Payrolls in the calendar month. `per_month` requires `amount_type` to be `fixed`. enum: - once - per_month - per_payroll date_basis: type: string description: >- Which payroll date determines the calendar month for the allocation. Applies only to `per_month` benefits. nullable: true enum: - by_pay_date - by_period_end_date - by_period_start_date pay_period_cadence: type: object description: >- Which pay periods within the month receive the allocation. An array of 1-based positions; `-1` is the final period. Applies only to `per_month` benefits. nullable: true effective_from: type: string description: The date from which this benefit is applied to Pay Stubs. format: date effective_to: type: string description: >- The date after which this benefit is no longer applied. `null` if the benefit applies indefinitely. nullable: true format: date expense_accounting_code: {} liability_accounting_code: {} external_ref: type: string description: >- A reference to the object in an external system, e.g. the primary key of the object in your application's database. Nmbr doesn't use, validate, parse, or require this value to be unique - it simply stores it for your reference. nullable: true maxLength: 255 created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime Deduction: type: object title: Deduction properties: work_assignment: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"work_assignment"`). readOnly: true frequency: type: string description: >- The frequency at which this deduction is applied to Pay Stubs. When `per_month`, the amount is distributed across selected Payrolls in the calendar month. `per_month` is only valid when `amount_type` is `fixed`; percent and per-hour deductions apply to every paycheque regardless of frequency. enum: - once - per_month - per_payroll date_basis: type: string description: >- Which payroll date determines the calendar month for the allocation. Applies only to fixed-amount `per_month` deductions. nullable: true enum: - by_pay_date - by_period_end_date - by_period_start_date pay_period_cadence: type: object description: >- Which pay periods within the month receive the allocation. An array of 1-based positions; `-1` is the final period. Applies only to fixed-amount `per_month` deductions. nullable: true deduction_type: type: object description: >- The type of deduction, which determines how it is categorized and remitted. properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"deduction_type"`). readOnly: true data: $ref: '#/components/schemas/DeductionType' amount: type: number description: >- The deduction amount per occurrence. When `amount_type` is `percentage`, this is interpreted as a percentage of the income basis rather than a fixed dollar amount. format: decimal amount_type: type: string description: >- Whether `amount` is a fixed dollar value (`fixed`) or a percentage of the income basis (`percentage`). enum: - fixed - fixed_per_hour - percent income_basis: type: string description: >- Determines the income used as the base for percentage-based deductions. `regular_earnings` includes only salary and wage earnings. `all_earnings` includes all earnings. `total_income` includes all earnings, taxable allowances, and taxable reimbursements. `none` doesn't include any line items, and can be used with `income_includes` for completely custom definitions of income. enum: - all_earnings - none - regular_earnings - total_income income_includes: type: object description: >- An optional list of specific earnings, allowances, and other line item types to include in the income calculation in addition to those included via `income_basis`. nullable: true income_subtractions: type: object description: >- An optional list of deductions and benefits to subtract from the income before the deduction amount is calculated. nullable: true income_statutory_withholdings: type: string description: >- Whether to subtract statutory withholdings (CPP, EI, income tax) from the income before the deduction amount is calculated. enum: - all - none income_exemption_amount: type: number description: >- A fixed dollar amount to exempt from the income before calculating the deduction. nullable: true format: decimal income_exemption_percent: type: number description: >- A percentage of the income to exempt before calculating the deduction amount. nullable: true format: decimal effective_from: type: string description: The date from which this deduction is applied to Pay Stubs. format: date effective_to: type: string description: >- The date after which this deduction is no longer applied. `null` if the deduction applies indefinitely. nullable: true format: date title: type: string nullable: true maxLength: 255 title_translations: type: object description: Optional translations for the `title` property. allOf: - $ref: '#/components/schemas/Translations' nullable: true title_translated: type: string description: >- The translation of the `title` property for the request locale. Computed using the values in `title` and `title_translations` and the value of the request's `Accept-Language` header. readOnly: true remittance_account: {} business_preset: {} expense_accounting_code: {} liability_accounting_code: {} external_ref: type: string description: >- A reference to the object in an external system, e.g. the primary key of the object in your application's database. Nmbr doesn't use, validate, parse, or require this value to be unique - it simply stores it for your reference. nullable: true maxLength: 255 created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime Reimbursement: type: object title: Reimbursement properties: work_assignment: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"work_assignment"`). readOnly: true reimbursement_type: type: object description: >- The type of reimbursement, which determines how it is categorized and reported on Pay Stubs. 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' 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 frequency: type: string description: >- The frequency at which this reimbursement is applied to Pay Stubs. When `per_month`, the amount is distributed evenly across all Payrolls in the calendar month. enum: - once - per_month - per_payroll date_basis: type: string description: >- Which payroll date determines the calendar month for the allocation. Applies only to `per_month` recurrences. nullable: true enum: - by_pay_date - by_period_end_date - by_period_start_date pay_period_cadence: type: object description: >- Which pay periods within the month receive the allocation. An array of 1-based positions; `-1` is the final period. Applies only to `per_month` recurrences. nullable: true amount: type: number description: >- The monetary amount applied each time this reimbursement is included on a Pay Stub. format: decimal effective_from: type: string description: The date from which this reimbursement is applied to Pay Stubs. format: date effective_to: type: string description: >- The date after which this reimbursement is no longer applied. `null` if the reimbursement applies indefinitely. nullable: true format: date business_preset: {} expense_accounting_code: {} liability_accounting_code: {} external_ref: type: string description: >- A reference to the object in an external system, e.g. the primary key of the object in your application's database. Nmbr doesn't use, validate, parse, or require this value to be unique - it simply stores it for your reference. nullable: true maxLength: 255 created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime PayRate: type: object title: Pay Rate properties: work_assignment: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"work_assignment"`). readOnly: true 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 type: type: string description: >- Whether this is a `salary` or `hourly` pay rate. Determines how `rate` is interpreted. enum: - hourly - salary rate: type: number description: >- The annual salary when `type` is `salary`, or the hourly wage when `type` is `hourly`. format: decimal expected_hours_per_week: type: number description: >- The expected number of working hours per week. Must be greater than `0` for `salary` pay rates. Used to calculate the equivalent hourly rate from salaries for overtime. format: decimal is_editable: type: boolean description: >- Whether the pay rate's `type`, `rate`, and `effective_from` can be modified. Once the pay rate has been used on a non-draft Payroll, these fields are locked. is_deletable: type: boolean description: >- Whether the pay rate can be deleted. A pay rate may not be deleted once it has been used on a non-draft Payroll. effective_from: type: string description: The date from which this pay rate is applied to Pay Stubs. format: date earliest_valid_effective_to: type: string description: >- The earliest date that `effective_to` may be set to, based on the most recent non-draft Payroll period in which this pay rate was active. format: date effective_to: type: string description: >- The date after which this pay rate is no longer applied and can no longer be used to create Earning Line Items. `null` if the pay rate applies indefinitely. nullable: true format: date business_preset: {} expense_accounting_code: {} liability_accounting_code: {} external_ref: type: string description: >- A reference to the object in an external system, e.g. the primary key of the object in your application's database. Nmbr doesn't use, validate, parse, or require this value to be unique - it simply stores it for your reference. nullable: true maxLength: 255 created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime ExpenseAccountingCode: $ref: '#/components/schemas/AccountingCode' LiabilityAccountingCode: $ref: '#/components/schemas/AccountingCode' Translations: type: object nullable: true properties: en: type: string maxLength: 255 fr: type: string maxLength: 255 RemittanceAccountMetadata: type: object description: >- Additional data points for this account. The available fields depend on the account's `category`; `null` for categories that capture no metadata. anyOf: - type: object title: Workers’ compensation properties: last_payment_amount: type: string description: >- The last payment made to the board before Nmbr takes over remittance, in dollars (e.g. `"1250.00"`). nullable: true format: decimal - type: object description: >- Categories with no category-specific metadata. Omit the field or send `null`. title: Other categories nullable: true nullable: true 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' 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' 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' 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' 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 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 ````