Workday Payroll · Schema

OneTimePayment

OneTimePayment schema from Workday Payroll Input API

CompensationEnterpriseHuman ResourcesPayrollSaaSTax

Properties

Name Type Description
id string Unique identifier for the one-time payment
worker object
earningCode string Earning code for the payment
amount number Payment amount
currency string ISO 4217 currency code
reason string Reason for the one-time payment
effectiveDate string Effective date for the payment
status string Current status
createdOn string When the request was created
submittedBy string User who submitted the request
View JSON Schema on GitHub

JSON Schema

payroll-input-one-time-payment-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-one-time-payment-schema.json",
  "title": "OneTimePayment",
  "description": "OneTimePayment schema from Workday Payroll Input API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the one-time payment",
      "example": "pmt_20260502_00045"
    },
    "worker": {
      "$ref": "#/$defs/WorkerRef"
    },
    "earningCode": {
      "type": "string",
      "description": "Earning code for the payment",
      "example": "REGULAR"
    },
    "amount": {
      "type": "number",
      "format": "double",
      "description": "Payment amount",
      "example": 2500.0
    },
    "currency": {
      "type": "string",
      "description": "ISO 4217 currency code",
      "example": "USD"
    },
    "reason": {
      "type": "string",
      "description": "Reason for the one-time payment",
      "example": "Q1 2026 performance bonus"
    },
    "effectiveDate": {
      "type": "string",
      "format": "date",
      "description": "Effective date for the payment",
      "example": "2026-04-30"
    },
    "status": {
      "type": "string",
      "enum": [
        "Pending",
        "Approved",
        "Processed",
        "Rejected"
      ],
      "description": "Current status",
      "example": "Pending"
    },
    "createdOn": {
      "type": "string",
      "format": "date-time",
      "description": "When the request was created",
      "example": "2026-04-30T16:45:00Z"
    },
    "submittedBy": {
      "type": "string",
      "description": "User who submitted the request",
      "example": "[email protected]"
    }
  },
  "$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"
        }
      }
    }
  }
}