# PayHero

PayHero is perfect for Kiwi companies that want stress free and compliant online payroll. Especially those with part time and mobile workforces, who face unique challenges tracking employee time accurately and calculating the right holiday entitlements for their staff.

### Prerequisites

To connect PayHero to Omnata, you need to have an active PayHero account on a Universal Plan. If you don't have one, you can sign up for a free trial [here](https://payhero.co.nz/).

### Authentication

API requests are authenticated using an API key and Subscription Key.

#### API Key

You can generate an API key from the PayHero web app by going to `Manage` > `Integrations` > `PayHero API` > `Connect`.

[![Manage](https://camo.githubusercontent.com/cd4de7c298e461b56de481566e9d120f14b8be43560e20090d3e5ca2f8afef1d/68747470733a2f2f737570706f72742e7061796865726f2e636f2e6e7a2f68632f61727469636c655f6174746163686d656e74732f343733393133323539323031352f436f6e6e6563742e706e67)](https://camo.githubusercontent.com/cd4de7c298e461b56de481566e9d120f14b8be43560e20090d3e5ca2f8afef1d/68747470733a2f2f737570706f72742e7061796865726f2e636f2e6e7a2f68632f61727469636c655f6174746163686d656e74732f343733393133323539323031352f436f6e6e6563742e706e67)

Clicking Connect will generate an API key for your company to use when accessing the PayHero API.

[![Manage](https://camo.githubusercontent.com/5972f1776d854256060cfcd094610e5861dd9e28488ab1ded75c9f10ee2d0865/68747470733a2f2f737570706f72742e7061796865726f2e636f2e6e7a2f68632f61727469636c655f6174746163686d656e74732f343733393134363239303434372f436f6e6e65637465642e706e67)](https://camo.githubusercontent.com/5972f1776d854256060cfcd094610e5861dd9e28488ab1ded75c9f10ee2d0865/68747470733a2f2f737570706f72742e7061796865726f2e636f2e6e7a2f68632f61727469636c655f6174746163686d656e74732f343733393134363239303434372f436f6e6e65637465642e706e67)

#### Subscription Key

Access to the PayHero API is by request, and subject to a review process. [API Application Form](https://docs.google.com/forms/d/e/1FAIpQLSd7x6fjVhIvhgDfgCFD69Jy2Rvqky-tzbONjfaRBw2j_0SMsg/viewform?usp=sf_link). Once your application has been approved, you can obtain a Subscription Key to use within Omnata.

### Inbound Syncs

The following streams are supported:

* Employees (Full Refresh and Incremental)
* Employee Leave Balances (Full Refresh and Incremental)
* Employee Pay History (Full Refresh and Incremental)
* Expenses (Full Refresh and Incremental)
* Leave Requests (Full Refresh and Incremental)
* Leave Types (Full Refresh and Incremental)
* Pay Cycles (Full Refresh and Incremental)
* Pay Items (Full Refresh and Incremental)
* Time Enteries (Full Refresh and Incremental)
* Work Records (Full Refresh and Incremental)

### Outbound Syncs

There is currently no Outbound sync support for this App, but please [let us know](https://omnata.com/contact-us) if you have a use case in mind.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.omnata.com/omnata-product-documentation/omnata-sync-for-snowflake/apps/payhero.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.