Workday Payroll · JSON Structure

Payroll Input Input Batch Collection Structure

InputBatchCollection schema from Workday Payroll Input API

Type: object Properties: 2

CompensationEnterpriseHuman ResourcesPayrollSaaSTax

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

Properties

data total

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

JSON Structure

{
  "$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-collection-structure.json",
  "name": "InputBatchCollection",
  "description": "InputBatchCollection schema from Workday Payroll Input API",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/InputBatch"
      }
    },
    "total": {
      "type": "int32",
      "description": "Total number of input batches",
      "example": 52
    }
  },
  "definitions": {
    "InputBatch": {
      "name": "InputBatch",
      "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"
        }
      }
    }
  }
}