Workday Payroll · JSON Structure

Payroll Input Supplemental Earning Collection Structure

SupplementalEarningCollection schema from Workday Payroll Input API

Type: object Properties: 2

CompensationEnterpriseHuman ResourcesPayrollSaaSTax

SupplementalEarningCollection 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-input-supplemental-earning-collection-structure.json",
  "name": "SupplementalEarningCollection",
  "description": "SupplementalEarningCollection schema from Workday Payroll Input API",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/SupplementalEarning"
      }
    },
    "total": {
      "type": "int32",
      "description": "Total number of supplemental earnings",
      "example": 52
    }
  },
  "definitions": {
    "SupplementalEarning": {
      "name": "SupplementalEarning",
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique identifier for the supplemental earning",
          "example": "sup_20260430_00121"
        },
        "worker": {
          "$ref": "#/$defs/WorkerRef"
        },
        "earningCode": {
          "type": "string",
          "description": "Earning code for the supplemental earning",
          "example": "REGULAR"
        },
        "type": {
          "type": "string",
          "enum": [
            "Bonus",
            "Commission",
            "Stipend",
            "Allowance",
            "Other"
          ],
          "description": "Type of supplemental earning",
          "example": "Bonus"
        },
        "amount": {
          "type": "double",
          "description": "Earning amount",
          "example": 2500.0
        },
        "currency": {
          "type": "string",
          "description": "ISO 4217 currency code",
          "example": "USD"
        },
        "effectiveDate": {
          "type": "date",
          "description": "Effective date",
          "example": "2026-04-30"
        },
        "status": {
          "type": "string",
          "enum": [
            "Pending",
            "Approved",
            "Processed",
            "Rejected"
          ],
          "description": "Current status",
          "example": "Pending"
        },
        "reason": {
          "type": "string",
          "description": "Description or reason for the earning",
          "example": "Q1 2026 performance bonus"
        },
        "createdOn": {
          "type": "datetime",
          "description": "When the earning was submitted",
          "example": "2026-04-30T16:45:00Z"
        }
      }
    },
    "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"
        }
      }
    }
  }
}