SuccessFactors API Endpoints

Introduction

SuccessFactors is a cloud-based Human Capital Management (HCM) system that provides various functionalities such as Talent Management, Performance Management, Learning Management, and many more.
SuccessFactors provides API endpoints to access and interact with data stored within the system.
In this document, we will go over the various SuccessFactors API endpoints and how to use them in Rivery.

Prerequisite

Reading the SuccessFactors Walkthrough is crucial for comprehending how to operate the SuccessFactors UI effectively.
The provided walkthrough offers a detailed guide on how to navigate the Source's UI and handle Effective Dates, with step-by-step instructions.

Supported SuccessFactors API Endpoints

SuccessFactors API endpoints allow access to the SuccessFactors system.
By using these endpoints, users can create integrations between SuccessFactors and other systems, enabling them to efficiently manage their HCM activities.
Here are the API endpoints supported by Rivery:

• Compensation Information

  Endpoint Descriptions:
  
  

1. EmpPayCompNonRecurring:
   The EmpPayCompNonRecurring endpoint provides access to employee payment and compensation data that is not part of regular payroll or compensation plans. This data may include bonuses, one-time payments, and other non-recurring forms of compensation.

2. EmpCompensation:
   The EmpCompensation endpoint provides access to information about an employee's compensation plan, including salary, bonuses, stock options, and other forms of compensation.
   Effective Dates - Supported
   
   
3. EmpPayCompRecurring:
   The EmpPayCompRecurring endpoint provides access to information about an employee's recurring payroll and compensation data, including base pay, regular bonuses, and other forms of recurring compensation.
   Effective Dates - Supported

• Personal Information

  Endpoint Descriptions:
  
  

1. PerNationalId:
   The PerNationalId endpoint allows you to retrieve employee data based on their national identification number. This can streamline your processes for verifying employee identities, managing compliance, and ensuring accurate record-keeping.

2. PerPersonal:
   The PerPersonal endpoint provides a comprehensive set of personal information for employees, including details such as their name, date of birth, gender, and contact information. This endpoint manages employee profiles, ensures data accuracy, and maintains compliance with privacy regulations.
   Effective Dates - Supported
   
   

3. PerPerson:
   The PerPerson endpoint allows you to retrieve and manage a wide range of employee data, such as employment history, job assignments, compensation, and more.

4. PerPersonRelationship:
   The PerPersonRelationship endpoint is useful for managing organizational hierarchies, team structures, and approvals.
   Effective Dates - Supported

5. PerAddressDEFLT:
   The PerAddressDEFLT endpoint enables you to retrieve and update employee addresses, such as home addresses, work addresses, and emergency contact information.
   Effective Dates - Supported

6. PerEmail:
   The PerEmail endpoint provides access to employee email addresses, allowing you to retrieve and manage their email information. This endpoint is useful for managing employee communication channels, ensuring timely and accurate communication, and maintaining up-to-date contact information.

• Foundation

  Endpoint Descriptions:

1. FODivision:
   The FODivision refers to a logical grouping of employees based on the division or department they work in within an organization. This endpoint can be used to manage and track employee data based on their respective divisions.
   Effective Dates - Supported

2. FOPayGrade:
   The FOPayGrade is an endpoint that defines the salary levels or pay grades within an organization. It can be used to define the range of salaries for a particular role or job function.
   Effective Dates - Supported

3. FOPayRange:
   The FOPayRange is an endpoint that specifies the minimum and maximum salary levels for a particular pay grade. This endpoint can be used to determine the salary range for a job and to ensure that employees are being compensated fairly.
   Effective Dates - Supported

4. FOBusinessUnit:
   The FOBusinessUnit refers to a logical grouping of employees based on the business unit they work in within an organization. This endpoint can be used to manage and track employee data based on their respective business units.
   Effective Dates - Supported

5. FOJobCode:
   The FOJobCode is an endpoint that defines the job codes or titles within an organization. This endpoint can be used to standardize job titles and descriptions across the organization and to ensure that employees are assigned to the appropriate job roles.
   Effective Dates - Supported

6. FOPayGroup:
   The FOPayGroup is an endpoint that defines the groups of employees who are paid on a particular payroll schedule. This endpoint can be used to manage and track employee data based on their respective pay groups.
   Effective Dates - Supported

7. FOCompany:
   The FOCompany refers to the legal entity or subsidiary within an organization. This endpoint can be used to manage and track employee data based on their respective companies.
   Effective Dates - Supported

8. FOEventReason:
   The FOEventReason is an endpoint that defines the reasons for employee events, such as hiring, termination, or promotion. This endpoint can be used to track the history of employee events and to generate reports based on the data.
   Effective Dates - Supported

9. FOLocation:
   The FOLocation refers to the physical location of an employee's work site within an organization. This endpoint can be used to manage and track employee data based on their respective work locations.
   Effective Dates - Supported

10. FOLocationGroup:
    The FOLocationGroup is an endpoint that groups multiple work locations together for reporting and management purposes. This endpoint can be used to manage and track employee data based on their respective location groups.
    Effective Dates - Supported

11. FODepartment:
    The FODepartment refers to a logical grouping of employees based on the department they work in within an organization. This endpoint can be used to manage and track employee data based on their respective departments.
    Effective Dates - Supported

• Employee Global Information

  Endpoint Descriptions:

1. CurrencyExchangeRate:
   The CurrencyExchangeRate endpoint is a function that enables users to retrieve and update currency exchange rates in the system. This endpoint allows users to retrieve the current exchange rate between two currencies, or to update the exchange rate if there are changes to the market rates. The endpoint provides a range of parameters that can be used to specify the currencies and date ranges for which the exchange rates are required.
   Effective Dates - Supported

2. PerGlobalInfoUSA:
   The PerGlobalInfoUSA endpoint is a function that provides users with access to personal information about employees located in the United States. This endpoint allows users to retrieve and update information such as an employee's name, address, contact details, employment history, and benefits information. The endpoint provides a range of parameters that can be used to specify the employee and the type of information that is required.
   Effective Dates - Supported

• Employment Information

  Endpoint Descriptions

1. EmpEmployment:
   EmpEmployment represents an employee's employment history. It contains information such as the employee's hire date, termination date, employment status, and job title. EmpEmployment also includes details about the employee's compensation, such as their salary and bonuses. This endpoint can be used to track an employee's employment history and to generate reports on employee turnover and retention.

2. EmpJobRelationships:
   EmpJobRelationships represents the relationships between an employee and their job. It contains information such as the employee's job code, job title, job status, and manager. EmpJobRelationships also includes details about the employee's job responsibilities and performance goals. This endpoint can be used to manage an employee's job details and to track their progress toward their performance goals.
   Effective Dates - Supported

3. EmpWorkPermit:
   EmpWorkPermit represents an employee's work permit status. It contains information such as the employee's work permit number, expiration date, and type of work permit. EmpWorkPermit can be used to manage an employee's work permit details and to track their work permit expiration dates.

4. EmpEmploymentTermination:
   EmpEmploymentTermination represents an employee's termination from employment. It contains information such as the reason for termination, the termination date, and the employee's final paycheck. EmpEmploymentTermination can be used to manage an employee's termination details and to generate reports on employee turnover.

5. EmpJob:
   EmpJob represents an employee's current job details. It contains information such as the employee's job code, job title, job status, and manager. EmpJob also includes details about the employee's job responsibilities and performance goals. This endpoint can be used to manage an employee's current job details and to track their progress toward their performance goals.
   Effective Dates - Supported

Limitation

The pagination structure of the SuccessFactors API might lead to instances of duplicated data in API responses. To prevent such duplications, we suggest opting for the "Upsert-Merge" loading mode over the "Overwrite" loading mode.
This approach will effectively manage and address any duplication occurrences.