> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Employment Hero

## Overview

> [card] [Pre-built tooling](#pre-built-tooling)

> [card] [Pre-built integrations](#pre-built-integrations)

> [card] [Access requirements](#access-requirements)

> [card] [Setup guide](#setup-guide)

> [card] [Useful links](#useful-links)

> [card] [API gotchas](#api-gotchas)

## Pre-built tooling

> [accordion] ✅ Authorization
>
> | Tools | Status |
> | - | - |
> | Pre-built authorization (OAuth) | ✅ |
> | Credentials auto-refresh | ✅ |
> | Auth parameters validation | ✅ |
> | Pre-built authorization UI | ✅ |
> | Custom authorization UI | ✅ |
> | Expired credentials detection | ✅ |

> [accordion] ✅ Read & write data
>
> | Tools | Status |
> | - | - |
> | Pre-built integrations | 🚫 (time to contribute: \<48h) |
> | API unification | ✅ |
> | 2-way sync | ✅ |
> | Webhooks from Nango on data modifications | ✅ |
> | Real-time webhooks from 3rd-party API | 🚫 (time to contribute: \<48h) |
> | Proxy requests | ✅ |

> [accordion] ✅ Observability & data quality
>
> | Tools | Status |
> | - | - |
> | HTTP request logging | ✅ |
> | End-to-end type safety | ✅ |
> | Data runtime validation | ✅ |
> | OpenTelemetry export | ✅ |
> | Slack alerts on errors | ✅ |
> | Integration status API | ✅ |

> [accordion] ✅ Customization
>
> | Tools | Status |
> | - | - |
> | Create or customize use-cases | ✅ |
> | Pre-configured pagination | 🚫 (time to contribute: \<48h) |
> | Pre-configured rate-limit handling | 🚫 (time to contribute: \<48h) |
> | Per-customer configurations | ✅ |

*No pre-built syncs or tools available yet.*

> [!TIP]
>
> Not seeing the integration you need? [Build your own](https://nango.dev/docs/guides/functions/functions-guide.md) independently.

## Access requirements

| Pre-Requisites | Status | Comment |
| - | - | - |
| Paid dev account | ✅ Not required | Free, self-signup for an [Employment Hero account](https://employmenthero.com/free-trial/). |
| Paid test account | ✅ Not required | Free, self-signup for an [Employment Hero account](https://employmenthero.com/free-trial/). |
| Partnership | ✅ Not required | |
| App review | ✅ Not required | |
| Security audit | ✅ Not required | |

## Setup guide

**1. Create an Employment Hero account**

Go to [Employment Hero signup page](https://employmenthero.com/free-trial/) and create a free account. Once your account is created, you can access the Developer Dashboard.

**2. Access the Developer Portal**

1. Log in to your [Employment Hero](https://secure.employmenthero.com/users/sign_in) account.
2. Click on your profile from the top right corner then click **Developer Portal**.

**3. Create a new app**

1. In the Developer Portal, navigate to the **API** page and click the **Add Application** button.
2. Enter a **Name** for your app and set `https://api.nango.dev/oauth/callback` as the **Redirect URI**.
3. Select the required API scopes.
4. Click **Create** to finalize your application.
5. Once your application is created, a **Client ID** and **Client Secret** will be displayed. Copy these credentials, as you will need them when setting up the integration in Nango.

**4. Next**

Follow the [*Quickstart*](https://nango.dev/docs/getting-started/quickstart.md).

> [!TIP]
>
> Need help getting started? Get help in the [community](https://nango.dev/slack).

## Useful links

| Topic | Links |
| - | - |
| General | [Website](https://employmenthero.com/) |
| | [Create an account](https://employmenthero.com/free-trial/) |
| | [Sign in to your account](https://secure.employmenthero.com/users/sign_in) |
| Developer | [API documentation](https://developer.employmenthero.com) |
| | [Authentication documentation](https://developer.employmenthero.com/api-references/#icon-key-authentication) |
| | [OAuth 2.0 guide](https://developer.employmenthero.com/api-references/#obtain-access-token) |
| | [How to register an application](https://developer.employmenthero.com/api-references/#obtain-credentials) |

> [!NOTE]
>
> Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/employment-hero.mdx)

## Common Scopes

| Scope | Description |
| - | - |
| organisations:list | Read all organisations you belong to |
| organisations:show | Read organisations details |
| employees:list | Read all employees which belong to an organisation |
| teams:list | Read all teams which belong to an organisation |
| invoices:list | Read all invoices which belong to an organisation |
| payslips:list | Read all payslips which belong to an employee |

## API gotchas

* The scopes used are the ones selected when creating a new application on the developer portal, so there is no need to supply scopes within Nango.

> [!NOTE]
>
> Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/employment-hero.mdx)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.