The CompoundEmployee application programming interface (API) for SAP SuccessFactors Employee Central is used to extract employee data out of Employee Central.
The CompoundEmployee API is based on the Simple Object Access Protocol (SOAP). It replicates employee master data from Employee Central to SAP systems, payroll systems, and benefits systems.
Key Features
The API returns all requested data of an employee in a single call providing a hierarchically structured response.
The query response comprises all time slices of all entities specified in the request. You can apply filters in the query request.
The API replicates only data that has been approved in Employee Central.
Only employees that have an employment are considered. Employees that don't have an employment, such as technical users aren't considered.
To improve the performance and due to the focus of the API, only those fields are extracted by the API that are needed for the respective replication process.
Supported Fields
Before you start implementing, please take the time to check which of the fields you need are supported by this API. We’re continually adding from release to release. You can also combine the CompoundEmployee API with other Employee Central APIs to cover any additional fields you need.
Transmission Modes
- Snapshot Transmission Mode: In this mode, the API returns the data as it was on the snapshot date, considering all changes, corrections, and deletions.
- Delta Transmission Mode: In this mode, the API only returns employee data that was created, changed, or deleted since the last replication.
The delta transmission mode of the CompoundEmployee API makes it possible to determine the concrete data changes of employees that have happened since a given point in time. In contrast to full transmission, consumers only get the changed data for an employee including the previous values, with a clear indication on how to process the data.
