> ## 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

<CardGroup cols={3}>
  <Card title="Pre-built tooling" icon="screwdriver-wrench" href="#pre-built-tooling" />

  <Card title="Pre-built integrations" icon="square-check" href="#pre-built-integrations" />

  <Card title="Access requirements" icon="triangle-exclamation" href="#access-requirements" />

  <Card title="Setup guide" icon="rocket" href="#setup-guide" />

  <Card title="Useful links" icon="circle-info" href="#useful-links" />

  <Card title="API gotchas" icon="biohazard" href="#api-gotchas" />
</CardGroup>

## Pre-built tooling

<AccordionGroup>
  <Accordion title="✅ Authorization">
    | Tools                           | Status |
    | ------------------------------- | ------ |
    | Pre-built authorization (OAuth) | ✅      |
    | Credentials auto-refresh        | ✅      |
    | Auth parameters validation      | ✅      |
    | Pre-built authorization UI      | ✅      |
    | Custom authorization UI         | ✅      |
    | Expired credentials detection   | ✅      |
  </Accordion>

  <Accordion title="✅ 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>

  <Accordion title="✅ 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>

  <Accordion title="✅ 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        | ✅                              |
  </Accordion>
</AccordionGroup>

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

<Tip>Not seeing the integration you need? [Build your own](/guides/functions/functions-guide) independently.</Tip>

## 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

<Steps>
  <Step title="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.
  </Step>

  <Step title="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**.
  </Step>

  <Step title="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.
  </Step>

  <Step title="Next">
    Follow the [*Quickstart*](/getting-started/quickstart).
  </Step>
</Steps>

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

## 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)</Note>

## 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)</Note>