# Employment Hero Business API

**Canonical:** https://apis.io/apis/employment-hero/employment-hero-business-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 Business 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 Business. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

## Operations (60 of 74)

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

…and 14 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-business-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

Business

---

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