Add Salary API
This API is used to add salary record for an employee.
Request URL:
https://people.zoho.com/api/compensation/v1/addsalary
Header:
Authorization:Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf
Request Method:
POST
Scope:
ZohoPeople.compensation.ALL
Request Parameters:
| revisionData: (mandatory) | Specify data to be revised |
| breakUpData: (mandatory) | Specify breakup of salary |
| dateFormat: (mandatory) | Specify date format which is used as the effective date in revision |
Sample Parameters:
| Parameter values | Mandatory keys | |
| revisionData: (mandatory) | {"CurrentCTC":0,"Employee":100002000000034638,"RevisedCTC":90000,"Effective_Date":01-Dec-2020,"Reason":"Initial Salary","Package":10000200000003977,"Currency":10000200000003969,Revised_Amount:90000,"Revised_Percentage":50,"Remarks":"test"} | Employee, RevisedCTC, Effective_Date, Reason(link fetch reasons api)(value should be only "Initial Salary"), Currency. |
| breakUpData: (mandatory) | [{"Component_Code":"Basic","Percentage":50.00,"Amount":0.00}] | Component_Code, Percentage, Amount |
| dateFormat: (mandatory) | dd-MMM-yy |
Note: Breakup data is not mandatory. It is only required if salary structure is enabled. If Salary structure is enabled and Breakup data is not given, then breakup of salary package value will be used.
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/addsalary?revisionData={"CurrentCTC":0,"Employee":100002000000034638,"RevisedCTC":90000,"Effective_Date":01-Dec-2020,"Reason":"Initial Salary","Package":10000200000003977,"Currency":10000200000003969,Revised_Amount:90000,"Revised_Percentage":50,"Remarks":"test"}&erecno=100002000000034636&dateFormat=dd-MMM-yySample Response:
Copied{
"response": {
"result": {
"Message": "Record added successfully.",
"revId": "148113000000379099",
"hasError": false
},
"message": "Success",
"uri": "/api/compensation/v1/addsalary",
"status": 0
}
}