Guides
Signup For Free

Keka API Integration

Suggest Edits

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

Get All Asset Types

  • ID: get_all_asset_types
  • Operation: read
  • Entities: response, asset type, page
  • Summary: This API endpoint retrieves all asset types available in the system. It supports optional query parameters such as 'assetTypeIds' to filter by specific asset type IDs, 'lastModified' to filter by the last modified date, 'pageNumber' to specify the page of results to retrieve, and 'pageSize' to define the number of results per page. The response includes a paged list of asset types, along with metadata about the pagination such as total pages and records. The response also indicates whether the request was successful and may include messages or errors if applicable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Assets

  • ID: get_all_assets
  • Operation: read
  • Entities: asset, employee
  • Summary: The 'Get All Assets' API endpoint allows users to retrieve a list of assets from the system. The API uses the GET method and requires the 'accept' header to be set to 'application/json'. Optional query parameters include 'assetIds', 'employeeIds', 'assetStatus', 'lastModified', 'pageNumber', and 'pageSize'. The response includes a boolean 'succeeded' indicating the success of the request, a 'message', any 'errors', and a 'data' array containing asset details such as 'id', 'assetName', 'assetId', 'status', 'assetCategoryId', 'assetTypeId', 'assetConditionId', and 'assignedTo' details. Pagination details such as 'pageNumber', 'pageSize', 'firstPage', 'lastPage', 'totalPages', 'totalRecords', 'nextPage', and 'previousPage' are also included in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Badges

  • ID: get_all_badges
  • Operation: read
  • Entities: page, response, badge
  • Summary: This API endpoint retrieves all badges. It supports filtering by badge IDs and pagination through query parameters. The request requires an 'accept' header specifying 'application/json'. The response includes a success indicator, optional message and errors, and a list of badge data with pagination details such as page number, page size, and URIs for navigation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All BGV Requests

  • ID: get_all_bgv_requests
  • Operation: read
  • Entities: check, candidate, bgv request
  • Summary: This API endpoint retrieves all Background Verification (BGV) requests for a specified BGV ID. The request is made using the GET method to the URL 'https://{company}.{environment}.com/api/v1/hris/bgv/{bgvId}/requests'. The path parameter 'bgvId' is required and specifies the identifier for the BGV requests. Optional query parameters include 'bgvStatus' for filtering by BGV status, 'lastModified' for filtering by the last modified date, 'pageNumber' for pagination, and 'pageSize' to specify the number of results per page. The response includes a boolean 'succeeded' indicating success, a 'message', any 'errors', and 'data' which is an array of BGV request details including candidate information and checks. Pagination details such as 'pageNumber', 'pageSize', 'firstPage', 'lastPage', 'totalPages', 'totalRecords', 'nextPage', and 'previousPage' are also included in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Capture Schemes

  • ID: get_all_capture_schemes
  • Operation: read
  • Entities: response, capturescheme, page
  • Summary: This API endpoint retrieves all capture schemes. It supports optional query parameters such as 'captureschemeIds' to filter by specific IDs, 'pageNumber' to specify the page of results to retrieve, and 'pageSize' to determine the number of results per page (default is 100, maximum is 200). The response includes a boolean 'succeeded' indicating success, a 'message', any 'errors', and 'data' containing the capture schemes. Pagination details such as 'pageNumber', 'pageSize', 'firstPage', 'lastPage', 'totalPages', 'totalRecords', 'nextPage', and 'previousPage' are also provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Clients

  • ID: get_all_clients
  • Operation: read
  • Entities: contact, client, address
  • Summary: The 'Get All Clients' API endpoint retrieves a list of clients from the specified company and environment. It supports filtering by client IDs and last modified date, and allows pagination through page number and page size parameters. The response includes a success indicator, message, errors, and a list of client data with details such as ID, name, code, description, billing address, client contacts, attributes, and additional fields. Pagination details such as page number, page size, total pages, and total records are also provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Currencies

  • ID: get_all_currencies
  • Operation: read
  • Entities: response, currency, page
  • Summary: This API endpoint retrieves all currencies available in the system. It supports pagination through the 'pageNumber' and 'pageSize' query parameters. The response includes a list of currencies with their IDs, codes, and names, along with pagination details such as total pages and records. The request requires an 'accept' header specifying 'application/json'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Departments

  • ID: get_all_departments
  • Operation: read
  • Entities: department, response, department head
  • Summary: The 'Get All Departments' API endpoint retrieves a list of all departments within the organization. It supports optional query parameters such as 'departmentIds' for filtering by specific department IDs, 'lastModified' for filtering by the last modified date, 'pageNumber' for pagination, and 'pageSize' to specify the number of results per page. The response includes details about each department, such as its ID, name, description, and department heads. Pagination details like total pages and records are also provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Employee Reviews

  • ID: get_all_employee_reviews
  • Operation: read
  • Entities: employee, review, rating
  • Summary: This API endpoint retrieves all employee reviews. It supports filtering by employee IDs, review group IDs, and review cycle IDs through query parameters. Pagination is supported with 'pageNumber' and 'pageSize' parameters. The response includes a success indicator, a message, any errors, and the data containing employee reviews with details such as review group ID, review cycle ID, summary, ratings, and status. Pagination details like total pages and records are also included.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Exit Reasons

  • ID: get_all_exit_reasons
  • Operation: read
  • Entities: termination reason, exit reason
  • Summary: This API endpoint retrieves all exit reasons from the HRIS system. It supports pagination through the 'pageNumber' and 'pageSize' query parameters. The response includes arrays of 'exitReason' and 'terminationReason', each containing objects with 'id' and 'name' fields. The request must include an 'accept' header specifying 'application/json'. The endpoint returns a 200 status code with the exit reasons on success, and may return 401 for unauthorized access, 403 for forbidden access, or 404 if the resource is not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Expense Categories

  • ID: get_all_expense_categories
  • Operation: read
  • Entities: request parameter, response, expense category
  • Summary: This API endpoint retrieves all expense categories. It supports filtering by expense category IDs and pagination through query parameters. The response includes a list of expense categories with details such as ID, name, description, code, and category type. Pagination details such as page number, page size, total pages, and total records are also included in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Expense Claims

  • ID: get_all_expense_claims
  • Operation: read
  • Entities: employee, expense claim, expense
  • Summary: This API endpoint retrieves all expense claims for a company. It uses the GET method and requires the 'accept' header to be set to 'application/json'. The endpoint supports pagination through the 'pageNumber' and 'pageSize' query parameters. The response includes a paged list of expense claims, each with details such as employee identifier, claim number, title, submission date, approval status, and associated expenses. The response also provides pagination details like total pages, total records, and URIs for navigation between pages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Expense Policies

  • ID: get_all_expense_policies
  • Operation: read
  • Entities: expense policy
  • Summary: This API endpoint retrieves all expense policies. It supports optional query parameters such as 'expensepolicyIds' to filter by specific policy IDs, 'pageNumber' to specify the page of results to retrieve, and 'pageSize' to determine the number of results per page (default is 100, maximum is 200). The response includes a paged list of expense policies with details such as 'id' and 'name', along with pagination information like 'pageNumber', 'pageSize', 'totalPages', and 'totalRecords'. The response also indicates success with a 'succeeded' boolean and may include a 'message' and 'errors' array if applicable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Goals with Parent and Child Goals

  • ID: get_all_goals_with_parent_and_child_goals
  • Operation: read
  • Entities: department, goal, employee
  • Summary: This API endpoint retrieves all goals along with their parent and child goals. It supports filtering by goal IDs, time frame IDs, and employee IDs. The response includes detailed information about each goal, such as its ID, employee details, time frame, name, description, start and end dates, values, progress, metric type, status, tags, type, department ID, and privacy status. Pagination is supported through page number and page size parameters. The response also provides pagination details like total pages, total records, and URIs for navigation between pages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Group Cycle Review Details

  • ID: get_all_group_cycle_review_details
  • Operation: read
  • Entities: review cycle, data, page
  • Summary: This API endpoint retrieves all group cycle review details. It supports filtering by review cycle IDs and pagination through query parameters. The request requires an 'accept' header specifying 'application/json'. The response includes a success indicator, optional message and errors, and the data containing review cycle details such as ID, name, and start date. Pagination details like page number, page size, and URIs for navigation are also provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Group Types

  • ID: get_all_group_types
  • Operation: read
  • Entities: group type, error, page
  • Summary: This API endpoint retrieves all group types available in the system. It supports pagination through the 'pageNumber' and 'pageSize' query parameters. The response includes a list of group types with details such as 'id', 'name', 'isSystemDefined', and 'systemGroupType'. The response also provides pagination details like 'pageNumber', 'pageSize', 'totalPages', and 'totalRecords'. The request requires an 'accept' header specifying 'application/json'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All HRIS Groups

  • ID: get_all_hris_groups
  • Operation: read
  • Entities: system group type, group type, group
  • Summary: This API endpoint retrieves all HRIS groups. It supports filtering by group type IDs and system group types, and allows pagination through page number and page size parameters. The response includes details about each group, such as ID, name, code, and description, along with pagination information like total pages and records.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Job Titles

  • ID: get_all_job_titles
  • Operation: read
  • Entities: record, page, job title
  • Summary: This API endpoint retrieves all job titles from the HRIS system. It supports pagination and can filter results based on the last modified date. The request does not require a body but accepts query parameters such as 'lastModified', 'pageNumber', and 'pageSize'. The response includes a paged list of job titles, along with metadata about the pagination such as total pages and records. The response also indicates whether the request was successful and may include error messages if applicable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Leave Plans

  • ID: get_all_leave_plans
  • Operation: read
  • Entities: leave plan, page size, page number
  • Summary: This API endpoint retrieves all leave plans available in the system. It supports filtering by leave plan IDs and pagination through query parameters. The request requires an 'accept' header specifying 'application/json'. The response includes a paged list of leave plans, with metadata such as page number, page size, total pages, and total records. The response body contains a 'succeeded' flag, a message, any errors, and the data array with leave plan details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Leave Types

  • ID: get_all_leave_types
  • Operation: read
  • Entities: page, error, leave type
  • Summary: This API endpoint retrieves all leave types available in the system. It supports filtering by leave type identifiers through the 'leaveTypeIds' query parameter. Pagination is supported with 'pageNumber' and 'pageSize' query parameters, where 'pageSize' defaults to 100 and has a maximum value of 200. The response includes a success indicator, a message, any errors, and the data containing leave type details such as identifier, name, description, and whether the leave is paid. Pagination details such as current page, total pages, and URIs for navigation are also provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Locations

  • ID: get_all_locations
  • Operation: read
  • Entities: location, page, address
  • Summary: This API endpoint retrieves all locations from the HRIS system. It supports pagination and filtering by the last modified date. The request can include query parameters such as 'lastModified' to filter locations modified after a certain date, 'pageNumber' to specify the page of results to retrieve, and 'pageSize' to determine the number of results per page. The response includes a paged list of locations, each with details such as ID, name, description, and address. The response also provides pagination information including the current page number, total pages, and URIs for navigation between pages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Notice Periods

  • ID: get_all_notice_periods
  • Operation: read
  • Entities: notice period
  • Summary: This API endpoint retrieves all notice periods from the HRIS system. It supports pagination and allows filtering by notice period IDs. The request is made using the GET method and requires an 'accept' header specifying 'application/json'. Optional query parameters include 'noticePeriodIds' for filtering specific notice periods, 'pageNumber' for selecting the page of results, and 'pageSize' for determining the number of results per page. The response includes a success indicator, a message, any errors, and the data containing notice period details, along with pagination information such as page number, page size, total pages, and total records.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Pay Bands

  • ID: get_all_pay_bands
  • Operation: read
  • Entities: record, page, pay band
  • Summary: This API endpoint retrieves all pay bands. It supports optional query parameters such as 'payBandIds' to filter specific pay bands, 'pageNumber' to specify the page of results to retrieve, and 'pageSize' to determine the number of results per page (default is 100, maximum is 200). The response includes a paged list of pay bands with details such as 'id' and 'name', along with pagination information like 'pageNumber', 'pageSize', 'totalPages', and 'totalRecords'. The response also indicates whether the request was successful and may include messages or errors if applicable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Pay Grades

  • ID: get_all_pay_grades
  • Operation: read
  • Entities: response, error, pay grade
  • Summary: This API endpoint retrieves all pay grades. It supports optional query parameters such as 'payGradeIds' to filter specific pay grades, 'pageNumber' to specify the page of results to retrieve, and 'pageSize' to determine the number of results per page (default is 100, maximum is 200). The response includes a paged list of pay grades with details such as 'id' and 'name', along with pagination information like 'pageNumber', 'pageSize', 'totalPages', and 'totalRecords'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Pay Groups

  • ID: get_all_pay_groups
  • Operation: read
  • Entities: legal entity, response, pay group
  • Summary: This API endpoint retrieves all pay groups for a given company and environment. It uses the GET method and requires an 'accept' header with the value 'application/json'. The endpoint supports pagination through the 'pageNumber' and 'pageSize' query parameters. The response includes a boolean 'succeeded' to indicate success, a 'message', any 'errors', and a 'data' array containing pay group details such as 'identifier', 'name', 'description', 'legalEntityId', and 'legalEntityName'. Pagination details like 'pageNumber', 'pageSize', 'firstPage', 'lastPage', 'totalPages', 'totalRecords', 'nextPage', and 'previousPage' are also included in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Projects

  • ID: get_all_projects
  • Operation: read
  • Entities: project, client, project manager
  • Summary: The 'Get All Projects' API endpoint retrieves a list of projects from the specified company and environment. It supports filtering by client IDs and last modified date, and allows pagination through page number and page size parameters. The response includes details about each project, such as its ID, client ID, name, code, start and end dates, status, project managers, billing information, and custom attributes. The response also provides pagination information, including the current page number, page size, total pages, and total records.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Requisition Requests

  • ID: get_all_requisition_requests
  • Operation: read
  • Entities: department, requisition request, employee
  • Summary: This API endpoint retrieves all requisition requests from the system. It supports filtering by requisition request IDs, status, and last modified date. Pagination is supported through the pageNumber and pageSize query parameters, with a default page size of 100 and a maximum of 200. The response includes a paged list of requisition requests, each containing details such as the requisition ID, job number, department, status, and more. The response also includes pagination details like total pages and records.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Review Groups

  • ID: get_all_review_groups
  • Operation: read
  • Entities: cycle, page, review group
  • Summary: This API endpoint retrieves all review groups. It supports filtering by review group IDs and pagination through query parameters. The request requires an 'accept' header specifying 'application/json'. The response includes a success indicator, optional message and errors, and data containing review group details such as ID, cycle ID, and name. Pagination details such as page number, page size, total pages, and total records are also included in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Shift Policies

  • ID: get_all_shift_policies
  • Operation: read
  • Entities: shift policy, data, page
  • Summary: This API endpoint retrieves all shift policies. It accepts optional query parameters such as 'shiftPolicyIds' to filter by specific shift policy IDs, 'pageNumber' to specify the page of results to retrieve, and 'pageSize' to determine the number of results per page (default is 100, maximum is 200). The response includes a boolean 'succeeded' indicating the success of the request, a 'message', any 'errors', and the 'data' which is an array of shift policies with 'id' and 'name'. Pagination details such as 'pageNumber', 'pageSize', 'firstPage', 'lastPage', 'totalPages', 'totalRecords', 'nextPage', and 'previousPage' are also provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Skills

  • ID: get_all_skills
  • Operation: read
  • Entities: error, page, skill
  • Summary: This API endpoint retrieves all skills available in the system. It supports pagination through the 'pageNumber' and 'pageSize' query parameters, allowing clients to specify the number of results per page and the specific page to retrieve. The 'lastModified' query parameter can be used to filter skills based on their last modification date. The response includes a paged list of skills, each with an 'id' and 'name', along with pagination details such as 'pageNumber', 'pageSize', 'totalPages', and 'totalRecords'. The response also indicates whether the request was successful through the 'succeeded' field and may include a 'message' and 'errors' if applicable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Time Frames

  • ID: get_all_time_frames
  • Operation: read
  • Entities: time frame, error, page
  • Summary: This API endpoint retrieves all time frames available in the system. It supports filtering by specific time frame IDs through query parameters. The response includes pagination details such as page number, page size, total pages, and total records. The data returned includes details about each time frame such as its ID, name, frequency, start and end dates, and status indicators like whether it is closed or locked.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Asset Categories

  • ID: get_asset_categories
  • Operation: read
  • Entities: response, asset category, error
  • Summary: This API endpoint retrieves all asset categories. It supports optional query parameters such as 'assetCategoryIds' to filter by specific category IDs, 'lastModified' to filter by the last modified date-time, 'pageNumber' to specify the page number, and 'pageSize' to define the number of results per page (default is 100, maximum is 200). The response includes a paged list of asset categories with details such as 'id' and 'name', along with pagination information like 'pageNumber', 'pageSize', 'totalPages', and 'totalRecords'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Asset Conditions

  • ID: get_asset_conditions
  • Operation: read
  • Entities: asset condition, error, page
  • Summary: This API endpoint retrieves all asset conditions. It supports optional query parameters such as 'assetConditionIds' to filter by specific asset condition IDs, 'lastModified' to filter by the last modified date-time, 'pageNumber' to specify the page of results to retrieve, and 'pageSize' to specify the number of results per page (default is 100, maximum is 200). The response includes a paged list of asset conditions, along with metadata about the pagination such as the current page number, page size, total pages, and total records. The response also indicates whether the request was successful and may include a message or errors if applicable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Attendance Records

  • ID: get_attendance_records
  • Operation: read
  • Entities: employee, attendance, timesheet
  • Summary: This API endpoint retrieves all attendance records within a specified date range. If the 'from' and 'to' dates are not provided, it defaults to the last 30 days. The 'from' date must be before the 'to' date, and the range cannot exceed 90 days. The API supports filtering by employee IDs and pagination with 'pageNumber' and 'pageSize'. The response includes a success indicator, message, errors, and an array of attendance data with details such as employee number, attendance date, shift timings, and location addresses for the first and last entries of the day.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Billing Roles for Client

  • ID: get_billing_roles_for_client
  • Operation: read
  • Entities: client, billing role
  • Summary: This API endpoint retrieves the billing roles for a specified client. It requires the client ID as a path parameter. Optional query parameters include 'lastModified' to filter by the last modified date-time, 'pageNumber' for pagination, and 'pageSize' to specify the number of results per page (default is 100, maximum is 200). The response includes a success indicator, a message, any errors, and the data containing the billing roles with their ID, name, and billing rate.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Client Details by Identifier

  • ID: get_client_details_by_identifier
  • Operation: read
  • Entities: billing address, client contact, client
  • Summary: This API endpoint retrieves the details of a specified client based on the provided identifier. The request requires the 'id' path parameter, which is the unique identifier of the client. The response includes a success flag, a message, any errors, and the client's data, which contains information such as the client's name, code, description, billing address, contacts, attributes, and additional fields. The response is returned in JSON format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Details

  • ID: get_employee_details
  • Operation: read
  • Entities: l2Manager, jobTitle, employees
  • Summary: This API endpoint retrieves details of all employees or specific employees based on provided search parameters. The request is made using the GET method to the URL 'https://{company}.{environment}.com/api/v1/hris/employees'. The API accepts various query parameters such as 'employeeIds', 'employeeNumbers', 'employmentStatus', 'inProbation', 'inNoticePeriod', 'lastModified', 'pageNumber', and 'pageSize' to filter and paginate the results. The request headers must include 'accept' and 'Authorization' with a Bearer token for authorization. The response includes a paged list of employee details, including personal and professional information, addresses, relations, education, experience, and various policy information. The response is structured with fields indicating success, message, errors, and data containing the employee details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Details by ID

  • ID: get_employee_details_by_id
  • Operation: read
  • Entities: l2Manager, jobTitle, employees
  • Summary: This API endpoint retrieves the details of an employee based on the specified identifier. The request is made using the GET method to the URL 'https://{company}.{environment}.com/api/v1/hris/employees/{id}', where '{id}' is the path parameter representing the employee's unique identifier. The request must include the 'accept' header set to 'application/json'. The response includes a boolean 'succeeded' indicating the success of the request, a 'message', any 'errors', and a 'data' object containing detailed information about the employee, such as personal details, job title, manager information, contact details, and more. The response also handles various status codes, including 200 for success, 401 for unauthorized access, 403 for forbidden access, and 404 if the employee is not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Full and Final Settlement Details

  • ID: get_employee_fnf_details
  • Operation: read
  • Entities: employee, termination, payroll
  • Summary: This API endpoint retrieves the Full and Final (FnF) settlement details for employees. It supports filtering by employee IDs and pagination through query parameters such as pageNumber and pageSize. The response includes detailed information about each employee's FnF settlement, including termination details, financial components like earnings, contributions, deductions, and net amounts. The response is paginated and provides metadata about the pagination state, such as total pages and records.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Praises

  • ID: get_employee_praises
  • Operation: read
  • Entities: employee, praise, feedback
  • Summary: The Get Employee Praises API retrieves all employee praises from the system. It supports filtering by praise IDs and date range using the 'praiseIds', 'from', and 'to' query parameters. Pagination is supported through 'pageNumber' and 'pageSize' parameters. The response includes a list of praises with details such as feedback, badge, employees involved, and the person who gave the praise. The response also includes pagination details like total pages and records.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Skills

  • ID: get_employee_skills
  • Operation: read
  • Entities: employee, rating, skill
  • Summary: The Get Employee Skills API retrieves the skills of a specified employee using their employee ID. The API requires the 'employeeId' as a path parameter. Optional query parameters include 'lastModified' to filter by the last modified date-time, 'pageNumber' to specify the page number, and 'pageSize' to define the number of results per page. The response includes a paged list of skills with details such as skill name and rating, along with pagination information like total pages and records.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Update Fields

  • ID: get_employee_update_fields
  • Operation: read
  • Entities: employee, profile field, job field
  • Summary: The Get Employee Update Fields API endpoint allows clients to retrieve information about the fields available for updating employee profiles and job details. The API accepts query parameters such as pageNumber and pageSize to paginate the results. The response includes a success indicator, a message, any errors, and data containing arrays of profileFields and jobFields. Each field includes details such as id, fieldName, whether it is required, fieldType, if it is system-defined, and any fieldOptions available.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Holidays Calendar

  • ID: get_holidays_calendar
  • Operation: read
  • Entities: holiday, calendar, page
  • Summary: The Get Holidays Calendar API retrieves the holidays calendar for a specified company and environment. It accepts query parameters such as holidaysCalendarIds, pageNumber, and pageSize to filter and paginate the results. The response includes a boolean indicating success, a message, any errors, and the data containing holiday information. Pagination details such as pageNumber, pageSize, totalPages, and totalRecords are also provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get HRIS Document Types

  • ID: get_hris_document_types
  • Operation: read
  • Entities: response, document, page
  • Summary: The Get HRIS Document Types API endpoint retrieves a list of document types available in the HRIS system. It supports pagination through the 'pageNumber' and 'pageSize' query parameters. The response includes a paged list of document types, each with an 'id' and 'name'. The response also provides pagination details such as 'pageNumber', 'pageSize', 'totalPages', and 'totalRecords'. The request requires an 'accept' header specifying 'application/json'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Leave Balances

  • ID: get_leave_balances
  • Operation: read
  • Entities: employee, leave balance, leave type
  • Summary: The 'Get Leave Balances' API endpoint retrieves all leave balances for employees. It accepts optional query parameters such as 'employeeIds' and 'leaveTypeIds' to filter results, and 'pageNumber' and 'pageSize' for pagination. The response includes a paged list of leave balances, with details such as employee identifiers, leave type IDs, accrued amounts, consumed amounts, available balances, and annual quotas. The response also includes pagination details like total pages and records.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Leave Requests

  • ID: get_leave_requests
  • Operation: read
  • Entities: employee, leave request, duration
  • Summary: This API endpoint retrieves all leave requests in the organization within a specified date range. If both 'from' and 'to' dates are not provided, it defaults to the last 30 days. The 'from' date must be before the 'to' date, and the range cannot exceed 90 days. The API supports filtering by employee IDs and pagination with 'pageNumber' and 'pageSize'. The response includes details of each leave request, such as employee identifiers, leave dates, sessions, status, and selection details. The response is paginated, providing metadata like total pages and records.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Pay Batches for a Pay Cycle

  • ID: get_pay_batches_for_a_pay_cycle
  • Operation: read
  • Entities: pay group, pay batch, pay cycle
  • Summary: This API endpoint retrieves pay batches for a specific pay cycle within a pay group. It requires the 'payGroupId' and 'payCycleId' as path parameters. Optional query parameters include 'status' to filter by payment status, 'pageNumber' for pagination, and 'pageSize' to specify the number of results per page. The response includes details about the pay batches, pagination information, and any errors if present.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Payments for Specified Pay Group, Pay Cycle, and Pay Batch

  • ID: get_payments_for_specified_pay_group_pay_cycle_and_pay_batch
  • Operation: read
  • Entities: pay group, payment, pay cycle
  • Summary: This API endpoint retrieves all payments for a specified pay group, pay cycle, and pay batch. The request requires the path parameters 'payGroupId', 'payCycleId', and 'payBatchId' to specify the pay group, cycle, and batch respectively. Optional query parameters include 'status' to filter payments by status (UnPaid, Paid), 'pageNumber' to specify the page of results, and 'pageSize' to specify the number of results per page. The response includes a boolean 'succeeded' indicating success, a 'message', any 'errors', and 'data' which is an array of payment details including 'id', 'identifier', 'employeeNumber', 'employeeName', 'forPeriod', 'amount', 'salaryPaymentMode', 'bankName', 'ifscCode', 'accountNumber', and 'status'. Pagination details such as 'pageNumber', 'pageSize', 'firstPage', 'lastPage', 'totalPages', 'totalRecords', 'nextPage', and 'previousPage' are also included.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Payroll Pay Register

  • ID: get_payroll_pay_register
  • Operation: read
  • Entities: pay register, pay group, pay cycle
  • Summary: The Get Payroll Pay Register API retrieves detailed payroll information for a specific pay group and pay cycle. It requires the 'payGroupId' and 'payCycleId' as path parameters, which are mandatory. The API supports pagination through optional query parameters 'pageNumber' and 'pageSize'. The response includes detailed payroll data such as employee details, earnings, deductions, and other financial information. The response is paginated and includes metadata about the pagination such as total pages and records.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Payroll Paygroup Paycycles

  • ID: get_payroll_paygroup_paycycles
  • Operation: read
  • Entities: run status, pay group, pay cycle
  • Summary: This API endpoint retrieves the pay cycles for a specific pay group identified by the 'payGroupId' path parameter. It supports filtering by 'runStatus' through a query parameter, which can take values such as Pending, Finalized, or Partial. Pagination is supported via 'pageNumber' and 'pageSize' query parameters, with a default page size of 100 and a maximum of 200. The response includes details about the pay cycles, such as their identifier, month, start and end dates, and run status. The response is paginated and includes metadata about the pagination state, such as total pages and records.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Penalisation Policies

  • ID: get_penalisation_policies
  • Operation: read
  • Entities: penalisation policy, tracking policy, page
  • Summary: The 'Get Penalisation Policies' API endpoint retrieves all tracking policies. It accepts optional query parameters such as 'trackingPolicyIds' to filter by specific policy IDs, 'pageNumber' to specify the page of results to retrieve, and 'pageSize' to determine the number of results per page (default is 100, maximum is 200). The response includes a boolean 'succeeded' indicating success, a 'message', any 'errors', and 'data' containing the list of policies. Pagination details such as 'pageNumber', 'pageSize', 'firstPage', 'lastPage', 'totalPages', 'totalRecords', 'nextPage', and 'previousPage' are also provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Project Allocations

  • ID: get_project_allocations
  • Operation: read
  • Entities: employee, project, allocation
  • Summary: This API endpoint retrieves the allocations for a specified project based on its identifier. The request requires the project ID as a path parameter and accepts optional query parameters such as lastModified, pageNumber, and pageSize to filter and paginate the results. The response includes details about the success of the request, any messages or errors, and the data of project allocations, which includes employee details, allocation percentage, billing role, and billing rate. Pagination details such as page number, page size, total pages, and total records are also provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Project Details by Identifier

  • ID: get_project_details_by_identifier
  • Operation: read
  • Entities: project, client, project manager
  • Summary: This API endpoint retrieves the details of a specified project using its identifier. The request is made using the GET method to the URL 'https://{company}.{environment}.com/api/v1/psa/projects/{id}', where '{id}' is the path parameter representing the project identifier. The request header should include 'accept: application/json' to specify the expected response format. The response includes a boolean 'succeeded' indicating the success of the request, a 'message' string, an array of 'errors' if any, and a 'data' object containing detailed information about the project such as 'id', 'clientId', 'name', 'code', 'startDate', 'endDate', 'status', 'projectManagers', 'isBillable', 'billingType', 'isArchived', and 'customAttributes'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Project Phases

  • ID: get_project_phases
  • Operation: read
  • Entities: paged response, project, phase
  • Summary: The 'Get Project Phases' API endpoint retrieves the phases of a specified project. It requires the 'projectId' as a path parameter. Optional query parameters include 'lastModified' to filter by modification date, 'pageNumber' to specify the page of results, and 'pageSize' to determine the number of results per page. The response includes a success indicator, a message, any errors, and the data containing project phases, along with pagination details such as page number, page size, total pages, and total records.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Project Task Time Entries

  • ID: get_project_task_time_entries
  • Operation: read
  • Entities: project, task, time entry
  • Summary: This API endpoint retrieves the time entries for a specific project task within a specified date range. The request requires the projectId and taskId as path parameters. Optional query parameters include 'from' and 'to' dates to specify the date range, 'employeeIds' to filter by specific employees, 'pageNumber' for pagination, and 'pageSize' to define the number of results per page. If 'from' and 'to' are not specified, the API defaults to the last 30 days. The response includes a paged list of time entries with details such as date, employeeId, totalMinutes, and status, along with pagination information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Project Tasks

  • ID: get_project_tasks
  • Operation: read
  • Entities: employee, task, project
  • Summary: This API endpoint retrieves the tasks associated with a specific project. The request requires the 'projectId' as a path parameter. Optional query parameters include 'lastModified' to filter tasks modified after a certain date, 'pageNumber' to specify the page of results, and 'pageSize' to determine the number of results per page. The response includes a paged list of tasks, each with details such as task ID, project ID, name, description, task type, billing type, assigned employees, start and end dates, and estimated hours. The response also includes pagination details like total pages and records.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Salary Components

  • ID: get_salary_components
  • Operation: read
  • Entities: response, error, salary component
  • Summary: This API endpoint retrieves all salary components. It is a GET request to the URL https://{company}.{environment}.com/api/v1/payroll/salarycomponents. The request requires an 'accept' header with the value 'application/json'. The response includes a boolean 'succeeded' indicating success, a 'message', an array of 'errors', and 'data' which is an array of salary components. Each component has an 'id', 'identifier', 'title', and 'accountingCode'. Pagination details such as 'pageNumber', 'pageSize', 'firstPage', 'lastPage', 'totalPages', 'totalRecords', 'nextPage', and 'previousPage' are also included in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Time Entries

  • ID: get_time_entries
  • Operation: read
  • Entities: employee, project, time entry
  • Summary: This API endpoint retrieves time entries within a specified date range. If both 'from' and 'to' dates are not provided, it defaults to the last 30 days. The 'from' date must be before the 'to' date, and the range cannot exceed 90 days. The API supports filtering by employee IDs, project IDs, and task IDs. Pagination is supported with 'pageNumber' and 'pageSize' parameters. The response includes a success indicator, message, errors, and a list of time entries with details such as date, employee ID, project ID, task ID, total minutes, start and end times, comments, billable status, and status code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Weekly Off Policies

  • ID: get_weekly_off_policies
  • Operation: read
  • Entities: weeklyoff policy, page
  • Summary: This API endpoint retrieves all weekly off policies. It supports optional query parameters such as 'weeklyoffPolicyIds' to filter by specific policy IDs, 'pageNumber' to specify the page of results to retrieve, and 'pageSize' to determine the number of results per page (default is 100, maximum is 200). The response includes a paged list of policies with details such as 'id' and 'name', along with pagination information like 'pageNumber', 'pageSize', 'totalPages', and 'totalRecords'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Praise and Return Identifier

  • ID: post_add_praise_and_return_identifier
  • Operation: write
  • Entities: employee, badge, praise
  • Summary: This API endpoint allows users to add a praise and returns the identifier of the created praise. The request requires headers specifying the accepted response format and the content type of the request body. The body must include 'badgeId', 'employeeIds', 'feedback', and 'givenBy'. The response indicates success or failure, includes a message, any errors, and the identifier of the created praise.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Project Allocation

  • ID: post_add_project_allocation
  • Operation: write
  • Entities: employee, project, allocation
  • Summary: The Add Project Allocation API allows users to add an allocation to a project by specifying the project ID in the path parameters. The request body can include details such as employee ID, allocation percentage, billing role ID, billing rate, start date, and end date. The response indicates whether the operation was successful and may include a message, errors, and additional data.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Client

  • ID: post_create_client
  • Operation: write
  • Entities: client, billing information, address
  • Summary: This API endpoint is used to create a new client in the system. It requires a POST request to the specified URL with headers indicating the content type as 'application/*+json'. The request body must include the client's code and name, and optionally other details such as description, billing information, phone, website, and email. Upon successful creation, the API returns a response indicating success, along with a message and the identifier of the created client. If there are any errors, they will be included in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Employee

  • ID: post_create_employee
  • Operation: write
  • Entities: employee
  • Summary: The Create Employee API allows you to create a new employee in the system. It requires a POST request to the endpoint with a JSON body containing details such as business unit, date joined, date of birth, department, display name, email, first name, gender, job title, last name, and location. The request headers must include 'accept' and 'content-type'. Upon successful creation, the API returns a response indicating success, along with the identifier of the created employee. If there are any errors, they will be listed in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Employee Exit Request

  • ID: post_create_employee_exit_request
  • Operation: write
  • Entities: employee, date, exit request
  • Summary: This API endpoint is used to create an exit request for an employee. It requires the employee's ID as a path parameter. The request body must include details such as the exit type, reason, resignation date, last working date, rehire eligibility, and any additional comments. The response will indicate whether the request was successful, along with any messages or errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Leave Request

  • ID: post_create_leave_request
  • Operation: write
  • Entities: employee, leave request, leave type
  • Summary: This API endpoint allows the creation of a leave request for an employee. The request requires the employee's ID, the start and end dates of the leave, the leave type ID, the reason for the leave, and the ID of the person requesting the leave. Optional fields include the session for the start and end dates and additional notes. The response includes a success indicator, a message, any errors, and the identifier of the created leave request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Project

  • ID: post_create_project
  • Operation: write
  • Entities: project, client
  • Summary: This API endpoint allows the creation of a new project. It requires a POST request to the specified URL with headers indicating the content type and accept type. The request body must include the clientId, code, endDate, name, and startDate as required fields, with optional fields such as description, status, and isBillable. The response will indicate success or failure, and if successful, it will return the identifier of the created project.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Project Phase

  • ID: post_create_project_phase
  • Operation: write
  • Entities: project, phase
  • Summary: This API endpoint is used to create a new project phase within a specified project. The request requires the 'projectId' as a path parameter to identify the project. Optionally, a 'phaseName' can be provided as a query parameter to name the phase. The response will include a boolean 'succeeded' indicating the success of the operation, a 'message' providing additional information, an 'errors' array if there are any issues, and 'data' containing the identifier of the newly created phase. The endpoint returns a 200 status code on success, with possible 401 Unauthorized or 403 Forbidden errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Project Task

  • ID: post_create_project_task
  • Operation: write
  • Entities: project, task, phase
  • Summary: This API endpoint is used to create a new task within a specified project. The request requires the project ID as a path parameter and a JSON body containing details about the task, such as its name, start and end dates, and optional fields like description and assigned users. The response includes a success indicator, a message, any errors, and the identifier of the created task.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Generate Access Token

  • ID: post_generate_access_token
  • Operation: read
  • Entities: client, authentication parameter, access token
  • Summary: The Generate Access Token API is used to fetch an access token by providing authentication parameters in the request body. The request must be sent as a POST request to the endpoint 'https://login.{environment}.com/connect/token'. The request headers must include 'accept: application/json' and 'content-type: application/x-www-form-urlencoded'. The body of the request should contain the following required parameters: 'grant_type', 'scope', 'client_id', 'client_secret', and 'api_key'. The response will include an access token, its expiration time, token type, and scope if the request is successful. In case of an error, an error code will be returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Upload Employee Documents

  • ID: post_upload_employee_documents
  • Operation: write
  • Entities: employee, type, document
  • Summary: The 'Upload Employee Documents' API allows users to upload documents for a specific employee. The API requires the 'employeeId' and 'typeId' as path parameters, which are UUIDs identifying the employee and the document type, respectively. The request must include a multipart/form-data body containing the document file(s) to be uploaded. The response will indicate whether the upload was successful, along with any messages or errors, and will return a UUID representing the uploaded document data.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add BGV Report to Keka

  • ID: put_add_bgv_report_to_keka
  • Operation: write
  • Entities: bgv report, request
  • Summary: This API endpoint is used to add a BGV (Background Verification) report to Keka. It requires the 'bgvId' and 'requestId' as path parameters, which are both mandatory. The request is made using the PUT method and does not require a request body. The headers should include 'accept' set to 'application/json' and 'content-type' set to 'multipart/form-data'. On success, it returns a boolean value 'true'. Possible error responses include '401 Unauthorized', '403 Forbidden', and '404 Not Found'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Asset Assignment

  • ID: put_update_asset_assignment
  • Operation: write
  • Entities: asset, response, asset assignment
  • Summary: The Update Asset Assignment API allows users to update the assignment details of a specific asset identified by the assetId path parameter. The request requires headers specifying the accepted response format and the content type of the request body. The request body can include details such as the person to whom the asset is assigned, the date of assignment, the condition of the asset, and any additional notes. The response indicates whether the update was successful and may include a message, any errors, and the data related to the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Client Details

  • ID: put_update_client_details
  • Operation: write
  • Entities: billing address, client
  • Summary: The Update Client Details API allows users to update the details of a client identified by a unique ID. The API requires the 'id' path parameter to specify the client to be updated. The request body can include optional fields such as 'name', 'description', 'code', and 'billingAddress', which contains address details like 'addressLine1', 'addressLine2', 'countryCode', 'city', 'state', and 'zip'. The response indicates whether the update was successful, along with any messages or errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee Exit Request

  • ID: put_update_employee_exit_request
  • Operation: write
  • Entities: employee, response, exit request
  • Summary: The Update Employee Exit Request API allows updating the exit request details for a specific employee identified by the 'id' path parameter. The request requires headers specifying 'accept' and 'content-type'. The request body includes details such as 'exitType', 'exitReason', 'resignationDate', 'lastWorkingDate', 'isOkToRehire', and 'comments'. The response returns a boolean 'data' indicating success, an optional 'message', and a list of 'errors' if any.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee Job Details

  • ID: put_update_employee_job_details
  • Operation: write
  • Entities: department, job detail, employee
  • Summary: This API endpoint allows updating the job details of an employee. It requires the employee's ID as a path parameter. The request body should contain the job details such as employee number, location, business unit, department, job title, reporting manager, and other related fields. The response will indicate whether the update was successful, along with any messages or errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee Personal Details

  • ID: put_update_employee_personal_details
  • Operation: write
  • Entities: employee, personal detail, address
  • Summary: This API endpoint allows updating the personal details of an employee. The request requires the employee's ID as a path parameter. The request body can include various personal details such as display name, first name, middle name, last name, gender, date of birth, contact information, marital status, relations, blood group, addresses, professional summary, and custom fields. The response indicates whether the update was successful and may include a message and any errors encountered.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Goal Progress

  • ID: put_update_goal_progress
  • Operation: write
  • Entities: progress, status, goal
  • Summary: The Update Goal Progress API allows users to update the progress of a specific goal identified by the 'goalId' path parameter. The request must include headers specifying 'accept' and 'content-type'. The request body requires 'currentValue', 'status', and 'updatedBy' fields, with an optional 'note'. The response indicates success with a boolean 'succeeded' field, and may include a 'message', 'errors', and 'data'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Payments Status in Payroll System

  • ID: put_update_payments_status
  • Operation: write
  • Entities: pay group, payment, pay cycle
  • Summary: This API endpoint updates the status of payments within a specific payroll batch. It allows for bulk transactions, with a limit of 100 transactions per batch. The request requires path parameters including payGroupId, payCycleId, and payBatchId, and a request body containing an array of payment objects. Each payment object includes a paymentIdentifier, status, transactionOn date-time, and an optional note. The response indicates success or failure, with a message and any errors encountered.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Project Details

  • ID: put_update_project_details
  • Operation: write
  • Entities: project, response, request
  • Summary: The Update Project Details API allows users to update the details of a specific project identified by its ID. The API requires the project ID as a path parameter and accepts a JSON request body containing the project details to be updated, such as name, description, code, status, start date, end date, and billable status. The response indicates whether the update was successful and includes any relevant messages or errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Project Task

  • ID: put_update_project_task
  • Operation: write
  • Entities: project, task
  • Summary: The Update Project Task API allows users to update details of a specific task within a project. The API requires the projectId and taskId as path parameters. The request body can include optional fields such as name, description, taskBillingType, assignedTo, startDate, endDate, estimatedHours, and phaseId. The response indicates whether the update was successful and may include a message and any errors encountered.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated 7 days ago