Employment Hero Payroll MCP by usefulapi is an MCP server published by io.usefulapi, hosted at keypay.usefulapi.io. When last checked on 2026-11-22 it was working: it answers and lists its tools. It declares 26 tools, including keypay_get_user, keypay_list_businesses, keypay_get_business, keypay_list_employees, keypay_get_employee.
Read Employment Hero Payroll pay runs, payslips, timesheets and leave; approve or decline leave.
4,107 connections through 5 shared values. Tap any node.
Inferred from the host name and headers: what a server runs on, not who runs it.
The Employment Hero Payroll user this API key belongs to: id, email, display name and time zone. GET /user.
No parameters.
{
"name": "keypay_get_user",
"title": "Get current user",
"description": "The Employment Hero Payroll user this API key belongs to: id, email, display name and time zone. GET /user.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
},
"annotations": {
"title": "Get current user",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}None yet. Changes appear after a server's second daily check.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
List the payroll businesses this user can access: id, name, region, legal name, contact details, pay cycle, number of employees. Start here: most other tools need a business id. GET /business (OData).
| Parameter | Type | Description |
|---|---|---|
| top | integer | Results per request, 1-100 (default 25; the API caps it at 100). |
| skip | integer | Results to skip (default 0). Pass the previous reply's next_skip. |
| filter | string | OData v3 $filter. Property names are capitalised, e.g. "Surname eq 'Smith'", "StartTime gt datetime'2026-04-01T00:00:00'", "DefaultSuperRate ne 9.5M". |
| orderby | string | OData $orderby, e.g. "Name" or "PayPeriodEnding desc". |
{
"name": "keypay_list_businesses",
"title": "List businesses",
"description": "List the payroll businesses this user can access: id, name, region, legal name, contact details, pay cycle, number of employees. Start here: most other tools need a business id. GET /business (OData).",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"top": {
"type": "integer",
"maximum": 100,
"description": "Results per request, 1-100 (default 25; the API caps it at 100).",
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Results to skip (default 0). Pass the previous reply's next_skip."
},
"filter": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "OData v3 $filter. Property names are capitalised, e.g. \"Surname eq 'Smith'\", \"StartTime gt datetime'2026-04-01T00:00:00'\", \"DefaultSuperRate ne 9.5M\"."
},
"orderby": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "OData $orderby, e.g. \"Name\" or \"PayPeriodEnding desc\"."
}
}
},
"annotations": {
"title": "List businesses",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One business by id: name, legal name, contact, address, ABN/company details, leave year, standard hours, pay cycle. GET /business/{businessId}.
| Parameter | Type | Description |
|---|---|---|
| business_id * | integer | Business id (from keypay_list_businesses). |
{
"name": "keypay_get_business",
"title": "Get business",
"description": "One business by id: name, legal name, contact, address, ABN/company details, leave year, standard hours, pay cycle. GET /business/{businessId}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id"
],
"properties": {
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get business",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List the business's employees with basic details: id, name, preferred name, gender, date of birth, contact details, address, start and end date, external id. Tax file, bank and super details are not part of this list. Filter with OData, e.g. "Surname eq 'Smith'". GET /business/{businessId}/employee/details (OData).
| Parameter | Type | Description |
|---|---|---|
| top | integer | Results per request, 1-100 (default 25; the API caps it at 100). |
| skip | integer | Results to skip (default 0). Pass the previous reply's next_skip. |
| filter | string | OData v3 $filter. Property names are capitalised, e.g. "Surname eq 'Smith'", "StartTime gt datetime'2026-04-01T00:00:00'", "DefaultSuperRate ne 9.5M". |
| orderby | string | OData $orderby, e.g. "Name" or "PayPeriodEnding desc". |
| business_id * | integer | Business id (from keypay_list_businesses). |
{
"name": "keypay_list_employees",
"title": "List employees",
"description": "List the business's employees with basic details: id, name, preferred name, gender, date of birth, contact details, address, start and end date, external id. Tax file, bank and super details are not part of this list. Filter with OData, e.g. \"Surname eq 'Smith'\". GET /business/{businessId}/employee/details (OData).",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id"
],
"properties": {
"top": {
"type": "integer",
"maximum": 100,
"description": "Results per request, 1-100 (default 25; the API caps it at 100).",
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Results to skip (default 0). Pass the previous reply's next_skip."
},
"filter": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "OData v3 $filter. Property names are capitalised, e.g. \"Surname eq 'Smith'\", \"StartTime gt datetime'2026-04-01T00:00:00'\", \"DefaultSuperRate ne 9.5M\"."
},
"orderby": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "OData $orderby, e.g. \"Name\" or \"PayPeriodEnding desc\"."
},
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List employees",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One employee's full record: name, contact, employment type, status, start/end date, pay schedule, primary location and pay category, rate and rate unit, hours per week, award, leave template, work types, tags. Tax file / national insurance / IRD / NRIC numbers, bank accounts and super member numbers are removed. GET /business/{businessId}/employee/unstructured/{employeeId}.
| Parameter | Type | Description |
|---|---|---|
| business_id * | integer | Business id (from keypay_list_businesses). |
| employee_id * | integer | Employee id (from keypay_list_employees). |
{
"name": "keypay_get_employee",
"title": "Get employee",
"description": "One employee's full record: name, contact, employment type, status, start/end date, pay schedule, primary location and pay category, rate and rate unit, hours per week, award, leave template, work types, tags. Tax file / national insurance / IRD / NRIC numbers, bank accounts and super member numbers are removed. GET /business/{businessId}/employee/unstructured/{employeeId}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id",
"employee_id"
],
"properties": {
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
},
"employee_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Employee id (from keypay_list_employees).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get employee",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}An employee's leave balances per leave category (accrued amount and unit), optionally as at a date. GET /business/{businessId}/employee/{employeeId}/leavebalances.
| Parameter | Type | Description |
|---|---|---|
| as_at_date | string | Balance as at this date (yyyy-mm-dd); default today. |
| business_id * | integer | Business id (from keypay_list_businesses). |
| employee_id * | integer | Employee id. |
{
"name": "keypay_get_leave_balances",
"title": "Get employee leave balances",
"description": "An employee's leave balances per leave category (accrued amount and unit), optionally as at a date. GET /business/{businessId}/employee/{employeeId}/leavebalances.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id",
"employee_id"
],
"properties": {
"as_at_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Balance as at this date (yyyy-mm-dd); default today."
},
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
},
"employee_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Employee id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get employee leave balances",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List the business's pay runs: id, pay schedule, pay period start/end, date paid, finalised flag, payslips published, notation. Newest first with orderby "PayPeriodEnding desc". GET /business/{businessId}/payrun (OData).
| Parameter | Type | Description |
|---|---|---|
| top | integer | Results per request, 1-100 (default 25; the API caps it at 100). |
| skip | integer | Results to skip (default 0). Pass the previous reply's next_skip. |
| filter | string | OData v3 $filter. Property names are capitalised, e.g. "Surname eq 'Smith'", "StartTime gt datetime'2026-04-01T00:00:00'", "DefaultSuperRate ne 9.5M". |
| orderby | string | OData $orderby, e.g. "Name" or "PayPeriodEnding desc". |
| business_id * | integer | Business id (from keypay_list_businesses). |
{
"name": "keypay_list_pay_runs",
"title": "List pay runs",
"description": "List the business's pay runs: id, pay schedule, pay period start/end, date paid, finalised flag, payslips published, notation. Newest first with orderby \"PayPeriodEnding desc\". GET /business/{businessId}/payrun (OData).",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id"
],
"properties": {
"top": {
"type": "integer",
"maximum": 100,
"description": "Results per request, 1-100 (default 25; the API caps it at 100).",
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Results to skip (default 0). Pass the previous reply's next_skip."
},
"filter": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "OData v3 $filter. Property names are capitalised, e.g. \"Surname eq 'Smith'\", \"StartTime gt datetime'2026-04-01T00:00:00'\", \"DefaultSuperRate ne 9.5M\"."
},
"orderby": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "OData $orderby, e.g. \"Name\" or \"PayPeriodEnding desc\"."
},
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List pay runs",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One pay run by id: pay schedule, period, date paid, whether it is finalised, notation. GET /business/{businessId}/payrun/{payRunId}.
| Parameter | Type | Description |
|---|---|---|
| pay_run_id * | integer | Pay run id (from keypay_list_pay_runs). |
| business_id * | integer | Business id (from keypay_list_businesses). |
{
"name": "keypay_get_pay_run",
"title": "Get pay run",
"description": "One pay run by id: pay schedule, period, date paid, whether it is finalised, notation. GET /business/{businessId}/payrun/{payRunId}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id",
"pay_run_id"
],
"properties": {
"pay_run_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Pay run id (from keypay_list_pay_runs).",
"exclusiveMinimum": 0
},
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get pay run",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Pay runs with their totals: total hours, gross wages and net wages, plus the usual pay run fields. GET /business/{businessId}/payrun/summary (OData).
| Parameter | Type | Description |
|---|---|---|
| top | integer | Results per request, 1-100 (default 25; the API caps it at 100). |
| skip | integer | Results to skip (default 0). Pass the previous reply's next_skip. |
| filter | string | OData v3 $filter. Property names are capitalised, e.g. "Surname eq 'Smith'", "StartTime gt datetime'2026-04-01T00:00:00'", "DefaultSuperRate ne 9.5M". |
| orderby | string | OData $orderby, e.g. "Name" or "PayPeriodEnding desc". |
| business_id * | integer | Business id (from keypay_list_businesses). |
{
"name": "keypay_list_pay_run_summaries",
"title": "List pay run summaries",
"description": "Pay runs with their totals: total hours, gross wages and net wages, plus the usual pay run fields. GET /business/{businessId}/payrun/summary (OData).",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id"
],
"properties": {
"top": {
"type": "integer",
"maximum": 100,
"description": "Results per request, 1-100 (default 25; the API caps it at 100).",
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Results to skip (default 0). Pass the previous reply's next_skip."
},
"filter": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "OData v3 $filter. Property names are capitalised, e.g. \"Surname eq 'Smith'\", \"StartTime gt datetime'2026-04-01T00:00:00'\", \"DefaultSuperRate ne 9.5M\"."
},
"orderby": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "OData $orderby, e.g. \"Name\" or \"PayPeriodEnding desc\"."
},
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List pay run summaries",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One pay run with its total hours, gross wages and net wages. GET /business/{businessId}/payrun/{payRunId}/summary.
| Parameter | Type | Description |
|---|---|---|
| pay_run_id * | integer | Pay run id. |
| business_id * | integer | Business id (from keypay_list_businesses). |
{
"name": "keypay_get_pay_run_summary",
"title": "Get pay run summary",
"description": "One pay run with its total hours, gross wages and net wages. GET /business/{businessId}/payrun/{payRunId}/summary.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id",
"pay_run_id"
],
"properties": {
"pay_run_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Pay run id.",
"exclusiveMinimum": 0
},
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get pay run summary",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Per-employee totals of a pay run (gross, net, tax withheld, super and the like; the fields depend on the region). Bank payment details are removed. GET /business/{businessId}/payrun/{payRunId}/totals.
| Parameter | Type | Description |
|---|---|---|
| pay_run_id * | integer | Pay run id. |
| business_id * | integer | Business id (from keypay_list_businesses). |
{
"name": "keypay_get_pay_run_totals",
"title": "Get pay run totals per employee",
"description": "Per-employee totals of a pay run (gross, net, tax withheld, super and the like; the fields depend on the region). Bank payment details are removed. GET /business/{businessId}/payrun/{payRunId}/totals.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id",
"pay_run_id"
],
"properties": {
"pay_run_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Pay run id.",
"exclusiveMinimum": 0
},
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get pay run totals",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Pay slip data for every employee in a pay run, keyed by employee: earnings lines, deductions, tax, super, leave taken and accrued, gross/net and year-to-date totals. Large for big pay runs. Bank account numbers and tax/identity numbers are removed. GET /business/{businessId}/payrun/{payRunId}/payslips.
| Parameter | Type | Description |
|---|---|---|
| pay_run_id * | integer | Pay run id. |
| business_id * | integer | Business id (from keypay_list_businesses). |
| show_all_data | boolean | Include all pay slip data, not only what is printed on the slip (default false). |
{
"name": "keypay_get_pay_run_payslips",
"title": "Get pay slip data of a pay run",
"description": "Pay slip data for every employee in a pay run, keyed by employee: earnings lines, deductions, tax, super, leave taken and accrued, gross/net and year-to-date totals. Large for big pay runs. Bank account numbers and tax/identity numbers are removed. GET /business/{businessId}/payrun/{payRunId}/payslips.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id",
"pay_run_id"
],
"properties": {
"pay_run_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Pay run id.",
"exclusiveMinimum": 0
},
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
},
"show_all_data": {
"type": "boolean",
"description": "Include all pay slip data, not only what is printed on the slip (default false)."
}
}
},
"annotations": {
"title": "Get pay slip data",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Warnings on a pay run (for example an employee paid below their award rate or with a negative net pay): type, employee and message. GET /business/{businessId}/payrun/{payRunId}/warnings.
| Parameter | Type | Description |
|---|---|---|
| pay_run_id * | integer | Pay run id. |
| business_id * | integer | Business id (from keypay_list_businesses). |
{
"name": "keypay_list_pay_run_warnings",
"title": "List pay run warnings",
"description": "Warnings on a pay run (for example an employee paid below their award rate or with a negative net pay): type, employee and message. GET /business/{businessId}/payrun/{payRunId}/warnings.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id",
"pay_run_id"
],
"properties": {
"pay_run_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Pay run id.",
"exclusiveMinimum": 0
},
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List pay run warnings",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List the business's timesheet lines: employee, start/end time, units, work type, location, status, comments, breaks. Filter by employee or date with OData, e.g. "EmployeeId eq 123 and StartTime gt datetime'2026-04-01T00:00:00'". GET /business/{businessId}/timesheet (OData: $filter, $orderby, $top, $skip).
| Parameter | Type | Description |
|---|---|---|
| top | integer | Results per request, 1-100 (default 25; the API caps it at 100). |
| skip | integer | Results to skip (default 0). Pass the previous reply's next_skip. |
| filter | string | OData v3 $filter. Property names are capitalised, e.g. "Surname eq 'Smith'", "StartTime gt datetime'2026-04-01T00:00:00'", "DefaultSuperRate ne 9.5M". |
| orderby | string | OData $orderby, e.g. "Name" or "PayPeriodEnding desc". |
| business_id * | integer | Business id (from keypay_list_businesses). |
{
"name": "keypay_list_timesheets",
"title": "List timesheets",
"description": "List the business's timesheet lines: employee, start/end time, units, work type, location, status, comments, breaks. Filter by employee or date with OData, e.g. \"EmployeeId eq 123 and StartTime gt datetime'2026-04-01T00:00:00'\". GET /business/{businessId}/timesheet (OData: $filter, $orderby, $top, $skip).",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id"
],
"properties": {
"top": {
"type": "integer",
"maximum": 100,
"description": "Results per request, 1-100 (default 25; the API caps it at 100).",
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Results to skip (default 0). Pass the previous reply's next_skip."
},
"filter": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "OData v3 $filter. Property names are capitalised, e.g. \"Surname eq 'Smith'\", \"StartTime gt datetime'2026-04-01T00:00:00'\", \"DefaultSuperRate ne 9.5M\"."
},
"orderby": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "OData $orderby, e.g. \"Name\" or \"PayPeriodEnding desc\"."
},
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List timesheets",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One timesheet line by id. GET /business/{businessId}/timesheet/{timesheetLineId}.
| Parameter | Type | Description |
|---|---|---|
| business_id * | integer | Business id (from keypay_list_businesses). |
| timesheet_id * | integer | Timesheet line id (from keypay_list_timesheets). |
{
"name": "keypay_get_timesheet",
"title": "Get timesheet line",
"description": "One timesheet line by id. GET /business/{businessId}/timesheet/{timesheetLineId}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id",
"timesheet_id"
],
"properties": {
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
},
"timesheet_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Timesheet line id (from keypay_list_timesheets).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get timesheet line",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}List the business's leave requests: employee, leave category, from/to date, total hours, status (Approved, Pending, Rejected, Cancelled), notes. Filter by status, dates, category, location or employee. GET /business/{businessId}/leaverequest.
| Parameter | Type | Description |
|---|---|---|
| status | string | Only requests with this status. |
| to_date | string | Only leave ending on or before this date (yyyy-mm-dd). |
| from_date | string | Only leave starting on or after this date (yyyy-mm-dd). |
| business_id * | integer | Business id (from keypay_list_businesses). |
| employee_id | integer | Only this employee. |
| location_id | integer | Only this location (keypay_list_locations). |
| leave_category_id | integer | Only this leave category (keypay_list_leave_categories). |
{
"name": "keypay_list_leave_requests",
"title": "List leave requests",
"description": "List the business's leave requests: employee, leave category, from/to date, total hours, status (Approved, Pending, Rejected, Cancelled), notes. Filter by status, dates, category, location or employee. GET /business/{businessId}/leaverequest.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id"
],
"properties": {
"status": {
"enum": [
"Approved",
"Pending",
"Rejected",
"Cancelled"
],
"type": "string",
"description": "Only requests with this status."
},
"to_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Only leave ending on or before this date (yyyy-mm-dd)."
},
"from_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Only leave starting on or after this date (yyyy-mm-dd)."
},
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
},
"employee_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only this employee.",
"exclusiveMinimum": 0
},
"location_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only this location (keypay_list_locations).",
"exclusiveMinimum": 0
},
"leave_category_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only this leave category (keypay_list_leave_categories).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List leave requests",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}One leave request: employee, category, dates, hours, status, notes. GET /business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId}.
| Parameter | Type | Description |
|---|---|---|
| business_id * | integer | Business id (from keypay_list_businesses). |
| employee_id * | integer | Employee id. |
| leave_request_id * | integer | Leave request id (from keypay_list_leave_requests). |
{
"name": "keypay_get_leave_request",
"title": "Get leave request",
"description": "One leave request: employee, category, dates, hours, status, notes. GET /business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id",
"employee_id",
"leave_request_id"
],
"properties": {
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
},
"employee_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Employee id.",
"exclusiveMinimum": 0
},
"leave_request_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Leave request id (from keypay_list_leave_requests).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Get leave request",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Leave categories of the business (annual, personal/sick, long service...): id, name, unit type, accrual rule. GET /business/{businessId}/leavecategory (OData).
| Parameter | Type | Description |
|---|---|---|
| top | integer | Results per request, 1-100 (default 25; the API caps it at 100). |
| skip | integer | Results to skip (default 0). Pass the previous reply's next_skip. |
| filter | string | OData v3 $filter. Property names are capitalised, e.g. "Surname eq 'Smith'", "StartTime gt datetime'2026-04-01T00:00:00'", "DefaultSuperRate ne 9.5M". |
| orderby | string | OData $orderby, e.g. "Name" or "PayPeriodEnding desc". |
| business_id * | integer | Business id (from keypay_list_businesses). |
{
"name": "keypay_list_leave_categories",
"title": "List leave categories",
"description": "Leave categories of the business (annual, personal/sick, long service...): id, name, unit type, accrual rule. GET /business/{businessId}/leavecategory (OData).",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id"
],
"properties": {
"top": {
"type": "integer",
"maximum": 100,
"description": "Results per request, 1-100 (default 25; the API caps it at 100).",
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Results to skip (default 0). Pass the previous reply's next_skip."
},
"filter": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "OData v3 $filter. Property names are capitalised, e.g. \"Surname eq 'Smith'\", \"StartTime gt datetime'2026-04-01T00:00:00'\", \"DefaultSuperRate ne 9.5M\"."
},
"orderby": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "OData $orderby, e.g. \"Name\" or \"PayPeriodEnding desc\"."
},
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List leave categories",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Pay schedules of the business: id, name, frequency, last date paid, last pay run. Bank and tax account details are removed. GET /business/{businessId}/payschedule (OData).
| Parameter | Type | Description |
|---|---|---|
| top | integer | Results per request, 1-100 (default 25; the API caps it at 100). |
| skip | integer | Results to skip (default 0). Pass the previous reply's next_skip. |
| filter | string | OData v3 $filter. Property names are capitalised, e.g. "Surname eq 'Smith'", "StartTime gt datetime'2026-04-01T00:00:00'", "DefaultSuperRate ne 9.5M". |
| orderby | string | OData $orderby, e.g. "Name" or "PayPeriodEnding desc". |
| business_id * | integer | Business id (from keypay_list_businesses). |
{
"name": "keypay_list_pay_schedules",
"title": "List pay schedules",
"description": "Pay schedules of the business: id, name, frequency, last date paid, last pay run. Bank and tax account details are removed. GET /business/{businessId}/payschedule (OData).",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id"
],
"properties": {
"top": {
"type": "integer",
"maximum": 100,
"description": "Results per request, 1-100 (default 25; the API caps it at 100).",
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Results to skip (default 0). Pass the previous reply's next_skip."
},
"filter": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "OData v3 $filter. Property names are capitalised, e.g. \"Surname eq 'Smith'\", \"StartTime gt datetime'2026-04-01T00:00:00'\", \"DefaultSuperRate ne 9.5M\"."
},
"orderby": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "OData $orderby, e.g. \"Name\" or \"PayPeriodEnding desc\"."
},
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List pay schedules",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Locations of the business (sites, departments): id, name, parent, fully qualified name, state. GET /business/{businessId}/location (OData).
| Parameter | Type | Description |
|---|---|---|
| top | integer | Results per request, 1-100 (default 25; the API caps it at 100). |
| skip | integer | Results to skip (default 0). Pass the previous reply's next_skip. |
| filter | string | OData v3 $filter. Property names are capitalised, e.g. "Surname eq 'Smith'", "StartTime gt datetime'2026-04-01T00:00:00'", "DefaultSuperRate ne 9.5M". |
| orderby | string | OData $orderby, e.g. "Name" or "PayPeriodEnding desc". |
| business_id * | integer | Business id (from keypay_list_businesses). |
{
"name": "keypay_list_locations",
"title": "List locations",
"description": "Locations of the business (sites, departments): id, name, parent, fully qualified name, state. GET /business/{businessId}/location (OData).",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id"
],
"properties": {
"top": {
"type": "integer",
"maximum": 100,
"description": "Results per request, 1-100 (default 25; the API caps it at 100).",
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Results to skip (default 0). Pass the previous reply's next_skip."
},
"filter": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "OData v3 $filter. Property names are capitalised, e.g. \"Surname eq 'Smith'\", \"StartTime gt datetime'2026-04-01T00:00:00'\", \"DefaultSuperRate ne 9.5M\"."
},
"orderby": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "OData $orderby, e.g. \"Name\" or \"PayPeriodEnding desc\"."
},
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List locations",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Pay categories (earnings types) of the business: id, name, rate unit, loadings, super rate, whether leave accrues. GET /business/{businessId}/paycategory (OData).
| Parameter | Type | Description |
|---|---|---|
| top | integer | Results per request, 1-100 (default 25; the API caps it at 100). |
| skip | integer | Results to skip (default 0). Pass the previous reply's next_skip. |
| filter | string | OData v3 $filter. Property names are capitalised, e.g. "Surname eq 'Smith'", "StartTime gt datetime'2026-04-01T00:00:00'", "DefaultSuperRate ne 9.5M". |
| orderby | string | OData $orderby, e.g. "Name" or "PayPeriodEnding desc". |
| business_id * | integer | Business id (from keypay_list_businesses). |
{
"name": "keypay_list_pay_categories",
"title": "List pay categories",
"description": "Pay categories (earnings types) of the business: id, name, rate unit, loadings, super rate, whether leave accrues. GET /business/{businessId}/paycategory (OData).",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id"
],
"properties": {
"top": {
"type": "integer",
"maximum": 100,
"description": "Results per request, 1-100 (default 25; the API caps it at 100).",
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Results to skip (default 0). Pass the previous reply's next_skip."
},
"filter": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "OData v3 $filter. Property names are capitalised, e.g. \"Surname eq 'Smith'\", \"StartTime gt datetime'2026-04-01T00:00:00'\", \"DefaultSuperRate ne 9.5M\"."
},
"orderby": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "OData $orderby, e.g. \"Name\" or \"PayPeriodEnding desc\"."
},
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List pay categories",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Work types of the business: id, name, pay category, leave category, short code. GET /business/{businessId}/worktype (OData).
| Parameter | Type | Description |
|---|---|---|
| top | integer | Results per request, 1-100 (default 25; the API caps it at 100). |
| skip | integer | Results to skip (default 0). Pass the previous reply's next_skip. |
| filter | string | OData v3 $filter. Property names are capitalised, e.g. "Surname eq 'Smith'", "StartTime gt datetime'2026-04-01T00:00:00'", "DefaultSuperRate ne 9.5M". |
| orderby | string | OData $orderby, e.g. "Name" or "PayPeriodEnding desc". |
| business_id * | integer | Business id (from keypay_list_businesses). |
{
"name": "keypay_list_work_types",
"title": "List work types",
"description": "Work types of the business: id, name, pay category, leave category, short code. GET /business/{businessId}/worktype (OData).",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id"
],
"properties": {
"top": {
"type": "integer",
"maximum": 100,
"description": "Results per request, 1-100 (default 25; the API caps it at 100).",
"exclusiveMinimum": 0
},
"skip": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Results to skip (default 0). Pass the previous reply's next_skip."
},
"filter": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "OData v3 $filter. Property names are capitalised, e.g. \"Surname eq 'Smith'\", \"StartTime gt datetime'2026-04-01T00:00:00'\", \"DefaultSuperRate ne 9.5M\"."
},
"orderby": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "OData $orderby, e.g. \"Name\" or \"PayPeriodEnding desc\"."
},
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "List work types",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Gross-to-net report per employee: earnings by pay category, tax, deductions, super, net pay. Choose a date range (from_date + to_date) or one finalised pay run (pay_run_id). The report has no paging: at most 200 rows are returned (narrow with employee_id or location_id). GET /business/{businessId}/report/grosstonet.
| Parameter | Type | Description |
|---|---|---|
| to_date | string | End of the date range (yyyy-mm-dd). |
| from_date | string | Start of the date range (yyyy-mm-dd), with to_date. |
| pay_run_id | integer | A pay run id: report that pay run (then from_date/to_date are ignored). |
| business_id * | integer | Business id (from keypay_list_businesses). |
| employee_id | integer | Only this employee. |
| location_id | integer | Only this location. |
| pay_schedule_id | integer | Only this pay schedule. |
{
"name": "keypay_report_gross_to_net",
"title": "Gross to net report",
"description": "Gross-to-net report per employee: earnings by pay category, tax, deductions, super, net pay. Choose a date range (from_date + to_date) or one finalised pay run (pay_run_id). The report has no paging: at most 200 rows are returned (narrow with employee_id or location_id). GET /business/{businessId}/report/grosstonet.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id"
],
"properties": {
"to_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "End of the date range (yyyy-mm-dd)."
},
"from_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Start of the date range (yyyy-mm-dd), with to_date."
},
"pay_run_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "A pay run id: report that pay run (then from_date/to_date are ignored).",
"exclusiveMinimum": 0
},
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
},
"employee_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only this employee.",
"exclusiveMinimum": 0
},
"location_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only this location.",
"exclusiveMinimum": 0
},
"pay_schedule_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only this pay schedule.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Gross to net report",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}Leave balances of all employees as at a date, per leave category. The report has no paging: at most 200 rows are returned (narrow with location_id or leave_category_id). For one employee use keypay_get_leave_balances. GET /business/{businessId}/report/leavebalances.
| Parameter | Type | Description |
|---|---|---|
| as_at_date | string | Balances as at this date (yyyy-mm-dd); default today. |
| business_id * | integer | Business id (from keypay_list_businesses). |
| location_id | integer | Only this location. |
| leave_category_id | integer | Only this leave category. |
{
"name": "keypay_report_leave_balances",
"title": "Leave balances report",
"description": "Leave balances of all employees as at a date, per leave category. The report has no paging: at most 200 rows are returned (narrow with location_id or leave_category_id). For one employee use keypay_get_leave_balances. GET /business/{businessId}/report/leavebalances.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id"
],
"properties": {
"as_at_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Balances as at this date (yyyy-mm-dd); default today."
},
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
},
"location_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only this location.",
"exclusiveMinimum": 0
},
"leave_category_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only this leave category.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Leave balances report",
"readOnlyHint": true,
"openWorldHint": true,
"destructiveHint": false
}
}WRITE: approves a pending leave request (the employee is notified and the leave is applied to their pay). Check the request first with keypay_get_leave_request. Cannot be undone through this server. POST /business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId}/approve.
| Parameter | Type | Description |
|---|---|---|
| business_id * | integer | Business id (from keypay_list_businesses). |
| employee_id * | integer | Employee id. |
| leave_request_id * | integer | Leave request id. |
{
"name": "keypay_approve_leave_request",
"title": "Approve leave request",
"description": "WRITE: approves a pending leave request (the employee is notified and the leave is applied to their pay). Check the request first with keypay_get_leave_request. Cannot be undone through this server. POST /business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId}/approve.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id",
"employee_id",
"leave_request_id"
],
"properties": {
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
},
"employee_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Employee id.",
"exclusiveMinimum": 0
},
"leave_request_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Leave request id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Approve leave request",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}WRITE: declines a leave request, with an optional reason the employee sees. Check the request first with keypay_get_leave_request. POST /business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId}/decline.
| Parameter | Type | Description |
|---|---|---|
| reason | string | Reason shown to the employee. |
| business_id * | integer | Business id (from keypay_list_businesses). |
| employee_id * | integer | Employee id. |
| leave_request_id * | integer | Leave request id. |
{
"name": "keypay_decline_leave_request",
"title": "Decline leave request",
"description": "WRITE: declines a leave request, with an optional reason the employee sees. Check the request first with keypay_get_leave_request. POST /business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId}/decline.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"business_id",
"employee_id",
"leave_request_id"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 1000,
"minLength": 1,
"description": "Reason shown to the employee."
},
"business_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Business id (from keypay_list_businesses).",
"exclusiveMinimum": 0
},
"employee_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Employee id.",
"exclusiveMinimum": 0
},
"leave_request_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Leave request id.",
"exclusiveMinimum": 0
}
}
},
"annotations": {
"title": "Decline leave request",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}Tools for Employment Hero Payroll (KeyPay), hosted by usefulapi.io. If the user is new or asks what this server can do, suggest requests such as: "Show my latest pay run and its total gross and net wages."; "Which leave requests are still pending approval?"; "What is Jane Smith's annual leave balance?". Read-only tools never change data; ask the user before a tool that creates, changes or deletes Employment Hero Payroll (KeyPay) data. Free plan: 50 tool calls per month. Run keypay_usage_status to see the calls used this month. If the user asks for something none of these tools can do, tell the user and, with their OK, run keypay_request_feature to record the request. Paid plans: Pro (10,000 tool calls a month, $9/month or $90/year, for normal use) and Pro+ (100,000 tool calls a month, $39/month or $390/year, for automations and heavy use). A plan can be cancelled at any time and then runs to the end of the paid period, so it also suits a one-time job. When the user wants more calls or reaches the limit, run keypay_upgrade without a plan: it returns both plans, each with a payment link for the user to open. keypay_cancel_subscription cancels Pro at the end of the paid period.
Names, descriptions and schemas were written by the server and are shown as data.
Shared addresses on big platforms (Cloudflare, Vercel and the like) put unrelated servers together; those are marked shared_infrastructure. A match is a pivot, not a link between operators.