Supported Methods

Supported Parameters

GET, POST, PATCH

Id, name, page, pageSize, modTimeStart, modTimeEnd, isActive, isDeleted

{
    "ID": "",
    "Name": "",
    "Salutation": "",
    "FirstName": "",
    "MiddleName": "",
    "LastName": "",
    "Suffix": "",
    "Address": {
        "Line1": "",
        "Line2": "",
        "City": "",
        "State": "",
        "PostalCode": "",
        "Line3": "",
        "Line4": "",
        "Country": "",
        "Line5": ""
    },
    "Phone": "",
    "Mobile": "",
    "AlternatePhone": "",
    "Email": "",
    "IsActive": true,
    "Department": "",
    "SSN": "",
    "Number": "",
    "HireDate": "2021-05-05T16:07:58Z",
    "JobTitle": "",
    "CustomFields": [{
        "FullName": "",
        "Value": ""
    }],
    "ExemptStatus": "",
    "Earnings": [{
        "Item": {
            "ID": "",
            "Name": ""
        },
        "Rate": 0.0
    }],
    "SickHours": {
        "AccrualPeriod": "",
        "HoursAvailable": "",
        "HoursAccrued": "",
        "MaximumHours": "",
        "ResetEachYear": true,
        "HoursUsed": "",
        "AccrualStartDate": "2021-05-05T16:07:58Z"
    },
    "Type": "",
    "UseTimeDataToCreatePaychecks": true,
    "DateOfBirth": "",
    "Class": {
        "ID": "",
        "FullName": ""
    },
    "CreatedDate": "2021-05-05T16:07:58Z",
    "LastModifiedDate": "2021-05-05T16:07:58Z",
    "PayPeriod": "",
    "Supervisor": {
        "Name": "",
        "ID": ""
    },
    "EmploymentType": "",
    "VacationHours": {
        "HoursAvailable": "",
        "AccrualPeriod": "",
        "HoursAccrued": "",
        "MaximumHours": "",
        "ResetEachYear": true,
        "HoursUsed": "",
        "AccrualStartDate": "2021-05-05T16:07:58Z"
    },
    "DeletedDate": "2021-05-05T16:07:58Z",
    "MiddleInitial": ""
}

Important Notes

POST/PATCH not supported for the following:

  • SSN (supported for POST but not PATCH)
  • PayPeriod
  • Supervisor.Name
  • Supervisor.ID
  • EmploymentType
  • VacationHours.HoursAvailable
  • VacationHours.AccrualPeriod
  • VacationHours.HoursAccrued
  • VacationHours.MaximumHours
  • VacationHours.ResetEachYear
  • VacationHours.HoursUsed
  • VacationHours.AccrualStartDate

Did this page help you?