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

Introduction

NextAuthentication

Last updated 7 months ago

The BrightPay API is in development and will be released soon for general use. This documentation outlines the proposed functionality.

BrightPay API (v1.0) provides functionality to allow third party applications to integrate with BrightPay Cloud. Currently BrightPay API provides end points to allow integration between Timesheet systems and BrightPay Cloud. The functionality available through the API will be expanded over time. Authentication is via an OAuth 2.0 flow using a Client ID and Secret to retrieve a Refresh and Access Token.

This site contains various sections to assist with integration such as:

Authentication
Available APIs
Integrating Timesheet Applications
Payroll Scenario Simulation
Configuring BrightPay for Testing
Managing Errors