Servers Playground How we check Submit a server

Employment Hero Payroll MCP by usefulapi

Working · 584 ms

io.usefulapi/keypayv1.1.0 Domain verified

Read Employment Hero Payroll pay runs, payslips, timesheets and leave; approve or decline leave.

Finance & Payments

Source Website Registry entry

Try it

Call this server's tools from your browser. Nothing to install.

https://keypay.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

keypay_approve_leave_request

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.

business_idinteger, required

Business id (from keypay_list_businesses).

employee_idinteger, required

Employee id.

leave_request_idinteger, required

Leave request id.

The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.

I understand, run it anyway

Employment Hero Payroll MCP by usefulapi MCP server | mcptry

Tools (26)

keypay_approve_leave_request

destructive

Argument	Type	Description
business_id*	integer	Business id (from keypay_list_businesses).
employee_id*	integer	Employee id.
leave_request_id*	integer	Leave request id.

Input schema (JSON)

{
  "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
    }
  }
}

keypay_decline_leave_request

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.

destructive

Argument	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.

Input schema (JSON)

{
  "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
    }
  }
}

keypay_get_business

One business by id: name, legal name, contact, address, ABN/company details, leave year, standard hours, pay cycle. GET /business/{businessId}.

read-only

Argument	Type	Description
business_id*	integer	Business id (from keypay_list_businesses).

Input schema (JSON)

{
  "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
    }
  }
}

keypay_get_employee

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}.

read-only

Argument	Type	Description
business_id*	integer	Business id (from keypay_list_businesses).
employee_id*	integer	Employee id (from keypay_list_employees).

Input schema (JSON)

{
  "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
    }
  }
}

keypay_get_leave_balances

An employee's leave balances per leave category (accrued amount and unit), optionally as at a date. GET /business/{businessId}/employee/{employeeId}/leavebalances.

read-only

Argument	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.

Input schema (JSON)

{
  "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
    }
  }
}

keypay_get_leave_request

One leave request: employee, category, dates, hours, status, notes. GET /business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId}.

read-only

Argument	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).

Input schema (JSON)

{
  "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
    }
  }
}

keypay_get_pay_run

One pay run by id: pay schedule, period, date paid, whether it is finalised, notation. GET /business/{businessId}/payrun/{payRunId}.

read-only

Argument	Type	Description
pay_run_id*	integer	Pay run id (from keypay_list_pay_runs).
business_id*	integer	Business id (from keypay_list_businesses).

Input schema (JSON)

{
  "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
    }
  }
}

keypay_get_pay_run_payslips

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.

read-only

Argument	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).

Input schema (JSON)

{
  "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)."
    }
  }
}

keypay_get_pay_run_summary

One pay run with its total hours, gross wages and net wages. GET /business/{businessId}/payrun/{payRunId}/summary.

read-only

Argument	Type	Description
pay_run_id*	integer	Pay run id.
business_id*	integer	Business id (from keypay_list_businesses).

Input schema (JSON)

{
  "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
    }
  }
}

keypay_get_pay_run_totals

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.

read-only

Argument	Type	Description
pay_run_id*	integer	Pay run id.
business_id*	integer	Business id (from keypay_list_businesses).

Input schema (JSON)

{
  "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
    }
  }
}

keypay_get_timesheet

One timesheet line by id. GET /business/{businessId}/timesheet/{timesheetLineId}.

read-only

Argument	Type	Description
business_id*	integer	Business id (from keypay_list_businesses).
timesheet_id*	integer	Timesheet line id (from keypay_list_timesheets).

Input schema (JSON)

{
  "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
    }
  }
}

keypay_get_user

The Employment Hero Payroll user this API key belongs to: id, email, display name and time zone. GET /user.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

keypay_list_businesses

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).

read-only

Argument	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".

Input schema (JSON)

{
  "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\"."
    }
  }
}

keypay_list_employees

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).

read-only

Argument	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).

Input schema (JSON)

{
  "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
    }
  }
}

keypay_list_leave_categories

Leave categories of the business (annual, personal/sick, long service...): id, name, unit type, accrual rule. GET /business/{businessId}/leavecategory (OData).

read-only

Argument	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).

Input schema (JSON)

{
  "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
    }
  }
}

keypay_list_leave_requests

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.

read-only

Argument	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).

Input schema (JSON)

{
  "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
    }
  }
}

keypay_list_locations

Locations of the business (sites, departments): id, name, parent, fully qualified name, state. GET /business/{businessId}/location (OData).

read-only

Argument	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).

Input schema (JSON)

{
  "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
    }
  }
}

keypay_list_pay_categories

Pay categories (earnings types) of the business: id, name, rate unit, loadings, super rate, whether leave accrues. GET /business/{businessId}/paycategory (OData).

read-only

Argument	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).

Input schema (JSON)

{
  "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
    }
  }
}

keypay_list_pay_run_summaries

Pay runs with their totals: total hours, gross wages and net wages, plus the usual pay run fields. GET /business/{businessId}/payrun/summary (OData).

read-only

Argument	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).

Input schema (JSON)

{
  "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
    }
  }
}

keypay_list_pay_run_warnings

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.

read-only

Argument	Type	Description
pay_run_id*	integer	Pay run id.
business_id*	integer	Business id (from keypay_list_businesses).

Input schema (JSON)

{
  "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
    }
  }
}

keypay_list_pay_runs

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).

read-only

Argument	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).

Input schema (JSON)

{
  "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
    }
  }
}

keypay_list_pay_schedules

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).

read-only

Argument	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).

Input schema (JSON)

{
  "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
    }
  }
}

keypay_list_timesheets

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).

read-only

Argument	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).

Input schema (JSON)

{
  "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
    }
  }
}

keypay_list_work_types

Work types of the business: id, name, pay category, leave category, short code. GET /business/{businessId}/worktype (OData).

read-only

Argument	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).

Input schema (JSON)

{
  "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
    }
  }
}

keypay_report_gross_to_net

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.

read-only

Argument	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.

Input schema (JSON)

{
  "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
    }
  }
}

keypay_report_leave_balances

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.

read-only

Argument	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.

Input schema (JSON)

{
  "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
    }
  }
}