v1

latestOpenAPI 3.1.1Proprietary2026-07-26184406877.9 KB

Employee Tables

Creates a new employment entry for a given employee.

post/people/{id}/employment

Path parameters

idstring required

employee id

Request body

idinteger

ID.

reasonstring

The reason for this change.

effectiveDatestring date required

The date this entry becomes effective.

personalWorkingPatternTypestring

indicates whether the working pattern personal (adjusted). Can be null (no personal defined), "custom", "library" or "flexible".

standardWorkingPatternobject

The working pattern that was selected from the library as standard. If null this means the standard is using the site default.

standardWorkingPatternIdnumber

The working pattern ID that was selected from the library as standard.

workingPatternobject

The personalized (adjusted) working pattern.

hoursInDayNotWorkednumber

Based on the actual working pattern

weeklyHoursnumber

Based on the actual working pattern

ftenumber

the FTE percentage for this entry as calculated based on the working pattern

calendarNamestring

The selected Holiday calendar

calendarIdinteger

The selected Holiday calendar

contractstring

Contract, can be Full-Time, Part-Time, Shifts

typestring

Type as appears in the Employment Type list. Can be Permanent, Temporary, Apprentice, Contractor or any custom value.

salaryPayTypestring

Salary pay type, can be Salaries or Hourly.

endEffectiveDatestring date

For entries that are not active - this is the date this entry became not effective.

activeEffectiveDatestring date

The effective date of the active working pattern.

isCurrentboolean

Is 'true' when this is the effective entry which is currently active.

canBeDeletedboolean

modificationDatestring date

The date this entry was modified.

CreationDatestring date

The date this entry was created.

flsaCodestring

FLSA code, can be Exempt or Non-Exempt.

Example request

{
  "actualWorkingPattern": {
    "workingPatternType": "hourly",
    "days": {
      "monday": 9,
      "tuesday": 9,
      "wednesday": 9,
      "thursday": 9,
      "friday": 9
    },
    "hoursPerDay": 9
  },
  "siteWorkingPattern": {
    "workingPatternType": "hourly",
    "days": {
      "monday": 9,
      "tuesday": 9,
      "wednesday": 9,
      "thursday": 9,
      "friday": 9
    },
    "hoursPerDay": 9
  }
}

Response

Entry created successfully