Skip to main content
When creating a new Business Entity in Nmbr, employers can set up the entity in Preview mode. This allows for the safe simulation of payroll operations without triggering any actual financial transactions.

​
Key Features of Preview Mode

  • No Financial Operations: While in Preview mode, no bank transactions are created and no money is remitted.
  • Full Functionality: Employers can set up Work Assignments, Pay Schedules, Benefits, Deductions, Allowances, and Reimbursements normally.
  • Payroll Processing: Regular payrolls can be approved, while Once-off and Historical payrolls can be created and processed. Approved payrolls are automatically marked as paid to facilitate the calculation of statutory withholdings on future payrolls, despite no actual payment transactions.
  • Employee Data Import: Employers can import employee year-to-date information during the setup of historical payrolls.

​
Transitioning Out of Preview Mode

When transitioning out of Preview mode:
  • Data Preservation: All Pay Schedules, Work Assignments, Deductions, and Allowances are retained.
  • Payroll Adjustment: You will have the option to convert paid payrolls to historic payrolls, preserve draft line items, and preserve draft off-cycles.
  • Historical Data: Historical payrolls and pay stubs are preserved with the existing imported year-to-date data intact.
This setup allows for comprehensive testing and verification of payroll setup before committing to live financial transactions, ensuring accuracy and confidence in payroll management.

​
Creating a Preview mode Business Entity example

To create a Business Entity in preview mode, set the attribute in_preview to true. 
curl --location --request POST 'http://localhost/services/payroll/business_entities' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <access_token>' \
--data-raw '{
    "in_preview": true,
    "business_number": "098873674RP0001",
    "name": "Business Inc",
    "legal_name": "Business Inc",
    "address_line_1": "2020 Yates St",
    "city": "Victoria",
    "province_code": "BC",
    "country_code": "CA",
    "postal_code": "V8S 1Z8",
    "contact_name": "Mary Jayne",
    "contact_area_code": "250",
    "contact_phone_number": "8097625"
}'