Xero

Xero PayrollUk API

The PayrollUk API from Xero — 47 operation(s) for payrolluk.

GitHub OpenAPI
Business capability
HR Operations Management BC-300.70

Operations 69

GET /Employees Retrieves employees #
POST /Employees Creates employees #
GET /Employees/{EmployeeID} Retrieves specific employees by using a unique employee ID #
PUT /Employees/{EmployeeID} Updates a specific employee's detail #
POST /Employees/{EmployeeID}/Employment Creates employment detail for a specific employee using a unique employee ID #
GET /Employees/{EmployeeID}/Tax Retrieves tax records for a specific employee using a unique employee ID #
GET /Employees/{EmployeeID}/ukopeningbalances Retrieves a specific employee's openingbalances using a unique employee ID #
POST /Employees/{EmployeeID}/ukopeningbalances Creates an opening balance for a specific employee #
PUT /Employees/{EmployeeID}/ukopeningbalances Updates a specific employee's opening balances #
GET /Employees/{EmployeeID}/Leave Retrieves a specific employee's leave records using a unique employee ID #
POST /Employees/{EmployeeID}/Leave Creates leave records for a specific employee #
GET /Employees/{EmployeeID}/Leave/{LeaveID} Retrieves a specific employee's leave record using a unique employee ID #
PUT /Employees/{EmployeeID}/Leave/{LeaveID} Updates a specific employee's leave records #
DELETE /Employees/{EmployeeID}/Leave/{LeaveID} Deletes a specific employee's leave record #
GET /Employees/{EmployeeID}/LeaveBalances Retrieves a specific employee's leave balances using a unique employee ID #
GET /Employees/{EmployeeID}/StatutoryLeaveBalance Retrieves a specific employee's leave balances using a unique employee ID #
GET /StatutoryLeaves/Summary/{EmployeeID} Retrieves a specific employee's summary of statutory leaves using a unique… #
POST /StatutoryLeaves/Sick Creates statutory sick leave records #
GET /StatutoryLeaves/Sick/{StatutorySickLeaveID} Retrieves a statutory sick leave for an employee #
GET /Employees/{EmployeeID}/LeavePeriods Retrieves a specific employee's leave periods using a unique employee ID #
GET /Employees/{EmployeeID}/LeaveTypes Retrieves a specific employee's leave types using a unique employee ID #
POST /Employees/{EmployeeID}/LeaveTypes Creates employee leave type records #
GET /Employees/{EmployeeID}/PaymentMethods Retrieves a specific employee's payment method using a unique employee ID #
POST /Employees/{EmployeeID}/PaymentMethods Creates an employee payment method #
GET /Employees/{EmployeeID}/PayTemplates Retrieves a specific employee pay templates using a unique employee ID #
POST /Employees/{EmployeeID}/PayTemplates/earnings Creates an earnings template records for a specific employee #
PUT /Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID} Updates a specific employee's earnings template records #
DELETE /Employees/{EmployeeID}/PayTemplates/earnings/{PayTemplateEarningID} Deletes a specific employee's earnings template record #
POST /Employees/{EmployeeID}/paytemplateearnings Creates multiple earnings template records for a specific employee using a… #
GET /Benefits Retrieves employee benefits #
POST /Benefits Creates a new employee benefit #
GET /Benefits/{id} Retrieves a specific benefit by using a unique benefit ID #
GET /Deductions Retrieves deductions #
POST /Deductions Creates a new deduction #
GET /Deductions/{deductionId} Retrieves a specific deduction by using a unique deduction ID #
GET /EarningsOrders Retrieves earnings orders #
GET /EarningsOrders/{id} Retrieves a specific earnings orders by using a unique earnings orders id #
GET /EarningsRates Retrieves earnings rates #
POST /EarningsRates Creates a new earnings rate #
GET /EarningsRates/{EarningsRateID} Retrieves a specific earnings rates by using a unique earnings rate id #
GET /LeaveTypes Retrieves leave types #
POST /LeaveTypes Creates a new leave type #
GET /LeaveTypes/{LeaveTypeID} Retrieves a specific leave type by using a unique leave type ID #
GET /Reimbursements Retrieves reimbursements #
POST /Reimbursements Creates a new reimbursement #
GET /Reimbursements/{ReimbursementID} Retrieves a specific reimbursement by using a unique reimbursement id #
GET /Timesheets Retrieves timesheets #
POST /Timesheets Creates a new timesheet #
GET /Timesheets/{TimesheetID} Retrieve a specific timesheet by using a unique timesheet ID #
DELETE /Timesheets/{TimesheetID} Deletes a specific timesheet #
POST /Timesheets/{TimesheetID}/Lines Creates a new timesheet line for a specific timesheet using a unique timesheet… #
POST /Timesheets/{TimesheetID}/Approve Approves a specific timesheet #
POST /Timesheets/{TimesheetID}/RevertToDraft Reverts a specific timesheet to draft #
PUT /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} Updates a specific timesheet line for a specific timesheet #
DELETE /Timesheets/{TimesheetID}/Lines/{TimesheetLineID} Deletes a specific timesheet line #
GET /PayRunCalendars Retrieves payrun calendars #
POST /PayRunCalendars Creates a new payrun calendar #
GET /PayRunCalendars/{PayRunCalendarID} Retrieves a specific payrun calendar by using a unique payrun calendar ID #
GET /Employees/{EmployeeID}/SalaryAndWages Retrieves a specific employee's salary and wages by using a unique employee ID #
POST /Employees/{EmployeeID}/SalaryAndWages Creates a salary and wage record for a specific employee #
GET /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID} Retrieves a specific salary and wages record for a specific employee using a… #
PUT /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID} Updates salary and wages record for a specific employee #
DELETE /Employees/{EmployeeID}/SalaryAndWages/{SalaryAndWagesID} Deletes a salary and wages record for a specific employee #
GET /PayRuns Retrieves pay runs #
GET /PayRuns/{PayRunID} Retrieves a specific pay run by using a unique pay run ID #
GET /Payslips Retrieves payslips #
GET /Payslips/{PayslipID} Retrieves a specific payslip by using a unique payslip ID #
GET /Settings Retrieves payroll settings #
GET /Settings/trackingCategories Retrieves tracking categories #

Documentation

📖
Documentation
https://developer.xero.com/documentation/api/accounting/overview
📖
Documentation
https://developer.xero.com/documentation/api/assets/overview
📖
Documentation
https://developer.xero.com/documentation/api/bank-feeds/overview
📖
Documentation
https://developer.xero.com/documentation/api/finance/overview
📖
Documentation
https://developer.xero.com/documentation/guides/oauth2/overview/
📖
Documentation
https://developer.xero.com/documentation/api/payroll-au/overview
📖
Documentation
https://developer.xero.com/documentation/api/payroll-nz/overview
📖
Documentation
https://developer.xero.com/documentation/api/payroll-uk/overview
📖
Documentation
https://developer.xero.com/documentation/api/projects/overview
📖
Documentation
https://developer.xero.com/documentation/api/files/overview

Specifications

⚙
OpenAPI
https://artifacts.apis.io/xero/openapi/xero-payrolluk-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/master/xero-payroll-uk.yaml
⚙
AsyncAPI
https://artifacts.apis.io/xero/asyncapi/xero-webhooks-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/xero/json-schema/xero-employee-statutory-sick-leave-schema.json
📊
JSONSchema
https://artifacts.apis.io/xero/json-schema/xero-employee-schema.json
📊
JSONSchema
https://artifacts.apis.io/xero/json-schema/xero-earnings-rate-schema.json
📊
JSONSchema
https://artifacts.apis.io/xero/json-schema/xero-deduction-schema.json
📊
JSONSchema
https://artifacts.apis.io/xero/json-schema/xero-benefit-schema.json
📊
JSONSchema
https://artifacts.apis.io/xero/json-schema/xero-salary-and-wage-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/xero:xero-payrolluk-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

xero-payrolluk-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 12.0.2
  title: Xero Payroll Uk API
  description: This is the Xero Payroll API for orgs in the UK region.
  termsOfService: https://developer.xero.com/xero-developer-platform-terms-conditions/
  contact:
    name: Xero Platform Team
    email: api@xero.com
    url: https://developer.xero.com
servers:
- description: Xero Payroll UK API
  url: https://api.xero.com/payroll.xro/2.0
tags:


# --- truncated at 32 KB (249 KB total) ---
# Full source: https://artifacts.apis.io/xero/openapi/xero-payrolluk-api-openapi.yml