The Employments API enables all information from the People >> Employment >> Employment Details for active and non active employees to be retrieve and modified through this API. The unique key for Employments is EMPLOYMENTID, PERSONID.
| Field | Label | Mandatory | Comments |
| PERSONID | Person Code | Y | |
| PERSONNAME | Name | ||
| EFFECTIVEFROM | Hire Date | Y | |
| EFFECTIVETO | Termination Date | Y | |
| EMPLOYMENTID | Employment ID | Y | |
| COMPANYCODE | Company Code | Y | |
| TRANSLATEDCOMPANYNAME | Company Name | ||
| PRIMARYEMPLOYMENT | Primary Employment | 1 means primary employment, 0 is non-primary employment | |
| EMPLOYMENTREASONDESCRIPTION | Employment Reason | ||
| SOURCEAGENCYDESCRIPTION | Hire Source | ||
| ORIGINALHIREDATE | Original Hire Date | ||
| LENGTHOFSERVICE | Length of Service | Read only. | |
| LENGTHOFSERVICEYEARS | Length of Service Yrs | Read only. | |
| LENGTHOFSERVICEMONTHS | Length of Service Mths | Read only. | |
| ADJUSTEDHIREDATE | Adjusted Hire Date | ||
| CONTINUOSSERVICE | Continuous Service | Read only | |
| CONTINUOUSSERVICEYEARS | Continuous Service (Yrs) | Read only | |
| CONTINUOUSSERVICEMONTHS | Continuous Service (Mths) | Read only | |
| DUTYENTRYDATE | Duty Entry Date | ||
| WORKINGTIMEOPTOUT | Working Time Opt Out | ||
| WORKINGTIMEOPTOUTDATE | Opt Out Date | ||
| HIRINGCOMMENT | Hiring Comments | ||
| PROBATIONPERIODTODATE | Probation Period To | ||
| PROBATIONPERIODLENGTH | Probation Period Length | ||
| PROBATIONTIMEUNITDESCRIPTION | Probation Period Time Unit | ||
| PROBATIONSTATUSDESCRIPTION | Probation Status | ||
| PROBATIONEXTENDEDTODATE | Probation Extended To | ||
| NOTICEPERIODLENGTH | Notice Period | ||
| NOTICETIMEUNITDESCRIPTION | Notice Period Time Unit | ||
| TERMINATIONREASONDESCRIPTION | Termination Reason | ||
| TIMEUNTILLEAVING | Time Until Leaving | ||
| LASTWORKDATE | Last Worked Date | ||
| LASTPAIDDATE | Last Paid Date | ||
| NOTICETERMINATIONDATE | Notice Given Date | ||
| INTENDEDRETIREMENTDATE | Intended Retirement Date | ||
| TERMINATIONCOMMENT | Termination Comments | ||
| REDUNDANCYSTATEMENTSENT | Date Statement Sent | ||
| REDUNDANCYNUMBERPAIDWEEKS | Number of Paid Weeks | ||
| REDUNDANCYCURRENCYEDESCRIPTION | Payment Currency | ||
| SYSTEMBASECURRENCY | Default Currency | ||
| STATUTORYREDUNDANCYLOCALAMOUNT | Statutory Payment Due | ||
| ACTUALREDUNDANCYLOCALAMOUNT | Actual Payment | ||
| STATUTORYREDUNDANCYBASEAMOUNT | Statutory Payment Due (Base Currency) | ||
| ACTUALREDUNDANCYBASEAMOUNT | Actual Payment (Base Currency) | ||
| REDUNDANCYCOMMENT | Redundancy Comments |
The security for each role is defined in the following table:
| Security Role | Comments |
| HR Prof | Has full access to everyone within the system. |
| Restricted HR | Has access to people as defined by the user's security configuration. |
| Line Manager | Has read only access to their and all subordinate records. |
| Self Service | Has read only access to their record. |