CreateSupplementalEarningRequest

CreateSupplementalEarningRequest schema from Workday Payroll Input API

CompensationEnterpriseHuman ResourcesPayrollSaaSTax

Properties

Name	Type	Description
workerId	string	Worker identifier
earningCode	string	Earning code
type	string	Type of supplemental earning
amount	number	Earning amount
currency	string	ISO 4217 currency code
effectiveDate	string	Effective date
reason	string	Description or reason

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-input-create-supplemental-earning-request-schema.json",
  "title": "CreateSupplementalEarningRequest",
  "description": "CreateSupplementalEarningRequest schema from Workday Payroll Input API",
  "type": "object",
  "properties": {
    "workerId": {
      "type": "string",
      "description": "Worker identifier",
      "example": "w_100542"
    },
    "earningCode": {
      "type": "string",
      "description": "Earning code",
      "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"
    },
    "reason": {
      "type": "string",
      "description": "Description or reason",
      "example": "Q1 2026 performance bonus"
    }
  },
  "required": [
    "workerId",
    "earningCode",
    "amount"
  ]
}