Payroll Integration
  • Introduction
  • Authentication
    • Testing the Client Id & Secret
    • Retrieving a Refresh and Access Token
    • Switching Users
  • Available APIs
    • Payroll API V1.0 Methods
    • Postman Import
  • Integrating Timesheet Applications
    • Login Management
    • Select an Employer
    • Mapping Hourly Rates and Employees
    • Storing the mapping for future use
    • Creating Hourly Payments in BrightPay
    • End 0f Financial Year Behaviour
  • Payroll Scenario Simulation
    • Payroll Simulation Request Headers
    • Payroll Simulation Scenarios
  • Configuring BrightPay for Testing
    • Setting up an Organisation and Employer
    • Setting up Employees
    • Setting up a Payment Schedule
    • Configuration Summary
  • Managing Errors
    • Error Responses
    • Error Code Definitions
  • Secure Design Requirements
Powered by GitBook
On this page
  • Scenario 1: BrightPay has been cloned (single minor change made)
  • Scenario 2: BrightPay has been cloned (although changes made)
  • Scenario 3: BrightPay has been set up manually for both years
  • Scenario 4: Multiple employers cloned
  1. Payroll Scenario Simulation

Payroll Simulation Scenarios

PreviousPayroll Simulation Request HeadersNextConfiguring BrightPay for Testing

Last updated 9 months ago

To assist with testing it is possible to simulate various scenarios. Please see the Payroll Simulation Request Headers section for the headers required to move the Payroll API into simulation mode.

Scenario 1: BrightPay has been cloned (single minor change made)

In this scenario the customer has cloned a BrightPay employer from one financial year to the next. The only change is that Dhivyaa's name has changed from "Dhivyaa Brown" (24/25) to "Dhivyaa Jones" (25/26).

Scenario 2: BrightPay has been cloned (although changes made)

In this scenario the customer has cloned a BrightPay employer from one financial year to the next and then made some changes.

The changes are:

  • Dhivyaa's name has changed from "Dhivyaa Brown" (24/25) to "Dhivyaa Jones" (25/26).

  • Bobby Dawson has been added manually to both BrightPay 24/25 and 25/26 meaning Bobby will have different employeeIds in each financial year

  • Joe Berks has been added to just BrightPay 25/26

Scenario 3: BrightPay has been set up manually for both years

In this scenario the BrightPay user has decided to manually set up BrightPay 25/26 and has reentered all the Employees (rather than cloning the set up in BrightPay 24/25). All Employees from year to year will have different employeeIds.

Scenario 4: Multiple employers cloned

In this scenario the organisation has two Employers. The two Employers have been cloned from BrightPay 24/25 into BrightPay 25/26. Note Ashkor Raj has two employments (one for the "Rabbit and Duck" and one for "Birkendale Arms Hotel”). Ashkor will have separate employeeIds for each employment.

Scenario 1
Scenario 2
Scenario 3
Scenario 4