Workday Payroll · Schema

PaymentElection

PaymentElection schema from Workday Payroll Results API

CompensationEnterpriseHuman ResourcesPayrollSaaSTax

Properties

Name Type Description
id string Unique identifier for the payment election
order integer Priority order of the election
distributionType string How payment is distributed
amount number Fixed amount (when distributionType is Amount)
percentage number Percentage of net pay (when distributionType is Percentage)
accountType string Bank account type
bankName string Financial institution name
lastFourDigits string Last four digits of account number
currency string ISO 4217 currency code
active boolean Whether this election is currently active
View JSON Schema on GitHub

JSON Schema

payroll-results-payment-election-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-results-payment-election-schema.json",
  "title": "PaymentElection",
  "description": "PaymentElection schema from Workday Payroll Results API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the payment election",
      "example": "pe_w100542_primary"
    },
    "order": {
      "type": "integer",
      "description": "Priority order of the election",
      "example": 1
    },
    "distributionType": {
      "type": "string",
      "enum": [
        "Amount",
        "Percentage",
        "Remainder"
      ],
      "description": "How payment is distributed",
      "example": "Amount"
    },
    "amount": {
      "type": "number",
      "format": "double",
      "description": "Fixed amount (when distributionType is Amount)",
      "example": 2500.0
    },
    "percentage": {
      "type": "number",
      "format": "double",
      "description": "Percentage of net pay (when distributionType is Percentage)",
      "example": 100.0
    },
    "accountType": {
      "type": "string",
      "enum": [
        "Checking",
        "Savings"
      ],
      "description": "Bank account type",
      "example": "Checking"
    },
    "bankName": {
      "type": "string",
      "description": "Financial institution name",
      "example": "Wells Fargo"
    },
    "lastFourDigits": {
      "type": "string",
      "description": "Last four digits of account number",
      "example": "4521"
    },
    "currency": {
      "type": "string",
      "description": "ISO 4217 currency code",
      "example": "USD"
    },
    "active": {
      "type": "boolean",
      "description": "Whether this election is currently active",
      "example": true
    }
  }
}