Workday Payroll · Schema

AdjustmentCollection

AdjustmentCollection schema from Workday Payroll Input API

CompensationEnterpriseHuman ResourcesPayrollSaaSTax

Properties

Name Type Description
data array
total integer Total number of adjustments
View JSON Schema on GitHub

JSON Schema

payroll-input-adjustment-collection-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-adjustment-collection-schema.json",
  "title": "AdjustmentCollection",
  "description": "AdjustmentCollection schema from Workday Payroll Input API",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Adjustment"
      }
    },
    "total": {
      "type": "integer",
      "description": "Total number of adjustments",
      "example": 52
    }
  },
  "$defs": {
    "Adjustment": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique identifier for the adjustment",
          "example": "adj_20260415_00012"
        },
        "worker": {
          "$ref": "#/$defs/WorkerRef"
        },
        "adjustmentType": {
          "type": "string",
          "enum": [
            "Correction",
            "Retroactive",
            "Reversal",
            "Reclass"
          ],
          "description": "Type of adjustment",
          "example": "Correction"
        },
        "originalPayRunId": {
          "type": "string",
          "description": "Reference to the original pay run being adjusted",
          "example": "pr_20260430_weekly_001"
        },
        "earningCode": {
          "type": "string",
          "description": "Earning code affected",
          "example": "REGULAR"
        },
        "deductionCode": {
          "type": "string",
          "description": "Deduction code affected",
          "example": "MEDICAL_PRETAX"
        },
        "amount": {
          "type": "number",
          "format": "double",
          "description": "Adjustment amount (positive or negative)",
          "example": 2500.0
        },
        "currency": {
          "type": "string",
          "description": "ISO 4217 currency code",
          "example": "USD"
        },
        "reason": {
          "type": "string",
          "description": "Reason for the adjustment",
          "example": "Q1 2026 performance bonus"
        },
        "effectiveDate": {
          "type": "string",
          "format": "date",
          "description": "Effective date of the adjustment",
          "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 adjustment was created",
          "example": "2026-04-30T16:45:00Z"
        }
      }
    },
    "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"
        }
      }
    }
  }
}