Fetch My Compensation API

This API is used to fetch the own compensation data of an employee.

Request URL:

https://people.zoho.com/api/compensation/v1/mycompensation

Header:

Authorization:Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf

Request Method:

GET

Scope:

ZohoPeople.compensation.ALL

Threshold Limit: 300 requests | Lock period: 5 minutes

Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.
 

Error Codes & Responses

Sample Request

Copiedhttps://people.zoho.com/api/compensation/v1/mycompensation

Sample Response:

Copied{
 "response": {
 "result": {
 "revisionHistory": [
 {
 "Revised_Amount_Formatted": "AED 0.00",
 "Revised_Percentage": "0",
 "Revised_Currency": "AED",
 "Revision_History_Id": "148113000000374001",
 "Revision_Letter_Exist": true,
 "Revised_Amount": "0",
 "Package_Id": "148113000000342707",
 "Revision_Letter_TemplateName": "apimobile",
 "Revised_CTC": "45000",
 "Reason": "Initial Salary",
 "Revised_CTC_Formatted": "AED 45000.00",
 "Modified_By": "148113000000340003",
 "Is_InitialSalary": true,
 "Revision_Id": "148113000000370073",
 "Effective_From": "19-Aug-2024",
 "Package_Name": "Entry Level"
 }
 ],
 "summary": {
 "Total_Earnings_No": "45000",
 "Total_Earnings_Words": "Forty Five Thousand United Arab Emirates Dirhams and Cents",
 "Gross_Earnings_Words": "Forty Five Thousand United Arab Emirates Dirhams",
 "Gross_Earnings_No": "45000",
 "Total_Deductions_Words": "",
 "Total_Benefits_Words": " United Arab Emirates Dirhams and Cents",
 "Total_Benefits_No": "0",
 "Total_Deductions_No": "0"
 },
 "employeeInformation": {
 "Designation": "",
 "Department": "",
 "Experience": "4 Year(s) 0 Month(s)",
 "Erecno": "148113000000340003",
 "Employee_Id": "1",
 "Employee_Name": "Adam",
 "DateofJoining": "04-Aug-2020"
 },
 "chartDetails": [
 {
 "Effective_Date": "19-Aug-2024",
 "Formatted_CTC": "AED 45000.00",
 "Revised_CTC": "45000"
 }
 ],
 "salaryInformation": {
 "Salary_Package": "Entry Level",
 "CTC_Formatted": "AED 45000.00",
 "Package_Id": "148113000000342707",
 "Effective_From": "19-Aug-2024",
 "Salary_Id": "148113000000342854",
 "Erecno": "148113000000340003",
 "MonthlyCTC_Formatted": "AED 3750.00",
 "Annual_CTC": "45000",
 "Currency_Id": "148113000000342626",
 "Monthly_CTC": "3750",
 "LastRevised_Date": "19-Aug-2024",
 "Currency_Code": "AED"
 },
 "breakupObject": {
 "componentList": {
 "ctcComponents": [
 {
 "Annually": "22500.00",
 "Payment_Frequency_Id": 1,
 "Monthly": "1875.00",
 "Component_Category_Id": 1,
 "Component_Category": "Earnings",
 "Payment_Frequency": "Monthly",
 "Component_Name": "Basic Pay"
 },
 {
 "Annually": "22500.00",
 "Payment_Frequency_Id": 1,
 "Monthly": "1875.00",
 "Component_Category_Id": 1,
 "Component_Category": "Earnings",
 "Payment_Frequency": "Monthly",
 "Component_Name": "Fixed Allowance"
 }
 ]
 }
 }
 },
 "message": "Success",
 "uri": "/api/compensation/v1/mycompensation",
 "status": 0
 }
}