The Compensation API enables all information from the People >> Compensation >> Current Comp Details and All Comp Details for active and non active employees to be retrieve and modified through this API. The unique key for Compensation is PERSONID, EFFECTIVEFROM, COMPITEMCODE.
| Field | Label | Mandatory | Comments |
| PERSONID | Person Code | Y | |
| PERSONNAME | Name | Read only | |
| TRANSLATEDCOMPITEMNAME | Comp Item | Read only | |
| COMPITEMCODE | Comp Item Code | Y | |
| EFFECTIVEFROM | Effective From | Y | |
| EFFECTIVETO | Effective To | Y | |
| EMPLOYMENTID | Employment ID | ||
| CURRENCYDESCRIPTION | Payment Currency | ||
| SYSTEMBASECURRENCY | Base Currency | Read only | |
| PAYPERIODDESCRIPTION | Pay Period | Read only | |
| COMPITEMTYPEDESCRIPTION | Comp Item Type | ||
| SINGLEPAYMENTITEM | Single Payment | Read only | |
| TARGETACHIEVEDPERCENT | Target % Achieved | ||
| COMPCHANGEREASONDESCRIPTION | Change Reason | ||
| SINGLEPAYMENTDATE | Single Payment Date | ||
| NEXTRETRIEVEDATE | Next Review Date | ||
| COMMENT | Comments | ||
| ACTUALLOCALAMOUNT | Actual Amount for Period | ||
| ANNUALLOCALAMOUNT | Annual Actual Amount for Period | Read only | |
| CHANGEDLOCALAMOUNT | Change from Previous Period | Read only | |
| ANNUALCHANGEDLOCALAMOUNT | Annual Change from Previous Period | Read only | |
| TARGETLOCALAMOUNT | Target | ||
| ACTUALBASEAMOUNT | Base Actual Amount for Period | Read only | |
| ANNUALBASEAMOUNT | Annual Base Actual Amount for Period | Read only | |
| CHANGEDBASEAMOUNT | Change from Previous Period | Read only | |
| ANNUALCHANGEDBASEAMOUNT | Base Annual Change from Previous Period | Read only | |
| TARGETBASEAMOUNT | Base Target | Read only |
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. |