Employment Hero

Employment Hero Pay Run API

Pay Run

GitHub OpenAPI

Operations 100

GET /api/v2/business/{businessId}/employee/{employeeId}/payruntotals List Pay Run Totals for Employee #
GET /api/v2/business/{businessId}/journal/{payRunId} Get Journal Details #
GET /api/v2/business/{businessId}/payrun List Pay Runs #
POST /api/v2/business/{businessId}/payrun Create Pay Run #
POST /api/v2/business/{businessId}/payrun/async Create Pay Run (Async) #
GET /api/v2/business/{businessId}/payrun/creationstatus/{jobId} Get Creation Status #
GET /api/v2/business/{businessId}/payrun/summary List Pay Runs Summaries #
GET /api/v2/business/{businessId}/payrun/{payRunId} Get Pay Run #
DELETE /api/v2/business/{businessId}/payrun/{payRunId} Delete Pay Run #
GET /api/v2/business/{businessId}/payrun/{payRunId}/EmployeeExpenses List Employee Expenses #
POST /api/v2/business/{businessId}/payrun/{payRunId}/EmployeeExpenses Create Employee Expenses #
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/EmployeeExpenses Delete Employee Expense #
GET /api/v2/business/{businessId}/payrun/{payRunId}/EmployeeExpenses/{employeeId} Get Employee Expenses by Employee ID #
POST /api/v2/business/{businessId}/payrun/{payRunId}/approval/start Start Approval Process #
POST /api/v2/business/{businessId}/payrun/{payRunId}/bulkapplyleaverequests Bulk Apply Leave Requests #
GET /api/v2/business/{businessId}/payrun/{payRunId}/deductions List Deductions #
POST /api/v2/business/{businessId}/payrun/{payRunId}/deductions Create Deductions #
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/deductions Delete Deduction #
GET /api/v2/business/{businessId}/payrun/{payRunId}/deductions/{employeeId} Get Deductions by Employee ID #
GET /api/v2/business/{businessId}/payrun/{payRunId}/details Get Pay Run Details #
GET /api/v2/business/{businessId}/payrun/{payRunId}/earningslines List Earnings Lines #
POST /api/v2/business/{businessId}/payrun/{payRunId}/earningslines Create Earnings Lines #
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/earningslines Delete Earnings Line #
GET /api/v2/business/{businessId}/payrun/{payRunId}/earningslines/{employeeId} Get Earnings Lines by Employee ID #
POST /api/v2/business/{businessId}/payrun/{payRunId}/employee/{employeeId} Include Employee #
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/employee/{employeeId} Remove Employee from Pay Run #
GET /api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities List Employer Liabilities #
POST /api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities Create Employer Liabilities #
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities Delete Employer Liability #
GET /api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities/{employeeId} Get Employer Liabilities by Employee ID #
POST /api/v2/business/{businessId}/payrun/{payRunId}/exportjournal Export journals for a pay run using the ExportPayRunJournalCommand #
GET /api/v2/business/{businessId}/payrun/{payRunId}/file/aba/{abaId} Get ABA File #
GET /api/v2/business/{businessId}/payrun/{payRunId}/file/payslip/{employeeId} Get Pay Slip File #
POST /api/v2/business/{businessId}/payrun/{payRunId}/finalise Finalise Pay Run #
GET /api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued Get Leave Accruals #
POST /api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued Save Leave Accruals #
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued Delete Leave Accrual #
GET /api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued/{employeeId} Get Leave Accruals for Employee #
POST /api/v2/business/{businessId}/payrun/{payRunId}/nettogross Net to Gross #
POST /api/v2/business/{businessId}/payrun/{payRunId}/notation Set Pay Run Notation #
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/notation Delete Pay Run Notation #
POST /api/v2/business/{businessId}/payrun/{payRunId}/notation/{employeeId} Create Note for Employee #
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/notation/{employeeId} Delete Note for Employee #
GET /api/v2/business/{businessId}/payrun/{payRunId}/paygadjustments List PAYG Adjustments #
POST /api/v2/business/{businessId}/payrun/{payRunId}/paygadjustments Create PAYG Adjustments #
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/paygadjustments Delete PAYG Adjustment #
GET /api/v2/business/{businessId}/payrun/{payRunId}/paygadjustments/{employeeId} Get PAYG Adjustments by Employee ID #
GET /api/v2/business/{businessId}/payrun/{payRunId}/paymentapproval/start Start Payment Approval Process #
GET /api/v2/business/{businessId}/payrun/{payRunId}/payments Get pay run payments #
GET /api/v2/business/{businessId}/payrun/{payRunId}/payslips List Pay Slip Data #
GET /api/v2/business/{businessId}/payrun/{payRunId}/payslips/{employeeId} Get Pay Slip Data by Employee ID #
POST /api/v2/business/{businessId}/payrun/{payRunId}/qualifyingearnings/{employeeId} Set Qualifying Earnings Override #
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/qualifyingearnings/{employeeId} Clear Qualifying Earnings Override #
POST /api/v2/business/{businessId}/payrun/{payRunId}/recalculate Recalculate #
POST /api/v2/business/{businessId}/payrun/{payRunId}/recalculate/async Recalculate background job #
POST /api/v2/business/{businessId}/payrun/{payRunId}/setuiunlockstate Set UI Unlock enabled #
GET /api/v2/business/{businessId}/payrun/{payRunId}/summary Get Pay Run Summary #
GET /api/v2/business/{businessId}/payrun/{payRunId}/superadjustments List Super Adjustments #
POST /api/v2/business/{businessId}/payrun/{payRunId}/superadjustments Create Super Adjustments #
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/superadjustments Delete Super Adjustment #
GET /api/v2/business/{businessId}/payrun/{payRunId}/superadjustments/{employeeId} Get Super Adjustments by Employee ID #
POST /api/v2/business/{businessId}/payrun/{payRunId}/terminate Terminate Employee in Pay Run #
GET /api/v2/business/{businessId}/payrun/{payRunId}/totals List Pay Run Totals #
GET /api/v2/business/{businessId}/payrun/{payRunId}/totals/{employeeId} Get Pay Run Totals by Employee ID #
POST /api/v2/business/{businessId}/payrun/{payRunId}/unlock Unlock Pay Run #
GET /api/v2/business/{businessId}/payrun/{payRunId}/warnings List Pay Run Warnings #
GET /api/v2/business/{businessId}/payrun/{payRunId}/file/bankpayment/{paymentFileId} Get Bank Payment File #
GET /api/v2/business/{businessId}/payrun/{payRunId}/kiwisaveradjustments List KiwiSaver Adjustments #
POST /api/v2/business/{businessId}/payrun/{payRunId}/kiwisaveradjustments Create KiwiSaver Adjustments #
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/kiwisaveradjustments Delete KiwiSaver Adjustment #
GET /api/v2/business/{businessId}/payrun/{payRunId}/kiwisaveradjustments/{employeeId} Get KiwiSaver Adjustments by Employee ID #
GET /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments List PAYE Adjustments #
POST /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments Create PAYE Adjustments #
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments Delete PAYE Adjustment #
GET /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments/{employeeId} Get PAYE Adjustments by Employee ID #
GET /api/v2/business/{businessId}/payrun/{payRunId}/sdladjustments List SDL adjustments #
POST /api/v2/business/{businessId}/payrun/{payRunId}/sdladjustments Create SDL adjustments #
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/sdladjustments Delete SDL adjustment #
GET /api/v2/business/{businessId}/payrun/{payRunId}/sdladjustments/{employeeId} Get voluntary SDL contributions by Employee ID #
GET /api/v2/business/{businessId}/payrun/{payRunId}/taxadjustments List withholding and clearance tax adjustments #
POST /api/v2/business/{businessId}/payrun/{payRunId}/taxadjustments Create a withholding or clearance tax adjustment #
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/taxadjustments Delete a withholding or clearance tax adjustment #
GET /api/v2/business/{businessId}/payrun/{payRunId}/taxadjustments/{employeeId} Get withholding and clearance tax adjustments by Employee ID #
GET /api/v2/business/{businessId}/payrun/{payRunId}/voluntarycpf List voluntary CPF contributions #
POST /api/v2/business/{businessId}/payrun/{payRunId}/voluntarycpf Create voluntary CPF contributions #
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/voluntarycpf Delete voluntary CPF contribution #
GET /api/v2/business/{businessId}/payrun/{payRunId}/voluntarycpf/{employeeId} Get voluntary CPF contributions by Employee ID #
GET /api/v2/business/{businessId}/payrun/{payRunId}/benefits List Benefits #
GET /api/v2/business/{businessId}/payrun/{payRunId}/benefits/{employeeId} Get Benefits #
POST /api/v2/business/{businessId}/payrun/{payRunId}/exclude/{employeeId} Exclude employee from pay run #
GET /api/v2/business/{businessId}/payrun/{payRunId}/file/bacs/{bacsDetailsId} Get BACS File #
GET /api/v2/business/{businessId}/payrun/{payRunId}/hmrcadjustments List HMRC Adjustments #
POST /api/v2/business/{businessId}/payrun/{payRunId}/hmrcadjustments Create HMRC Adjustments #
DELETE /api/v2/business/{businessId}/payrun/{payRunId}/hmrcadjustments Delete HMRC Adjustment #
GET /api/v2/business/{businessId}/payrun/{payRunId}/hmrcadjustments/{employeeId} Get HMRC Adjustments by Employee ID #
GET /api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/sap/employee/{employeeId} Get statutory adoption pay calculation for pay run #
POST /api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/sap/employee/{employeeId} Apply statutory adoption payments to pay run #
GET /api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/ssp/employee/{employeeId} Get Statutory Sick Pay By Employee Id #
POST /api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/ssp/employee/{employeeId} Add Statutory Sick Pay #
GET /api/v2/business/{businessId}/payrun/{payRunId}/statutorypay/ssp/{sspId} Get Statutory Sick Pay By Id #

Documentation

📖
Documentation
https://api.keypay.com.au/guides/Home.html
📖
APIReference
https://api.keypay.com.au/
📖
APIReference
https://api.keypay.com.au/new-zealand/reference.html
📖
APIReference
https://api.keypay.com.au/united-kingdom/reference.html
📖
APIReference
https://api.keypay.com.au/singapore/reference.html
📖
APIReference
https://api.keypay.com.au/malaysia/reference.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/employment-hero/refs/heads/main/openapi/employment-hero-payrun-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/employment-hero:employment-hero-payrun-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

employment-hero-payrun-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Employment Hero Pay Run API
  version: '1.0'
  description: 'Operations tagged PayRun across 5 of this provider''s published API definitions: employment-hero-payroll-au-swagger.json, employment-hero-payroll-my-swagger.json, employment-hero-payroll-nz-swagger.json, employment-hero-payroll-sg-swagger.json, employment-hero-payroll-uk-swagger.json. Each path carries the servers of the definition it was published in.'
security:
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
tags:


# --- truncated at 32 KB (401 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/employment-hero/refs/heads/main/openapi/employment-hero-payrun-api-openapi.yml