Employee Salary
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
The Employee Salary module enables you to manage and configure salary details, benefits and deductions of an employee.
Attribute
Allowed values are
active, terminatedis_employee_restricted_basic_enabled is true, the employee''s contribution is restricted to Rs.15,0000 of Basic Pay by default, defining the maximum wage for EPF calculation. Users can provide alternative values if organizational override is permitted. (Applicable only for EPF).is_employer_restricted_basic_enabled is true, the employer''s contribution is restricted to Rs.15,0000 of Basic Pay by default, defining the maximum wage for EPF calculation. Users can provide alternative values if organizational override is permitted. (Applicable only for EPF).disabled. For Reimbursements, when the claim amount can be carried forward monthly within the financial year, specify the value as monthly. For LTA, when the claim amount can be carried forward monthly and to the next financial year, specify the value as monthly_and_yearlydisabled. For Reimbursements, when the claim amount can be carried forward monthly within the financial year, specify the value as monthly. For LTA, when the claim amount can be carried forward monthly and to the next financial year, specify the value as monthly_and_yearlytrue to prevent overriding the Flexible Benefit Plan amount.{
"ctc": 650000,
"first_name": "Anand",
"employee_name": "Anand Maya",
"employee_id": "36000000012849",
"template_id": "179695000000174001",
"template_name": "Salary Template(Sample)",
"monthly_salary": 50000,
"employee_status": "active",
"earnings": [
{
"id": "49774000000236001",
"is_enabled": true,
"amount": 25000,
"is_amount_in_percentage": false,
"amount_in_percentage": "",
"type": "basic",
"name": "Basic",
"is_included_in_pf": true,
"is_included_in_esi": true
}
],
"benefits": [
{
"id": "49774000000118005",
"is_enabled": true,
"is_amount_in_percentage": true,
"employer_amount_in_percentage": 12,
"employer_amount": 1200,
"type": "epf_contribution",
"name": "EPF - Employer Contribution",
"is_eligible_for_eps": true,
"is_employee_restricted_basic_enabled": false,
"is_employer_restricted_basic_enabled": true,
"employee_restricted_basic_amount": "",
"employer_restricted_basic_amount": 15000
}
],
"reimbursements": [
{
"id": "49774000000095172",
"is_enabled": true,
"amount": 1000,
"max_limit": 12000,
"carry_forward_option": "monthly",
"type": "fuel",
"name": "Fuel Reimbursement"
}
],
"fbp_components": [
{
"id": "49774000000095174",
"is_enabled": true,
"max_limit": 12000,
"amount": 1200,
"carry_forward_option": "monthly",
"is_opt_in": false,
"type": "telephone",
"name": "Telephone Reimbursement"
}
],
"variable_earnings": [
{
"id": "49774000000095515",
"is_enabled": true,
"amount": 5000,
"type": "bonus",
"name": "bonus",
"is_included_in_esi": true
}
]
}
Get salary details
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
To fetch the salary details of an employee.
OAuth Scope : ERP.salary.READ
Path Parameters
Query Parameters
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v1/employees/36000000012849/salary?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v1/employees/36000000012849/salary?organization_id=10234695")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'GET',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v1/employees/36000000012849/salary?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/erp/v1/employees/36000000012849/salary?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v1/employees/36000000012849/salary?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url 'https://www.zohoapis.in/erp/v1/employees/36000000012849/salary?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "success",
"employee": {
"ctc": 650000,
"first_name": "Anand",
"employee_name": "Anand Maya",
"employee_id": "36000000012849",
"template_id": "179695000000174001",
"template_name": "Salary Template(Sample)",
"monthly_salary": 50000,
"employee_status": "active",
"earnings": [
{
"id": "49774000000236001",
"is_enabled": true,
"amount": 25000,
"is_amount_in_percentage": false,
"amount_in_percentage": "",
"type": "basic",
"name": "Basic",
"is_included_in_pf": true,
"is_included_in_esi": true
}
],
"benefits": [
{
"id": "49774000000118005",
"is_enabled": true,
"is_amount_in_percentage": true,
"employer_amount_in_percentage": 12,
"employer_amount": 1200,
"type": "epf_contribution",
"name": "EPF - Employer Contribution",
"is_eligible_for_eps": true,
"is_employee_restricted_basic_enabled": false,
"is_employer_restricted_basic_enabled": true,
"employee_restricted_basic_amount": "",
"employer_restricted_basic_amount": 15000
}
],
"reimbursements": [
{
"id": "49774000000095172",
"is_enabled": true,
"amount": 1000,
"max_limit": 12000,
"carry_forward_option": "monthly",
"type": "fuel",
"name": "Fuel Reimbursement"
}
],
"fbp_components": [
{
"id": "49774000000095174",
"is_enabled": true,
"max_limit": 12000,
"amount": 1200,
"carry_forward_option": "monthly",
"is_opt_in": false,
"type": "telephone",
"name": "Telephone Reimbursement"
}
],
"variable_earnings": [
{
"id": "49774000000095515",
"is_enabled": true,
"amount": 5000,
"type": "bonus",
"name": "bonus",
"is_included_in_esi": true
}
]
}
}
Associate deduction
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Create a deduction component at organization level, which you can associate to employees.
OAuth Scope : ERP.salary.CREATE
Arguments
is_value_in_percent set to true, specify the percentage else specify the fixed value.true if the deduction is calculated as a percentage type and specify the percentage in valueby_month, by_amount and infinite.If the deduction is intended to end after a specific month, specify the value as
by_month.If the deduction is intended to end after a specific amount has deducted, specify the value as
by_amount.If the deduction is never intended to end specify the value as
infiniteYYYY-MM if the termination type is by_month.by_amount.Path Parameters
Query Parameters
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v1/employees/36000000012849/deductions?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v1/employees/36000000012849/deductions?organization_id=10234695")
.post(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'POST',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
'content-type': 'application/json'
},
body: '{"field1":"value1","field2":"value2"}'
};
fetch('https://www.zohoapis.in/erp/v1/employees/36000000012849/deductions?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("POST", "/erp/v1/employees/36000000012849/deductions?organization_id=10234695", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v1/employees/36000000012849/deductions?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
curl --request POST \
--url 'https://www.zohoapis.in/erp/v1/employees/36000000012849/deductions?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"deduction_name": "Cab Deduction",
"value": 500,
"is_value_in_percent": false,
"is_recurring": true,
"recurrence_termination_type": "infinite",
"recurrence_termination_month": "",
"recurrence_termination_amount": ""
}
{
"code": 0,
"message": "A new deduction has been created.",
"employee_deduction": {
"employee_id": "36000000012849",
"deduction_id": "49774000000257078",
"deduction_name": "Cab Deduction",
"is_value_in_percent": false,
"value": 500,
"recurrence_termination_type": "infinite",
"recurrence_termination_month": "",
"recurrence_termination_amount": ""
}
}
List Deductions
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Retrieve a list of deductions associated with an employee.
OAuth Scope : ERP.salary.READ
Path Parameters
Query Parameters
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v1/employees/36000000012849/deductions?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v1/employees/36000000012849/deductions?organization_id=10234695")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'GET',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v1/employees/36000000012849/deductions?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/erp/v1/employees/36000000012849/deductions?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v1/employees/36000000012849/deductions?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url 'https://www.zohoapis.in/erp/v1/employees/36000000012849/deductions?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "success",
"employee_deductions": [
{
"employee_id": "36000000012849",
"deduction_id": "49774000000257078",
"deduction_name": "Cab Deduction",
"is_value_in_percent": false,
"value": 500,
"recurrence_termination_type": "by_amount",
"recurrence_termination_month": "",
"recurrence_termination_amount": "",
"total_amount_deducted": 100,
"amount_to_be_deducted": 400
},
{...},
{...}
]
}
Update deduction
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Update the details of a deduction associated with an employee.
OAuth Scope : ERP.salary.UPDATE
Arguments
is_value_in_percent set to true, specify the percentage else specify the fixed amount.true if the deduction is calculated as a percentage type and specify the percentage in valueby_month, by_amount and infinite.If the deduction is intended to end after a specific month, specify the value as
by_month.If the deduction is intended to end after a specific amount has deducted, specify the value as
by_amount.If the deduction is never intended to end specify the value as
infiniteYYYY-MM if the termination type is by_month.by_amount.Path Parameters
Query Parameters
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v1/employees/36000000012849/deductions/49774000000257078?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v1/employees/36000000012849/deductions/49774000000257078?organization_id=10234695")
.put(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'PUT',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
'content-type': 'application/json'
},
body: '{"field1":"value1","field2":"value2"}'
};
fetch('https://www.zohoapis.in/erp/v1/employees/36000000012849/deductions/49774000000257078?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("PUT", "/erp/v1/employees/36000000012849/deductions/49774000000257078?organization_id=10234695", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "PUT",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v1/employees/36000000012849/deductions/49774000000257078?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
curl --request PUT \
--url 'https://www.zohoapis.in/erp/v1/employees/36000000012849/deductions/49774000000257078?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"deduction_name": "Cab Deduction",
"value": 20,
"is_value_in_percent": true,
"recurrence_termination_type": "by_month",
"recurrence_termination_month": "2024-10",
"recurrence_termination_amount": ""
}
{
"code": 0,
"message": "Deduction contribution has been updated.",
"employee_deduction": {
"employee_id": "36000000012849",
"deduction_id": "49774000000257078",
"deduction_name": "Cab Deduction",
"value": 20,
"is_value_in_percent": true,
"recurrence_termination_type": "by_month",
"recurrence_termination_month": "2024-10",
"recurrence_termination_amount": ""
}
}
Delete deduction
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
To delete the deduction associated with an employee.
OAuth Scope : ERP.salary.DELETE
Path Parameters
Query Parameters
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v1/employees/36000000012849/deductions/49774000000257078?organization_id=10234695"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v1/employees/36000000012849/deductions/49774000000257078?organization_id=10234695")
.delete(null)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'DELETE',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v1/employees/36000000012849/deductions/49774000000257078?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("DELETE", "/erp/v1/employees/36000000012849/deductions/49774000000257078?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "DELETE",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v1/employees/36000000012849/deductions/49774000000257078?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request DELETE \
--url 'https://www.zohoapis.in/erp/v1/employees/36000000012849/deductions/49774000000257078?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "Deduction has been removed for employee."
}
Associate benefit
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Create a benefit component at organization level, which you can also associate to employees.
OAuth Scope : ERP.salary.CREATE
Arguments
true if the contribution is calculated as a percentage of the sum of Basic and Dearness Allowance (if present)by_amount_and_reset_every_year, by_amount and infinite.If the benefit is intended to end after a specific amount has been deducted and reset every year, specify the value as
by_amount_and_reset_every_year.If the benefit is intended to end after a specific amount has deducted, specify the value as
by_amount.If the benefit is never intended to end specify the value as
infinite.by_amount or by_amount_and_reset_every_yeartrue if the contribution is calculated as a percentage of the sum of Basic and Dearness Allowance (if present)by_amount_and_reset_every_year, by_amount and infinite.If the benefit is intended to end after a specific amount has been deducted and reset every year, specify the value as
by_amount_and_reset_every_year.If the benefit is intended to end after a specific amount has deducted, specify the value as
by_amount.If the benefit is never intended to end specify the value as
infinite.by_amount or by_amount_and_reset_every_yearPath Parameters
Query Parameters
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v1/employees/36000000012849/benefits?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v1/employees/36000000012849/benefits?organization_id=10234695")
.post(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'POST',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
'content-type': 'application/json'
},
body: '{"field1":"value1","field2":"value2"}'
};
fetch('https://www.zohoapis.in/erp/v1/employees/36000000012849/benefits?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("POST", "/erp/v1/employees/36000000012849/benefits?organization_id=10234695", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v1/employees/36000000012849/benefits?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
curl --request POST \
--url 'https://www.zohoapis.in/erp/v1/employees/36000000012849/benefits?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"employee_contribution_value": 0,
"is_employee_contribution_in_percent": false,
"employee_recurrence_termination_type": "infinite",
"employee_contribution_max_limit": "",
"employer_contribution_value": 2000,
"is_employer_contribution_in_percent": false,
"employer_recurrence_termination_type": "by_amount_and_reset_every_year",
"employer_contribution_max_limit": 6000,
"benefit_id": "49774000000095189"
}
{
"code": 0,
"message": "Benefit has been added to employee.",
"employee_benefit": {
"employee_id": "36000000012849",
"employee_name": "Anand Maya",
"benefit_id": "49774000000095189",
"benefit_name": "Public Provident Fund",
"benefit_plan": "other_non_taxable_benefit",
"is_included_in_ctc": true,
"can_allow_employer_contribution": true,
"employee_contribution_value": 0,
"is_employee_contribution_in_percent": false,
"employee_recurrence_termination_type": "infinite",
"employee_contribution_max_limit": "",
"employer_contribution_value": 2000,
"is_employer_contribution_in_percent": false,
"employer_recurrence_termination_type": "by_amount_and_reset_every_year",
"employer_contribution_max_limit": 6000
}
}
List benefits
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Retrieve a list of benefits associated with an employee.
OAuth Scope : ERP.salary.READ
Path Parameters
Query Parameters
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v1/employees/36000000012849/benefits?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v1/employees/36000000012849/benefits?organization_id=10234695")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'GET',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v1/employees/36000000012849/benefits?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/erp/v1/employees/36000000012849/benefits?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v1/employees/36000000012849/benefits?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url 'https://www.zohoapis.in/erp/v1/employees/36000000012849/benefits?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "success",
"employee_benefits": [
{
"employee_id": "36000000012849",
"benefit_id": "49774000000095189",
"benefit_name": "Public Provident Fund",
"benefit_plan": "other_non_taxable_benefit",
"is_active": true,
"is_included_in_ctc": true,
"employee_contribution_value": 0,
"is_employee_contribution_in_percent": false,
"employee_recurrence_termination_type": "infinite",
"employee_contribution_max_limit": "",
"is_employee_restricted_basic_enabled": false,
"employee_restricted_basic_amount": "",
"employer_contribution_value": 2000,
"is_employer_contribution_in_percent": false,
"employer_recurrence_termination_type": "by_amount_and_reset_every_year",
"employer_contribution_max_limit": 6000,
"is_employer_restricted_basic_enabled": true,
"employer_restricted_basic_amount": 15000,
"can_override_restricted_basic_amount": false
},
{...},
{...}
]
}
Update benefit
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Update the details of a benefit associated with an employee.
OAuth Scope : ERP.salary.UPDATE
Arguments
true if the contribution is calculated as a percentage of the sum of Basic and Dearness Allowance (if present)by_amount_and_reset_every_year, by_amount and infinite.If the benefit is intended to end after a specific amount has been deducted and reset every year, specify the value as
by_amount_and_reset_every_year.If the benefit is intended to end after a specific amount has deducted, specify the value as
by_amount.If the benefit is never intended to end specify the value as
infinite.by_amount or by_amount_and_reset_every_yeartrue if the contribution is calculated as a percentage of the sum of Basic and Dearness Allowance (if present)by_amount_and_reset_every_year, by_amount and infinite.If the benefit is intended to end after a specific amount has been deducted and reset every year, specify the value as
by_amount_and_reset_every_year.If the benefit is intended to end after a specific amount has deducted, specify the value as
by_amount.If the benefit is never intended to end specify the value as
infinite.by_amount or by_amount_and_reset_every_yeartrue if the employee is eligible for EPF and employer's contribution calculation is restricted to the amount based on your organization's configuration. (Applicable only for EPF).is_employer_restricted_basic_enabled is true, the employer''s contribution is restricted to Rs.15,0000 of Basic Pay by default, defining the maximum wage for EPF calculation. Users can provide alternative values if organizational override is permitted. (Applicable only for EPF).true if the employee is eligible for EPF and employee's contribution calculation is restricted to the amount based on your organization's configuration. (Applicable only for EPF).is_employee_restricted_basic_enabled is true, the employee''s contribution is restricted to Rs.15,0000 of Basic Pay by default, defining the maximum wage for EPF calculation. Users can provide alternative values if organizational override is permitted. (Applicable only for EPF).Path Parameters
Query Parameters
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v1/employees/36000000012849/benefits/49774000000095189?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v1/employees/36000000012849/benefits/49774000000095189?organization_id=10234695")
.put(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'PUT',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
'content-type': 'application/json'
},
body: '{"field1":"value1","field2":"value2"}'
};
fetch('https://www.zohoapis.in/erp/v1/employees/36000000012849/benefits/49774000000095189?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("PUT", "/erp/v1/employees/36000000012849/benefits/49774000000095189?organization_id=10234695", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "PUT",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v1/employees/36000000012849/benefits/49774000000095189?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
curl --request PUT \
--url 'https://www.zohoapis.in/erp/v1/employees/36000000012849/benefits/49774000000095189?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"benefit_id": "49774000000095189",
"employee_contribution_value": 10,
"is_employee_contribution_in_percent": false,
"employee_recurrence_termination_type": "infinite",
"employee_contribution_max_limit": 4000,
"employer_contribution_value": 2000,
"is_employer_contribution_in_percent": false,
"employer_recurrence_termination_type": "by_amount_and_reset_every_year",
"employer_contribution_max_limit": 6000,
"is_employer_restricted_basic_enabled": true,
"employer_restricted_basic_amount": 15000,
"is_employee_restricted_basic_enabled": false,
"employee_restricted_basic_amount": ""
}
{
"code": 0,
"message": "Benefit contribution details have been updated.",
"employee_benefit": {
"employee_id": "36000000012849",
"employee_name": "Anand Maya",
"benefit_id": "49774000000095189",
"benefit_name": "Public Provident Fund",
"benefit_plan": "other_non_taxable_benefit",
"is_included_in_ctc": true,
"employee_contribution_value": 10,
"is_employee_contribution_in_percent": false,
"employee_recurrence_termination_type": "infinite",
"employee_contribution_max_limit": 4000,
"employer_contribution_value": 2000,
"is_employer_contribution_in_percent": false,
"employer_recurrence_termination_type": "by_amount_and_reset_every_year",
"employer_contribution_max_limit": 6000
}
}
Delete benefit
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
To delete the benefit associated to the employee.
OAuth Scope : ERP.salary.DELETE
Path Parameters
Query Parameters
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v1/employees/36000000012849/benefits/49774000000095189?organization_id=10234695"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v1/employees/36000000012849/benefits/49774000000095189?organization_id=10234695")
.delete(null)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'DELETE',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v1/employees/36000000012849/benefits/49774000000095189?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("DELETE", "/erp/v1/employees/36000000012849/benefits/49774000000095189?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "DELETE",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v1/employees/36000000012849/benefits/49774000000095189?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request DELETE \
--url 'https://www.zohoapis.in/erp/v1/employees/36000000012849/benefits/49774000000095189?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "Benefit has been removed for employee."
}