Guides
Signup For Free

SAP SuccessFactors API Integration

Suggest Edits

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

Get all compensation information for an employee

  • ID: get_all_compensation_information_for_an_employee
  • Operation: read
  • Entities:
  • Summary: The 'Get all compensation information for an employee' API retrieves comprehensive compensation details for a specified employee. The API requires an Authorization header with a Bearer token and a path parameter 'employeeId' to identify the employee. The response includes detailed metadata about the employee's personal and employment information, compensation details, and navigation links to related entities. The response body is structured with metadata, personal details, employment navigation, compensation navigation, and other related navigations, providing a complete view of the employee's compensation information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Bank Accounts for Employee

  • ID: get_bank_accounts_for_employee
  • Operation: read
  • Entities:
  • Summary: The 'Get Bank Accounts for Employee' API retrieves detailed information about an employee's bank accounts and related employment details. The API requires an Authorization header with a Bearer token and a path parameter 'employeeId' to identify the employee. Optional query parameters include '$expand' to expand related entities. The response includes metadata, personal details, employment navigation, and payment information navigation, detailing the employee's bank accounts, payment methods, and related financial information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get benefits for employee

  • ID: get_benefits_for_employee
  • Operation: read
  • Entities:
  • Summary: The 'Get benefits for employee' API retrieves the benefit enrollment details for a specific employee identified by the 'employeeId' path parameter. The API requires an 'Authorization' header with a Bearer token for authentication. Optional query parameters include '$expand' to expand related entities, '$filter' to filter results, '$top' to limit the number of results, and '$skip' to skip a number of results. The response includes detailed information about the employee's benefit enrollment, such as effective start and end dates, benefit IDs, currency, and various metadata. Deferred navigation properties are provided for related entities, allowing further exploration of the benefit details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get company of employee

  • ID: get_company_of_employee
  • Operation: read
  • Entities:
  • Summary: The 'Get company of employee' API retrieves detailed information about an employee's company and employment details. It requires an Authorization header with a Bearer token and a path parameter 'employeeId' to identify the employee. Optional query parameters include '$expand' to expand related entities. The response includes metadata, personal details, and employment navigation with detailed job and company information, such as job title, department, company name, and more.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get deductions for employee

  • ID: get_deductions_for_employee
  • Operation: read
  • Entities:
  • Summary: The 'Get deductions for employee' API retrieves both one-time and recurring deductions for a specified employee. The API requires an Authorization header with a Bearer token and a path parameter 'employeeId' to uniquely identify the employee. Optional query parameters include '$expand' to expand related entities, '$filter' to filter results, '$top' to limit the number of results, and '$skip' to skip a number of results. The response includes detailed information about one-time deductions and recurring deductions, with metadata and navigation links for related entities.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get department for employee

  • ID: get_department_for_employee
  • Operation: read
  • Entities:
  • Summary: The 'Get department for employee' API retrieves detailed information about an employee's department based on their unique employee ID. The API requires an Authorization header with a Bearer token for access. The employeeId is a required path parameter that uniquely identifies the employee. Optional query parameters include $expand to expand related entities and $format to specify the response format, which can be 'JSON'. The response includes metadata about the employee, their employment details, and job information, including the department code and navigation to department details such as the department name and description.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get employee details by employee identifier

  • ID: get_employee_details_by_employee_identifier
  • Operation: read
  • Entities:
  • Summary: This API retrieves the details of an employee using their unique employee identifier. The request requires an Authorization header with a Bearer token for authentication. The employeeId is a required path parameter that specifies the unique identifier for the employee. Optional query parameters include $filter for filtering the results based on specific criteria and $format to specify the response format, which can be 'JSON'. The response includes detailed information about the employee, such as personal information, contact details, employment information, and more, with various navigational links to related data.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Locations

  • ID: get_employee_locations
  • Operation: read
  • Entities:
  • Summary: The Get Employee Locations API retrieves detailed information about an employee's locations and related employment details. The API requires an Authorization header with a Bearer token and a path parameter 'employeeId' to uniquely identify the employee. Optional query parameters include '$expand' to expand related entities and '$format' to specify the response format, which can be 'JSON'. The response includes metadata, personal information, employment details, job information, and location details, with navigation links to related entities. The response is structured in a nested JSON format, providing comprehensive data about the employee's employment and location.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Identification details of employee

  • ID: get_identification_details_of_employee
  • Operation: read
  • Entities:
  • Summary: The 'Get Identification details of employee' API retrieves the identification details of a specific employee using their unique employee ID. The API requires an Authorization header with a Bearer token for authentication. The employeeId is a required path parameter that specifies the unique identifier for the employee. Optional query parameters include $expand to expand related entities and $format to specify the response format, which can be 'JSON'. The response includes metadata, country, person ID, card type, national ID, and other related details. Navigation links to person and country entities are also provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Leave Requests

  • ID: get_leave_requests
  • Operation: read
  • Entities:
  • Summary: The Get Leave Requests API allows users to retrieve leave requests for employees from the EmployeeTime dataset. The API requires an Authorization header with a Bearer token for authentication. Optional query parameters include $skip for pagination to skip a number of items, $top to limit the number of items returned, $filter to apply specific criteria to the dataset, and $format to specify the response format, which can be 'JSON'. The response includes detailed information about each leave request, such as metadata, external code, absence duration category, start and end dates, approval status, and more. Deferred navigation properties are also included for related entities.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Leave Types

  • ID: get_leave_types
  • Operation: read
  • Entities:
  • Summary: The Get Leave Types API retrieves information about different types of leave available for employees. It requires an Authorization header with a Bearer token for authentication and a path parameter 'employeeId' to specify the employee. Optional query parameters include '$filter' to apply specific criteria to the data set and '$format' to specify the response format, which can be 'JSON'. The response includes detailed metadata and attributes for each leave type, such as external codes, names in various languages, workflow configurations, and other relevant details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get timesheets for employee in given date range

  • ID: get_timesheets_employee
  • Operation: read
  • Entities:
  • Summary: The 'Get timesheets for employee in given date range' API allows users to retrieve timesheet data for a specific employee within a specified date range. The API requires an Authorization header with a Bearer token for authentication. The query parameters include 'employeeId', 'startDate', and 'endDate', which are used to filter the timesheets for the specified employee and date range. The response includes detailed timesheet information such as 'externalCode', 'lastModifiedDateTime', 'plannedHoursAndMinutes', 'period', 'approvalStatus', and various navigation links for related entities. This API is useful for tracking employee work hours and attendance records over a given period.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all employees

  • ID: list_all_employees
  • Operation: read
  • Entities:
  • Summary: The 'List all employees' API retrieves a list of all employees from the system. It requires an Authorization header with a Bearer token for authentication. The API supports pagination through the optional query parameters '$skip' and '$top', which allow you to specify the number of items to skip and the maximum number of items to return, respectively. The response includes detailed information about each employee, such as their person ID, date of birth, country of birth, and various navigation links to related data. The '__next' field in the response provides a URL for fetching the next set of results if pagination is used.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Employee

  • ID: post_create_employee
  • Operation: write
  • Entities:
  • Summary: The Create Employee API allows you to create a new employee record in the system. It requires an Authorization header with a Bearer token for authentication. The API accepts various parameters including path parameters like employeeId, query parameters like $format, and a detailed request body containing employee details such as startDate, workEmail, personalEmails, jobCode, jobTitle, location, position, payScaleArea, payScaleType, eventReason, company, businessUnit, managerId, gender, nationality, nativePreferredLang, firstName, and lastName. The response includes details of the operation status for different entities like per_person, per_email, emp_employment, emp_job, and per_personal, each containing a key, status, editStatus, message, index, httpCode, and inlineResults. The employeeId is also returned in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Terminate Employee with given Employee ID

  • ID: terminate_employee
  • Operation: write
  • Entities: employee, termination
  • Summary: The Terminate Employee API allows you to terminate an employee by providing the employee's ID and email. The request requires an Authorization header with a Bearer token. The body of the request includes 'employeeId' and 'employeeEmail'. The response returns a status indicating the success of the operation, along with a message and HTTP code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update compensation information for an employee

  • ID: update_compensation_information_for_an_employee
  • Operation: write
  • Entities:
  • Summary: The 'Update compensation information for an employee' API allows updating various compensation-related details for an employee identified by their employee ID. The API requires an Authorization header with a Bearer token. The request includes path parameters for the employee ID, optional query parameters for response format, and a body with detailed employee information such as start date, work email, personal emails, job code, job title, location, position, pay scale area, pay scale type, event reason, company, business unit, manager ID, gender, nationality, native preferred language, first name, and last name. The response provides detailed status information for each updated entity, including person, email, employment, job, and personal information, along with the employee ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee Department

  • ID: update_department_for_employee
  • Operation: write
  • Entities: employee, department
  • Summary: The Update Employee Department API allows you to update the department of a specific employee. You need to provide the employee's ID, email, and the new department ID in the request body. The request must include an Authorization header with a Bearer token. The API returns a response indicating the status of the upsert operation, including a unique key, status, edit status, message, index, HTTP code, and any inline results.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Employee details

  • ID: update_employee_details
  • Operation: write
  • Entities:
  • Summary: The Update Employee details API allows updating various details of an employee such as personal information, email addresses, and addresses. The API requires an Authorization header with a Bearer token for authentication. The employeeId is a required path parameter to identify the employee. The request body can include updated first name, last name, work email, personal emails, present and work addresses, employment details, and metadata. The response provides the status of the updates for personal details, email details, and address details, indicating whether each was successfully upserted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Identification Details for Employee

  • ID: update_identifitcation_details_for_employee
  • Operation: write
  • Entities: identification, nationalId
  • Summary: The Update Identification Details for Employee API allows you to update the identification details of an employee. You need to provide the employee ID, card type, national ID, country, and whether it is the primary identification. The API requires an Authorization header with a Bearer token. Upon successful update, it returns a response with the status, edit status, and HTTP code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated about 1 month ago