Darwinbox MCP Server

The Create Employee API allows you to create a new employee record in the system. It requires a POST request to the endpoint with necessary headers and a JSON body containing employee details such as first name, last name, employment details, work email, and more. The employment object must include a positionId and designation. The API supports various HR applications, each with specific requirements and unsupported fields. The response includes a success flag and the employeeId of the newly created employee. In case of an error, a descriptive error message is returned.

The Enroll Employee Deductions API allows for enrolling an employee in a deduction plan. It requires the employee ID as a mandatory field. Other optional fields include deduction ID, deduction code, employee and employer contributions, start date, and metadata. The API supports various apps like ADP Run, Paycor, Paychex, Paylocity, PrismHR, Avionte, and ADP Workforce Now. The response indicates success or failure, with an optional error message in case of failure.

The List HR Departments API retrieves a list of departments from the HR system. It supports multiple applications such as Workday, SAP SuccessFactors, GreytHR, and more. The API requires an 'accept' header specifying 'application/json'. It has an optional query parameter 'originData' which defaults to false. The response includes a success flag and a data object containing an array of department objects, each with an id, name, description, parentId, and companyId. In case of an error, the response will include a success flag set to false and an error message.

This API endpoint retrieves the leave balance for a specified employee for the current year. It requires the 'employeeId' as a query parameter and optionally accepts 'originData' to include the origin API response. The response includes a list of leave balances, detailing the type of leave, unit, available balance, and used balance. Supported applications include Darwinbox, GreytHR, Zoho People, Workday, Sage, ADP Workforce Now, Personio, BambooHR, Paychex, Remote, Deel, Paycor, Ceredian Dayforce, Rippling, UKG Pro, Keka HR, and UKG Ready.

The Update Employee Compensation API allows updating the compensation details of an employee. It requires the employee ID and the effective date of the update. The request body can include fixed, variable, and stock compensation elements, each with specific properties such as type, planId, amount, percentage, currency, payPeriod, and frequency. The API supports various applications like Workday, Hibob, BambooHR, and others, each with specific rules for updating compensation. The response indicates success or failure, with an optional error message in case of failure.

The Add HR Attendance Record API allows you to add an attendance record for an employee. It requires the employee ID as a mandatory field, and optionally accepts check-in and check-out date-time values, along with metadata that can include fields like break_duration or remarks. The API supports various apps like Darwinbox, HROne, and Lucca HR, each with specific metadata fields. The response indicates success or failure of the operation, with a success flag and optional error message.

The Get Employee Field Values API retrieves the values for specified employee fields such as employmentType and employmentStatus. It supports various HR applications like BambooHR, Darwinbox, GreytHR, Keka HR, Zoho People, Hibob, Workday, Paycom, Paycor, Paychex, HR One, Alexis HR, and UKG Ready. The API requires a query parameter 'fieldType' to specify the type of field to retrieve. The response includes a success flag and a list of fields with their IDs and labels. In case of an error, an error message is provided.

The Create HR Deduction API allows users to create a new deduction in the HR system. The API requires a POST request to the endpoint with headers specifying 'accept' and 'content-type' as 'application/json'. The request body must include the deduction's name, type, frequency, description, and any additional metadata. Upon success, the API returns a response with a 'success' flag and the 'deductionId' of the newly created deduction. In case of an error, the response includes a 'success' flag set to false and an error message.

This API endpoint retrieves the payroll statement for a specified employee for a given month or date range. The request requires the 'employeeId' as a mandatory query parameter. You can specify the time range using either the 'month' parameter in 'yyyy-mm' format or 'startDate' and 'endDate' parameters. However, some apps like Darwinbox, GreytHR, and RazorpayX Payroll require the 'month' parameter and do not support 'startDate' and 'endDate'. The response includes details such as gross pay, net pay, processed date, pay date, earnings, contributions, and deductions. The API supports various HR systems like Keka HR, Zoho People, Workday, and more.

The Update Employee Details API allows updating various details of an employee such as personal and work email addresses, present and work addresses, and employment details. The API supports multiple HR applications, each with specific field support limitations. The request requires an employeeId and can include optional fields like firstName, lastName, workEmail, personalEmails, presentAddress, workAddress, employment, and metadata. The response indicates success or failure, with an optional error message in case of failure.

The Update Employee Deductions API allows updating the deduction details for an employee. It requires the employeeId as a mandatory field in the request body, along with optional fields such as employeeDeductionId, deductionId, employeeContribution, employerContribution, and metadata. The API supports applications like ADP Run, Paycor, Paychex, Paylocity, and ADP Workforce Now. The response indicates success or failure of the operation, with a success flag and optional error message.

The Get Compensation Plans API retrieves compensation plans including fixed, variable, and stock components. It supports various applications such as Workday, Hibob, Paycor, SAP Successfactors, Paychex, Quickbooks Payroll, Lucca HR, and PrismHR. The API requires an 'accept' header with 'application/json' and optionally accepts a 'originData' query parameter to include origin data. The response includes detailed compensation data with fixed, variable, and stock plans, or an error message if the request fails.

The Get HR Document Categories API retrieves a list of document categories available in the HR system. It supports various applications such as Workday, Sage, Hibob, Personio, Zoho People, SAP Successfactors, Keka, and Avionte. The API requires an 'accept' header specifying 'application/json'. It has an optional query parameter 'originData' which is a boolean flag to include origin data, defaulting to false. The response includes a 'success' flag and a 'data' object containing an array of categories, each with an 'id' and 'name'. In case of an error, an 'error' object with a descriptive message is returned.

The Get Leave Types API retrieves a list of leave types supported by various HR applications. The request is made using the GET method to the endpoint https://api.getknit.dev/v1.0/hr.leave.types. It accepts a query parameter 'originData' which is a boolean flag to include origin data, defaulting to false. The request header must include 'accept: application/json'. The response includes a success flag and a data object containing an array of leave types, each with an id, name, and type. In case of an error, the response will include a success flag set to false and an error message.

The Terminate Employee API allows you to terminate an employee by providing their employee ID, termination date, and termination reason. The API requires the 'accept' and 'content-type' headers to be set to 'application/json'. The request body must include 'employeeId', 'terminationDate', and 'terminationReason'. Optionally, 'metadata' can be provided for additional information. The response will indicate success or failure, with an error message if applicable. Supported apps may have specific requirements for the 'terminationReason' and 'metadata' fields.

This API retrieves a list of attendance records for a specified employee within a given month. The request requires the 'employeeId' and 'month' as query parameters. An optional 'originData' parameter can be included to return the origin API response. The response includes details such as date, shift start and end times, total hours, break hours, effective hours, first in and last out times, and attendance status. The API is supported by various HR applications including Darwinbox, Keka HR, GreytHR, and others.

The Unenroll Employee Deductions API allows supported applications to unenroll an employee from specific deductions. The API requires a POST request to the endpoint with headers specifying 'accept' and 'content-type' as 'application/json'. The request body must include the 'employeeId' as a required field, and optionally 'employeeDeductionId', 'deductionId', 'deductionCode', and 'metadata'. The response will indicate success with a boolean and may include additional data or an error message if the operation fails.

This API endpoint allows the creation of a leave request for an employee. It requires the employee ID, leave type ID, start and end date-time, unit of leave (DAYS or HOURS), and the amount of leave. The request body must be in JSON format. On success, it returns a success status and the leave request ID. If the request fails, it returns an error message.

The List HR Deductions API allows users to retrieve a list of HR deductions. It supports various applications such as SAP SuccessFactors, ADP Run, Paycor, Paychex, Workday, Paylocity, UKG Ready, and PrismHR. The API uses the GET method and requires the 'accept' header to be set to 'application/json'. It has an optional query parameter 'originData' which is a boolean flag to include origin data. The response can be a list of deductions with details such as deductionId, deductionCode, type, description, frequency, startDate, and isTax. In case of an error, the response will include a success flag and an error message.

The Update HR Deductions API allows users to update details of HR deductions. It requires a POST request to the endpoint 'https://api.getknit.dev/v1.0/hr.deductions.update'. The request must include headers specifying 'accept' and 'content-type' as 'application/json'. The body of the request must include the 'deductionId' as a required field, and optionally 'frequency', 'description', and 'metadata'. The response will indicate success with a boolean 'success' field and may include additional data or error messages.

The List HR Companies API endpoint allows users to retrieve a list of HR companies. It supports various applications such as Darwinbox, Rippling, Workline, and more. The API uses the GET method and requires an 'accept' header with the value 'application/json'. It also accepts an optional query parameter 'originData' which is a boolean flag to include origin data. The response includes a success flag and a data object containing an array of companies, each with details like companyId, companyName, and address information. In case of an error, an error message is provided.

This API endpoint retrieves the list of employee positions and work shifts. It supports various HR applications such as Workday, Sage, Hibob, and more. The request is made using the GET method to the URL https://api.getknit.dev/v1.0/hr.employees.positions. The request requires an 'accept' header with the value 'application/json'. An optional query parameter 'originData' can be included to specify if origin data should be included in the response. The response includes a success flag, a list of positions with their IDs, designations, and departments, and a list of work shifts with their IDs and names. In case of an error, the response will include an error message.

This API retrieves a list of leave requests for a specified employee within a given date range. The request requires the 'employeeId' as a mandatory query parameter. You can specify the time range using either the 'month' parameter in yyyy-mm format or 'startDate' and 'endDate' parameters. The response includes details such as leave request ID, start and end dates, status, leave type, and whether the leave is paid. The API supports various HR applications such as Darwinbox, Keka HR, GreytHR, and others.

The Upload Employee Document API allows users to upload documents for employees. The API requires the employee ID and file name as mandatory fields. The document can be uploaded by providing either the base64 encoded content or a URL to the file. Additional optional fields include content type, category, comment, and metadata. The response includes a success flag and the document ID if successful, or an error message and type if the request fails. The category field is mandatory for some applications like Darwinbox and Zoho People.

The Get Termination Reasons API retrieves a list of termination reasons supported by various apps such as Workday, Hibob, BambooHR, Remote, 7shifts, and UKG Ready. The API requires an 'accept' header specifying 'application/json'. It supports an optional query parameter 'originData' which defaults to false. The response includes a success flag and a data object containing an array of termination reasons, each with an 'id' and 'name'. In case of an error, an error message is provided.