PayRun.IO

Name: PayRun.IO API
Brand: PayRun API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentHR recruitingPayrolloauth2390 EndpointsREST

For Agents

Run UK payroll calculations, manage employees, submit RTI to HMRC, and control user permissions through the latest version of the PayRun.IO payroll engine.

Install Jentic One Beta

Connect the PayRun.IO to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the PayRun.IO, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with PayRun.IO API.

Execute pay runs with automatic PAYE, NI, and pension calculations for UK employees

Submit Real Time Information (RTI) reports including FPS and EPS to HMRC

Manage user permissions with role-based access control over payroll operations

GET STARTED

Start building with PayRun.IO API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use PayRun.IO API for, with concrete tasks.

★ UK Payroll Processing with Access Control

Execute monthly or weekly pay runs with the latest PayRun.IO engine while controlling who has access to payroll operations through permission management. Version 23 adds the ability to map users to specific permissions, enabling role-based access so only authorized personnel can run payroll, view pay data, or submit RTI reports.

List users assigned to a specific permission via GET /Permission/{PermissionId}/Users, then execute a pay run for the authorized employer

HMRC Compliance Reporting

Generate and submit all required HMRC reports including Full Payment Submissions (FPS) after each pay event, Employer Payment Summaries (EPS) monthly, and end-of-year P60 certificates. The API handles RTI data formatting, submission tracking, and HMRC acknowledgement monitoring.

Trigger an RTI FPS submission for employer emp_001 after the latest pay run and verify HMRC acknowledgement status

Pension and Benefits Administration

Manage workplace pension obligations including auto-enrolment assessments, contribution calculations based on qualifying earnings, and pension scheme configuration. The API evaluates each employee's eligibility at every pay period and calculates the correct employer and employee contributions automatically.

Retrieve AE assessments for all employees under employer emp_001 and identify any requiring re-assessment or opt-out processing

AI Agent Payroll Automation

AI agents use the PayRun.IO v23 API through Jentic to automate UK payroll operations across 390 endpoints without managing OAuth tokens or navigating the complex resource hierarchy. Jentic provides intent-based discovery to find the right operation among employers, employees, pay runs, and reporting resources.

Search Jentic for 'check payroll permissions', load the permission-users schema, and verify which users can execute pay runs

Key Endpoints

390 endpoints — jentic publishes the only available openapi specification for payrun.

METHOD

PATH

DESCRIPTION

GET

/Employer/{EmployerId}

Retrieve employer details

GET

/Employer/{EmployerId}/Employees

List all employees

GET

/Employer/{EmployerId}/PayRuns

List pay runs

GET

/Employer/{EmployerId}/PaySchedules

List pay schedules

GET

/Employer/{EmployerId}/RtiTransactions

List RTI submissions

GET

/Permission/{PermissionId}/Users

List users with a permission

GET

/Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessments

Get pension assessments

GET

/Employer/{EmployerId}/CisTransactions

List CIS transactions

GET

/Employer/{EmployerId}

Retrieve employer details

GET

/Employer/{EmployerId}/Employees

List all employees

GET

/Employer/{EmployerId}/PayRuns

List pay runs

GET

/Employer/{EmployerId}/PaySchedules

List pay schedules

GET

/Employer/{EmployerId}/RtiTransactions

List RTI submissions

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

PayRun.IO OAuth 2.0 credentials are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped tokens with automatic refresh — raw client secrets never enter the agent context.

Intent-based discovery

Agents search by intent (e.g., 'manage payroll permissions' or 'submit RTI to HMRC') and Jentic returns matching operations from the 390-endpoint surface, so agents navigate the complex resource hierarchy without manual exploration.

Time to first call

Direct PayRun.IO integration: 5-10 days for OAuth setup, resource hierarchy navigation, and payroll flow testing. Through Jentic: under 2 hours — search, load schema, execute.

FAQs

Specific to using PayRun.IO API through Jentic.

Why is there no official OpenAPI spec for PayRun.IO?

PayRun.IO does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call PayRun.IO via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the PayRun API use?

PayRun.IO uses OAuth 2.0 authentication. You obtain access tokens via the OAuth flow and include them in the Authorization header. Through Jentic, OAuth tokens are stored encrypted in the MAXsystem vault with automatic refresh, so agents never handle client secrets directly.

How does this version differ from the older PayRun.IO API?

Version 23.24.2.136 adds the GET /Permission/{PermissionId}/Users endpoint for mapping users to specific payroll permissions. This enables role-based access control over who can run payroll, submit RTI, or view sensitive pay data. All other endpoints remain consistent with version 22.

How do I manage payroll permissions through Jentic?

Use Jentic to search for 'list payroll permission users', load the schema for GET /Permission/{PermissionId}/Users, and execute with the permission ID. This returns all users assigned to that permission, enabling audit and access control verification.

Can I generate end-of-year tax documents?

Yes. The API provides endpoints for P60 generation (end-of-year employee summary), P45 (leaving certificate), and P32 (employer payment summary). These are accessible under the Employer and Employee resource hierarchy and generate the correct HMRC-compliant output.

Does the PayRun API handle pension auto-enrolment?

Yes. The AE Assessment endpoints evaluate each employee's pension eligibility at every pay period, calculate qualifying earnings, and determine correct contribution rates. The API tracks opt-in, opt-out, and postponement status for each employee under the employer's pension scheme.