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

Integrating Timesheet Applications

PreviousPostman ImportNextLogin Management

Last updated 9 months ago

This section contains information to help integrate Timesheet applications with BrightPay and provide a good user experience. The flow takes into account how customers set up their BrightPay applications from year to year and tries to minimise the effort for users and give a consistent user experience.

Areas covered include:

Please be aware that around the change of the financial year the Payroll API may respond in a different manner than expected. This is because each financial year BrightPay publishes a new application and so the Payroll API may need to query across multiple BrightPay applications. This is covered in detail in the section on

Login Management
Select an Employer
Mapping Hourly Rates and Employees
Storing the mapping for future use
Creating Hourly Payments in BrightPay
End of Financial Year Behaviour
End of Financial Year Behaviour.