Fetch Salary Components API

This API is used to fetch components that part of an employee's salary.

Request URL:

https://people.zoho.com/api/compensation/v1/salary/<erecno>/components

Header:

Authorization:Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf

Request Method:

GET

Scope:

ZohoPeople.compensation.ALL

Request Parameters:

erecno:
(mandatory)

Specify erecno of the employee whose record is to be fetched

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/salary/138695000000333325/components

Sample Response:

Copied{
 "response": {
 "result": {
 "ctcComponents": [
 {
 "Annually": "22500",
 "Payment_Frequency_Id": 1,
 "Monthly": "1875",
 "Calculation_Type_Id": 3,
 "Calculation_Type": "CTC",
 "Percentage": "50.00",
 "Amount": "0.00",
 "Component_Category": "Earnings",
 "Payment_Type": "Fixed",
 "Payment_Frequency": "Monthly",
 "Component_Name": "Basic Pay"
 },
 {
 "Annually": "22500",
 "Payment_Frequency_Id": 1,
 "Monthly": "1875",
 "Calculation_Type_Id": 1,
 "Calculation_Type": "Flat Amount",
 "Percentage": "0.00",
 "Amount": "0.00",
 "Component_Category": "Earnings",
 "Payment_Type": "Fixed",
 "Payment_Frequency": "Monthly",
 "Component_Name": "Fixed Allowance"
 }
 ]
 },
 "message": "Success",
 "uri": "/api/compensation/v1/salary/148113000000340003/components",
 "status": 0
 }
}