Workday Payroll · JSON Structure

Payroll Input Input Batch Structure

InputBatch schema from Workday Payroll Input API

Type: object Properties: 9
CompensationEnterpriseHuman ResourcesPayrollSaaSTax

InputBatch is a JSON Structure definition published by Workday Payroll, describing 9 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name status recordCount validRecords failedRecords submittedOn completedOn submittedBy

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/workday-payroll/refs/heads/main/json-structure/payroll-input-input-batch-structure.json",
  "name": "InputBatch",
  "description": "InputBatch schema from Workday Payroll Input API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the input batch",
      "example": "ib_20260428_00007"
    },
    "name": {
      "type": "string",
      "description": "Batch name",
      "example": "April 2026 Bonus Batch"
    },
    "status": {
      "type": "string",
      "enum": [
        "Pending",
        "Validating",
        "Validated",
        "Processing",
        "Completed",
        "Failed"
      ],
      "description": "Current batch status",
      "example": "Pending"
    },
    "recordCount": {
      "type": "int32",
      "description": "Number of records in the batch",
      "example": 100
    },
    "validRecords": {
      "type": "int32",
      "description": "Number of records that passed validation",
      "example": 98
    },
    "failedRecords": {
      "type": "int32",
      "description": "Number of records that failed validation",
      "example": 2
    },
    "submittedOn": {
      "type": "datetime",
      "description": "When the batch was submitted",
      "example": "2026-04-30T16:45:00Z"
    },
    "completedOn": {
      "type": "datetime",
      "description": "When batch processing completed",
      "example": "2026-04-30T16:45:00Z"
    },
    "submittedBy": {
      "type": "string",
      "description": "User who submitted the batch",
      "example": "payroll.admin@example.com"
    }
  }
}