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
  • Mapping Hourly Rates
  • Mapping Employees
  1. Integrating Timesheet Applications

Mapping Hourly Rates and Employees

PreviousSelect an EmployerNextStoring the mapping for future use

Last updated 7 months ago

Once the Organisation/Employer has been selected the Employer's Hourly Rates and Employees can be retrieved from the Payroll API. Then the user can map Hourly Rates and Employees between the Timesheet application and BrightPay in preparation for the upload of the TimeSheet data. Also, any previously stored Hourly Rates and Employee mappings can be loaded to reduce the user effort.

Mapping Hourly Rates

In order to map Hourly Rates between the Timesheet application and BrightPay, please retrieve from Payroll API the Hourly Rates using . For any listbox presented for selection use the field rateNameWithHint as the display value and the field rateName as the identifier.

It is important to use rateNameWithHint for the display value as around the turn of the financial year the Payroll API may be working across two financial years. During this time the Hourly Rates may be returned with a hint indicating which year the rate is set up for. However, the rateName field should be passed in the request to create hourly payments and should be saved when storing the mapping for future use.

Mapping Employees

It is important to use fullNameWithHint for the display value as around the turn of the financial year the Payroll API may be working across two financial years. During this time the Employees may be returned with a hint indicating which year the rate is set up for. However, the employeeId field should be passed in the request to create hourly payments and should be saved when storing the mapping for future use.

In order to map Employees between the Timesheet application and BrightPay, please retrieve from Payroll API the Employees using . Then for any list presented for selection use the field fullNameWithHint as the display value and the field employeeId as the identifier.

GetEmployees
GetEmployerHourlyRates
Mapping Hourly Rates
Mapping Employees