Companies on our Universe plan can use the PayHero API to build private integrations with their own systems. Software providers building an integration for use by multiple PayHero customers go through a separate assessment process, set out below.
What the API is for
The PayHero API supports integrations that bring data into PayHero, such as timesheets, work records and employee information, and read data out of it for reporting and analysis. Pay runs are always created, reviewed and finalised inside PayHero by an authorised person at the employing company.
What we do not support
So you do not spend time on an application we cannot approve, these are out of scope and we will not consider them:
Creating, approving or sending pay runs through the API.
Any workflow where an action in another product is the last human step before employees, IRD or a bank account are affected.
Initiating direct debits, employee payments or IRD filing from outside PayHero.
Running PayHero as a payroll engine behind another product’s interface, where that product owns the employee experience.
Endpoints that do not exist today. If you need something we do not offer, tell us and we will treat it as product feedback, but it is not an API access request.
If you are a PayHero customer building a private integration
If you are on the Universe plan and want to connect PayHero to your own systems, using your own account and your own data, review our API docs, complete the private integration application form and email it to api@flexitime.works. We will come back to you within 10 working days.
If you are a software provider building an integration for PayHero customers
We assess third party integrations on whether there is a clear benefit for PayHero customers and for PayHero. At the first stage we need to assess the commercial benefits of an integration.
Before completing your application, we ask that you review our API docs, then, email partnerships@flexitime.works with the following. It should take about fifteen minutes.
Details of your product, a link to it, how long it has been live, how many paying customers you have and what they pay.
Which of your customers use PayHero today. Please name them, and tell us whether they would be happy to confirm to us directly that they want this integration.
What the integration would do: what data moves, and in which direction.
What PayHero gets from it. Would it bring us customers we do not have (roughly how many, and from where), or make things better for customers we already have? Please be specific.
Integrations you have already built and shipped, with links.
Anything you need that PayHero does not currently do.
We will come back to you within 5 working days. If we can see a genuine opportunity for both sides, we will send you the application form and our standard third party agreement and take it from there.