Employment Hero

Employment Hero Business API

Business

GitHub OpenAPI

Operations 74

GET /api/v2/business List Businesses #
POST /api/v2/business Create New Business #
PUT /api/v2/business Update Business Details #
GET /api/v2/business/externalid Get Business Details by External ID #
GET /api/v2/business/{businessId} Get Business Details #
PUT /api/v2/business/{businessId} Update Business Details #
GET /api/v2/business/{businessId}/access List All Business Access Users #
POST /api/v2/business/{businessId}/access Assign Business Access #
PUT /api/v2/business/{businessId}/access Update details of an associated user #
DELETE /api/v2/business/{businessId}/access Revoke Business Access #
GET /api/v2/business/{businessId}/access/user Get User Business Access #
GET /api/v2/business/{businessId}/actionitems/businessnotifications List Business Notifications #
DELETE /api/v2/business/{businessId}/actionitems/businessnotifications/{id}/dismiss Dismiss Business Notifications #
GET /api/v2/business/{businessId}/ato Get ATO Details #
POST /api/v2/business/{businessId}/ato Set ATO Details #
GET /api/v2/business/{businessId}/document List Business Document Details #
POST /api/v2/business/{businessId}/document Create Business Document #
GET /api/v2/business/{businessId}/document/{id} Get Business Document Details #
PUT /api/v2/business/{businessId}/document/{id} Update Business Document Permissions #
DELETE /api/v2/business/{businessId}/document/{id} Delete Business Document #
GET /api/v2/business/{businessId}/document/{id}/content Get Business Document Content #
GET /api/v2/business/{businessId}/employeeportalsettings Get Employee Portal Settings #
POST /api/v2/business/{businessId}/employeeportalsettings Update Employee Portal Settings #
GET /api/v2/business/{businessId}/entitlements List Entitlements #
POST /api/v2/business/{businessId}/initialfinancialyear Change the tax year #
GET /api/v2/business/{businessId}/initialfinancialyear Get the initial tax year #
GET /api/v2/business/{businessId}/leavesettings Get the leave settings for the business #
PUT /api/v2/business/{businessId}/leavesettings Update the leave settings for the business #
GET /api/v2/business/{businessId}/payslip Get payslip configuration #
POST /api/v2/business/{businessId}/payslip Create payslip configuration #
GET /api/v2/business/{businessId}/roundingrules Get Rounding Rules #
POST /api/v2/business/{businessId}/roundingrules Set Rounding Rules #
GET /api/v2/business/{businessId}/stpregister Get STP Registration Details #
POST /api/v2/business/{businessId}/stpregister Apply STP Registration Details #
GET /api/v2/business/{businessId}/subscription/billingplans List Billing Plans #
GET /api/v2/business/{businessId}/subscription/currentbillingplan Get Business Billing PLan #
POST /api/v2/business/{businessId}/subscription/setbillingplan Set Business Billing Plan #
GET /api/v2/business/{businessId}/tags List the Business tags #
GET /api/v2/business/{businessId}/timesheetsettings Get the timesheet settings for the business #
PUT /api/v2/business/{businessId}/timesheetsettings Update the timesheet settings for the business #
POST /api/v2/business/{businessId}/{businessTemplateId} Copy Business Settings From Template #
GET /api/v2/business/{businessId}/paymentfiles List payment files #
POST /api/v2/business/{businessId}/paymentfiles Create payment file record #
GET /api/v2/business/{businessId}/paymentfiles/{id} Get payment file by ID #
PUT /api/v2/business/{businessId}/paymentfiles/{id} Update payment file record #
DELETE /api/v2/business/{businessId}/paymentfiles/{id} Delete payment file record #
POST /api/v2/business/{businessId}/paymentfiles/{id}/signing-key/activate Activate the signing key #
GET /api/v2/business/{businessId}/paymentfiles/{id}/signing-key/download Download a signing key #
POST /api/v2/business/{businessId}/paymentfiles/{id}/signing-key/generate Generate a signing key #
DELETE /api/v2/business/{businessId}/paymentfiles/{id}/signing-key/remove Remove the signing key #
GET /api/v2/business/{businessId}/statutorysettings Get Statutory Settings #
POST /api/v2/business/{businessId}/statutorysettings Set Statutory Settings #
GET /api/v2/business/{businessId}/bacs List BACS Settings #
POST /api/v2/business/{businessId}/bacs Create BACS Settings Record #
GET /api/v2/business/{businessId}/bacs/{id} Get BACS Settings Record by ID #
PUT /api/v2/business/{businessId}/bacs/{id} Update BACS Settings Record #
DELETE /api/v2/business/{businessId}/bacs/{id} Delete BACS Settings Record #
GET /api/v2/business/{businessId}/dataimport/52weekdatatemplate Template for 52 Week Data #
POST /api/v2/business/{businessId}/dataimport/import52weekdata Import 52 Week Data #
GET /api/v2/business/{businessId}/dataimport/import52weekdataquery Query 52 Week Data Import Status #
GET /api/v2/business/{businessId}/employee/{employeeId}/location List Employee Locations #
GET /api/v2/business/{businessId}/hmrcsettings Get HMRC Settings #
PUT /api/v2/business/{businessId}/hmrcsettings Update HMRC Settings #
GET /api/v2/business/{businessId}/hmrcsettings/employmentallowance Get Employment Allowance Settings #
PUT /api/v2/business/{businessId}/hmrcsettings/employmentallowance Update Employment Allowance Settings #
DELETE /api/v2/business/{businessId}/hmrcsettings/hmrcpaymentreminder Delete HMRC Payment Reminder #
PUT /api/v2/business/{businessId}/hmrcsettings/simple-update Simple Update Employer HMRC Settings #
GET /api/v2/business/{businessId}/location List Business Locations #
POST /api/v2/business/{businessId}/location Create Location #
GET /api/v2/business/{businessId}/location/{id} Get Location By Id #
PUT /api/v2/business/{businessId}/location/{id} Update Location #
DELETE /api/v2/business/{businessId}/location/{id} Delete Location #
GET /api/v2/business/{businessId}/statutorypay Get All Statutory Maternity Leave Data #
GET /api/v2/business/{businessId}/taxyearlist Get list of financial years #

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-business-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-business-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-business-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Employment Hero Business API
  version: '1.0'
  description: 'Operations tagged Business 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 (250 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/employment-hero/refs/heads/main/openapi/employment-hero-business-api-openapi.yml