# Employment Hero Pay Run API

**Canonical:** https://apis.io/apis/employment-hero/employment-hero-payrun-api/  
**Provider:** Employment Hero — https://apis.io/providers/employment-hero/  
**Base URL:** https://api.employmenthero.com/api/v1  
**Documentation:** https://developer.employmenthero.com/api-references

Employment Hero Pay Run API is one of 79 APIs that [Employment Hero](https://apis.io/providers/employment-hero/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include PayRun. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

## Operations (60 of 100)

| Method | Path | Summary |
|---|---|---|
| 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 |

…and 40 more operations. They are listed in full on the page.

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/employment-hero/refs/heads/main/openapi/employment-hero-payrun-api-openapi.yml
- **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

## Other Employment Hero APIs (12)

- [Employment Hero REST API](https://apis.io/apis/employment-hero/rest-api/)
- [Employment Hero Bank Accounts API](https://apis.io/apis/employment-hero/employment-hero-bank-accounts-api/)
- [Employment Hero Certifications API](https://apis.io/apis/employment-hero/employment-hero-certifications-api/)
- [Employment Hero Cost Centres API](https://apis.io/apis/employment-hero/employment-hero-cost-centres-api/)
- [Employment Hero Custom Fields API](https://apis.io/apis/employment-hero/employment-hero-custom-fields-api/)
- [Employment Hero Departments API](https://apis.io/apis/employment-hero/employment-hero-departments-api/)
- [Employment Hero Documents API](https://apis.io/apis/employment-hero/employment-hero-documents-api/)
- [Employment Hero Emergency Contacts API](https://apis.io/apis/employment-hero/employment-hero-emergency-contacts-api/)
- [Employment Hero Employees API](https://apis.io/apis/employment-hero/employment-hero-employees-api/)
- [Employment Hero Forms API](https://apis.io/apis/employment-hero/employment-hero-forms-api/)
- [Employment Hero Job Histories API](https://apis.io/apis/employment-hero/employment-hero-job-histories-api/)
- [Employment Hero Aba Settings API](https://apis.io/apis/employment-hero/employment-hero-abasettings-api/)

## Tags

PayRun

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/employment-hero/employment-hero-payrun-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/employment-hero/.