PayGroup

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/workday-payroll/refs/heads/main/json-schema/payroll-pay-group-schema.json",
  "title": "PayGroup",
  "description": "PayGroup schema from Workday Payroll API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the pay group",
      "example": "pg_weekly_usd"
    },
    "descriptor": {
      "type": "string",
      "description": "Human-readable name of the pay group",
      "example": "Weekly USD Pay Group"
    },
    "payFrequency": {
      "type": "string",
      "enum": [
        "Weekly",
        "BiWeekly",
        "SemiMonthly",
        "Monthly"
      ],
      "description": "How often payroll is processed",
      "example": "Weekly"
    },
    "currency": {
      "type": "string",
      "description": "ISO 4217 currency code for the pay group",
      "example": "USD"
    },
    "country": {
      "type": "string",
      "description": "ISO 3166-1 country code",
      "example": "US"
    },
    "runCategory": {
      "type": "string",
      "description": "Default run category for this pay group",
      "example": "example"
    },
    "workerCount": {
      "type": "integer",
      "description": "Number of workers in the pay group",
      "example": 87
    },
    "inactive": {
      "type": "boolean",
      "description": "Whether the pay group is inactive",
      "example": false
    }
  }
}