Xero · Schema

PayRun

AccountingBank FeedsFinanceFinancial-ServicesInvoicingPayrollSmall Business

Properties

Name	Type	Description
PayrollCalendarID	string	Xero identifier for pay run
PayRunID	string	Xero identifier for pay run
PayRunPeriodStartDate	string	Period Start Date for the PayRun (YYYY-MM-DD)
PayRunPeriodEndDate	string	Period End Date for the PayRun (YYYY-MM-DD)
PayRunStatus	object
PaymentDate	string	Payment Date for the PayRun (YYYY-MM-DD)
PayslipMessage	string	Payslip message for the PayRun
UpdatedDateUTC	string	Last modified timestamp
Payslips	array	The payslips in the payrun
Wages	number	The total Wages for the Payrun
Deductions	number	The total Deductions for the Payrun
Tax	number	The total Tax for the Payrun
Super	number	The total Super for the Payrun
Reimbursement	number	The total Reimbursements for the Payrun
NetPay	number	The total NetPay for the Payrun
ValidationErrors	array	Displays array of validation error messages from the API

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PayRun",
  "title": "PayRun",
  "type": "object",
  "required": [
    "PayrollCalendarID"
  ],
  "properties": {
    "PayrollCalendarID": {
      "description": "Xero identifier for pay run",
      "type": "string",
      "format": "uuid",
      "example": "bfac31bd-ea62-4fc8-a5e7-7965d9504b15"
    },
    "PayRunID": {
      "description": "Xero identifier for pay run",
      "type": "string",
      "format": "uuid",
      "example": "bba1d10f-63b1-4692-b5c5-a99f869523a4"
    },
    "PayRunPeriodStartDate": {
      "description": "Period Start Date for the PayRun (YYYY-MM-DD)",
      "type": "string",
      "x-is-msdate": true,
      "example": "/Date(322560000000+0000)/"
    },
    "PayRunPeriodEndDate": {
      "description": "Period End Date for the PayRun (YYYY-MM-DD)",
      "type": "string",
      "x-is-msdate": true,
      "example": "/Date(322560000000+0000)/"
    },
    "PayRunStatus": {
      "$ref": "#/components/schemas/PayRunStatus"
    },
    "PaymentDate": {
      "description": "Payment Date for the PayRun (YYYY-MM-DD)",
      "type": "string",
      "x-is-msdate": true,
      "example": "/Date(322560000000+0000)/"
    },
    "PayslipMessage": {
      "description": "Payslip message for the PayRun",
      "type": "string",
      "example": "Thanks for being awesome"
    },
    "UpdatedDateUTC": {
      "description": "Last modified timestamp",
      "type": "string",
      "readOnly": true,
      "x-is-msdate-time": true,
      "example": "/Date(1583967733054+0000)/"
    },
    "Payslips": {
      "description": "The payslips in the payrun",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PayslipSummary"
      }
    },
    "Wages": {
      "description": "The total Wages for the Payrun",
      "type": "number",
      "format": "double",
      "x-is-money": true,
      "example": 1060.5
    },
    "Deductions": {
      "description": "The total Deductions for the Payrun",
      "type": "number",
      "format": "double",
      "x-is-money": true,
      "example": 0.0
    },
    "Tax": {
      "description": "The total Tax for the Payrun",
      "type": "number",
      "format": "double",
      "x-is-money": true,
      "example": 198.0
    },
    "Super": {
      "description": "The total Super for the Payrun",
      "type": "number",
      "format": "double",
      "x-is-money": true,
      "example": 75.6
    },
    "Reimbursement": {
      "description": "The total Reimbursements for the Payrun",
      "type": "number",
      "format": "double",
      "x-is-money": true,
      "example": 0.0
    },
    "NetPay": {
      "description": "The total NetPay for the Payrun",
      "type": "number",
      "format": "double",
      "x-is-money": true,
      "example": 862.5
    },
    "ValidationErrors": {
      "description": "Displays array of validation error messages from the API",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ValidationError"
      }
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
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 JSON Schema

curl "https://apis.io/api/v1/json-schemas/xero-payrun"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

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