Creates a new employment entry for a given employee.

post

https://api.hibob.com/v1/people/{id}/employment

Path Params

string

required

employee id

Body Params

Employment entry to add. This must not conflict with another entry on the same effective date.

integer

ID.

reason

string

The reason for this change.

effectiveDate

date

required

The date this entry becomes effective.

personalWorkingPatternType

string

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

actualWorkingPattern

The active working pattern for this entry. It will hold the pattern that is selected, no matter which type it is.

standardWorkingPattern

object

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

standardWorkingPatternId

number

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

workingPattern

object

The personalized (adjusted) working pattern.

siteWorkingPattern

object

The site's default working pattern (always a weekly pattern).

hoursInDayNotWorked

number

Based on the actual working pattern

weeklyHours

number

Based on the actual working pattern

fte

number

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

calendarName

string

The selected Holiday calendar

calendarId

integer

The selected Holiday calendar

contract

string

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

type

string

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

salaryPayType

string

Salary pay type, can be Salaries or Hourly.

endEffectiveDate

date

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

activeEffectiveDate

date

The effective date of the active working pattern.

isCurrent

boolean

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

canBeDeleted

boolean

modificationDate

date

The date this entry was modified.

CreationDate

date

The date this entry was created.

flsaCode

string

FLSA code, can be Exempt or Non-Exempt.

change

object

Details of the last change and the ID of the user who updated this entry

Response

200

Entry created successfully