Workday Payroll · Schema

CreateInputBatchRequest

CreateInputBatchRequest schema from Workday Payroll Input API

CompensationEnterpriseHuman ResourcesPayrollSaaSTax

Properties

Name Type Description
name string Batch name
records array Input records to process
View JSON Schema on GitHub

JSON Schema

payroll-input-create-input-batch-request-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-create-input-batch-request-schema.json",
  "title": "CreateInputBatchRequest",
  "description": "CreateInputBatchRequest schema from Workday Payroll Input API",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Batch name",
      "example": "April 2026 Bonus Batch"
    },
    "records": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/InputRecord"
      },
      "description": "Input records to process"
    }
  },
  "required": [
    "name",
    "records"
  ],
  "$defs": {
    "InputRecord": {
      "type": "object",
      "properties": {
        "workerId": {
          "type": "string",
          "description": "Worker identifier",
          "example": "w_100542"
        },
        "inputType": {
          "type": "string",
          "enum": [
            "Earning",
            "Deduction",
            "TimeOff"
          ],
          "description": "Type of input record",
          "example": "Earning"
        },
        "earningCode": {
          "type": "string",
          "description": "Earning code (for Earning type)",
          "example": "REGULAR"
        },
        "deductionCode": {
          "type": "string",
          "description": "Deduction code (for Deduction type)",
          "example": "MEDICAL_PRETAX"
        },
        "amount": {
          "type": "number",
          "format": "double",
          "description": "Amount",
          "example": 2500.0
        },
        "hours": {
          "type": "number",
          "format": "double",
          "description": "Hours (for time-based entries)",
          "example": 40.0
        },
        "effectiveDate": {
          "type": "string",
          "format": "date",
          "description": "Effective date",
          "example": "2026-04-30"
        }
      },
      "required": [
        "workerId",
        "inputType"
      ]
    }
  }
}