PayRun

PayRun schema from Workday Payroll API

CompensationEnterpriseHuman ResourcesPayrollSoftware-as-a-ServiceTax

Properties

Name	Type	Description
id	string	Unique identifier for the pay run
descriptor	string	Human-readable name of the pay run
payGroup	object
payPeriod	object
status	string	Current status of the pay run
runCategory	string	Category of the pay run
paymentDate	string	Date payments will be distributed
totalGrossPay	number	Total gross pay for the pay run
totalNetPay	number	Total net pay for the pay run
totalDeductions	number	Total deductions for the pay run
totalTaxes	number	Total tax withholdings for the pay run
workerCount	integer	Number of workers included in the pay run
currency	string	ISO 4217 currency code
createdOn	string	When the pay run was created
completedOn	string	When the pay run was completed

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/workday-payroll/refs/heads/main/json-schema/payroll-pay-run-schema.json",
  "title": "PayRun",
  "description": "PayRun schema from Workday Payroll API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the pay run",
      "example": "pr_20260430_weekly_001"
    },
    "descriptor": {
      "type": "string",
      "description": "Human-readable name of the pay run",
      "example": "Weekly USD Pay Group"
    },
    "payGroup": {
      "$ref": "#/$defs/PayGroupRef"
    },
    "payPeriod": {
      "$ref": "#/$defs/PayPeriod"
    },
    "status": {
      "type": "string",
      "enum": [
        "Draft",
        "InProgress",
        "Completed",
        "Cancelled"
      ],
      "description": "Current status of the pay run",
      "example": "Draft"
    },
    "runCategory": {
      "type": "string",
      "enum": [
        "Regular",
        "OffCycle",
        "OnDemand"
      ],
      "description": "Category of the pay run",
      "example": "Regular"
    },
    "paymentDate": {
      "type": "string",
      "format": "date",
      "description": "Date payments will be distributed",
      "example": "2026-04-30"
    },
    "totalGrossPay": {
      "type": "number",
      "format": "double",
      "description": "Total gross pay for the pay run",
      "example": 245830.5
    },
    "totalNetPay": {
      "type": "number",
      "format": "double",
      "description": "Total net pay for the pay run",
      "example": 178452.3
    },
    "totalDeductions": {
      "type": "number",
      "format": "double",
      "description": "Total deductions for the pay run",
      "example": 38210.8
    },
    "totalTaxes": {
      "type": "number",
      "format": "double",
      "description": "Total tax withholdings for the pay run",
      "example": 29167.4
    },
    "workerCount": {
      "type": "integer",
      "description": "Number of workers included in the pay run",
      "example": 87
    },
    "currency": {
      "type": "string",
      "description": "ISO 4217 currency code",
      "example": "USD"
    },
    "createdOn": {
      "type": "string",
      "format": "date-time",
      "description": "When the pay run was created",
      "example": "2026-04-30T16:45:00Z"
    },
    "completedOn": {
      "type": "string",
      "format": "date-time",
      "description": "When the pay run was completed",
      "example": "2026-04-30T16:45:00Z"
    }
  },
  "$defs": {
    "PayPeriod": {
      "type": "object",
      "properties": {
        "startDate": {
          "type": "string",
          "format": "date",
          "description": "Start date of the pay period",
          "example": "2026-04-30"
        },
        "endDate": {
          "type": "string",
          "format": "date",
          "description": "End date of the pay period",
          "example": "2026-04-30"
        }
      }
    },
    "PayGroupRef": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Pay group identifier",
          "example": "pg_weekly_usd"
        },
        "descriptor": {
          "type": "string",
          "description": "Pay group display name",
          "example": "Weekly USD Pay Group"
        }
      }
    }
  }
}

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/payroll-pay-run"

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.