Show more

Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.

API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Penfold Payroll API v4
main
  • main default
  • dev

Topics

  • Introduction
  • Authentication

Endpoints

  • Health
    • Health check GET
  • Employers
    • Retrieve an employer GET
    • Update an employer PATCH
    • Retrieve a list of employers GET
    • Create employer POST
  • Employees
    • Retrieve a paginated list of employees for a specified employer GET
    • Create new employees for a specified employer POST
    • Retrieve a single employee GET
    • Update an employee's information PATCH
    • Retrieve the contributions for a specified employee GET
    • Submit a pending employee contribution change request for contribution percentage changes and salary sacrifice preference POST
    • **Partner organisations only GET
    • **Partner organisations only GET
    • **Partner organisations only GET
    • **Partner organisations only GET
    • **Partner organisations only PUT
    • **Partner organisations only GET
    • **Partner organisations only PUT
  • Leavers
    • Mark multiple employees as leavers in a single request POST
  • Contributions
    • Retrieve a list of contributions for a specified employer GET
    • Create multiple contributions for a specified employer in a single request POST
  • Pay Periods
    • List pay periods for an employer GET
    • Get a pay period for an employer GET
  • Agreement Signing
    • Create an agreement signing session POST
    • Retrieve an agreement signing session GET
  • Direct Debit
    • Create a Direct Debit session POST
  • File Upload
    • Retrieve all uploads GET
    • Initiate an upload POST
    • Retrieve an upload GET
    • Retrieve errors for an upload GET
    • Retrieve contributions for an upload GET
    • Retrieve enrolments for an upload GET
  • Fund Allocations
    • **Partner organisations only GET
    • **Partner organisations only GET
Powered by Bump.sh
API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Penfold Payroll API v4