Employees 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

The Employees module in Zoho ERP allows you to add and manage employees' personal and salary details, assign deductions to them, upload their investment declaration and so much more.

Download Employees OpenAPI Document

End Points

POST

/employees/{employee_id}

GET

/employees/{employee_id}

DELETE

/employees/{employee_id}

POST

/employees/portal/enable

POST

/employees/portal/disable

POST

/employees/{employee_id}/invite

POST

/employees/{employee_id}/dismiss

PUT

/employees/{employee_id}/dismiss

GET

/employees/{employee_id}/terminations

Attribute

employee_id

string

Unique identifier for the employee.

first_name

string

First Name of the Employee.

middle_name

string

Middle Name of the Employee.

last_name

string

Last Name of the Employee.

employee_number

string

Employee Number.

date_of_joining

string

Date of Joining.

work_mail

string

Work Email.

mobile

string

🇮🇳 only

Work Mobile.

gender

string

🇮🇳 only

Allowed values are male, female, other

designation_id

string

Unique identifier for the designation.

designation_name

string

Designation.

department_id

string

Not applicable

Unique identifier for the department.

department_name

string

Department.

work_location_id

string

Unique identifier for the worklocation.

work_location_name

string

Name of the Work Location.

last_working_day

string

Enter last working date of the employee.

termination_type

string

Allowed values are
resigned_by_employee, terminated_by_employer, by_death and by_disability

is_portal_enabled

boolean

Enter Portal Status.

employee_status

string

Status of the employee.
Allowed values are active, terminated

is_invitation_accepted

boolean

Shows whether portal invitation accepted or note.

email_ids

array

is_director

boolean

🇮🇳 only

If the employee is director of the organization, set it as true.

personal_details

object

Show Sub-Attributes

date_of_birth

string

Enter Date of Birth.

personal_mail

string

Employee's personal Email.

father_name

string

🇮🇳 only

Employee's Father Name.

pan

string

🇮🇳 only

Enter PAN Number.

differently_abled_type

string

🇮🇳 only

Allowed values are none, visual, hearing, speech, mobility and other.

present_residential_address

object

Show Sub-Attributes

address_line_1

string

Indicates the first address line of the employee's personal residential area.

address_line_2

string

Indicates the Second Address line of the employee's personal residential area (optional).

city

string

Indicates the City of the employee's current residential address.

state_code

string

The code of the State where the employee currently resides.

zip_code

string

🇮🇳 only

The Postal or ZIP code of the employee's current address.

custom_fields

array

Custom fields.

Show Sub-Attributes

customfield_id

string

Custom Field ID.

value

string

Value of the Custom Field.

{
    "employee_id": "36000000012849",
    "first_name": "Anand",
    "middle_name": "",
    "last_name": "Maya",
    "employee_number": "2404",
    "date_of_joining": "2022-01-03",
    "work_mail": "anandmaya@zylker.in",
    "mobile": "",
    "gender": "male",
    "designation_id": "29774000000095436",
    "designation_name": "Developer",
    "department_id": "28774000000095446",
    "department_name": "Payroll",
    "work_location_id": "49774000000095438",
    "work_location_name": "Chennai",
    "last_working_day": "",
    "termination_type": "",
    "is_portal_enabled": true,
    "employee_status": "active",
    "is_invitation_accepted": true,
    "email_ids": [
        "anandmaya@zylker.in"
    ],
    "is_director": false,
    "personal_details": {
        "date_of_birth": "1994-08-09",
        "personal_mail": "anandmaya@sendwizard.in",
        "father_name": "Ram Thakur",
        "pan": "AAAAA0000K",
        "differently_abled_type": "none"
    },
    "present_residential_address": {
        "address_line_1": "SRT Avenue",
        "address_line_2": "Guduvancheri",
        "city": "Chennai",
        "state_code": "TN",
        "zip_code": "636308"
    },
    "custom_fields": [
        {
            "customfield_id": "46000000012845",
            "value": "Developer"
        }
    ]
}

Create an employee 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

Create an employee with the given information.
OAuth Scope : ERP.employee.CREATE

Arguments

first_name

string

(Required)

First Name of the Employee.

middle_name

string

Middle Name of the Employee.

last_name

string

Last Name of the Employee.

employee_number

string

(Required)

Employee Number.

date_of_joining

string

(Required)

Date of Joining.

work_mail

string

(Required)

Work Email.

mobile

string

🇮🇳 only

Work Mobile.

gender

string

(Required)

🇮🇳 only

Allowed values are male, female, other

designation_id

string

(Required)

Unique identifier for the designation.

department_id

string

(Required)

Not applicable

Unique identifier for the department.

work_location_id

string

(Required)

Unique identifier for the worklocation.

is_portal_enabled

boolean

Enter Portal Status.

employee_status

string

(Required)

Status of the employee.
Allowed values are active, terminated

last_working_day

string

Enter last working date of the employee.

termination_type

string

Allowed values are
resigned_by_employee, terminated_by_employer, by_death and by_disability

is_director

boolean

🇮🇳 only

If the employee is director of the organization, set it as true.

personal_details

object

Show Sub-Attributes

date_of_birth

string

(Required)

Enter Date of Birth.

personal_mail

string

Employee's personal Email.

father_name

string

(Required)

🇮🇳 only

Employee's Father Name.

pan

string

🇮🇳 only

Enter PAN Number.

differently_abled_type

string

🇮🇳 only

Allowed values are none, visual, hearing, speech, mobility and other.

present_residential_address

object

Show Sub-Attributes

address_line_1

string

Indicates the first address line of the employee's personal residential area.

address_line_2

string

Indicates the Second Address line of the employee's personal residential area (optional).

city

string

Indicates the City of the employee's current residential address.

state_code

string

The code of the State where the employee currently resides.

zip_code

string

🇮🇳 only

The Postal or ZIP code of the employee's current address.

custom_fields

array

Custom fields.

Show Sub-Attributes

customfield_id

string

Custom Field ID.

value

string

Value of the Custom Field.

Query Parameters

organization_id

string

(Required)

Unique identifier for the organization.

Request Example

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?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?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?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?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?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?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "first_name": "Anand",
    "middle_name": "",
    "last_name": "Maya",
    "employee_number": "2404",
    "date_of_joining": "2022-01-03",
    "work_mail": "anandmaya@zylker.in",
    "mobile": "",
    "gender": "male",
    "designation_id": "29774000000095436",
    "department_id": "28774000000095446",
    "work_location_id": "49774000000095438",
    "is_portal_enabled": true,
    "employee_status": "active",
    "last_working_day": "",
    "termination_type": "",
    "is_director": false,
    "personal_details": {
        "date_of_birth": "1994-08-09",
        "personal_mail": "anandmaya@sendwizard.in",
        "father_name": "Ram Thakur",
        "pan": "AAAAA0000K",
        "differently_abled_type": "none"
    },
    "present_residential_address": {
        "address_line_1": "SRT Avenue",
        "address_line_2": "Guduvancheri",
        "city": "Chennai",
        "state_code": "TN",
        "zip_code": "636308"
    },
    "custom_fields": [
        {
            "customfield_id": "46000000012845",
            "value": "Developer"
        }
    ]
}

{
    "code": 0,
    "message": "Anand Maya details saved successfully.",
    "employee": {
        "employee_id": "36000000012849",
        "first_name": "Anand",
        "middle_name": "",
        "last_name": "Maya",
        "employee_number": "2404",
        "date_of_joining": "2022-01-03",
        "work_mail": "anandmaya@zylker.in",
        "mobile": "",
        "gender": "male",
        "designation_id": "29774000000095436",
        "designation_name": "Developer",
        "department_id": "28774000000095446",
        "department_name": "Payroll",
        "work_location_id": "49774000000095438",
        "work_location_name": "Chennai",
        "last_working_day": "",
        "termination_type": "",
        "is_portal_enabled": true,
        "employee_status": "active",
        "is_invitation_accepted": true,
        "email_ids": [
            "anandmaya@zylker.in"
        ],
        "is_director": false,
        "personal_details": {
            "date_of_birth": "1994-08-09",
            "personal_mail": "anandmaya@sendwizard.in",
            "father_name": "Ram Thakur",
            "pan": "AAAAA0000K",
            "differently_abled_type": "none"
        },
        "present_residential_address": {
            "address_line_1": "SRT Avenue",
            "address_line_2": "Guduvancheri",
            "city": "Chennai",
            "state_code": "TN",
            "zip_code": "636308"
        },
        "custom_fields": [
            {
                "customfield_id": "46000000012845",
                "value": "Developer"
            }
        ]
    }
}

List employees 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

List all employees with pagination.
OAuth Scope : ERP.employee.READ

Query Parameters

organization_id

string

(Required)

Unique identifier for the organization.

filter_by

string

Filter employees by status. Allowed Values: Status.All, Status.Active, Status.Terminated, Status.InComplete, Status.PortalEnabled, Status.PortalDisabled, Status.PortalInvitationNotAccepted and Status.WithoutPAN

sort_column

string

Sort employees. Allowed Value: full_name, date_of_joining and created_time

page

integer

Page number to be fetched. Default value is 1.

per_page

integer

Number of records to be fetched per page. Default value is 200.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v1/employees?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?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?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?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?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?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "employees": [
        {
            "employee_id": "36000000012849",
            "first_name": "Anand",
            "middle_name": "",
            "last_name": "Maya",
            "employee_number": "2404",
            "work_location_name": "Chennai",
            "designation_name": "Developer",
            "department_name": "Payroll",
            "work_mail": "anandmaya@zylker.in",
            "employee_status": "active",
            "last_working_day": "",
            "termination_type": "",
            "ctc": 650000,
            "date_of_joining": "2022-01-03",
            "gender": "male",
            "mobile": "",
            "father_name": "Ram Thakur",
            "date_of_birth": "1994-08-09",
            "pan": "AAAAA0000K"
        },
        {...},
        {...}
    ],
    "page_context": [
        {
            "page": 1,
            "per_page": 10,
            "has_more_page": false,
            "applied_filter": "Status.Active",
            "sort_column": "created_time",
            "sort_order": "A",
            "custom_fields": []
        }
    ]
}

Update employee 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

Update existing employee details.
OAuth Scope : ERP.employee.UPDATE

Arguments

first_name

string

(Required)

First Name of the Employee.

middle_name

string

Middle Name of the Employee.

last_name

string

Last Name of the Employee.

employee_number

string

(Required)

Employee Number.

date_of_joining

string

(Required)

Date of Joining.

work_mail

string

(Required)

Work Email.

mobile

string

🇮🇳 only

Work Mobile.

gender

string

(Required)

🇮🇳 only

Allowed values are male, female, other

designation_id

string

(Required)

Unique identifier for the designation.

department_id

string

(Required)

Not applicable

Unique identifier for the department.

work_location_id

string

(Required)

Unique identifier for the worklocation.

is_portal_enabled

boolean

Enter Portal Status.

employee_status

string

(Required)

Status of the employee.
Allowed values are active, terminated

last_working_day

string

Enter last working date of the employee.

termination_type

string

Allowed values are
resigned_by_employee, terminated_by_employer, by_death and by_disability

is_director

boolean

🇮🇳 only

If the employee is director of the organization, set it as true.

personal_details

object

Show Sub-Attributes

date_of_birth

string

(Required)

Enter Date of Birth.

personal_mail

string

Employee's personal Email.

father_name

string

(Required)

🇮🇳 only

Employee's Father Name.

pan

string

🇮🇳 only

Enter PAN Number.

differently_abled_type

string

🇮🇳 only

Allowed values are none, visual, hearing, speech, mobility and other.

present_residential_address

object

Show Sub-Attributes

address_line_1

string

Indicates the first address line of the employee's personal residential area.

address_line_2

string

Indicates the Second Address line of the employee's personal residential area (optional).

city

string

Indicates the City of the employee's current residential address.

state_code

string

The code of the State where the employee currently resides.

zip_code

string

🇮🇳 only

The Postal or ZIP code of the employee's current address.

custom_fields

array

Custom fields.

Show Sub-Attributes

customfield_id

string

Custom Field ID.

value

string

Value of the Custom Field.

Path Parameters

employee_id

string

(Required)

Unique identifier for the employee.

Query Parameters

organization_id

string

(Required)

Unique identifier for the organization.

Request Example

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?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?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?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?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?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?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "first_name": "Anand",
    "middle_name": "",
    "last_name": "Maya",
    "employee_number": "2404",
    "date_of_joining": "2022-01-03",
    "work_mail": "anandmaya@zylker.in",
    "mobile": "",
    "gender": "male",
    "designation_id": "29774000000095436",
    "department_id": "28774000000095446",
    "work_location_id": "49774000000095438",
    "is_portal_enabled": true,
    "employee_status": "active",
    "last_working_day": "",
    "termination_type": "",
    "is_director": false,
    "personal_details": {
        "date_of_birth": "1994-08-09",
        "personal_mail": "anandmaya@sendwizard.in",
        "father_name": "Ram Thakur",
        "pan": "AAAAA0000K",
        "differently_abled_type": "none"
    },
    "present_residential_address": {
        "address_line_1": "SRT Avenue",
        "address_line_2": "Guduvancheri",
        "city": "Chennai",
        "state_code": "TN",
        "zip_code": "636308"
    },
    "custom_fields": [
        {
            "customfield_id": "46000000012845",
            "value": "Developer"
        }
    ]
}

{
    "code": 0,
    "message": "Anand Maya details saved successfully.",
    "employee": {
        "employee_id": "36000000012849",
        "first_name": "Anand",
        "middle_name": "",
        "last_name": "Maya",
        "employee_number": "2404",
        "date_of_joining": "2022-01-03",
        "work_mail": "anandmaya@zylker.in",
        "mobile": "",
        "gender": "male",
        "designation_id": "29774000000095436",
        "designation_name": "Developer",
        "department_id": "28774000000095446",
        "department_name": "Payroll",
        "work_location_id": "49774000000095438",
        "work_location_name": "Chennai",
        "last_working_day": "",
        "termination_type": "",
        "is_portal_enabled": true,
        "employee_status": "active",
        "is_invitation_accepted": true,
        "email_ids": [
            "anandmaya@zylker.in"
        ],
        "is_director": false,
        "personal_details": {
            "date_of_birth": "1994-08-09",
            "personal_mail": "anandmaya@sendwizard.in",
            "father_name": "Ram Thakur",
            "pan": "AAAAA0000K",
            "differently_abled_type": "none"
        },
        "present_residential_address": {
            "address_line_1": "SRT Avenue",
            "address_line_2": "Guduvancheri",
            "city": "Chennai",
            "state_code": "TN",
            "zip_code": "636308"
        },
        "custom_fields": [
            {
                "customfield_id": "46000000012845",
                "value": "Developer"
            }
        ]
    }
}

Get employee 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

Fetch existing employee details.
OAuth Scope : ERP.employee.READ

Path Parameters

employee_id

string

(Required)

Unique identifier for the employee.

Query Parameters

organization_id

string

(Required)

Unique identifier for the organization.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v1/employees/36000000012849?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?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?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?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?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?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "employee": {
        "employee_id": "36000000012849",
        "first_name": "Anand",
        "middle_name": "",
        "last_name": "Maya",
        "employee_number": "2404",
        "date_of_joining": "2022-01-03",
        "designation_id": "29774000000095436",
        "designation_name": "Developer",
        "department_id": "28774000000095446",
        "department_name": "Payroll",
        "work_mail": "anandmaya@zylker.in",
        "mobile": "",
        "gender": "male",
        "employee_status": "active",
        "last_working_day": "2021-03-31",
        "work_location_details": {
            "work_location_id": "49774000000095438",
            "work_location_name": "Chennai",
            "state_code": "TN"
        },
        "is_director": false,
        "is_tax_deductor": false,
        "termination_type": "",
        "personal_details": {
            "date_of_birth": "1994-08-09",
            "personal_mail": "anandmaya@sendwizard.in",
            "father_name": "Ram Thakur",
            "pan": "AAAAA0000K",
            "differently_abled_type": "none"
        },
        "present_residential_address": {
            "address_line_1": "SRT Avenue",
            "address_line_2": "Guduvancheri",
            "city": "Chennai",
            "state_code": "TN",
            "zip_code": "636308"
        },
        "email_ids": [
            "anandmaya@zylker.in"
        ],
        "custom_fields": [
            {
                "customfield_id": "46000000012845",
                "value": "Developer"
            }
        ]
    }
}

Delete employee 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

Delete an existing employee.
OAuth Scope : ERP.employee.DELETE

Path Parameters

employee_id

string

(Required)

Unique identifier for the employee.

Query Parameters

organization_id

string

(Required)

Unique identifier for the organization.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v1/employees/36000000012849?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?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?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?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?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?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "Employee has been deleted from the organization."
}

Bulk enable portal 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

Bulk enable portal for the employees.
OAuth Scope : ERP.employee.CREATE

Arguments

employee_ids

string

Employee IDs separated by comma.

Path Parameters

employee_id

string

(Required)

Unique identifier for the employee.

Query Parameters

organization_id

string

(Required)

Unique identifier for the organization.

Request Example

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/portal/enable?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/portal/enable?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/portal/enable?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/portal/enable?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/portal/enable?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/portal/enable?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "employee_ids": "40712000000092001,40712000000101001"
}

{
    "code": 0,
    "message": "Employee Portal enabled for the selected active employees"
}

Bulk disable portal 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

Bulk disable portal for the employees.
OAuth Scope : ERP.employee.CREATE

Arguments

employee_ids

string

Employee IDs separated by comma.

Path Parameters

employee_id

string

(Required)

Unique identifier for the employee.

Query Parameters

organization_id

string

(Required)

Unique identifier for the organization.

Request Example

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/portal/disable?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/portal/disable?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/portal/disable?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/portal/disable?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/portal/disable?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/portal/disable?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "employee_ids": "40712000000092001,40712000000101001"
}

{
    "code": 0,
    "message": "Employee Portal disabled for the selected employees"
}

Send portal invitation 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

Send portal invitation to the employee.
OAuth Scope : ERP.employee.CREATE

Path Parameters

employee_id

string

(Required)

Unique identifier for the employee.

Query Parameters

organization_id

string

(Required)

Unique identifier for the organization.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v1/employees/36000000012849/invite?organization_id=10234695"
type: POST
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/invite?organization_id=10234695")
  .post(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.in/erp/v1/employees/36000000012849/invite?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("POST", "/erp/v1/employees/36000000012849/invite?organization_id=10234695", headers=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/invite?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 POST \
  --url 'https://www.zohoapis.in/erp/v1/employees/36000000012849/invite?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "Your invitation has been sent."
}

Initiate employee exit 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

Inititate employee exit.
OAuth Scope : ERP.employee.CREATE

Arguments

last_working_day

string

Enter last working date of the employee.

termination_type

string

Allowed values are
resigned_by_employee, terminated_by_employer, by_death and by_disability

personal_mail

string

Employee's personal Email.

termination_payroll_date

string

Enter processing date of the final settlement payroll.

Path Parameters

employee_id

string

(Required)

Unique identifier for the employee.

Query Parameters

organization_id

string

(Required)

Unique identifier for the organization.

Request Example

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/dismiss?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/dismiss?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/dismiss?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/dismiss?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/dismiss?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/dismiss?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "last_working_day": "2021-03-31",
    "termination_type": "resigned_by_employee",
    "personal_mail": "anandmaya@sendwizard.in",
    "termination_payroll_date": "2021-03-31"
}

{
    "code": 0,
    "message": "Exit Processed",
    "termination_payroll_run": {
        "payroll_run_id": "49774000000257017"
    }
}

Update exit 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

Update exit details of the employee.
OAuth Scope : ERP.employee.UPDATE

Arguments

last_working_day

string

Enter last working date of the employee.

termination_type

string

Allowed values are
resigned_by_employee, terminated_by_employer, by_death and by_disability

personal_mail

string

Employee's personal Email.

termination_payroll_date

string

Enter processing date of the final settlement payroll.

Path Parameters

employee_id

string

(Required)

Unique identifier for the employee.

Query Parameters

organization_id

string

(Required)

Unique identifier for the organization.

Request Example

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/dismiss?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/dismiss?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/dismiss?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/dismiss?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/dismiss?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/dismiss?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "last_working_day": "2021-03-31",
    "termination_type": "resigned_by_employee",
    "personal_mail": "anandmaya@sendwizard.in",
    "termination_payroll_date": "2021-03-31"
}

{
    "code": 0,
    "message": "Employee exit details updated."
}

Get Exit History 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

Get Employee Exit History Details.
OAuth Scope : ERP.employee.READ

Path Parameters

employee_id

string

(Required)

Unique identifier for the employee.

Query Parameters

organization_id

string

(Required)

Unique identifier for the organization.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v1/employees/36000000012849/terminations?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/terminations?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/terminations?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/terminations?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/terminations?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/terminations?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "employee": {
        "employee_id": "36000000012849",
        "first_name": "Anand",
        "middle_name": "",
        "last_name": "Maya",
        "employee_work_history": [
            {
                "work_history_id": "43723000000374109",
                "date_of_joining": "2022-01-03",
                "last_working_day": "2021-03-31",
                "termination_type": "resigned_by_employee",
                "final_payrollrun_id": "43723000000374532",
                "final_settlement_date": "2021-03-31"
            }
        ]
    }
}

Employees 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

Attribute

Create an employee 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

Arguments

Query Parameters

List employees 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

Query Parameters

Update employee 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

Arguments

Path Parameters

Query Parameters

Get employee 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

Path Parameters

Query Parameters

Delete employee 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

Path Parameters

Query Parameters

Bulk enable portal 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

Arguments

Path Parameters

Query Parameters

Bulk disable portal 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

Arguments

Path Parameters

Query Parameters

Send portal invitation 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

Path Parameters

Query Parameters

Initiate employee exit 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

Arguments

Path Parameters

Query Parameters

Update exit 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

Arguments

Path Parameters

Query Parameters

Get Exit History 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

Path Parameters

Query Parameters

Employees 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

Create an employee 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

List employees 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

Update employee 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

Get employee 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

Delete employee 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

Bulk enable portal 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

Bulk disable portal 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

Send portal invitation 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

Initiate employee exit 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

Update exit 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

Get Exit History 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