Workday Payroll · JSON Structure

Payroll Results Worker Result Collection Structure

WorkerResultCollection schema from Workday Payroll Results API

Type: object Properties: 2

CompensationEnterpriseHuman ResourcesPayrollSaaSTax

WorkerResultCollection is a JSON Structure definition published by Workday Payroll, describing 2 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

data total

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/workday-payroll/refs/heads/main/json-structure/payroll-results-worker-result-collection-structure.json",
  "name": "WorkerResultCollection",
  "description": "WorkerResultCollection schema from Workday Payroll Results API",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/WorkerResult"
      }
    },
    "total": {
      "type": "int32",
      "description": "Total number of worker results",
      "example": 52
    }
  },
  "definitions": {
    "WorkerResult": {
      "name": "WorkerResult",
      "type": "object",
      "properties": {
        "worker": {
          "$ref": "#/$defs/WorkerRef"
        },
        "grossPay": {
          "type": "double",
          "description": "Worker gross pay for this run",
          "example": 1.0
        },
        "netPay": {
          "type": "double",
          "description": "Worker net pay for this run",
          "example": 1.0
        },
        "totalEarnings": {
          "type": "double",
          "description": "Total earnings",
          "example": 5240.0
        },
        "totalDeductions": {
          "type": "double",
          "description": "Total deductions",
          "example": 38210.8
        },
        "totalTaxes": {
          "type": "double",
          "description": "Total taxes withheld",
          "example": 29167.4
        },
        "currency": {
          "type": "string",
          "description": "ISO 4217 currency code",
          "example": "USD"
        },
        "paymentMethod": {
          "type": "string",
          "enum": [
            "DirectDeposit",
            "Check",
            "Wire"
          ],
          "description": "Method of payment",
          "example": "DirectDeposit"
        }
      }
    },
    "WorkerRef": {
      "name": "WorkerRef",
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Worker identifier",
          "example": "w_100542"
        },
        "descriptor": {
          "type": "string",
          "description": "Worker display name",
          "example": "Weekly USD Pay Group"
        }
      }
    }
  }
}