Fetch Components API
This API is used to fetch all components.
Request URL:
https://people.zoho.com/api/compensation/v1/components
Header:
Authorization:Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf
Request Method:
GET
Scope:
ZohoPeople.compensation.ALL
Request Parameters:
| Parameters | ValuesAllowed | DefaultValue | Description | Mandatory |
| locationIds: | example:["148113000000376003"] | Location Id of the component belonging to a particular location. | No | |
| type: | example:ctc | Type of the component (benefit or ctc component) | Mandatory if locationid is given | |
| status | active|inactive | irrespective of status , we will show all the data | Verify if a salary component is enabled or disabled | No |
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.
Sample Request
Copiedhttps://people.zoho.com/api/compensation/v1/componentsSample Response - Success
Copied{
"response": {
"result": {
"benefits": [
{
"Status": "active",
"Payment_Type_Id": 2,
"Payment_Frequency_Id": 4,
"Description": "",
"Part_Of_CTC": false,
"Calculation_Type_Id": 1,
"Calculation_Type": "Flat Amount",
"Payment_Type": "Variable",
"Component_Name": "Bonus",
"Payment_Frequency": "Annually",
"Component_Code": "Bonus",
"Component_Id": "148113000000458472",
"Location": [
"-1"
]
},
{
"Status": "active",
"Payment_Type_Id": 1,
"Payment_Frequency_Id": 1,
"Description": "",
"Part_Of_CTC": false,
"Calculation_Type_Id": 1,
"Calculation_Type": "Flat Amount",
"Payment_Type": "Fixed",
"Component_Name": "Meal Pass",
"Payment_Frequency": "Monthly",
"Component_Code": "Meal_Pass",
"Component_Id": "148113000000458480",
"Location": [
"-1"
]
},
{
"Status": "active",
"Payment_Type_Id": 1,
"Payment_Frequency_Id": 1,
"Description": "",
"Part_Of_CTC": false,
"Calculation_Type_Id": 1,
"Calculation_Type": "Flat Amount",
"Payment_Type": "Fixed",
"Component_Name": "Gift Card",
"Payment_Frequency": "Monthly",
"Component_Code": "Gift_Card",
"Component_Id": "148113000000458484",
"Location": [
"-1"
]
},
{
"Status": "active",
"Payment_Type_Id": 1,
"Payment_Frequency_Id": 1,
"Description": "",
"Part_Of_CTC": false,
"Calculation_Type_Id": 1,
"Calculation_Type": "Flat Amount",
"Payment_Type": "Fixed",
"Component_Name": "Medical Insurance",
"Payment_Frequency": "Monthly",
"Component_Code": "Medical_Insurance",
"Component_Id": "148113000000458492",
"Location": [
"-1"
]
},
{
"Status": "active",
"Payment_Type_Id": 2,
"Payment_Frequency_Id": 1,
"Description": "",
"Part_Of_CTC": false,
"Calculation_Type_Id": 1,
"Calculation_Type": "Flat Amount",
"Amount": "4500",
"Payment_Type": "Variable",
"Component_Name": "vp",
"Payment_Frequency": "Monthly",
"Component_Code": "vp",
"Component_Id": "148113000000912094",
"Location": [
"-1"
]
},
{
"Status": "inactive",
"Payment_Type_Id": 1,
"Payment_Frequency_Id": 1,
"Description": "",
"Part_Of_CTC": false,
"Calculation_Type_Id": 2,
"Calculation_Type": "Basic",
"Percentage": "2.00",
"Payment_Type": "Fixed",
"Component_Name": "Food Coupon",
"Payment_Frequency": "Monthly",
"Component_Code": "Food_Coupon",
"Component_Id": "148113000001011101",
"Location": [
"-1"
]
}
],
"displayName": {
"benefits": "Benefits",
"ctcComponents": "Salary Component"
},
"ctcComponents": [
{
"Status": "active",
"Payment_Type_Id": 1,
"Payment_Frequency_Id": 1,
"Description": "",
"Part_Of_CTC": true,
"Calculation_Type_Id": 3,
"Calculation_Type": "Salary",
"Percentage": "50.00",
"Component_Category": "Earnings",
"Payment_Type": "Fixed",
"Component_Name": "Basic",
"Payment_Frequency": "Monthly",
"Component_Code": "Basic",
"Component_Id": "148113000000458448",
"Component_Category_Id": 1,
"Location": [
"-1"
]
},
{
"Status": "active",
"Payment_Type_Id": 1,
"Payment_Frequency_Id": 1,
"Description": "",
"Part_Of_CTC": true,
"Calculation_Type_Id": 2,
"Calculation_Type": "Basic",
"Percentage": "40.00",
"Component_Category": "Earnings",
"Payment_Type": "Fixed",
"Component_Name": "House Rent Allowance",
"Payment_Frequency": "Monthly",
"Component_Code": "HRA",
"Component_Id": "148113000000458452",
"Component_Category_Id": 1,
"Location": [
"-1"
]
},
{
"Status": "active",
"Payment_Type_Id": 1,
"Payment_Frequency_Id": 1,
"Description": "",
"Part_Of_CTC": true,
"Calculation_Type_Id": 1,
"Calculation_Type": "Flat Amount",
"Component_Category": "Earnings",
"Payment_Type": "Fixed",
"Component_Name": "Fixed Allowance",
"Payment_Frequency": "Monthly",
"Component_Code": "Fixed_Allowance",
"Component_Id": "148113000000458456",
"Component_Category_Id": 1,
"Location": [
"-1"
]
},
{
"Status": "active",
"Payment_Type_Id": 1,
"Payment_Frequency_Id": 1,
"Description": "",
"Part_Of_CTC": true,
"Calculation_Type_Id": 1,
"Calculation_Type": "Flat Amount",
"Component_Category": "Earnings",
"Payment_Type": "Fixed",
"Component_Name": "Fuel Allowance",
"Payment_Frequency": "Monthly",
"Component_Code": "Fuel_Allowance",
"Component_Id": "148113000000458460",
"Component_Category_Id": 1,
"Location": [
"-1"
]
},
{
"Status": "active",
"Payment_Type_Id": 1,
"Payment_Frequency_Id": 1,
"Description": "",
"Part_Of_CTC": true,
"Calculation_Type_Id": 1,
"Calculation_Type": "Flat Amount",
"Component_Category": "Earnings",
"Payment_Type": "Fixed",
"Component_Name": "Education Allowance",
"Payment_Frequency": "Monthly",
"Component_Code": "Education_Allowance",
"Component_Id": "148113000000458464",
"Component_Category_Id": 1,
"Location": [
"-1"
]
},
{
"Status": "active",
"Payment_Type_Id": 1,
"Payment_Frequency_Id": 1,
"Description": "",
"Part_Of_CTC": true,
"Calculation_Type_Id": 1,
"Calculation_Type": "Flat Amount",
"Component_Category": "Earnings",
"Payment_Type": "Fixed",
"Component_Name": "Conveyance Allowance",
"Payment_Frequency": "Monthly",
"Component_Code": "Conveyance_Allowance",
"Component_Id": "148113000000458468",
"Component_Category_Id": 1,
"Location": [
"-1"
]
},
{
"Status": "active",
"Payment_Type_Id": 2,
"Payment_Frequency_Id": 4,
"Description": "",
"Part_Of_CTC": true,
"Calculation_Type_Id": 3,
"Calculation_Type": "Salary",
"Component_Category": "Earnings",
"Payment_Type": "Variable",
"Component_Name": "Flexible Pay",
"Payment_Frequency": "Annually",
"Component_Code": "Variable_Pay",
"Component_Id": "148113000000458476",
"Component_Category_Id": 1,
"Location": [
"-1"
]
},
{
"Status": "active",
"Payment_Type_Id": 1,
"Payment_Frequency_Id": 1,
"Description": "",
"Part_Of_CTC": true,
"Calculation_Type_Id": 2,
"Calculation_Type": "Basic",
"Percentage": "12.00",
"Component_Category": "Deductions",
"Payment_Type": "Fixed",
"Component_Name": "Provident Fund",
"Payment_Frequency": "Monthly",
"Component_Code": "PF",
"Component_Id": "148113000000458488",
"Component_Category_Id": 2,
"Location": [
"-1"
]
},
{
"Status": "active",
"Payment_Type_Id": 1,
"Payment_Frequency_Id": 1,
"Description": "ikmlkr",
"Part_Of_CTC": true,
"Calculation_Type_Id": 1,
"Calculation_Type": "Flat Amount",
"Amount": "4500",
"Component_Category": "Earnings",
"Payment_Type": "Fixed",
"Component_Name": "VPF",
"Payment_Frequency": "Monthly",
"Component_Code": "VPF",
"Component_Id": "148113000000544049",
"Component_Category_Id": 1,
"Location": [
"-1"
]
},
{
"Status": "inactive",
"Payment_Type_Id": 1,
"Payment_Frequency_Id": 1,
"Description": "",
"Part_Of_CTC": true,
"Calculation_Type_Id": 2,
"Calculation_Type": "Basic",
"Percentage": "50.00",
"Component_Category": "Earnings",
"Payment_Type": "Fixed",
"Component_Name": "Fuel Allowance",
"Payment_Frequency": "Monthly",
"Component_Code": "Fuel_Allowance",
"Component_Id": "148113000000817051",
"Component_Category_Id": 1,
"Location": [
"-1"
]
},
{
"Status": "active",
"Payment_Type_Id": 2,
"Payment_Frequency_Id": 1,
"Description": "",
"Part_Of_CTC": true,
"Calculation_Type_Id": 1,
"Calculation_Type": "Flat Amount",
"Amount": "4500",
"Component_Category": "Earnings",
"Payment_Type": "Variable",
"Component_Name": "vpay flat",
"Payment_Frequency": "Monthly",
"Component_Code": "vpay_flat",
"Component_Id": "148113000000913003",
"Component_Category_Id": 1,
"Location": [
"-1"
]
},
{
"Status": "active",
"Payment_Type_Id": 1,
"Payment_Frequency_Id": 1,
"Description": "",
"Part_Of_CTC": true,
"Calculation_Type_Id": 1,
"Calculation_Type": "Flat Amount",
"Amount": "90000",
"Component_Category": "Earnings",
"Payment_Type": "Fixed",
"Component_Name": "Travel Allowance",
"Payment_Frequency": "Monthly",
"Component_Code": "Travel_Allowance",
"Component_Id": "148113000001011069",
"Component_Category_Id": 1,
"Location": [
"-1"
]
}
]
},
"message": "Success",
"uri": "/api/compensation/v1/components",
"status": 0
}
}