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:

locationIds:

Location Id of the component belonging to a particular location.

example:["148113000000376003"]

type: (mandatory if location id is given)

Type of the component (benefit or ctc component)

example:ctc

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

Sample Response - Success

Copied{
 "response": {
 "result": {
 "ctcComponents": [
 {
 "Payment_Type_Id": 1,
 "Payment_Frequency_Id": 1,
 "Description": "",
 "Part_Of_CTC": true,
 "Calculation_Type_Id": 3,
 "Calculation_Type": "CTC",
 "Percentage": "50.00",
 "Component_Category": "Earnings",
 "Payment_Type": "Fixed",
 "Component_Name": "Basic Pay",
 "Payment_Frequency": "Monthly",
 "Component_Code": "Basic",
 "Component_Id": "148113000000342659",
 "Component_Category_Id": 1,
 "Location": [
 "-1"
 ]
 },
 {
 "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": "148113000000342663",
 "Component_Category_Id": 1,
 "Location": [
 "-1"
 ]
 },
 {
 "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": "148113000000342667",
 "Component_Category_Id": 1,
 "Location": [
 "-1"
 ]
 },
 {
 "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": "148113000000342671",
 "Component_Category_Id": 1,
 "Location": [
 "-1"
 ]
 },
 {
 "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": "148113000000342675",
 "Component_Category_Id": 1,
 "Location": [
 "-1"
 ]
 },
 {
 "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": "148113000000342679",
 "Component_Category_Id": 1,
 "Location": [
 "-1"
 ]
 },
 {
 "Payment_Type_Id": 2,
 "Payment_Frequency_Id": 4,
 "Description": "",
 "Part_Of_CTC": true,
 "Calculation_Type_Id": 3,
 "Calculation_Type": "CTC",
 "Component_Category": "Earnings",
 "Payment_Type": "Variable",
 "Component_Name": "Flexible Pay",
 "Payment_Frequency": "Annually",
 "Component_Code": "Variable_Pay",
 "Component_Id": "148113000000342687",
 "Component_Category_Id": 1,
 "Location": [
 "-1"
 ]
 },
 {
 "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": "148113000000342699",
 "Component_Category_Id": 2,
 "Location": [
 "-1"
 ]
 },
 {
 "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": "trichyloc",
 "Payment_Frequency": "Monthly",
 "Component_Code": "trichyloc",
 "Component_Id": "148113000000376068",
 "Component_Category_Id": 1,
 "Location": [
 "148113000000376003"
 ]
 }
 ]
 },
 "message": "Success",
 "uri": "/api/compensation/v1/components",
 "status": 0
 }
}