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
  1. Configuring BrightPay for Testing

Configuration Summary

PreviousSetting up a Payment ScheduleNextManaging Errors

Last updated 7 months ago

At this stage you should have

  • An Employer set up

  • At least one Employee set up

  • A Payment Schedule and at least one Employee assigned to it

Your application should be able to retrieve via the Payroll API an Employer, Employees, Pay Rates and upload Hourly Payments (into an Employee's current open payslip). Also you can test retrieving data via the swagger interface ().

Payroll API Swagger