eedm.pay-classes.v12.1.0.pay-classes.json Maven / Gradle / Ivy

Go to download
{
  "title" : "Pay Classes",
  "description" : "The standard method of paying employees.",
  "version" : "12.1.0",
  "type" : "object",
  "properties" : {
    "metadata" : {
      "$ref" : "resource:/eedm/metadata.json"
    },
    "id" : {
      "title" : "ID",
      "description" : "The global identifier of the pay class.",
      "type" : "string",
      "format" : "guid",
      "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
    },
    "title" : {
      "title" : "Title",
      "description" : "The full name of the pay class.",
      "type" : "string",
      "minLength" : 1
    },
    "description" : {
      "title" : "Description",
      "description" : "The description of the pay class.",
      "type" : "string"
    },
    "code" : {
      "title" : "Code",
      "description" : "A code that may be used to identify the pay class.",
      "type" : "string"
    },
    "paysPerYear" : {
      "title" : "Pays Per Year",
      "description" : "The number of pays per year employees are scheduled to receive.",
      "oneOf" : [ {
        "type" : "integer"
      }, {
        "type" : "null"
      } ]
    },
    "classType" : {
      "title" : "Class Type",
      "description" : "An indicator if the pay class is supplemental to (used in addition to) another pay class.",
      "oneOf" : [ {
        "type" : "string",
        "enum" : [ "supplemental", "notSupplemental" ]
      }, {
        "type" : "string",
        "maxLength" : 0
      } ]
    },
    "payCycle" : {
      "title" : "Pay Cycle",
      "description" : "The cycle which determines how employees are paid for the given pay class.",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Pay Cycle.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/pay-cycles/{id}",
          "targetSchema" : {
            "$ref" : "pay-cycles.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "payFrequency" : {
      "title" : "Pay Frequency",
      "description" : "The frequency at which employees are paid when they are working.",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Pay Frequency.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/employment-frequencies/{id}",
          "targetSchema" : {
            "$ref" : "employment-frequencies.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "hoursPerPeriod" : {
      "title" : "Hours Per Period",
      "description" : "The default pay period work hours for positions associated with the pay class.",
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "period" : {
            "title" : "Period",
            "description" : "The default time period (e.g. day, week, month, etc.).",
            "enum" : [ "day", "week", "month", "year", "payPeriod" ],
            "type" : "string"
          },
          "hours" : {
            "title" : "Hours",
            "description" : "The default work hours in the specified time period.",
            "type" : "number"
          }
        },
        "additionalProperties" : false,
        "required" : [ "period", "hours" ]
      }
    },
    "status" : {
      "title" : "Status",
      "description" : "The status of the pay class (e.g. active or inactive).",
      "oneOf" : [ {
        "type" : "string",
        "enum" : [ "active", "inactive" ]
      }, {
        "type" : "string",
        "maxLength" : 0
      } ]
    },
    "compensationType" : {
      "title" : "Compensation Type",
      "description" : "The compensation type associated with the pay class (e.g. salary or wages).",
      "oneOf" : [ {
        "type" : "string",
        "enum" : [ "salary", "wages" ]
      }, {
        "type" : "string",
        "maxLength" : 0
      } ]
    }
  },
  "required" : [ "id", "title" ],
  "additionalProperties" : false,
  "links" : [ {
    "rel" : "filter",
    "encType" : "application/x-www-form-urlencoded",
    "method" : "GET",
    "href" : "/pay-classes?criteria={\"code\": {$code}}",
    "title" : "Code",
    "description" : "A code that may be used to identify the pay class.",
    "schema" : {
      "type" : "object",
      "properties" : {
        "code" : {
          "type" : "string"
        }
      }
    },
    "targetSchema" : {
      "$ref" : "pay-classes.json#"
    }
  } ]
}