Workday Payroll · Schema

SupplementalEarning

SupplementalEarning schema from Workday Payroll Input API

CompensationEnterpriseHuman ResourcesPayrollSaaSTax

Properties

Name Type Description
id string Unique identifier for the supplemental earning
worker object
earningCode string Earning code for the supplemental earning
type string Type of supplemental earning
amount number Earning amount
currency string ISO 4217 currency code
effectiveDate string Effective date
status string Current status
reason string Description or reason for the earning
createdOn string When the earning was submitted
View JSON Schema on GitHub

JSON Schema

payroll-input-supplemental-earning-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/workday-payroll/refs/heads/main/json-schema/payroll-input-supplemental-earning-schema.json",
  "title": "SupplementalEarning",
  "description": "SupplementalEarning schema from Workday Payroll Input API",
  "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": "number",
      "format": "double",
      "description": "Earning amount",
      "example": 2500.0
    },
    "currency": {
      "type": "string",
      "description": "ISO 4217 currency code",
      "example": "USD"
    },
    "effectiveDate": {
      "type": "string",
      "format": "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": "string",
      "format": "date-time",
      "description": "When the earning was submitted",
      "example": "2026-04-30T16:45:00Z"
    }
  },
  "$defs": {
    "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"
        }
      }
    }
  }
}