Guides
Signup For Free

GreytHR API Integration

Suggest Edits

These are the list of integration use cases supported by Knit for GreytHR API as part of the HRIS category

Delete Asset Allocated to Employee

  • ID: delete_asset_allocated_to_employee
  • Operation: write
  • Entities: family member, asset, employee
  • Summary: This API endpoint allows the deletion of an asset allocated to a specific employee. The request requires the employee ID and asset ID as path parameters. The headers must include an ACCESS-TOKEN for authentication and the x-greythr-domain to specify the company domain. Upon successful deletion, the API returns an empty response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Attendance Snapshot

  • ID: delete_attendance_snapshot
  • Operation: write
  • Entities: period, employee, attendance snapshot
  • Summary: The Delete Attendance Snapshot API allows for the deletion of attendance snapshot details for a specified employee over a given period. The API requires the employee's primary ID as a path parameter and the start and end dates of the period as query parameters. The request headers must include an access token and the domain. The request body should contain an array of objects with 'item' and 'fromDate' fields. The response returns a message indicating the success of the deletion operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Employee Address Details

  • ID: delete_employee_address_details
  • Operation: write
  • Entities: employee, address
  • Summary: The 'Delete Employee Address Details' API allows you to delete a specific type of address for a given employee. The API requires the employee ID and the address type as path parameters. It also requires an access token and the domain of your company as headers. The API uses the DELETE method and does not require a request body. Upon successful deletion, the API returns an empty response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Employee Card Details

  • ID: delete_employee_card_details
  • Operation: delete
  • Entities: employee, card
  • Summary: This API is used to delete a particular employee’s card details based on the employee Id and card Id. It requires the 'employeeId' and 'cardId' as path parameters, and the 'ACCESS-TOKEN' and 'x-greythr-domain' as headers. The API is only available for the Middle East region. Upon successful deletion, it returns a message indicating that the card details were deleted successfully.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Employee Identity

  • ID: delete_employee_identity
  • Operation: write
  • Entities: access token, employee, identity
  • Summary: The Delete Employee Identity API allows you to delete a specific identity of an employee in the greythr system. The API requires the employee ID and the identity code as path parameters. It also requires an access token and the domain of your company as headers. The request does not return any response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Employee Qualifications Details

  • ID: delete_employee_qualifications_details
  • Operation: write
  • Entities: qualification, employee
  • Summary: This API deletes a specific qualification for an employee. It requires the employee ID and the qualification ID as path parameters. The request must include headers for 'ACCESS-TOKEN' and 'x-greythr-domain'. Upon successful deletion, the API returns an empty JSON object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Employee Salary Items

  • ID: delete_employee_salary_items
  • Operation: write
  • Entities: salary, item, employee
  • Summary: This API deletes specific salary items for a given employee identified by the employee-id in the path. The request requires an access token and the domain of the company in the headers. The body of the request should contain an array of objects, each specifying a salary item code and a start date. Upon successful deletion, the API returns a confirmation message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Family Member Details

  • ID: delete_family_member_details
  • Operation: write
  • Entities: family member, employee
  • Summary: The Delete Family Member Details API allows you to delete a family member associated with an employee in the system. To use this API, you need to provide the employee ID and the relation ID of the family member you wish to delete. The request requires an access token and the domain of your company as headers. Upon successful deletion, the API returns an empty response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Employee Address Details

  • ID: get_all_employee_address_details
  • Operation: read
  • Entities: employee, address, company
  • Summary: This API endpoint is used to fetch address details for all employees by specifying the address type in the path parameter. The request requires headers including an ACCESS-TOKEN and the x-greythr-domain. The response returns a list of employee addresses with details such as employeeId, address lines, city, state, country, postal code, contact numbers, email, and address type. The response also includes pagination details indicating the total number of pages, elements, and sorting information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Employee Asset Details

  • ID: get_all_employee_asset_details
  • Operation: read
  • Entities: page, asset, employee
  • Summary: This API endpoint is used to fetch asset details for all employees. It requires two headers: 'ACCESS-TOKEN' which is the access token for authentication, and 'x-greythr-domain' which specifies the domain of the company. The response includes a list of assets with details such as asset ID, employee ID, asset type, asset details, asset value, and status. Pagination information is also provided in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Employee Bank Details

  • ID: get_all_employee_bank_details
  • Operation: read
  • Entities: page, employee, bank account
  • Summary: The 'Get All Employee Bank Details' API retrieves the bank details of all employees. It requires two headers: 'ACCESS-TOKEN' which is the access token for authentication, and 'x-greythr-domain' which specifies the domain of the company. The API returns a list of employee bank details including employee ID, bank account number, account type, bank name, bank branch, branch code, salary payment mode, demand draft payable location, and name as per bank records. The response also includes pagination details such as total pages, total elements, page size, and sorting information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Employee Hand Entry Salary Items

  • ID: get_all_employee_hand_entry_salary_items
  • Operation: read
  • Entities: employee, hand entry, salary item
  • Summary: This API endpoint retrieves hand entry salary items for all employees. It requires two headers: 'ACCESS-TOKEN' for authentication and 'x-greythr-domain' to specify the company domain. The response includes a list of employees, each with their respective hand entry salary items, which consist of an item ID, start date, optional end date, and value. The response also includes pagination details such as total pages, total elements, and whether there are more pages available.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Employee Identity Details

  • ID: get_all_employee_identity_details
  • Operation: read
  • Entities: document, employee, identity detail
  • Summary: The 'Get All Employee Identity Details' API retrieves the identity details of all employees based on the provided identity code. The API requires an access token and the domain of the company as headers. The identity code is a path parameter and can be one of the following: PAN, BANKACCNO, PASSPORT, AADHAR, NPR, PRAN, LWF, DL, RC, EC. The response includes a list of employee identity details such as id, idType, employeeId, documentNo, nameAsPerDoc, ifscCode, expiryDate, verified status, verifiedDate, aadharAppNo, enableMasking, and guid. The response also includes pagination details like totalPages, totalElements, size, and sort information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Employee Personal Details

  • ID: get_all_employee_personal_details
  • Operation: read
  • Entities: personal detail, employee
  • Summary: This API endpoint is used to fetch personal details for all employees. It requires two headers: 'ACCESS-TOKEN' which is the access token for authentication, and 'x-greythr-domain' which specifies the domain of the company. The response includes an array of employee personal details such as employeeId, bloodGroup, maritalStatus, marriageDate, spouseBirthday, spouseName, and actualDOB. Additionally, pagination details are provided in the 'pages' object, indicating the total number of pages, total elements, and sorting information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Employee PF & ESI Details

  • ID: get_all_employee_pf_esi_details
  • Operation: read
  • Entities: employee, pf, esi
  • Summary: This API endpoint is used to fetch Provident Fund (PF), Employee State Insurance (ESI), and Universal Account Number (UAN) details for all employees. It requires an access token and the company's domain as headers. The response includes an array of employee records, each containing details such as employee ID, PF eligibility, ESI eligibility, PF number, UAN, and more. The response also includes pagination information indicating the total number of pages, elements, and other pagination details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Employee Positions Details

  • ID: get_all_employee_positions_details
  • Operation: read
  • Entities: employee, position, category
  • Summary: The 'Get All Employee Positions Details' API retrieves a list of all employees along with their associated category details from the greythr system. The API requires two headers: 'ACCESS-TOKEN' for authentication and 'x-greythr-domain' to specify the domain of the company. The response includes a list of employees, each with a unique 'employeeId' and a 'categoryList' detailing various categories associated with the employee, including category type, value, and effective dates. The response also includes pagination details such as total pages, total elements, and sorting information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Employee Profile Details

  • ID: get_all_employee_profile_details
  • Operation: read
  • Entities: page, employee, profile
  • Summary: This API endpoint is used to fetch profile details for all employees. It requires two headers: 'ACCESS-TOKEN' which is the access token for authentication, and 'x-greythr-domain' which specifies the domain of the company. The response includes an array of employee profiles, each containing details such as employeeId, nickname, social media profiles, biography, and wishDOB. Additionally, pagination details are provided in the 'pages' object, indicating the total number of pages, elements, and sorting information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Employee Qualifications Details

  • ID: get_all_employee_qualifications_details
  • Operation: read
  • Entities: qualification, employee, institute
  • Summary: This API endpoint is used to fetch qualifications details for all employees. It requires two headers: 'ACCESS-TOKEN' which is the access token for authentication, and 'x-greythr-domain' which specifies the domain of the company using greythr. The response includes a list of qualifications for each employee, with details such as qualification ID, employee ID, qualification description, year, completion year, duration, institute, and more. The response also includes pagination details indicating the total number of pages, elements, and whether there are more pages available.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Employee Separation Details

  • ID: get_all_employee_separation_details
  • Operation: read
  • Entities: resignation, employee, separation
  • Summary: This API endpoint is used to fetch exit-separation details for all employees. It requires an access token and the domain of the company as headers. The API supports optional query parameters such as 'sort' and 'state' to filter the results. The response includes a list of employee separation details, including employee ID, leaving date, retirement date, and other relevant information. The response also contains pagination details indicating the total number of pages, elements, and sorting information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Employee Statutory Details

  • ID: get_all_employee_statutory_details
  • Operation: read
  • Entities: page, statutory detail, employee
  • Summary: The Get All Employee Statutory Details API retrieves the statutory details of employees in India. It requires an access token and the domain of the company as headers. The response includes an array of employee statutory details such as employee ID, birthplace, parents' names, nationality, disability status, expatriate status, and more. The response also includes pagination details indicating the total number of pages, elements, and sorting information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Employee Work Details

  • ID: get_all_employee_work_details
  • Operation: read
  • Entities: page, work detail, employee
  • Summary: This API endpoint is used to fetch work details for all employees. It requires two headers: 'ACCESS-TOKEN' which is the access token for authentication, and 'x-greythr-domain' which specifies the domain of the company. The response includes a list of employees with their work details such as employee ID, extension, confirmation date, last promotion date, last previous employment, notice period, original hire date, probation extended by, and onboarding status. The response also includes pagination details such as total pages, total elements, page size, and sorting information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Employees

  • ID: get_all_employees
  • Operation: read
  • Entities: page, employee, parameter
  • Summary: The Get All Employees API retrieves a list of all employees with their detailed information. It supports filtering based on parameters such as state, status, and categories. The API uses pagination, with a default page size of 25 records, which can be adjusted using the 'page' and 'size' query parameters. The 'page' parameter is mandatory. Additional optional query parameters include 'state', 'status', 'category', 'modifiedSince', 'attendanceScheme', and 'sort'. The response includes employee details such as employeeId, name, email, employeeNo, dateOfJoin, and more, along with pagination details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Attendance Muster Details for All Employees

  • ID: get_attendance_muster_details_for_all_employees
  • Operation: read
  • Entities: muster, attendance, employee
  • Summary: The 'Get Attendance Muster Details for All Employees' API retrieves attendance muster details for all employees within a specified date range. The API requires an access token and the domain of the company as headers. The start and end dates for the attendance period must be provided as query parameters. The response includes detailed attendance records for each employee, including attendance date, scheme name, day type, shift details, work hours, and any exceptions. The response also includes pagination details to navigate through the records.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Attendance Snapshot Details

  • ID: get_attendance_snapshot_details
  • Operation: read
  • Entities: period, employee, attendance snapshot
  • Summary: This API retrieves the attendance snapshot details of an employee for a specified period based on the employee ID. The request requires the employee ID as a path parameter and the start and end dates as query parameters in ISO format (yyyy-mm-dd). The headers must include an access token and the domain of the company. The response provides an array of attendance snapshots, each containing details such as attendance date, session statuses, total hours, shift type, overtime details, day type, early out and late in minutes, actual hours, leave types for sessions, and any remarks.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Attendance Summary for All Employees

  • ID: get_attendance_summary_for_all_employees
  • Operation: read
  • Entities: attendance, insight, employee
  • Summary: The 'Get Attendance Summary for All Employees' API provides a summary of attendance insights for all employees within a specified date range. The API requires an access token and the domain of the company as headers. The start and end dates are mandatory query parameters. The response includes detailed insights for each employee, such as average work hours, penalty days, and attendance status. The response also includes pagination details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Bank Branch Details

  • ID: get_bank_branch_details
  • Operation: read
  • Entities: branch, bank
  • Summary: The Get Bank Branch Details API retrieves details of branches for a specified bank using the bank ID. The request requires an access token and the domain of the company as headers. The bank ID is a path parameter. The response returns an array of branch objects, each containing an ID and a description of the branch location.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Download Employee Documents

  • ID: get_download_employee_documents
  • Operation: read
  • Entities: document, employee, field
  • Summary: The 'Download Employee Documents' API allows users to download specific documents related to an employee. It requires the employee ID, document ID, and file ID as path parameters to identify and retrieve the correct document. The request must include headers for 'ACCESS-TOKEN' and 'x-greythr-domain' to authenticate and specify the domain. The response is a PDF document containing the requested employee document. This API is useful for accessing employee-related documents stored in the system.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Address Details

  • ID: get_employee_address_details
  • Operation: read
  • Entities: employee, address, company
  • Summary: The Get Employee Address Details API retrieves the address details of a specific employee based on the employee ID and address type provided in the path parameters. The request requires an access token and the domain of the company as headers. The response includes detailed information about the employee's address, such as address lines, city, state, country, postal code, phone numbers, email, and other related details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee All Card Details

  • ID: get_employee_all_card_details
  • Operation: read
  • Entities: card detail, employee
  • Summary: The 'Get Employee All Card Details' API is used to fetch all card details associated with a specific employee based on their employee ID. This API is specifically available for the Middle East region. The request requires an 'ACCESS-TOKEN' and 'x-greythr-domain' in the headers, and the 'employeeId' as a path parameter. The response returns an array of card details, including information such as relation, card type, card ID, card number, personal number, issue date, expiry date, and whether the card is currently active.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Asset Details

  • ID: get_employee_asset_details
  • Operation: read
  • Entities: asset, asset type, employee
  • Summary: The Get Employee Asset Details API allows users to fetch the asset details of a specific employee using their employee ID. The request requires an access token and the domain of the company as headers. The response returns an array of asset objects, each containing details such as asset ID, type, value, status, issue date, validity, and any remarks.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Attendance Muster

  • ID: get_employee_attendance_muster
  • Operation: read
  • Entities: shift, attendance, employee
  • Summary: The 'Get Employee Attendance Muster' API retrieves the attendance records for a specific employee within a given date range. The API requires the employee ID as a path parameter and the start and end dates as query parameters. The request headers must include an access token and the company's greythr domain. The response includes detailed attendance records for each day within the specified period, including information about the employee, attendance summary, shift details, work hours, and any exceptions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Attendance Muster Raw Swipes

  • ID: get_employee_attendance_muster_raw_swipes
  • Operation: read
  • Entities: shift, attendance, employee
  • Summary: The 'Get Employee Attendance Muster Raw Swipes' API retrieves raw swipe data for a specified employee within a given date range. The API requires an access token and the company's domain in the headers. The employee ID is specified in the path parameters, while the start and end dates, along with a flag for system swipes, are provided as query parameters. The response includes a list of swipe records, each containing details about the employee, attendance date, punch time, in/out indicator, door name, and shift information, among other attributes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Attendance Summary

  • ID: get_employee_attendance_summary
  • Operation: read
  • Entities: attendance, employee, summary
  • Summary: The Get Employee Attendance Summary API retrieves an employee's attendance summary for a specified date range, with a maximum range of 31 days. The API requires an access token and the company's domain in the headers, and the employee ID as a path parameter. The start and end dates must be provided as query parameters. The response includes averages of work hours, actual work hours, in and out times, and differences, as well as counts of penalty, late in, early out, and exception days. It also provides the status of days as present, remote, or leave, along with the employee's details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Bank Details

  • ID: get_employee_bank_details
  • Operation: read
  • Entities: employee, bank account
  • Summary: The Get Employee Bank Details API retrieves the bank details of a specific employee using their employee ID. The request requires an access token and the domain of the company as headers. The employee ID is a path parameter. The response includes details such as the bank account number, account type, bank name, bank branch, branch code, salary payment mode, demand draft payable location, and the name as per bank records.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Card Details

  • ID: get_employee_card_details
  • Operation: read
  • Entities: card detail, employee
  • Summary: This API is used to fetch card details for a particular employee based on employee ID and card ID. It requires the 'ACCESS-TOKEN' and 'x-greythr-domain' headers. The path parameters 'employeeId' and 'cardId' are mandatory. The response includes details such as the relation of the cardholder to the employee, card type, card ID, card number, personal number, issue date, expiry date, and whether the card is current. This API is only available for the Middle East region.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Details

  • ID: get_employee_details
  • Operation: read
  • Entities: employee detail, employee
  • Summary: The Get Employee Details API retrieves information about an employee using their employee ID. The request requires an access token and the domain of the company as headers, and the employee ID as a path parameter. The response includes detailed information about the employee such as their name, email, employee number, joining date, and other personal and employment details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Documents

  • ID: get_employee_documents
  • Operation: read
  • Entities: employee, document, category
  • Summary: The Get Employee Documents API is used to fetch documents associated with a specific employee based on their employee ID and an optional category ID. The API requires an access token and the domain of the company as headers. The employee ID is mandatory, while the category ID is optional. The response includes a list of documents categorized by their category ID, each containing document IDs and associated files with details such as file ID, name, and creation date.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Family Details

  • ID: get_employee_family_details
  • Operation: read
  • Entities: family, employee, relation
  • Summary: The Get Employee Family Details API allows users to fetch the family details of a specific employee using their employee ID. The request requires headers including an ACCESS-TOKEN for authentication and the x-greythr-domain to specify the company domain. The employee ID is a path parameter that identifies which employee's family details are being requested. The response returns an array of family members, each with details such as ID, name, relation ID, date of birth, blood group, gender, and profession.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Hand Entry Salary Items

  • ID: get_employee_hand_entry_salary_items
  • Operation: read
  • Entities: page, employee, salary item
  • Summary: The Get Employee Hand Entry Salary Items API retrieves hand entry item values for a specified employee. The API requires an access token and the domain of the company as headers, and the employee ID as a path parameter. The response includes a list of salary items with details such as item name, description, order, date range, and value. Pagination information is also provided in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Identity Details

  • ID: get_employee_identity_details
  • Operation: read
  • Entities: employee, identity
  • Summary: The Get Employee Identity Details API allows you to retrieve specific identity details of an employee by providing the employee ID and the identity code. The identity code can be one of several types such as PAN, BANKACCNO, PASSPORT, AADHAR, etc. The request requires an access token and the domain of the company as headers. The response includes details such as the document number, name as per the document, verification status, and other relevant information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Leave Balance for a Year

  • ID: get_employee_leave_balance_for_a_year
  • Operation: read
  • Entities: balance, employee, leave type category
  • Summary: This API retrieves the leave balance for a specific employee for a given year. The request requires the employee ID and the year as path parameters. The headers must include an ACCESS-TOKEN for authentication and the x-greythr-domain to specify the company domain. The response provides a list of leave balances for different leave types, including details such as the leave type category, balance, granted leaves, availed leaves, and more, along with employee details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Leave Transactions

  • ID: get_employee_leave_transactions
  • Operation: read
  • Entities: leave type category, employee, leave transaction
  • Summary: The Get Employee Leave Transactions API retrieves the leave transactions of a specified employee within a given date range, with a maximum span of 31 days. The API requires an access token and the domain of the company as headers. The employee ID is specified as a path parameter, while the start and end dates are specified as query parameters. The response includes a list of leave transactions, detailing the employee's information, leave type, transaction type, date range, sessions, number of days, remarks, and any child transactions associated with the leave.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Employee Lookup

  • ID: get_employee_lookup
  • Operation: read
  • Entities: email, employee, access card
  • Summary: The Employee Lookup API allows users to retrieve individual employee details using a query parameter. The query parameter can be an employee number, email, GUID, access card, personal email, or reference number. The API requires an access token and the company's domain as headers. The response includes details such as the employee's ID, name, employee number, joining date, whether they have left the organization, and their email.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Manager Details

  • ID: get_employee_manager_details
  • Operation: read
  • Entities: manager, organization, employee
  • Summary: The Get Employee Manager Details API retrieves the organizational tree details for a specific employee using their employee ID. The request requires an access token and the domain of the company as headers. The employee ID is a path parameter. The response includes details about the employee's position in the organization. If the employee is not found, an error message with type 'NOT-FOUND' and code 'ORGANIZATION-EXCEPTION' is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Personal Details

  • ID: get_employee_personal_details
  • Operation: read
  • Entities: personal detail, employee
  • Summary: The Get Employee Personal Details API retrieves the personal details of an employee by using their employee ID. The request requires headers including an ACCESS-TOKEN and the x-greythr-domain. The path parameter 'employee-id' is mandatory to specify which employee's details are being requested. The response includes details such as the employee's ID, blood group, marital status, marriage date, spouse's birthday and name, and the employee's actual date of birth.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee PF & ESI Details

  • ID: get_employee_pf_esi_details
  • Operation: read
  • Entities: pf detail, employee, esi detail
  • Summary: This API fetches the Employee Provident Fund (PF) and Employee State Insurance (ESI) details based on the provided Employee ID. The request requires headers including an ACCESS-TOKEN and the x-greythr-domain. The response includes details such as PF eligibility, ESI eligibility, PF number, PF join date, UAN, ESI number, and information about excess contributions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Positions Details

  • ID: get_employee_positions_details
  • Operation: read
  • Entities: employee, position, category
  • Summary: The Get Employee Positions Details API retrieves the position details of a specific employee identified by the employee-id. The request requires headers including an ACCESS-TOKEN for authentication and the x-greythr-domain specifying the domain of the company. The response returns an array of position details, each containing an id, category, value, effectiveFrom date, and an optional effectiveTo date.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Profile Details

  • ID: get_employee_profile_details
  • Operation: read
  • Entities: social media, employee, profile
  • Summary: The Get Employee Profile Details API retrieves the profile details of a specific employee using their employee ID. The request requires an access token and the domain of the company as headers. The employee ID is specified as a path parameter. The response includes details such as the employee's nickname, social media handles (Twitter, LinkedIn, Facebook, Google Plus), biography, and date of birth.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Qualifications Details

  • ID: get_employee_qualifications_details
  • Operation: read
  • Entities: qualification, employee, institute
  • Summary: This API endpoint is used to fetch the qualifications details of an individual employee. The request requires an access token and the domain of the company as headers. The employee ID is specified as a path parameter. The response returns an array of qualification objects, each containing details such as qualification ID, employee ID, qualification description, year, completion year, duration, institute, and other related information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Separation Details

  • ID: get_employee_separation_details
  • Operation: read
  • Entities: organization, employee, separation
  • Summary: The Get Employee Separation Details API retrieves the separation details of a specific employee using their employee ID. The API requires an access token and the domain of the company as headers. The employee ID is a path parameter. The response includes details such as whether the employee has left the organization, the leaving date, retirement date, tentative relieve date, exit interview date, whether resignation was submitted, tentative leaving date, submission date, whether the employee is fit to be rehired, final settlement date, and the reason code for leaving.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Statutory Details

  • ID: get_employee_statutory_details
  • Operation: read
  • Entities: statutory detail, nationality, employee
  • Summary: The Get Employee Statutory Details API retrieves the statutory details of an employee by using the employee ID. The request requires headers including an ACCESS-TOKEN and the x-greythr-domain. The response includes details such as birthplace, father and mother names, nationality, disability status, religion, residential status, and more.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee User ID

  • ID: get_employee_user_id
  • Operation: read
  • Entities: employee, user
  • Summary: The Get Employee User ID API is used to obtain the user ID based on the provided employee number, which is essential for acquiring the Graphical User ID (GUID) in the next step. This API requires the 'ACCESS-TOKEN' and 'x-greythr-domain' headers for authentication and domain specification. The query parameters 'userType' and 'userName' are mandatory, where 'userType' should be 'employee' and 'userName' should be the specific employee number. The response returns an array of user objects containing details such as 'id', 'userName', 'email', 'admin', 'employee', 'deleted', 'type', 'onboardingStatus', and 'systemPassword'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Work Details

  • ID: get_employee_work_details
  • Operation: read
  • Entities: work detail, employment history, employee
  • Summary: The Get Employee Work Details API retrieves detailed work-related information for a specific employee identified by the employee-id. The request requires headers including an ACCESS-TOKEN for authentication and x-greythr-domain specifying the domain. The response includes details such as the employee's extension number, confirmation date, last promotion date, last previous employment, notice period, original hire date, probation extension, and onboarding status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee's All Identity Details

  • ID: get_employees_all_identity_details
  • Operation: read
  • Entities: document, employee, identity detail
  • Summary: This API retrieves all identity details for a specific employee using their employee ID. The request requires an access token and the domain of the company as headers. The employee ID is a path parameter. The response returns an array of identity objects, each containing details such as the identity record ID, document type code, document number, name as per the document, IFSC code (if applicable), expiry date, verification status, and a globally unique identifier.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employees Family Details

  • ID: get_employees_family_details
  • Operation: read
  • Entities: relationship, family, employee
  • Summary: This API endpoint is used to fetch family details for all employees by passing the relationship-type id. The request requires headers including an ACCESS-TOKEN and x-greythr-domain. The path parameter relationtype-id specifies the type of relationship to filter the family details. The response includes a list of family members with details such as id, employeeId, name, relationId, date of birth, blood group, nationality, gender, and profession. Pagination details are also provided in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employees Resettlement for a Month

  • ID: get_employees_resettlement_for_a_month
  • Operation: read
  • Entities: resettlement, employee, payroll month
  • Summary: This API retrieves a list of employee resettlement details for a specified payroll month. The request requires an access token and the domain of the company as headers, and the payroll month as a path parameter in ISO format (yyyy-mm-dd). The response is an array of objects, each containing details such as employeeId, settlementDate, processedDate, and any remarks.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Generate Payslip For Employee

  • ID: get_generate_payslip_for_employee
  • Operation: read
  • Entities: payslip, employee, payroll
  • Summary: This API endpoint is used to generate a payslip file for an employee based on the provided payroll information. It requires the employeeId, payrollId, and payslipType as query parameters, all of which are mandatory. The request headers must include an ACCESS-TOKEN and the x-greythr-domain. The response is a PDF file containing the payslip details. The 'encoded' query parameter is optional and defaults to true, indicating if the response should be encoded.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Leave Balance Details for All Employees

  • ID: get_leave_balance_details_for_all_employees
  • Operation: read
  • Entities: leave type category, leave balance, employee
  • Summary: This API retrieves the leave balance details for all employees for a specified year. The request requires an access token and the company's greythr domain to be included in the headers. The year for which the leave balance is requested is specified as a path parameter. The response includes a list of employees with their respective leave balance details, categorized by leave type. Each employee's leave summary includes details such as the leave type category, current balance, opening balance, granted leaves, availed leaves, applied leaves, lapsed leaves, deducted leaves, and encashed leaves. The response also includes pagination details indicating the total number of pages, elements, and whether there are more pages available.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Leave Transactions Details for All Employees

  • ID: get_leave_transactions_details_for_all_employees
  • Operation: read
  • Entities: page, employee, leave transaction
  • Summary: This API retrieves leave transaction details for all employees within a specified date range. The request requires an access token and the domain of the company as headers. The start and end dates for the leave transactions must be provided as query parameters. The response includes a list of leave transactions for each employee, detailing the transaction ID, leave type category, transaction type, dates, number of days, sessions, remarks, cancellation status, and reason. Pagination details are also included in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Orgtree Reporting Structure

  • ID: get_orgtree_reporting_structure
  • Operation: read
  • Entities: orgtree, page, employee
  • Summary: The Get Orgtree Reporting Structure API retrieves the organizational tree structure for employees. It requires two headers: ACCESS-TOKEN, which is the access token for authentication, and x-greythr-domain, which specifies the domain of the company. The response includes a list of employees with their respective reporting structures, represented as a list of employee IDs. Additionally, pagination details are provided, indicating the total number of pages, elements, and whether there are more pages available.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Pay Period API For The Financial Year

  • ID: get_pay_period_api_for_the_financial_year
  • Operation: read
  • Entities: pay period, financial year, payroll
  • Summary: The Get Pay Period API For The Financial Year is used to retrieve the payroll periods for a specified year. The year is provided as a query parameter. The API requires an access token and the domain of the company as headers. The response is a list of payroll periods for the specified year, each containing the name of the period, start and end dates, and the number of work days.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Pay Period For Particular Date

  • ID: get_pay_period_for_particular_date
  • Operation: read
  • Entities: pay period, payroll
  • Summary: This API retrieves the payroll period corresponding to the provided date. The date is sent as a query parameter 'inputDate'. The request requires headers 'ACCESS-TOKEN' and 'x-greythr-domain'. The response includes the month, start date, and end date of the payroll period.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Salary Repository Items

  • ID: get_salary_repository_items
  • Operation: read
  • Entities: salary, repository, payroll
  • Summary: The 'Get Salary Repository Items' API is used to fetch the complete salary repository for an account. It requires two headers: 'ACCESS-TOKEN' which is the access token for authentication, and 'x-greythr-domain' which specifies the domain of the company. The API returns a list of salary repository items, each with details such as id, name, description, type, taxable status, parent, and children. The response also includes pagination details indicating the total number of pages, elements, and other pagination-related information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Salary Revision Difference

  • ID: get_salary_revision_difference
  • Operation: read
  • Entities: salary revision, difference, employee
  • Summary: The 'Get Salary Revision Difference' API allows you to fetch the difference in salary amounts between the latest approved revision and the previous revision for each salary item of a specific employee. The API requires the employee's unique ID as a path parameter and requires headers for authentication, including an access token and the domain of the company. The response includes the employee ID, effective dates and payout months for the current and previous revisions, and an array of salary items with their current and previous values and the difference between them.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Salary Revision History

  • ID: get_salary_revision_history
  • Operation: read
  • Entities: salary, revision, employee
  • Summary: The Get Salary Revision History API allows you to fetch the revision history of the salary for a single employee. You need to provide the employee ID and the salary revision status to retrieve the complete salary revision history. The API endpoint requires path parameters for the employee ID and status, and it supports query parameters for pagination and sorting. The response includes detailed information about each salary revision, including the effective date, payout month, status, and revision items. The pagination details are also provided in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Salary Statement for a Month

  • ID: get_salary_statement_for_a_month
  • Operation: read
  • Entities: salary statement, employee, payroll month
  • Summary: This API endpoint is used to retrieve the salary statement for a specific payroll month. The request requires the payroll month to be specified in the path parameter in the format yyyy-mm-01. The request headers must include an ACCESS-TOKEN for authentication and the x-greythr-domain to specify the company domain. The response includes a list of salary statement items for each employee, detailing the employee ID, employee number, employee name, item name, description, amount, type, and item order. Additionally, pagination information is provided, including total pages, total elements, page size, and sorting details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Salary Statement for an Employee for a Month

  • ID: get_salary_statement_for_an_employee_for_a_month
  • Operation: read
  • Entities: salary statement, item, employee
  • Summary: This API endpoint is used to retrieve the salary statement for a specific payroll month for a given employee. The request requires the payroll month and employee ID as path parameters. The request headers must include an ACCESS-TOKEN and the x-greythr-domain. The request body can optionally include a list of items. The response includes the employee's name, employee number, and a list of salary items, each with details such as name, amount, type, order, and description.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Users List

  • ID: get_users_list
  • Operation: read
  • Entities: employee, admin, user
  • Summary: The Get Users List API helps you collect the details of all active Named users and Employee users, along with their basic information. It requires an ACCESS-TOKEN and x-greythr-domain in the headers. The API supports optional query parameters such as userType to specify the user type (admin or employee) and userName to match a specific username. The response returns an array of user objects, each containing details like id, userName, name, admin status, employee details, deletion status, user type, onboarding status, and system password.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Asset to Employee

  • ID: post_add_asset_to_employee
  • Operation: write
  • Entities: asset, employee
  • Summary: The 'Add Asset to Employee' API allows you to add a new asset to an employee's record in the system. You need to provide the employee ID in the path parameters and include details about the asset in the request body, such as asset type, details, ID, value, status, issued date, return date, validity, and remarks. The request headers must include an access token and the domain. Upon successful addition, the API returns a response with a unique identifier for the asset entry.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Employee

  • ID: post_add_employee
  • Operation: write
  • Entities: contact number, employee, experience
  • Summary: The Add Employee API allows you to add new employees to the system by providing various details about the employee. The request requires an access token and domain in the headers. The body of the request includes mandatory fields such as 'employeeNo', 'name', 'dateOfJoin', and 'gender', along with optional fields like 'firstName', 'middleName', 'lastName', 'email', 'dateOfBirth', 'status', 'title', 'mobile', 'initials', 'probationPeriod', 'relevantExperience', 'yearsInJob', 'yearsInService', 'prevExperience', 'nonRelevantExperience', 'personalEmail', 'officialMobile', 'personalEmail2', 'personalEmail3', 'remarks', 'referenceNo', and 'loginAccount'. The response returns a message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Employee Bank Details

  • ID: post_add_employee_bank_details
  • Operation: write
  • Entities: bank detail, employee
  • Summary: The 'Add Employee Bank Details' API allows you to add bank details for a specific employee using their employee ID. The API requires an access token and the domain of your company as headers. The request body must include the bank account number, account type, branch code, salary payment mode, the location where the demand draft is payable, and the name of the employee as per bank records. Upon successful execution, the API returns the ID of the newly created bank details entry.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Employee Card Details

  • ID: post_add_employee_card_details
  • Operation: write
  • Entities: card detail, employee
  • Summary: The 'Add Employee Card Details' API is used to push a particular employee’s card details based on the employee id. This API is only available for the Middle East region. It requires the employeeId as a path parameter and expects a JSON body containing the card details such as relation, cardType, cardNo, issueDate, expiryDate, and Current status. The request must include headers for ACCESS-TOKEN and x-greythr-domain. Upon successful execution, it returns a message indicating that the card details were added successfully.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Employee Document

  • ID: post_add_employee_document
  • Operation: write
  • Entities: employee, document, category
  • Summary: The 'Add Employee Document' API is used to add a document to an employee's record in the system. It requires the employee ID and document category as path parameters to correctly identify and categorize the document. The request must include headers for 'ACCESS-TOKEN' and 'x-greythr-domain' to authenticate and specify the domain. The request body is empty. Upon successful creation, the API returns a 201 status code with a response body containing a unique identifier for the newly created document.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Employee Document Category

  • ID: post_add_employee_document_category
  • Operation: write
  • Entities: employee, document, category
  • Summary: This API is used to add a new employee document category to the system. It requires an access token and the domain of the company as headers. The request body must include the name and code of the document category to be added. Upon successful creation, the API returns the ID of the newly created document category.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Employee Family Benefits

  • ID: post_add_employee_family_benefits
  • Operation: write
  • Entities: employee, family member, benefit
  • Summary: The 'Add Employee Family Benefits' API allows users to add family benefits for employees, such as airfare and child allowance. The API requires the employee ID as a path parameter and an access token and domain in the headers. The request body should include details of the benefits being added, such as the benefit type, family member ID, and the effective date range. The response returns a message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Employee Handenrty Salary Items

  • ID: post_add_employee_handenrty_salary_items
  • Operation: write
  • Entities: employee, value, salary item
  • Summary: This API allows you to add salary items for a specific employee in the Greythr payroll system. You need to provide the employee ID in the path parameters. The request headers must include an ACCESS-TOKEN for authentication and the x-greythr-domain to specify your company domain. The request body should be a JSON array containing salary items, each with a value, fromDate, and item code. The API responds with a success message upon successful addition of the salary items.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Employee Identity

  • ID: post_add_employee_identity
  • Operation: write
  • Entities: employee, identity
  • Summary: The Add Employee Identity API allows you to add an identity document for a specific employee in the system. The API requires the employee ID and identity code as path parameters. The request headers must include an access token and the domain of the company. The request body should contain details about the identity document such as the type, document number, name as per the document, IFSC code, expiry date, verification status, verification date, and whether to enable masking of sensitive information. This API does not return any response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Employee Manager

  • ID: post_add_employee_manager
  • Operation: write
  • Entities: manager, employee
  • Summary: The 'Add Employee Manager' API allows you to assign a manager to an employee in the organizational tree. The API requires the employee ID as a path parameter and expects an access token and company domain in the headers. The request body must include the manager ID and the effective date for the manager assignment. Upon successful execution, the API returns the ID of the newly created manager assignment.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Employee PF & ESI Details

  • ID: post_add_employee_pf_esi_details
  • Operation: write
  • Entities: pf detail, employee, esi detail
  • Summary: This API is used to add Provident Fund (PF) and Employee State Insurance (ESI) details for a specific employee. The API requires the employee ID as a path parameter and expects a JSON body containing details such as PF eligibility, PF number, PF join date, UAN, ESI eligibility, and ESI number. The request headers must include an access token and the domain of the company. The API does not return any response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Employee Positions

  • ID: post_add_employee_positions
  • Operation: write
  • Entities: employee, category
  • Summary: The 'Add Employee Positions' API allows you to add multiple categories and their corresponding values to a specific employee's record. The request requires an access token and the domain of your company in the headers. The employee ID is specified in the path parameters. The body of the request contains a list of categories, each with a category ID, value, and effective date. The response returns a list of IDs for the added categories.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Employee Qualifications

  • ID: post_add_employee_qualifications
  • Operation: write
  • Entities: qualification, employee, institute
  • Summary: The 'Add Employee Qualifications' API allows you to add qualification details to a specific employee. You need to provide the employee ID in the path parameters. The request headers must include an 'ACCESS-TOKEN' for authentication and 'x-greythr-domain' to specify your company domain. The request body should contain details about the qualification such as 'qualification' ID, 'fromYear', 'toYear', 'institute', 'grade', 'qualificationArea', and any 'remarks'. Upon successful addition, the API returns the ID of the newly created qualification entry.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Family Member to Employee

  • ID: post_add_family_member_to_employee
  • Operation: write
  • Entities: family member, employee, address
  • Summary: This API allows you to add a new family member to an employee in the system. You need to provide the employee ID in the path parameters and include details of the family member in the request body, such as name, relation, date of birth, blood group, gender, profession, nationality, address, and contact information. The request headers must include an access token and the domain of your company. Upon successful addition, the API returns the ID of the newly added family member.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add greytHR Org Entities

  • ID: post_add_greythr_org_entities
  • Operation: write
  • Entities: org unit, org entity
  • Summary: The 'Add greytHR Org Entities' API allows users to add organizational entities under organizational units in the greytHR system. It supports adding both parent-level and child-level org entities by providing the necessary request payload. The API requires an access token and the domain of the company as headers. The request body should be a JSON array containing objects with 'code', 'description', 'orgUnit', and optionally 'assignTo' fields. The response includes a status code, any errors, and a message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add New Users to GreytHR System

  • ID: post_add_new_users_to_greythr_system
  • Operation: write
  • Entities: role, user
  • Summary: This API allows you to add a new user to the GreytHR system. The user can be either an admin or an employee. You need to provide the user's name, email, and roles in the request body. Optional parameters include login user name, system disable status, and category shortlist. The request requires headers for access token and domain. Upon successful addition, the API returns a message indicating the user was added successfully with a status code of 201.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Salary Revision

  • ID: post_add_salary_revision
  • Operation: write
  • Entities: salary revision, item, employee
  • Summary: The Add Salary Revision API allows you to add a revised salary for a single employee using their unique employee ID. The API requires an access token and the domain of your company as headers. The path parameter 'employee-id' is mandatory to specify the employee whose salary is being revised. The request body must include the effective date, payout date, optional remarks, and a list of salary components with their revised values. Upon successful execution, the API returns a success message indicating the salary revision was created.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Loan for Employee

  • ID: post_create_loan_for_employee
  • Operation: write
  • Entities: loan component, loan, employee
  • Summary: This API is used to create a new loan for an employee for a particular loan component with certain loan type and loan details. Users need to have the 'Create Loan' feature to access the API. The employee for whom the loan has to be created must have joined before the loan start date. Loans will be deducted based on a certain interest type whose values are constant and listed in the payload example. In the Loan component configuration, the Loan type should be 'Both' or 'Deduct Interest After Principal' in order to successfully create a loan. A loan will be created only when there is no existing loan running for the particular item. The request requires headers such as ACCESS-TOKEN and x-greythr-domain, and a body containing details like employeeNo, loanComponentName, loanDate, deductFrom, interestType, amount, interestRate, installments, loanAccountNo, perquisiteRate, and optional remarks. The response returns the same details as confirmation of the loan creation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Form16 Download API

  • ID: post_form16_download
  • Operation: read
  • Entities: form16, employee, payroll
  • Summary: The Form16 Download API allows users to download Form 16 for an employee in both preview and base64 encoded formats. The API requires an access token and the company's domain as headers. It accepts optional query parameters 'encoded' to specify if the response should be base64 encoded, and 'fileType' to specify the type of file to download, defaulting to 'FORM16'. The response includes the employee number and the year for which Form 16 is generated.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get greytHR List of Values (LOV)

  • ID: post_get_greythr_lov
  • Operation: read
  • Entities: lov, status, bank
  • Summary: The Get greytHR List of Values (LOV) API allows users to retrieve various lists of values used in the greytHR system. The API requires an access token and the domain of the company as headers. The request body should contain an array of LOV types that the user wants to retrieve, such as transition types, pay types, banks, nationalities, physically challenged types, and statuses. The response returns a JSON object with each requested LOV type as a key, and the corresponding list of values as an array of arrays, where each sub-array contains an ID and a description.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Leave Transaction Update

  • ID: post_leave_transaction_update
  • Operation: write
  • Entities: leave type, employee, leave transaction
  • Summary: The Leave Transaction Update API allows updating availed and cancelled leave transactions for a specific period. It requires the employee number, leave dates, leave type, and transaction type as mandatory fields. Optional fields include session details, number of days, whether to ignore leave rules, and a reason for the leave. The API returns a message indicating the success or failure of the transaction.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Post List of Values for Categories

  • ID: post_list_of_values_for_categories
  • Operation: read
  • Entities: department, location, company
  • Summary: This API endpoint allows you to retrieve a list of values for specified categories such as Department, Location, and Company. The request requires an access token and the domain of your company as headers. The body of the request should contain an array of category identifiers. The response returns a mapping of each category identifier to its respective list of values, where each value is represented as an array containing an ID, name, and an optional description.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Payslip Download

  • ID: post_payslip_download
  • Operation: read
  • Entities: payslip, payroll period, employee
  • Summary: The Payslip Download API endpoint is used to retrieve the payslip file for an employee for a specified payroll period. Users must have the 'Payslip Download' feature access to use this API. The API requires an access token and the domain of the company as headers. It also accepts an optional query parameter 'encoded' to specify if the response should be in encoded string format. The response includes the employee number, payroll date, and type of payslip.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Save Attendance Snapshot

  • ID: post_save_attendance_snapshot
  • Operation: write
  • Entities: attendance detail, employee, attendance snapshot
  • Summary: The Save Attendance Snapshot API allows you to save attendance snapshot details for a specific employee using their employee ID. The API requires an access token and the domain of your company as headers. The employee ID is a required path parameter. The request body should contain an array of objects, each with a 'value', 'fromDate', and 'item' to specify the attendance snapshot details. The API returns a response message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

User SSO Authentication

  • ID: post_user_sso_authentication
  • Operation: read
  • Entities: token, authentication, user
  • Summary: The User SSO Authentication API is used to obtain a One Time Token (OTT) for a user, which can be a Named User or an Employee User, for Single Sign On (SSO) purposes. The API requires a userId as a path parameter to identify the specific user. The request must include headers for ACCESS-TOKEN and x-greythr-domain. Upon successful request, the API returns a GUID in the response body, which can be used to authenticate the user by redirecting to the authentication URL with the GUID as a parameter.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee Address Details

  • ID: put_update_employee_address_details
  • Operation: write
  • Entities: employee, address, company
  • Summary: The Update Employee Address Details API allows updating the address details of a specific employee. The API requires the employee ID and address type as path parameters. The request must include headers for authentication and domain specification. The body of the request should contain detailed address information including address lines, city, state, country, postal code, phone numbers, email, and other relevant details. The response is an empty JSON object, indicating the update was successful.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee Assets

  • ID: put_update_employee_assets
  • Operation: write
  • Entities: asset, employee, company
  • Summary: The 'Update Employee Assets' API allows updating the asset details of a specific employee. The API requires the employee ID and asset ID as path parameters. The request must include headers for 'ACCESS-TOKEN' and 'x-greythr-domain'. The body of the request should contain details about the asset such as 'assetType', 'assetDetails', 'assetId', 'assetValue', 'assetStatus', 'issuedDate', 'returnedOn', 'validTill', and 'remarks'. The response is an empty JSON object, indicating the update was successful.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee Bank Details

  • ID: put_update_employee_bank_details
  • Operation: write
  • Entities: bank detail, employee
  • Summary: The 'Update Employee Bank Details' API allows updating the bank details of a specific employee identified by the 'employee-id' in the path. The request requires headers including 'ACCESS-TOKEN' for authentication and 'x-greythr-domain' for specifying the domain. The body of the request must include the bank account number, account type, branch code, salary payment mode, demand draft payable location, and the name as per bank records. The response is an empty JSON object, indicating a successful update.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee Handenrty Salary Items

  • ID: put_update_employee_handenrty_salary_items
  • Operation: write
  • Entities: employee, salary item
  • Summary: The 'Update Employee Handenrty Salary Items' API allows you to update the salary items for a specific employee identified by the 'employee-id' in the URL path. The request requires headers including 'ACCESS-TOKEN' for authentication and 'x-greythr-domain' to specify the domain. The body of the request is an array of objects, each containing 'value', 'fromDate', and 'item' to specify the salary item details. The API responds with a success message upon successful update of the employee's salary items.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee Identity

  • ID: put_update_employee_identity
  • Operation: write
  • Entities: document, employee, identity
  • Summary: The Update Employee Identity API allows you to update the identity details of an employee in the system. The API requires the employee ID and identity code as path parameters. The request must include headers for authentication and domain specification. The body of the request should contain details such as the identity document type, document number, name as per the document, IFSC code, expiry date, verification status, verified date, and whether to enable masking of sensitive information. The API does not return any response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee Information

  • ID: put_update_employee_information
  • Operation: write
  • Entities: domain, information, employee
  • Summary: The Update Employee Information API allows you to update the basic information of an existing employee in the system. The API requires the employee's unique identifier as a path parameter. The request must include headers for authentication and domain specification. The body of the request should contain the employee's name, date of birth, status, and date of joining. Upon successful update, the API returns a message indicating the success of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee Manager

  • ID: put_update_employee_manager
  • Operation: write
  • Entities: manager, employee
  • Summary: The 'Update Employee Manager' API allows you to update the manager of a specific employee in the organizational tree. The API requires the employee ID as a path parameter, and the request must include headers for 'ACCESS-TOKEN' and 'x-greythr-domain'. The body of the request should contain the 'managerId' of the new manager and the 'effectiveDate' from which the change should take effect. The response is an empty JSON object, indicating the update was successful.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee Personal Details

  • ID: put_update_employee_personal_details
  • Operation: write
  • Entities: personal detail, employee
  • Summary: The 'Update Employee Personal Details' API allows updating personal details of an employee identified by the 'employee-id' in the path. The request requires headers including 'ACCESS-TOKEN' and 'x-greythr-domain'. The body can include optional fields such as 'bloodGroup', 'maritalStatus', 'marriageDate', 'spouseBirthday', 'spouseName', and 'actualDOB'. The response returns the updated details of the employee including 'employeeId', 'bloodGroup', 'maritalStatus', 'marriageDate', 'spouseBirthday', 'spouseName', and 'actualDOB'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee PF & ESI Details

  • ID: put_update_employee_pf_esi_details
  • Operation: write
  • Entities: pf detail, employee, esi detail
  • Summary: The 'Update Employee PF & ESI Details' API allows updating the Provident Fund (PF) and Employee State Insurance (ESI) details of a specific employee identified by the 'employee-id'. The API requires an access token and the domain of the company as headers. The request body must include details such as PF eligibility, PF number, PF join date, UAN, ESI eligibility, and ESI number. Optional fields include PF scheme, family PF number, PF KYC linked date, and flags for excess EPF and EPS contributions. The API does not return any response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee Position

  • ID: put_update_employee_position
  • Operation: write
  • Entities: employee, category, value
  • Summary: The Update Employee Position API allows for updating employee category details within the system. It requires the employee ID as a path parameter and an access token and domain in the headers. The request body must include a list of categories, each with a category ID, value, and effective date. The response is an empty object indicating a successful update.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee Profile Details

  • ID: put_update_employee_profile_details
  • Operation: write
  • Entities: employee, profile
  • Summary: The 'Update Employee Profile Details' API allows updating the profile details of an employee identified by 'employee-id'. The API requires an access token and the company's greythr domain in the headers. The request body can include optional fields such as nickname, wishDOB, twitter, linkedIn, facebook, googlePlus, and biography. The response is an empty JSON object indicating a successful update.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee Qualifications Details

  • ID: put_update_employee_qualifications_details
  • Operation: write
  • Entities: qualification, employee
  • Summary: The Update Employee Qualifications Details API allows you to update the qualification details of a specific employee. You need to provide the employee ID and qualification ID in the path parameters. The request headers must include an ACCESS-TOKEN and the x-greythr-domain. The request body should contain the qualification ID, the years from and to, the institute name, the grade, the qualification area, and any remarks. The response is an empty JSON object, indicating the update was successful.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee Separation Details

  • ID: put_update_employee_separation_details
  • Operation: write
  • Entities: separation detail, employee
  • Summary: The 'Update Employee Separation Details' API allows updating the separation details of an employee in the system. It requires the employee's unique identifier as a path parameter and an access token and domain in the headers. The request body must include details such as whether the employee has left the organization, leaving date, retirement date, tentative relieve date, exit interview date, resignation submission status, tentative leaving date, submission date, rehire eligibility, final settlement date, and the reason for leaving. The API returns an empty response body upon successful update.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee Statutory Details

  • ID: put_update_employee_statutory_details
  • Operation: write
  • Entities: statutory detail, employee, disability type
  • Summary: The 'Update Employee Statutory Details' API allows updating the statutory details of an employee in the system. The API endpoint requires the employee's unique identifier as a path parameter. The request body can include various optional fields such as birthplace, father's name, mother's name, nationality, disability type, religion, exemption status, residential status, country of origin, director status, and expatriate status. The response is an empty JSON object, indicating the update was successful.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee Work Details

  • ID: put_update_employee_work_details
  • Operation: write
  • Entities: promotion, employment detail, employee
  • Summary: The 'Update Employee Work Details' API allows updating the work-related details of an employee in the system. The API requires the employee ID as a path parameter and expects an access token and domain in the headers. The request body can include various optional fields such as extension, last promotion date, last previous employment, notice period, original hire date, probation extension duration, and onboarding status. The response is an empty JSON object indicating a successful update.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Family Member Details

  • ID: put_update_family_member_details
  • Operation: write
  • Entities: employee, family, detail
  • Summary: This API endpoint allows updating the family details of an individual employee. It requires the employee ID and the relation ID as path parameters. The request must include headers for 'ACCESS-TOKEN' and 'x-greythr-domain'. The body of the request should contain the name, date of birth, and email of the family member. The response is an empty JSON object, indicating a successful update.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated about 1 month ago