> ## 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.

# Customization

> Hide or disable parts of the Nmbr Component UI by passing settings during initialization.

## 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:

```html payroll.html theme={null}
<!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.

<Note>
  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.
</Note>

The full settings payload is shown below:

```json theme={null}
{
  "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,
    "showTaxOverrides": false,
    "showProfile": false,
    "profile": {
      "hidePayRates": false
    }
  },
  "contractorTabs": {
    "hideDetails": false,
    "hideBankAccount": false,
    "hidePaymentFrequency": false,
    "hideReceipts": false,
    "showEarnings": 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
  }
}
```

#### General

<ParamField body="padEnabled" type="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.
</ParamField>

<ParamField body="disablePayrollApproveButton" type="boolean" default="false">
  Disables the "Approve" button on the Payroll Approve step.
</ParamField>

<ParamField body="outerPaddingFactor" type="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.
</ParamField>

<ParamField body="language" type="string" default="en-CA">
  The language to use in the component. Accepts `en-CA` or `fr-CA`.
</ParamField>

<ParamField body="hideNavigationMenu" type="boolean" default="false">
  Hides the built-in navigation menu. Useful when combined with [deep
  linking](/components/deep-linking) to build your own navigation experience —
  you can use `goto()` to control which page the component displays while hiding
  the default navigation entirely.
</ParamField>

<ParamField body="showROEs" type="boolean" default="false">
  Shows the "ROEs" tab for both the Employee Section and the Business Settings.
</ParamField>

<ParamField body="showTags" type="boolean" default="false">
  Surfaces tag configuration at the business level, tag assignment at the
  employee level, and tag allocations across payroll line items. See [Tagging &
  Journal Entry Tracking](/guides/advanced/tagging).
</ParamField>

<ParamField body="hidePayrollPayRates" type="boolean" default="false">
  Hide the "Pay Rates" column on the Run Payroll screens.
</ParamField>

<ParamField body="createFromPresetsOnly" type="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.
</ParamField>

<ParamField body="showHistoricalPayroll" type="boolean" default="false">
  Shows the "Historical" tab in the payroll dashboard.
</ParamField>

<ParamField body="showCorrectionPayroll" type="boolean" default="false">
  Shows the "Correction" tab in the payroll dashboard.
</ParamField>

<ParamField body="showPayrollAdjustments" type="boolean" default="false">
  Show "Adjustments" for Statutory Withholdings.
</ParamField>

<ParamField body="hidePayroll" type="boolean" default="false">
  Hide the "Payroll" section, including the Run Payroll screens and the payroll
  dashboard.
</ParamField>

<ParamField body="hideBusinessSelector" type="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.
</ParamField>

<ParamField body="hideCompanyHeader" type="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.
</ParamField>

<ParamField body="hideReports" type="boolean" default="false">
  Hide the "Reports" section.
</ParamField>

<ParamField body="hideYearEndTaxPackages" type="boolean" default="false">
  Hide the "Year-End Tax Packages" section.
</ParamField>

#### 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.

<ParamField body="employeeTabs.hideDetails" type="boolean" default="false">
  Hide the "Details" tab in the Employee Section. When hidden, the "Create
  Employee" button is also hidden.
</ParamField>

<ParamField body="employeeTabs.hideEmployeePersonalDetailsSection" type="boolean" default="false">
  Hide the "Personal Details" section in the "Details" tab in the Employee
  Section.
</ParamField>

<ParamField body="employeeTabs.hideEmployeeIdentificationDetailsSection" type="boolean" default="false">
  Hide the "Identification Details" section in the "Details" tab in the Employee
  Section.
</ParamField>

<ParamField body="employeeTabs.hideBankAccount" type="boolean" default="false">
  Hide the "Bank Account" tab in the Employee Section.
</ParamField>

<ParamField body="employeeTabs.hideBenefits" type="boolean" default="false">
  Hide the "Benefits" tab in the Employee Section.
</ParamField>

<ParamField body="employeeTabs.hideAllowances" type="boolean" default="false">
  Hide the "Allowances" tab in the Employee Section.
</ParamField>

<ParamField body="employeeTabs.hideDeductions" type="boolean" default="false">
  Hide the "Deductions" tab in the Employee Section.
</ParamField>

<ParamField body="employeeTabs.hideReimbursements" type="boolean" default="false">
  Hide the "Reimbursements" tab in the Employee Section.
</ParamField>

<ParamField body="employeeTabs.hidePayRates" type="boolean" default="false">
  Hide the "Pay Rates" tab in the Employee Section.
</ParamField>

<ParamField body="employeeTabs.showOtherEarnings" type="boolean" default="false">
  Show the "Other Earnings" tab in the Employee Section.
</ParamField>

<ParamField body="employeeTabs.hideVacationPay" type="boolean" default="false">
  Hide the "Vacation Pay" tab in the Employee Section.
</ParamField>

<ParamField body="employeeTabs.hidePayStubs" type="boolean" default="false">
  Hide the "Pay Stubs" tab in the Employee Section.
</ParamField>

<ParamField body="employeeTabs.hideTaxForms" type="boolean" default="false">
  Hide the "Tax Forms" tab in the Employee Section.
</ParamField>

<ParamField body="employeeTabs.hideTaxImplications" type="boolean" default="false">
  Hide the "Tax Implications" tab in the Employee Section.
</ParamField>

<ParamField body="employeeTabs.hideTaxDetails" type="boolean" default="false">
  Hide the "Tax Details" tab in the Employee Section. When hidden, the
  "Overrides" table controlled by `showTaxOverrides` is also hidden.
</ParamField>

<ParamField body="employeeTabs.hideWorkersCompensation" type="boolean" default="false">
  Hide the "Workers' Comp" tab in the Employee Section.
</ParamField>

<ParamField body="employeeTabs.hideCreateEmployeeButton" type="boolean" default="false">
  Hide the "Create Employee" button in the Employee Section.
</ParamField>

<ParamField body="employeeTabs.showStatHolidayPay" type="boolean" default="false">
  Shows the "Stat Holiday Pay" tab in the Employee Section.
</ParamField>

<ParamField body="employeeTabs.showPayScheduleAddRemove" type="boolean" default="false">
  Shows the `...` menu in the "Employee" header where the employee can be added
  to/removed from a "Pay Schedule".
</ParamField>

<ParamField body="employeeTabs.showTaxOverrides" type="boolean" default="false">
  Shows the "Overrides" table in the "Tax Details" tab in the Employee Section.
</ParamField>

<ParamField body="employeeTabs.showProfile" type="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.
</ParamField>

<ParamField body="employeeTabs.profile.hidePayRates" type="boolean" default="false">
  Hide the "Pay Rates" section in the "Profile" tab. Only applies when
  `showProfile` is `true`.
</ParamField>

#### 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.

<ParamField body="contractorTabs.hideDetails" type="boolean" default="false">
  Hide the "Details" tab in the Contractor Section. When hidden, the "Create
  Contractor" button is also hidden.
</ParamField>

<ParamField body="contractorTabs.hideBankAccount" type="boolean" default="false">
  Hide the "Bank Account" tab in the Contractor Section.
</ParamField>

<ParamField body="contractorTabs.hidePaymentFrequency" type="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.
</ParamField>

<ParamField body="contractorTabs.hideReceipts" type="boolean" default="false">
  Hide the "Receipts" tab in the Contractor Section.
</ParamField>

<ParamField body="contractorTabs.showEarnings" type="boolean" default="false">
  Show the "Earnings" tab in the Contractor Section.
</ParamField>

#### Business Settings

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

<ParamField body="businessSettings.hideDetails" type="boolean" default="false">
  Hide the "Details" tab in the Business Settings.
</ParamField>

<ParamField body="businessSettings.hideBankAccounts" type="boolean" default="false">
  Hide the "Bank Accounts" tab in the Business Settings.
</ParamField>

<ParamField body="businessSettings.hideTaxAccounts" type="boolean" default="false">
  Hide the "Tax Accounts" tab in the Business Settings.
</ParamField>

<ParamField body="businessSettings.showRemittanceAccounts" type="boolean" default="false">
  Show the "Remittance Accounts" tab in the Business Settings.
</ParamField>

<ParamField body="businessSettings.allowAdditionalTaxAccounts" type="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](/guides/payroll-fundamentals/tax-agency-configuration) for
  details on how multi-account enrollments work.
</ParamField>

<ParamField body="businessSettings.hidePaySchedules" type="boolean" default="false">
  Hide the "Pay Schedules" tab in the Business Settings.
</ParamField>

<ParamField body="businessSettings.hidePayRunConfig" type="boolean" default="false">
  Hide the "Pay Run Configuration" settings in the Business Settings.
</ParamField>

<ParamField body="businessSettings.hideEmployees" type="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.
</ParamField>

<ParamField body="businessSettings.hideContractors" type="boolean" default="false">
  Hide the "Contractors" tab in the Business Settings.
</ParamField>

<ParamField body="businessSettings.hideCreateAnotherBusinessButton" type="boolean" default="false">
  Hide the "Create Another" button in the "Details" tab in the Business
  Settings.
</ParamField>

<ParamField body="businessSettings.hideVacationPay" type="boolean" default="false">
  Hide the "Vacation Pay" tab in the Business Settings.
</ParamField>

<ParamField body="businessSettings.hideWorkersCompensation" type="boolean" default="false">
  Hide the "Workers' Comp" tab in the Business Settings.
</ParamField>

<ParamField body="businessSettings.hidePayrollItems" type="boolean" default="false">
  Hide the "Payroll Items" tab in the Business Settings.
</ParamField>

<ParamField body="businessSettings.hidePresets" type="boolean" default="false" deprecated>
  **Deprecated.** Use `businessSettings.hidePayrollItems` instead.
</ParamField>

<ParamField body="businessSettings.showGlCodes" type="boolean" default="false">
  Show the "GL Codes" tab in the Business Settings.
</ParamField>

<ParamField body="businessSettings.hideEmploymentInsurance" type="boolean" default="false">
  Hide the "EI Rates" tab in the Business Settings.
</ParamField>

<ParamField body="businessSettings.hideReports" type="boolean" default="false" deprecated>
  **Deprecated.** The "Reports" tab is no longer in the Business Settings. Use
  the top-level `hideReports` setting instead.
</ParamField>

<ParamField body="businessSettings.hideCreateAnotherPayScheduleButton" type="boolean" default="false">
  Hide the "Create Another" button on the "Pay Schedules" tab in the Business
  Settings.
</ParamField>

<ParamField body="businessSettings.hideEpt" type="boolean" default="false">
  Hide the "EPT" tab in the Business Settings. Formerly
  `businessSettings.hideEht`.
</ParamField>

<ParamField body="businessSettings.showIntegrations" type="boolean" default="false">
  Show the "Integrations" tab in the Business Settings.
</ParamField>

<ParamField body="businessSettings.showPreviewModeBanner" type="boolean" default="false">
  Show the "Preview Mode" banner when a business is in preview mode.
</ParamField>

<ParamField body="businessSettings.allowOutsideCanadaBEs" type="boolean" default="false">
  When `true`, allow creating business entities located outside Canada.
</ParamField>
