Update Salary API

This API is used to update the salary data of an employee.

Request URL:

https://people.zoho.com/api/compensation/v1/updatesalary

Header:

Authorization:Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf

Request Method:

PUT

Request Parameters:

revisionData: (mandatory)	Specify data to be revised
breakUpData: (mandatory)	Specify breakup of salary
dateFormat: (mandatory)	Specify the 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

Scope:

ZohoPeople.compensation.ALL

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/updatesalary?revisionData={"CurrentCTC":0,"Employee":100002000000034638,"RevisedCTC":90000,"Effective_Date":01-Dec-2020,"Reason":"Hike","Package":10000200000003977,"Currency":10000200000003969,Revised_Amount:90000,"Revised_Percentage":50,"Remarks":"test"}&erecno=100002000000034636&dateFormat=dd-MMM-yy

Sample Response:

Copied{
    "response": {
        "result": {
            "Message": "Record added successfully.",
            "revId": "100002000000043027",
            "hasError": false
        },
        "message": "Success",
        "uri": "/api/compensation/v1/salary",
        "status": 0
    }
}