CreatePayRunRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/workday-payroll/refs/heads/main/json-schema/payroll-create-pay-run-request-schema.json",
  "title": "CreatePayRunRequest",
  "description": "CreatePayRunRequest schema from Workday Payroll API",
  "type": "object",
  "properties": {
    "payGroupId": {
      "type": "string",
      "description": "Identifier of the pay group for this run",
      "example": "pg_weekly_usd"
    },
    "payPeriod": {
      "$ref": "#/$defs/PayPeriod"
    },
    "runCategory": {
      "type": "string",
      "enum": [
        "Regular",
        "OffCycle",
        "OnDemand"
      ],
      "default": "Regular",
      "description": "Category of the pay run",
      "example": "Regular"
    },
    "paymentDate": {
      "type": "string",
      "format": "date",
      "description": "Desired payment date",
      "example": "2026-04-30"
    }
  },
  "required": [
    "payGroupId",
    "payPeriod"
  ],
  "$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"
        }
      }
    }
  }
}