Customization

Settings

When initializing the Nmbr Component, you can pass additional configurations through via the settings property, allowing you to hide and disable parts of the UI:

payroll.html

<!DOCTYPE html>
<html>
  <head>
    <!-- ... -->
    <script type="module">
      // ....
      window.components = nmbr.initialize({
        companyId,
        partnerId,
        signingUrl: '/sign_nmbr_request',
        settings: {
          padEnabled: true,
          showROEs: false,
          employeeTabs: {
            hideBenefits: true,
            hideAllowances: true,
            hideTaxForms: true,
          },
          contractorTabs: {
            hideDetails: true,
            hideReceipts: true,
          },
          businessSettings: {
            hideVacationPay: true,
            allowAdditionalTaxAccounts: true,
          },
        },
      });
      // ...
    </script>
  </head>

  <body>
    <!-- ... -->
  </body>
</html>

Available Settings

All properties are optional.

These settings are meant to change the UX of the component, and do not prevent the user from, at the API level, creating, reading, updating or deleting the related resource(s). For example, if the Employee “Bank Accounts” section is hidden, the user will not be able to view the Bank Accounts tab or access any of its functionality through the Nmbr Component. However, if your signing server does not disallow it, the user could still create, read, update, or delete a bank account by accessing the API directly.

The full settings payload is shown below:

{
  "padEnabled": true,
  "disablePayrollApproveButton": false,
  "hideNavigationMenu": false,
  "hideBusinessSelector": false,
  "hideCompanyHeader": false,
  "outerPaddingFactor": 4,
  "language": "en-CA",
  "showROEs": false,
  "showTags": false,
  "hidePayroll": false,
  "hidePayrollPayRates": false,
  "createFromPresetsOnly": false,
  "showHistoricalPayroll": false,
  "showCorrectionPayroll": false,
  "showPayrollAdjustments": false,
  "hideReports": false,
  "hideYearEndTaxPackages": false,
  "employeeTabs": {
    "hideDetails": false,
    "hideEmployeePersonalDetailsSection": false,
    "hideEmployeeIdentificationDetailsSection": false,
    "hideBankAccount": false,
    "hideBenefits": false,
    "hideAllowances": false,
    "hideDeductions": false,
    "hideReimbursements": false,
    "hidePayRates": false,
    "showOtherEarnings": false,
    "hideVacationPay": false,
    "hidePayStubs": false,
    "hideTaxForms": false,
    "hideTaxImplications": false,
    "hideTaxDetails": false,
    "hideWorkersCompensation": false,
    "hideCreateEmployeeButton": false,
    "showStatHolidayPay": false,
    "showPayScheduleAddRemove": false,
    "showSetPrimaryPaySchedule": false,
    "showTaxOverrides": false,
    "showProfile": false,
    "profile": {
      "hidePayRates": false
    },
    "hideTags": false
  },
  "contractorTabs": {
    "hideDetails": false,
    "hideBankAccount": false,
    "hidePaymentFrequency": false,
    "hideReceipts": false,
    "showEarnings": false,
    "hideTags": false
  },
  "businessSettings": {
    "hideDetails": false,
    "hideBankAccounts": false,
    "hideTaxAccounts": false,
    "showRemittanceAccounts": false,
    "allowAdditionalTaxAccounts": false,
    "hidePaySchedules": false,
    "hidePayRunConfig": false,
    "hideEmployees": false,
    "hideContractors": false,
    "hideCreateAnotherBusinessButton": false,
    "hideVacationPay": false,
    "hideWorkersCompensation": false,
    "hidePayrollItems": false,
    "showGlCodes": false,
    "hideEmploymentInsurance": false,
    "hideCreateAnotherPayScheduleButton": false,
    "hideEpt": false,
    "showIntegrations": false,
    "showPreviewModeBanner": false,
    "allowOutsideCanadaBEs": false,
    "showTags": false,
    "hideTagGroupCreation": false,
    "hidePrimaryTagSelection": false,
    "hideJournalEntryDimensionSelection": false
  }
}

General

boolean

default:"true"

When true, the PAD agreement will be shown in the “Bank Account” tab of the Business Settings, both when viewing and creating a bank account. When creating a bank account, the user will need to review and agree to the PAD agreement.

boolean

default:"false"

Disables the “Approve” button on the Payroll Approve step.

integer

default:"4"

A number greater than or equal to 0. Applied as the multiplier of the scaling factor (8px) to determine the outer padding around the component. For example, a value of 2 results in 16px of outer padding.

string

default:"en-CA"

The language to use in the component. Accepts en-CA or fr-CA.

Hides the built-in navigation menu. Useful when combined with deep linking to build your own navigation experience. Use goto() to control which page the component displays while hiding the default navigation entirely.

boolean

default:"false"

Shows the “ROEs” tab for both the Employee Section and the Business Settings.

boolean

default:"false"

Enables tagging in the Component. Controls tag assignment on employees and contractors, and tag allocations across payroll line items. The “Tags” tab in the Business Settings also needs businessSettings.showTags. See Tagging & Journal Entry Tracking.

boolean

default:"false"

Hide the “Pay Rates” column on the Run Payroll screens.

boolean

default:"false"

When true, line items and recurring employee benefits, allowances, and reimbursements can only be created from pre-existing presets and cannot be created from scratch.

boolean

default:"false"

Shows the “Historical” tab in the payroll dashboard.

boolean

default:"false"

Shows the “Correction” tab in the payroll dashboard.

boolean

default:"false"

Show “Adjustments” for Statutory Withholdings.

boolean

default:"false"

Hide the “Payroll” section, including the Run Payroll screens and the payroll dashboard.

boolean

default:"false"

Hide the business selector. Use this when the Component is scoped to a single business and switching businesses should not be available.

boolean

default:"false"

Hide the company name header shown above the navigation on the account-wide views (Employees, Contractors, and ROEs). The navigation and breadcrumbs remain.

boolean

default:"false"

Hide the “Reports” section.

boolean

default:"false"

Hide the “Year-End Tax Packages” section.

Employee Tabs

If all of the tabs in employeeTabs are hidden, the employee table will still show all employees, but you won’t be able to see their details.

boolean

default:"false"

Hide the “Details” tab in the Employee Section. When hidden, the “Create Employee” button is also hidden.

boolean

default:"false"

Hide the “Personal Details” section in the “Details” tab in the Employee Section.

boolean

default:"false"

Hide the “Identification Details” section in the “Details” tab in the Employee Section.

boolean

default:"false"

Hide the “Bank Account” tab in the Employee Section.

boolean

default:"false"

Hide the “Benefits” tab in the Employee Section.

boolean

default:"false"

Hide the “Allowances” tab in the Employee Section.

boolean

default:"false"

Hide the “Deductions” tab in the Employee Section.

boolean

default:"false"

Hide the “Reimbursements” tab in the Employee Section.

boolean

default:"false"

Hide the “Pay Rates” tab in the Employee Section.

boolean

default:"false"

Show the “Other Earnings” tab in the Employee Section.

boolean

default:"false"

Hide the “Vacation Pay” tab in the Employee Section.

boolean

default:"false"

Hide the “Pay Stubs” tab in the Employee Section.

boolean

default:"false"

Hide the “Tax Forms” tab in the Employee Section.

boolean

default:"false"

Hide the “Tax Implications” tab in the Employee Section.

boolean

default:"false"

Hide the “Tax Details” tab in the Employee Section. When hidden, the “Overrides” table controlled by showTaxOverrides is also hidden.

boolean

default:"false"

Hide the “Workers’ Comp” tab in the Employee Section.

boolean

default:"false"

Hide the “Create Employee” button in the Employee Section.

boolean

default:"false"

Shows the “Stat Holiday Pay” tab in the Employee Section.

boolean

default:"false"

Shows the ... menu in the “Employee” header where the employee can be added to/removed from a “Pay Schedule”.

boolean

default:"false"

Shows the “Set Primary Pay Schedule” option in the ... menu in the “Employee” header, where the employee’s primary “Pay Schedule” can be chosen for each business. The option only appears when the employee has more than one “Pay Schedule” in the same business. The primary “Pay Schedule” is used for tax forms, ROEs, and year-end reporting, and is marked “Primary” wherever the employee’s pay schedules are listed.

boolean

default:"false"

Shows the “Overrides” table in the “Tax Details” tab in the Employee Section.

boolean

default:"false"

Shows the read-only “Profile” tab in the Employee Section. The “Profile” tab consolidates the employee’s details, bank account, and pay rates into a single display-only view.

boolean

default:"false"

Hide the “Pay Rates” section in the “Profile” tab. Only applies when showProfile is true.

boolean

default:"false"

Hide the “Tags” tab in the Employee Section. Tags stay visible everywhere else showTags governs, including the “Tags” column on the employee list and the tag pickers on payroll line items.

Contractor Tabs

If all of the tabs in contractorTabs are hidden, the table will still show all contractors, but you won’t be able to see their details.

boolean

default:"false"

Hide the “Details” tab in the Contractor Section. When hidden, the “Create Contractor” button is also hidden.

boolean

default:"false"

Hide the “Bank Account” tab in the Contractor Section.

boolean

default:"false"

Hide the “Payment Frequency” tab in the Contractor Section. When hidden, the ... menu for removing the contractor from a “Payment Frequency” is also hidden.

boolean

default:"false"

Hide the “Receipts” tab in the Contractor Section.

boolean

default:"false"

Show the “Earnings” tab in the Contractor Section.

boolean

default:"false"

Hide the “Tags” tab in the Contractor Section. Tags stay visible everywhere else showTags governs.

Business Settings

If all of the tabs in businessSettings are hidden, the “Business Settings” option will not appear in the main navigation menu.

boolean

default:"false"

Hide the “Details” tab in the Business Settings.

boolean

default:"false"

Hide the “Bank Accounts” tab in the Business Settings.

boolean

default:"false"

Hide the “Tax Accounts” tab in the Business Settings.

boolean

default:"false"

Show the “Remittance Accounts” tab in the Business Settings.

boolean

default:"false"

When true, the user can create more than one Remittance Account of the same provider type (e.g. multiple CRA RP accounts, multiple RQ RS accounts) for a Business Entity. Useful for businesses that operate multiple program accounts with the CRA (for example, separate divisions that each remit under their own RP number). See Tax Agency Configuration for details on how multi-account enrollments work.

boolean

default:"false"

Hide the “Pay Schedules” tab in the Business Settings.

boolean

default:"false"

Hide the “Pay Run Configuration” settings in the Business Settings.

boolean

default:"false"

Hide the “Employees” tab in the Business Settings. When hidden, the “Edit Employee Details” option is also hidden from the ... menu on the Payroll Earnings and Review screens.

boolean

default:"false"

Hide the “Contractors” tab in the Business Settings.

boolean

default:"false"

Hide the “Create Another” button in the “Details” tab in the Business Settings.

boolean

default:"false"

Hide the “Vacation Pay” tab in the Business Settings.

boolean

default:"false"

Hide the “Workers’ Comp” tab in the Business Settings.

boolean

default:"false"

Hide the “Payroll Items” tab in the Business Settings.

boolean

default:"false"

deprecated

Deprecated. Use businessSettings.hidePayrollItems instead.

boolean

default:"false"

Show the “GL Codes” tab in the Business Settings.

boolean

default:"false"

Hide the “EI Rates” tab in the Business Settings.

boolean

default:"false"

deprecated

Deprecated. The “Reports” tab is no longer in the Business Settings. Use the top-level hideReports setting instead.

boolean

default:"false"

Hide the “Create Another” button on the “Pay Schedules” tab in the Business Settings.

boolean

default:"false"

Hide the “EPT” tab in the Business Settings. Formerly businessSettings.hideEht.

boolean

default:"false"

Show the “Integrations” tab in the Business Settings.

boolean

default:"false"

Show the “Preview Mode” banner when a business is in preview mode.

boolean

default:"false"

When true, allow creating business entities located outside Canada.

boolean

default:"false"

Show the “Tags” tab in the Business Settings. Also needs the account-wide showTags set to true.

Hide the “Add Tag Group” button on the “Tags” tab in the Business Settings. When importing tracking dimensions from a connected accounting system (ex: Xero or Quickbooks), the step that asks whether to create a new group or link existing tags is skipped, and the import goes straight to linking. See Importing tracking dimensions.

boolean

default:"false"

Hide the “Primary tag group” section in “Manage Accounting Settings”. The primary tag group stays identifiable from the “Tags” table. The banner explaining why accounting code rules are inactive stays, without its “Set Primary Tag Group” action. See Primary tag group.

boolean

default:"false"

Hide the “Journal entry dimensions” section in “Manage Accounting Settings”. Choosing a new primary tag group still adds it as a journal entry dimension, and a business entity can hold at most three. If the new primary would push past three, the “Primary tag group” section asks for a tag group that already holds a dimension, and save is blocked until one is chosen. See Journal entry tracking dimensions.

​Settings

​Available Settings

​General

​Employee Tabs

​Contractor Tabs

​Business Settings

Settings

Available Settings

General

Employee Tabs

Contractor Tabs

Business Settings