Fetch Package Components API

This API is used to fetch components added that are part of a salary package.

Request URL:

https://people.zoho.com/api/compensation/v1/packages/<packageID>/components

Header:

Authorization:Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf

Request Method:

GET

Scope:

ZohoPeople.compensation.ALL

Request Parameters:

packageId:
(mandatory)

Package ID of the package to fetch components from the package

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/packages/138695000000361496/components"

Sample Response:

Copied{
 "response": {
 "result": [
 {
 "Component_Code": "Fixed_Allowance",
 "Payment_Type_Id": 1,
 "Payment_Frequency_Id": 1,
 "Part_Of_CTC": true,
 "Calculation_Type_Id": 1,
 "Percentage": "0.00",
 "Component_Id": "148113000000342667",
 "Component_Category_Id": 1,
 "Component_Category": "Earnings",
 "Payment_Type": "Fixed",
 "Component_Name": "Fixed Allowance",
 "Payment_Frequency": "Monthly"
 }
 ],
 "message": "Success",
 "uri": "/api/compensation/v1/packages/148113000000376130/components",
 "status": 0
 }
}