PUBLIC

Document Version: 1H 2022 – 2022-08-19

SAP SuccessFactors Employee Central OData API:

Reference Guide (V2)
© 2022 SAP SE or an SAP affiliate company. All rights reserved.

THE BEST RUN

Content

1 About Employee Central OData APIs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

1.1 When is an Employee Central OData API used?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
1.2 Admin Mode and User Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.3 Provisioning Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.4 Permission Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.5 Employee Central Entity Relationships. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
1.6 Entity Association & Navigation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Navigation to the Picklist entity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Navigation to the User entity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26
Navigation to MDF entity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Foundation Object Navigation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Navigation to Territory entity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27
CSF Entity Navigation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27
Person Entity Navigation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Employment Entity Navigation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Navigation from User and MDF Entities to Employee Central Entities. . . . . . . . . . . . . . . . . . . . . . . . 28
1.7 Country/Region-Specific Logic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
EmpCompensation/EmpJob/EmpEmployment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
PerGlobalInfo<Country/Region>. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
FOCorporateAddressDEFLT / HrisEmergencyContactAddressDEFLT. . . . . . . . . . . . . . . . . . . . . . . . 29
PerAddressDEFLT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
FOLegalEntityLocal<Country/Region> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
FOJobClassLocal<Country/Region>. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
PerNationalId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
1.8 Date Handling for Employee Central Entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Effective Dating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Getting your time zones right. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
1.9 Employee Central Entity Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Retrieving changes to records. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46
Business keys. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Property Attribute Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50
Processing Parameters for Upsert. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
suppressUpdateOfIdenticalData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
fileLocale. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
1.10 Pagination. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
1.11 Use &&NO_OVERWRITE&& When Upserting Entities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

2 PUBLIC Content
1.12 External Users' Access to Employee Central OData APIs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

2 Advances. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
2.1 AdvancesAccumulation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59
2.2 AdvancesEligibility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
2.3 NonRecurringPayment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

3 Apprentice Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
3.1 Apprentice. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69
3.2 ApprenticeEventType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71
3.3 ApprenticeInternalTrainingEvent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
3.4 ApprenticePracticalTrainingEvent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
3.5 ApprenticeSchool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
3.6 ApprenticeSchoolEvent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

4 Contingent Workforce. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .81

4.1 VendorInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
4.2 WorkOrder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

5 Deductions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
5.1 DeductionScreenId. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .90
5.2 OneTimeDeduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
5.3 RecurringDeduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

6 Employment Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
6.1 EmpBeneficiary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
6.2 EmpCompensation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
EmpCompensationCalculated. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100
EmpCompensationGroupSumCalculated. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
6.3 EmpEmployment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
6.4 EmpEmploymentTermination. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
6.5 EmpGlobalAssignment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
6.6 EmpJob. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
6.7 EmpJobRelationships. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
6.8 EmpPensionPayout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
6.9 EmpWfRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .130
6.10 EmpWorkPermit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
6.11 EmpPayCompNonRecurring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
6.12 EmpPayCompRecurring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
6.13 EmpTimeAccountBalance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
6.14 HireDateChange. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
6.15 EmpCostDistribution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
EmpCostDistributionItem. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Content PUBLIC 3
6.16 SecondaryAssignments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
SecondaryAssignmentsItem. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

7 Employee Central for Public Sector. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

7.1 HDTempAssignment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
7.2 EmpCostAssignment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .182
7.3 EmpCostAssignmentItem. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
7.4 FundGO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
7.5 FundCenterGO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
7.6 GrantGO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
7.7 BudgetPeriodGO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
7.8 FunctionalAreaGO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

8 Fiscal Year Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

8.1 FiscalYearVariant. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .213
8.2 FiscalYearToCountryMap. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

9 Foundation Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

9.1 Foundation Object Structure in OData API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
9.2 FODynamicRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
9.3 FOEventReason. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .221
9.4 FOFrequency. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
9.5 FOGeozone. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
9.6 FOLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
9.7 FOLocationGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
9.8 FOPayComponent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
9.9 FOPayComponentGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
9.10 FOPayGrade. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .236
9.11 FOPayRange. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .237
9.12 FOWfConfig. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
9.13 FOWfConfigStepApprover. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
9.14 Working with Migrated Foundation Objects (MDF FOs). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Basic Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Associations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Country/region-Specific Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Difference Between FO Upsert and MDF Upsert. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
CurrencyExchangeRate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
FOBusinessUnit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .268
FOCostCenter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
FOCompany. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
FODepartment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .281
FODivision. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

4 PUBLIC Content
 FOLegalEntityLocal<Country/Region>. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
FOJobClassLocal<Country/Region>. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
JobClassificationCountry. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
FOJobFunction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
FOJobCode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
FOPayGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
PayCalendar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325

10 Global Benefits Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

10.1 Benefit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
10.2 BenefitAutomaticActionConfiguration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .341
10.3 BenefitBalanceCarryForward. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
10.4 BenefitClaimAccumulation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
10.5 BenefitCompanyCarAllowedModels. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
10.6 BenefitCompanyCarLeaseServiceProvider. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
10.7 BenefitsConfirmationStatementConfiguration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
10.8 BenefitCompanyCarRecommendedVendors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
10.9 BenefitContact. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
10.10 BenefitDeductibleDetails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
10.11 BenefitDocuments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
10.12 BenefitEmployeeClaim. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
10.13 BenefitEnrollment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
10.14 BenefitEnrollmentDependencyConfiguration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
10.15 BenefitEnrollmentDependencyDetails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .373
10.16 BenefitEnrollmentOptoutDetail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
10.17 BenefitEmployeeOptoutRequests. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .376
10.18 BenefitEventDetermination. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
10.19 BenefitEventProcessingLog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
10.20 BenefitOpenEnrollmentCycleConfiguration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .380
10.21 BenefitsException. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .382
10.22 BenefitHyperlinkConfiguration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .385
10.23 BenefitInsurancePlan. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
10.24 BenefitInsurancePlanEnrollmentDetails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
10.25 BenefitInsurancePlanUSA. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
10.26 BenefitInsuranceDependentDetail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
10.27 BenefitInsuranceCoverage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
10.28 BenefitInsuranceProvider. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
10.29 BenefitInsuranceEnrolleeOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .400
10.30 BenefitInsuranceRateChart. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
10.31 BenefitInsuranceRateChartEnrollee. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
10.32 BenefitInsuranceRateChartFixedAmount. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
10.33 BenefitInsuranceCoverageOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Content PUBLIC 5
10.34 BenefitInsuranceCoverageDetails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
10.35 BenefitInsuranceEnrolleeType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
10.36 BenefitOverviewHyperlinkConfiguration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
10.37 BenefitOverviewHyperlinkDetails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
10.38 BenefitProgramEnrollment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
10.39 BenefitProgram. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
10.40 BenefitSavingsPlanEnrollmentDetails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .426
10.41 BenefitSavingsPlanCatchUpDetail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
10.42 BenefitSavingsPlanContingentBeneficiary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
10.43 BenefitSavingsPlanERContributionConfigDetail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
10.44 BenefitSavingsPlanERContributionConfig. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
10.45 BenefitSavingsPlanPrimaryBeneficiary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .432
10.46 BenefitSavingsPlanTierConfiguration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
10.47 BenefitSchedulePeriod. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
10.48 BenefitSchedules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
10.49 BenefitEffectiveDate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
10.50 BenefitEvent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
10.51 BenefitLifeEvent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
10.52 BenefitDeductibleAllowanceEnrollment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
10.53 BenefitsIntegrationRecurringInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
10.54 ConfigurationProcessingLogDetails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
10.55 EventDeterminationRuleConfiguration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
10.56 EmployeeDismissalProtection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
10.57 EmployeeDismissalProtectionDetail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
10.58 EmployeeSeniority. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
10.59 EmployeeWithEmployerMatchContributions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
10.60 EmployeeWithEmployerMatchContributionEntries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
10.61 LegalEntityListForEventRule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
10.62 BenefitPensionMinMaxContributionLimits. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
10.63 BenefitPensionAdditionalContributionLimits. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .464
10.64 PensionBandingConfiguration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
10.65 PensionBandingConfigurationDetails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
10.66 IRSPremiumTable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
10.67 ImputedCostForAgeRanges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
10.68 Sample_API_Topic_with_Template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475

11 Payment Information Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .478

11.1 Bank. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
11.2 PaymentInformationDetailV3GHA and PaymentInformationDetailV3SUR. . . . . . . . . . . . . . . . . . . . . . 482
11.3 PaymentInformationDetailV3ZAF. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .485
11.4 PaymentInformationDetailV3MOZ. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

6 PUBLIC Content
12 Payroll. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
12.1 DataReplicationProxy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
12.2 EmployeePayrollRunResults. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .501
EmployeePayrollRunResultsItems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
12.3 PayrollDataMaintenanceTask. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .509
12.4 PayrollDataMaintenanceTaskConfiguration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
12.5 PayrollSystemConfiguration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
12.6 SAPSystemConfiguration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532

13 Person Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534

13.1 PerAddressDEFLT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .534
13.2 PerEmail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537
13.3 PersonEmpTerminationInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
13.4 PerEmergencyContacts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
13.5 PerGlobalInfo<Country/Region>. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
13.6 PerNationalId. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
13.7 PerPerson. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
generateNextPersonID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
13.8 PerPersonal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
13.9 PerPersonRelationship. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
13.10 PerPhone. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .568
13.11 PerSocialAccount. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
13.12 PersonKey. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
13.13 PersonType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
13.14 PersonTypeUsage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576

14 Position Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581

14.1 PositionRightToReturn. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
14.2 Position. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
14.3 PositionCompetencyMappingEntity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
14.4 PositionEntity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .596
14.5 Function Imports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
getPositionObjectData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599

15 Service Center. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601

15.1 ServiceCenterConfiguration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .601
15.2 LandingPageConfiguration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
15.3 CreateTicketPageConfiguration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611

16 Time & Attendance Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615

16.1 Time Off Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
AbsenceCountingMethod. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
AccrualCalculationBase. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Content PUBLIC 7
 AvailableTimeType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
EmployeeTime. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .621
EmployeeTime<Country/Region>. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
EmployeeTimeCalendar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
EmployeeTimeGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
EmployeeTimeGroupItem. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649
Holiday. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
HolidayAssignment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
HolidayCalendar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
ShiftClassification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
TemporaryTimeInformation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
TimeAccount. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
TimeAccountDetail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673
TimeAccountPayoutProfile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
TimeAccountPostingRule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
TimeAccountPurchaseProfile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
TimeAccountPurchaseProfilePayComponentAssignment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
TimeAccountSnapshot. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
TimeAccountType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
TimeAccountType<Country/Region>. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
TimeManagementAlert. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
TimeManagementAlertMessage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
TimeManagementPriorServiceConfiguration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701
TimeType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
TimeType<Country/Region>. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .710
TimeTypeProfile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .722
WorkSchedule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725
WorkScheduleDayModel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .748
WorkScheduleDayModelAssignment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752
WorkScheduleDayModelAssignmentSegment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753
WorkScheduleDayModelSegment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
WorkScheduleDay. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
16.2 Time Recording Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
ExternalTimeData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
ExternalTimeRecord. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 769
TimeCollector. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
EmployeeTimeSheet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
EmployeeTimeValuationResult. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 775

17 Workflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .778
17.1 WfRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 780
How do I access my assigned workflow requests?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 784

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

8 PUBLIC Content
17.2 WfRequestComments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787
17.3 WfRequestParticipator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 788
17.4 WfRequestStep. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 790
17.5 WfRequestUIData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792
17.6 WorkflowAllowedActionList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 795
17.7 AutoDelegateConfig. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797
17.8 AutoDelegateDetail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .804
17.9 MyPendingWorkflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809
17.10 Function Imports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 811
approveWfRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 811
commentWfRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .812
rejectWfRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
sendbackWfRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .815
withdrawWfRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
getWorkflowPendingData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 817
changeWfRequestApprover. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 823

18 Business Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825

18.1 Adding a New Employee. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825
User entity upsert. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 826
PerPerson Upsert. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .827
EmpEmployment Upsert. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 828
EmpJob Upsert. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
PerPersonal Upsert. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831
18.2 Filtering out external user data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .832
18.3 Exposing person UUID for intergration and import scenarios. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 837
18.4 Using wfStepApproverNav for more detailed workflow configuration information. . . . . . . . . . . . . . . . . 839
18.5 Differentiating primary from secondary employment during concurrent employment replication. . . . . . 844

19 FAQs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 850
19.1 Admin Access to OData: What does it mean?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 850
19.2 API: Do I use OData or Compound Employee API for Employee Central entities?. . . . . . . . . . . . . . . . . . 850
19.3 APIs are missing or not up-to-date in the OData API Data Dictionary?. . . . . . . . . . . . . . . . . . . . . . . . . 851
19.4 Broken APIs: What causes them?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 851
19.5 Duplicate Records? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 852
19.6 Error message: Behavior in upsert statements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .853
19.7 Expanded entities: Handling deleted objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
19.8 How to have more than one pay component on the same pay date. . . . . . . . . . . . . . . . . . . . . . . . . . . .857
19.9 Inactive users: Do Employee Central OData APIs ignore them?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857
19.10 Linking to custom MDF objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
19.11 Performance: How to improve it. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
19.12 Roundtrips: Why are there errors in some upserts?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Content PUBLIC 9
19.13 Side Effect: What Is It?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
19.14 Upsert Behavior in a $batch ChangeSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
strictTransactionIsolate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
19.15 $filter: How does it work with fromDate?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .862

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

10 PUBLIC Content
Change History

Learn about changes to the documentation for SAP SuccessFactors Employee Central OData API: Reference Guide
in recent releases.

1H 2022

Type of Change Description More Info

Added We refined the topic and added the infor­ Side Effect: What Is It? [page 859]
mation about the rule context item "API".

Added We added a new property FOCompany [page 276]

mdfSystemRecordId entityUID to FOCostCenter [page 272]
FOCostCenter and FOCompany.

Added We added a new property to several MDF FOBusinessUnit [page 268]

FO A PIs. FOCostCenter [page 272]
FOCompany [page 276]
FODepartment [page 281]
FODivision [page 286]
FOJobFunction [page 306]
FOJobCode [page 310]
FOPayGroup [page 321]

Added We enabled the navigation from EmpEmployment [page 105]

EmpEmpoyment the MDF OData API On­
boardingInfo.

Added We added the information about the Em­ Permission Settings [page 15]
ployee Data Import permissions re­
spected in OData APIs.

Changed We made some minor improvements to EmployeeTime<Country/Region> [page

the structure of the documentation for 623]
country/region-specific entities for Em­
ployeeTime.

Changed Updated the business keys for the non-re­ Business keys [page 47]
curring pay component entity.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Change History PUBLIC 11
2H 2021

Type of Change Description More Info

New We added a new topic to include informa­ FundGO [page 191]

tion about the new navigation property for
fund.

New We added a new topic to include informa­ FundCenterGO [page 195]

tion about the new navigation property for
fund center.

New We added a new topic to include informa­ GrantGO [page 199]

tion about the new navigation property for
grant

New We added a new topic to include informa­ BudgetPeriodGO [page 203]

tion about the new navigation property for
budget period.

New We added a new topic to include informa­ FunctionalAreaGO [page 208]

tion about the new navigation property for
functional area.

Changed We modified the topic to include new navi­ EmpCostAssignmentItem [page 188]
gation properties for fund, fund center,
grant, functional area, and budget period.

New We added a new entity that contains Ger­ TimeTypeDEU [page 715]
many-specific fields that are the basis for
calculating default values for continued
sick pay dates and the sick pay supple­
ment dates.

New We added a new entity that contains a TimeTypeNLD [page 718]

Netherlands-specific enum field which is
used for tracking recovery from illness in
Time Off.

New We added a new entity that contains a EmployeeTimeNLD [page 638]

Netherlands-specific field to record the
available working capacity of an employee
when recovering from illness in Time Off.

Added We enhanced EmpJob with a new prop­ EmpJob [page 121]

erty effectiveLatestChange.

Added We enhanced EmpEmployment with two EmpEmployment [page 105]

new navigation properties
costAssignmentNav and
costDistributionNav.

Added Added the description about the See the Properties and Navigation Prop­
operation property. erties section of each API reference topic
(applicable to APIs that have this prop­
erty).

Added Added a note about the date time fields Getting your time zones right [page 44]
<createdOn> and <lastModifiedOn>

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

12 PUBLIC Change History
1 About Employee Central OData APIs

This guide contains all information about OData v2 APIs in Employee Central, including API references, use cases,
and usage guidelines.

What is an Employee Central OData API?

Employee Central comprises of three types of objects:

● Employee objects contain personal and employment details for employees.

○ Personal objects are exposed as OData entities starting with Per*. In People Profile, you can find the same
personal information contained in person entities in the Biographical Information and Personal Information
blocks.
○ Employment objects are exposed as OData entities usually starting with Emp*. In People Profile, you can
find the same employment information in Employment Details (Emp*) and Job Information (EmpJob*)
blocks.
● Foundation objects contain organization, pay and job structure details of a company. Foundation objects are
exposed as OData entities starting with FO*.
● Metadata Framework (MDF) objects are used to extend the capability of the standard delivered foundation
objects. In MDF, generic objects (both predelivered and custom objects) can be exposed as OData entities to
extend Employee Central capabilities. In this guide, only API references of OData entities exposed by
predelivered objects are listed.

Recommended Read

Before you dive into this guide, here are a few recommended resources to help you better understand and use
Employee Central OData APIs. You can find the links to these resources in the Related Information section.

Resource Description

SAP SuccessFactors HXM Suite OData API: Developer Guide General guidelines about OData v2 APIs in SAP SuccessFac­
(v2) tors HXM Suite, including general permissions, authentication,
metadata, query and edit operations, as well as how to use the
API Center tool to help you get your way around OData APIs.

SAP SuccessFactors HXM Suite OData API: Reference Guide A list of other OData v2 APIs in SAP SuccessFactors HXM
(v2) Suite.

Employee Central Compound Employee API The SOAP-based Compound Employee API allows you to ex­
tract employee data out of Employee Central for data replica­
tion purpose.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

About Employee Central OData APIs PUBLIC 13
Resource Description

Implementing Employee Central Core Learn what data Employee Central stores and what capabilities
it offers so that you can better understand the Employee Cen­
tral APIs.

SAP SuccessFactors HXM Suite OData API: Reference Guide Learn what OData v4 APIs are available in SAP SuccessFactors
(v4) HXM Suite. OData v4 is the latest version of the OData protocol
that offers more features and capabilities.

SAP API Business Hub A resource portal where you can find the specifications of all
APIs offered by SAP and try them out in your own environ­
ment.

Related Information

SAP SuccessFactors Employee Central APIs on SAP API Business Hub

SAP SuccessFactors HXM Suite OData API: Developer Guide (V2)
SAP SuccessFactors HXM Suite OData API: Reference Guide (V2)
Implementing Employee Central Core
SAP SuccessFactors HXM Suite OData API: Reference Guide (V4)
Employee Central Compound Employee API

1.1 When is an Employee Central OData API used?

We recommend using Employee Central OData APIs if one or more of these factors applies to your situation:

● You want to use the Role Based Permission (RBP) concept.

● You want concurrent user access with an extension platform to build your own UIs on top of Employee Central.
● You want to access MDF data.
● You want to replicate data in Admin Mode for read and write operations. Admin Mode is used chiefly for
technical integrations. The different modes are explained in Admin Mode and User Mode [page 15]

 Note

Don't use our OData APIs when:

● Your system cannot consume either OData APIs or SOAP for an initial data load. In this case, you would go
for Import/Export with a CSV. Automation via FTP would also be a possibility.
● You need employee replication field level delta, snapshot, or read modified employees only, then SOAP
Compound Employee API is your tool of choice. You can find more information in the guide Implementing
the Employee Central Compound Employee API.
● You only need to read data, then the SOAP Compound Employee API would also be your tool of choice.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

14 PUBLIC About Employee Central OData APIs
1.2 Admin Mode and User Mode

There are two modes in Employee Central OData APIs which determine what a user or user group (in this context a
user and user group are treated as one and the same) is authorized to view or do.

● User Mode
Assigned permissions determine what entities can be viewed and what can be done with them. You sometimes
see the term RBP mode but in this guide, we use the term user mode.

● Admin Mode
The admin mode allows user full access to Employee Central OData API entities and operations. You only use
this in a limited number of cases, mostly for technical integrations. Admin mode overrides any RBP settings.
You sometimes see the term technical user or non-RBP mode, but in this guide we use the term admin mode.

 Note

The upsert operation requires additional permission. See the Related Links section for more information.

Related Information

Permission Settings [page 15]

1.3 Provisioning Settings

Employee Central OData APIs are part of the Employee Central solution. You don't need to make any settings in
Provisioning.

To have access to individual APIs, you also need the corresponding features enabled in Provisioning. For example if
you're using Global Assignment, the corresponding Provisioning setting must be enabled. You can find more
information in the implementation guides for your feature available on https://help.sap.com/hr_ec/.

 Remember

As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.

1.4 Permission Settings

Learn what role-based permissions are required before you can use Employee Central OData APIs.

This topic covers only the permissions required for accessing Employee Central OData APIs. For general
permission settings, refer to the documentation in the Developer Guide in Related Information section.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

About Employee Central OData APIs PUBLIC 15
The following tables are grouped by different entities and what a permission item allows user to do with those
entities. Remember to read any additional information for the permission setting that is available in your system.

Employee Central HRIS (Person and Employment Objects) and Workflow OData
APIs

Authorization/Action In Permission..., choose Additional Info

User Mode (Query Only) ● Effective-dated entities: You can grant view permissions
User Permissions Employee Central Effective Dated at entity and field levels.

Entities Upsert, that is import informa­

● Non effective-dated entities: tion in your instance, is only
available in Admin Mode.
User Permissions Employee Data
● Workflow entities:

Administrator Permissions Manage Workflows

Manage Workflow Requests

Admin Mode (Query) Administrator Permissions Employee Central API This permission allows users to
Employee Central HRIS OData API (read-only) query all HRIS objects and over­
rides entity-level and field-level
view permissions.

If you want to upsert HRIS ob­

jects, you need to have the Ad­
min Mode (Upsert) authoriza­
tion.

Admin Mode (Upsert) Administrator Permissions Employee Central API This permission allows users to
Employee Central HRIS OData API (editable) upsert all HRIS objects and
overrides entity-level and field-
level edit permissions.

If you want to query HRIS ob­

jects, you need to have the en­
tity-level or field-level view per­
missions, or have the Admin
Mode (Query) authorization.

Employee Central Foundation Objects OData APIs

Authorization/Action In Permission..., choose Additional Info

User Mode Administrator Permissions Manage Foundation Objects You can grant view and edit per­
Types missions at entity level.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

16 PUBLIC About Employee Central OData APIs
 Authorization/Action In Permission..., choose Additional Info

Admin Mode (Query) Administrator Permissions Employee Central API This permission allows users to
Employee Central Foundation OData API (read-only) query all Foundation Objects
and overrides entity-level view
permissions.

If you want to upsert Foundation

Objects, you need to have the
entity-level edit permissions or
the Admin Mode (Upsert) au­
thorization.

Admin Mode (Upsert) Administrator Permissions Employee Central API This permission allows users to
Employee Central Foundation OData API (editable) upsert all Foundation Objects
and overrides entity-level edit
permissions.

If you want to query Foundation

Objects, you need to have the
entity-level view permissions or
have the Admin Mode (Query)
authorization.

Migrated Foundation Objects (MDF FO) OData APIs

Authorization/Action In Permission..., choose Additional Info

User Mode ● Administrator Permissions MDF Foundation Objects You can grant view and edit per­
missions at entity level. To set
● Administrator Permissions Metadata Framework
field-level permissions that over­
Access to non-secured objects
ride entity-level permissions, se­
lect Field Level Overrides.

Admin Mode (Query and Administrator Permissions Metadata Framework Admin This permission allows users to
Upsert) Access to MDF OData API query and upsert all Generic Ob­
jects and overrides entity-level
and field-level permissions.

 Note
If you have the Admin Mode
authorizations for Founda­
tion Objects, you have the
corresponding authoriza­
tions for Generic Objects
without setting this permis­
sion.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

About Employee Central OData APIs PUBLIC 17
Employee Data Import Permissions

The following permissions for Employee Data Import also apply to OData APIs.

Permission Type Permission Category Permission Name Result

Administrator Permissions Employee Central Import Enable Workflows for selected Workflows attached with the
Settings entities selected Employee Central Im­
port entities are triggered
when you’re importing em­
ployee data.

Enable Business Rules for Business rules attached with

selected entities the selected Employee Central
Import entities are triggered
when you’re importing em­
ployee data.

Enable execution of rules Business rules attached with

against NO_OVERWRITE the selected Employee Central
Import entities will also up­
date fields that are marked as
'NO_OVERWRITE' in your im­
port file template.

Enable Forward Propagation Data is propagated to effective

during Incremental Import dated records when you’re im­
porting data with the selected
Employee Central Import enti­
ties.

Support cumulative update of Country/region-specific data

country-specific data for global existing in the Employee Pro­
information import in full purge files is retained when you’re
mode importing Global Information
in full purge mode.

Miscellaneous Permission Settings

Take a look at this table in case you need to arrange access to picklist management, SOAP APIs, API tools, or even
restrict access.

Authorization/Action In Permission..., choose Additional Info

Picklist Handling in OData Administrator Permissions Manage System Properties For more information, see pick­
and SOAP Picklist Management and Plicklists Mapping Set Up lists.

Access Employee Central Administrator Permissions Employee Central API You can grant access to Em­
HRIS SOAP APIs ployee Central HRIS SOAP APIs
Employee Central HRIS SOAP API
here.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

18 PUBLIC About Employee Central OData APIs
Related Information

Deprecation of HTTP Basic Authentication

Permissions

1.5 Employee Central Entity Relationships

Employee Central consists of employee entities and foundation entities:

1. Employee Entities: Describes person and employment objects.

2. Foundation Entities: Describes other general data such as organization, job code and pay component.

The following Entity Relation Diagram shows the relationship between the different entities. The Person and
Employment objects make up Employee entities. In this diagram, the K fields denote business keys. The field
names here are from the HRIS element.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

About Employee Central OData APIs PUBLIC 19
  Note

The images that follow are not complete but show a representation of some of the most important entities and
their relationships within the Employee Central OData Structure. For a complete list of available entities, you
can:

● use the OData API Dictionary Admin tool

● download the ODATA API metadata from the Admin Tools
● execute the following operation

odata/v2/$metadata

These OData entities are grouped as:

● Foundation Objects – Examples: FODepartment, FODivision, FOBusinessUnit

● Employment Objects - Examples: EmpJob, EmpEmployment, EmpCompensation
● Person Objects – Examples: PerPerson, PerPersonal, PerEmail
● Workflow Objects – Examples: WfRequest, WfRequestStep
● Platform Objects – Examples: User, Picklist
● MDF Objects – Example: Position

Overview of OData Structure

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

20 PUBLIC About Employee Central OData APIs
The next diagram shows the relationships for the PerPerson entity. Arrows in the picture denote navigations from
one entity to another. The names written next to the arrows can be used to expand the target entity within an
OData API request. For example:

odata/v2/PerPerson?$filter=personIdExternal+eq+’cgrant1’&$expand=emailNav

This request will return PerPerson entity for cgrant1 and all her emails embedded within the response for PerPerson
entity. For more examples and their responses refer to the section on entities.

 Note

The names within << >> provide the name used on the UI while the name next to the +sign denotes a business
key. For example, <<PerAddressDEFLT>> is referred to on the UI as Address Information. It also shows that the
following fields are used as business keys: personIdExternal, startDate, and addressType.

Navigations from the PerPerson Entity

The diagram above shows the major navigations going out of the PerPerson entity while the next diagram shows
the major relationships navigating to the PerPerson entity.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

About Employee Central OData APIs PUBLIC 21
 Navigations into the PerPerson Entity

Likewise, the next two diagrams show the navigations from and to the EmpEmployment entity.

Navigations from the EmpEmployment Entity

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

22 PUBLIC About Employee Central OData APIs
 Navigations into the EmpEmployment Entity

The next two diagrams show the navigations from and to the EmpJob entity.

Navigations from the EmpJob Entity

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

About Employee Central OData APIs PUBLIC 23
 Navigations into the EmpJob Entity

The next diagram shows the relationship for the User entity. In this diagram, the names next to the PicklistOption
box show fields of User entity that are navigating to the PicklistOption entity. Likewise, for User entity. Additionally,
the arrow pointing back to itself shows that the User entity navigates back to the User entity. For example, the User
entity of a manager navigates to the User entity of the direct report using the directReports navigation.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

24 PUBLIC About Employee Central OData APIs
 Navigations from the User Entity

The next diagram shows the relationship for the EmpCompensation entity.

Navigations from the EmpCompensation Entity

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

About Employee Central OData APIs PUBLIC 25
 Navigations from the WfRequest Entity

1.6 Entity Association & Navigation

Odata APIs supports navigation for associated entities. For examples of supported scenarios, refer to the section
describing the OData entity.

1.6.1 Navigation to the Picklist entity

For Employee Central fields configured as picklists in data model, navigation is available from Employee Central
entities to the Picklist entity.

1.6.2 Navigation to the User entity

Employment related entities such as EmpJob, EmpEmployment and EmpCompensation can navigate to the User
entity.

Foundation Object entities can also navigate to the User entity. For example, the manager of the Cost
Center(costcenterManager) in the FOCostCenter entity or the head of the unit(headOfUnit) in the FODivision can
navigate to the User entity. Custom field configured in the Corporate Data Model with Type=Worker can also
navigate to the User entity.

1.6.3 Navigation to MDF entity

Fields in Employee Central referring to MDF objects such as the Position field in Job Information(EmpJob entity)
can navigate to the position MDF entity. Custom fields configured as MDF type can also navigate to the related MDF
entity.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

26 PUBLIC About Employee Central OData APIs
1.6.4 Foundation Object Navigation

OData APIs support the following foundation object relationships by navigation:

● Default foundation object navigation

For example, in the Corporate Data Model, the costCenter field in the HRIS element Department
(FODepartment entity) has a predefined relationship to the cost center.
● Flexible foundation object navigation based on associations
For example, associations can be defined in the Corporate Data Model to link FODepartment to FOGeozone
which will also create navigations from FODepartment to FOGeozone.

 Note

The navigations described for the Picklist entity, User entity and MDF entity (in the previous sections) are
supported for foundation object navigation as well.

1.6.5 Navigation to Territory entity

In OData APIs, Employee Central fields related to country can navigate to the Territory Entity. For example,
navigation to the Territory entity exists for the following cases:

● countryOfBirth in PerPerson
● country field in PerNationalIdCard
● FOJobClassLocal
● PerGlobalInfoUSA

1.6.6 CSF Entity Navigation

Country-specific entities (CSF entities) are defined in the Country Specific Data Model. Examples of such entities
are:

● FOJobClassLocal<country_code> (for example, FOJobClassLocalUSA)

● PerGlobalInfo<country_code> (for example, PerGlobalInfoUSA)

The parent entity can navigate to CSF child entity. For example:

● FOJobCode can navigate to the child entity FOJobClassLocal<country_code> (for example,

FOJobClassLocalUSA)
● FOCompany can navigate to the child entity FOLegalEntityLocal<country_code> (for example,
FOLegalEntityLocalUSA)
● PerPersonal can navigate to the child entity PerGlobalInfo<country_code> (for example, PerGlobalInfoUSA)

The OData API supports navigation from the CSF entity to the territory entity to get detailed information about the
country.

Some of the CSF parent entities like FOLocation and PerPerson also provide navigation to address information. For
example, FOLocation to FOCorporateAddressDEFLT and PerPerson to PerAddressDEFLT.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

About Employee Central OData APIs PUBLIC 27
1.6.7 Person Entity Navigation

1.6.7.1 Navigation to PerPerson entity

Person related entities such as PerPhone, PerEmail can navigate to PerPerson entity; EmpEmployment entity can
navigate to PerPerson entity too.

1.6.7.2 Navigation from PerPerson entities to other entities

PerPerson entity can navigate to entities like:

● PerPersonal
● PerPhone
● PerEmail
● PerNationalId
● PerEmergencyContact
● EmpEmployment

1.6.8 Employment Entity Navigation

OData APIs support navigation from Employment related entities such as EmpJob, EmpCompensation to the
EmpEmployment entity and vice-versa.

1.6.9 Navigation from User and MDF Entities to Employee

Central Entities

OData APIs support navigation of the User Entity to the EmpEmployment entity.

MDF entities, depending on their configuration, can offer navigation to the User Entity and Employee Central
Foundation Objects.

1.7 Country/Region-Specific Logic

This section describes the different types of country/region-specific logic for Employee Central entities and
Foundation Objects (FO). The Employee Central country/region-specific configuration allows the use of different
labels in the Succession Data Model and in the Country/Region-Specific Succession Data Model for one field.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

28 PUBLIC About Employee Central OData APIs
  Note

SOAP APIs have limitations in accessing country/region-specific information. We recommend you to use OData
APIs that provide the same functionalities with better performance.

1.7.1 EmpCompensation/EmpJob/EmpEmployment

The Employee Central CSF configuration allows the use of different labels in the Succession Data Model and the
Country/region-Specific Succession Data Model for a field. However, the data type must be the same. For this
reason, all fields from the CSF and the Succession Data Model are merged in the entity and a separate CSF entity
doesn't exist.

 Note

Due to this design, different labels of the country/region-specific entities are not available in the OData
metadata yet.

1.7.2 PerGlobalInfo<Country/Region>

Countries or regions which have not been defined in the Country/region-Specific Succession Data Model for the
HRIS element globalInfo aren't visible in OData as a PerGlobalInfo<Country/Region> entity. Because it is not
possible to define the HRIS element globalInfo in the Succession Data Model, there is also no PerGlobal default
entity.

For upsert, there is no restriction on the country or region entity used. For example, the PerGlobalInfoUSA entity
can be used to upsert records for USA, India, and Germany.

1.7.3 FOCorporateAddressDEFLT /
HrisEmergencyContactAddressDEFLT

You can define the attributes of the fields for these entities differently for countries and regions in the Succession
Data Model and the Country/region-Specific Data Model. As it is not possible to have multiple entities per country
or region, the OData API for these entities offers a single field for all countries and regions.

Here are some things to consider before you use the API:

● If a field is configured in both the Succession Data Model and Country/region-Specific Succession Data Model,
the OData API exposes the field as is configured in the Succession Data Model.
● If a field is configured in the Country/region-Specific Succession Data Model for multiple countries or regions,
the OData API exposes the field as is earliest configured for a country or region on the XML.
● The OData API checks the length for all country/region-specific configurations and uses the maximum length.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

About Employee Central OData APIs PUBLIC 29
● If a field is configured as a picklist for all countries or regions in the Country/region-Specific Data Model, the
OData API exposes the field as a picklist even if different picklists are used. For example, custom_string1 can be
defined for corporateAddress of DEU as picklist=A1, and it can be also defined for corporateAddress of
country=USA as picklist=B1.
● If a field is configured with a different type (Worker / FO / MDF/picklist), the field is ignored in the OData API
query. This applies to the following scenarios:
○ the Succession/Corporate Data Model and the Country/region-Specific Corporate Data Model have
different types, OR
○ the Country/region-Specific Data Model for different countries and regions have different types defined for
the same field. For example, type is defined as a picklist for USA and type is defined as a FO for DEU.

For corporateAddress, the parententity: FOLocation has a field name, <addressId> which can uniquely identify
the related corporateAddress field. The same goes for emergency contact’s address info (addressId).

1.7.4 PerAddressDEFLT

You can define the attributes of the PerAddressDEFLT fields differently for countries and regions in the
Succession Data Model and the Country/region-Specific Data Model. As it is not possible to have multiple entities
per country or region, this OData API exposes a single entity PerAddressDEFLT, and offers a single field for all
countries and regions.

Here are some things to consider before you use the API:

● If a field is configured in the Country/region-Specific Succession Data Model for multiple countries or regions,
the OData API exposes the field as is earliest configured for a country or region on the XML.
● If a field is configured in both the Succession Data Model and Country/region-Specific Succession Data Model,
the OData API exposes the field as is configured in the Succession Data Model.
● The OData API checks the length for all country/region-specific configurations and uses the maximum length.
● If a field is configured as a picklist for all countries or regions in the Country/region-Specific Data Model, the
OData API exposes the field as a picklist even if different picklists are used. For example, custom_string1 can be
defined for corporateAddress of DEU as picklist=A1, and it can be also defined for corporateAddress of
country=USA as picklist=B1.
● If a field is configured with a different type (Worker / FO / MDF / picklist), the field is ignored in the OData API
query. This applies to the following scenarios:
○ the Succession/Corporate Data Model and the Country/region-Specific Corporate Data Model have
different types, OR
○ the Country/region-Specific Data Model for different countries and regions have different types defined for
the same field. For example, type is defined as a picklist for USA and type is defined as a FO for DEU.
● If there is no country-specific data defined for the HRIS element homeAddress, the definition specified in the
Succession Data Model will be used.

1.7.5 FOLegalEntityLocal<Country/Region>

The same field can be defined differently in the Succession Data Model and the Country/region-Specific Data
Model for attributes like visibility, required, picklist, and type. The OData API supports this by providing different

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

30 PUBLIC About Employee Central OData APIs
entities for each country and region (FOLegalEntity<Country/Region>) and an entity FOLegalEntityDEFLT for all
countries and regions that have not been defined in the Country/region-Specific Data Model.

For FOLegalEntityLocal<Country/Region>, the parent entity FOCompany has three fields: externalCode,
startDdate and country which can uniquely identify the related legal entity local record.

1.7.6 FOJobClassLocal<Country/Region>

For the HRIS element jobClassLocal, the OData API provides the FOJobClassLocal<Country/Region> entity for
each country or region defined in the Country/region-Specific Data model. For all other countries and regions not
defined in the Country/region-Specific Data model, the FOJobClassLocalDEFLT entity is used.

1.7.7 PerNationalId

This entity contains national identification card information for an employee. Only the format of the HRIS element
nationalId can be defined in the Country/region-Specific Succession Data model. Other fields for the HRIS element
nationalId must be defined in the Succession Data Model. There is no special handling required for National ID with
respect to the OData API query operation.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

cardType Type of the national ID. This is a busines key.

country Country of the employee. This is a business key.

personIdExternal Person ID of the employee. This is a business key.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

About Employee Central OData APIs PUBLIC 31
Property Description

nationalId National ID of the employee.

Use Case: Query the National ID information of an employee

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
PerNationalId(cardType='TFN',country='AUS'
,personIdExternal='106032')?$format=JSON

Response

{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PerNationalId(cardType='TFN',country='AUS',personIdExternal='106032')",
"type": "SFOData.PerNationalId"
},
"country": "AUS",
"personIdExternal": "106032",
"cardType": "TFN",
"lastModifiedDateTime": "/Date(1441856057000+0000)/",
"notes": null,
"nationalId": "123 456 789",
"createdBy": "admindlr",
"isPrimary": true,
"lastModifiedBy": "admindlr",
"createdDateTime": "/Date(1441856057000+0000)/",
"createdOn": "/Date(1441841657000)/",
"lastModifiedOn": "/Date(1441841657000)/",
"personNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PerNationalId(cardType='TFN',country='AUS',personIdExternal='106032')/personNav"
}
},
"countryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PerNationalId(cardType='TFN',country='AUS',personIdExternal='106032')/countryNav"
}
}
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

32 PUBLIC About Employee Central OData APIs
1.8 Date Handling for Employee Central Entities

To understand date handling for Employee Central Entities, you need to understand the concepts of effective
dating, multiple changes per day (MCPD) and last modified query behavior.

Take a look at the related topics, if these concepts are new to you.

Related Information

Effective Dating [page 33]

Effective Dated Query in OData [page 34]
Multiple Changes Per Day (MCPD) Entities [page 40]
Effective-Dated Entities with $expand [page 36]
Last Modified Queries and Effective Dated Entities [page 42]

1.8.1 Effective Dating

The effective dating mechanism enables entities to have an effective start date and an effective end date, and a
record becomes effective between its start date and end date. Effective dating ensures that there is no time gap
between records, and enable you to track historical data accurately.

Effective-Dated Entities

Effective-dated entities, including EmpCompensation, EmpJob, EmpJobRelationships, and PerPersonal, are

usually featuring a business key startDate. However, for a few effective-dated entities like
EmpCostDistribution, such business key is named effectiveStartDate, instead of startDate.

How Does It Work?

For an effective-dated entity, when you insert a new record, the end date of the previous record is automatically set
to the day before the effective start date of the new record. And the new record is automatically assigned an end
date of 12-31-9999.

 Note

● When you insert a record for an effective-dated entity, do not provide the end date in your request URI. End
dates are assigned by system automatically. If you provide a different end date, the system cannot accept
the record and returns errors.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

About Employee Central OData APIs PUBLIC 33
 ● Do not provide time in the start date or custom date type fields. Any time value in date type fields is
regarded as "00:00:00".

UI Behavior

When you edit an existing record in an effective-dated entity, this is same as making an incremental upsert using
the API with a new key (that is a new date or sequence number).

Corrections to effective-dated records become effective immediately.

Effective Dated Query in OData [page 34]

When querying an effective-dated entity, you can use parameters asOfDate, fromDate, and toDate as
filters to query the history or future records.

Effective-Dated Entities with $expand [page 36]

Know about the behaviors when you query effective-dated entities with $expand.

Multiple Changes Per Day (MCPD) Entities [page 40]

Some effective-dated entities support multiple changes per day (MCPD).

Last Modified Queries and Effective Dated Entities [page 42]

Learn about how to query the last modified information of effective dated entities.

1.8.1.1 Effective Dated Query in OData

When querying an effective-dated entity, you can use parameters asOfDate, fromDate, and toDate as filters to
query the history or future records.

There are two ways to query effective-dated entities. You can use either one but you cannot use both in one query.
When you use these parameters, you need to define the date in the format YYYY-MM-DD, or errors occur.

● asOfDate query: Returns one single effective record as of the specified date.
● fromDate and toDate query (also known as date range query): Returns records effective between the
specified date range.

If no asOfDate parameter or date range parameter is specified, by default asOfDate = Today (the current date
of the query) is applied to the query. For example, if you query EmpJob with https://<api-server>/odata/v2/
EmpJob on 2021-03-29, it returns the EmpJob record effective as of 2021-03-29.

The URI parameters asOfDate, fromDate, toDate are global Employee Central parameters but not standard
OData parameters. They aren’t preceded by the $ symbol as other OData parameters. When you use these
parameters with $expand, they’re applied to the root entity specified in the query request and also to the
expanded entities. See Effective-Dated Entities with $expand.

Related Information

Effective-Dated Entities with $expand [page 36]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

34 PUBLIC About Employee Central OData APIs
1.8.1.1.1 fromDate and toDate (Date Range) Query

Use the date range parameters fromDate and toDate to query records of effective-dated entities that are
effective between a defined time interval.

In a date range query, the returned records should have an effective start date no later than toDate, and an
effective end date no earlier than fromDate. A query in which fromDate equals to toDate is also regarded as a
date range query.

You can use the two parameters in pairs, or use either of them. If you only specify fromDate in the request, the
system end date is used as toDate. And if you only specify a toDate, the system start date is used as fromDate.
In this way an effective date range is defined.

Examples

Example 1: Use fromDate only

Request: https://<api-server>/odata/v2/PerPersonal?fromDate=2020-12-31

Results: Returns the PerPersonal records effective from 2020-12-31 to the system end date.

Example 2: Use toDate only

Request: https://<api-server>/odata/v2/PerPersonal?toDate=2020-12-31

Results: Returns the PerPersonal records effective from the system start date to 2020-12-31(included).

Example 3: Use in pairs

Request: https://<api-server>/odata/v2/PerPersonal?fromDate=2010-12-31&toDate=2020-12-31

Results: Returns the PerPersonal records effective from 2010-12-31 to 2020-12-31(included).

Example 4: Date range query with filters

Request: https://<api-server>/odata/v2/PerPersonal?&$filter=startDate+gt
+datetime'2012-10-30T00:00:00'&fromDate=01-01-1990&
$select=startDate,createdOn,personIdExternal

Results: Returns the PerPersonal records effective from 2012-10-30 to the system end date.

 Note

If you remove the fromDate parameter, fewer records are returned. This is because without any date range or
asOfDate parameter specified, asOfDate=Today is applied before the filter is applied.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

About Employee Central OData APIs PUBLIC 35
1.8.1.1.2 asOfDate Query

Use the asOfDate parameter to query records of effective-dated entities effective on a defined date.

In an asOfDate query, the returned records should have asOfDate between their effective start date and effective
end date.

If no asOfDate parameter or date range parameter is specified, by default asOfDate = Today (the current date
of the query) is applied to the query.

Examples

Example 1: Use asOfDate

Request: https://<api-server>/odata/v2/PerPersonal?asOfDate=2020-02-16

Results: Returns the PerPersonal records effective on 2020-02-16.

Example 2: No asOfDate or date range parameter

Request: https://<api-server>/odata/v2/PerPersonal

Results: Returns the PerPersonal records effective today.

Example 2: asOfDate query with filters

Request: https://<api-server>/odata/v2/PerPersonal?$filter=standardHours+gt
+'20'&asOfDate=2020-01-01

Results: Returns the PerPersonal records that meet the requirements and are effective on 2020-01-01.

1.8.1.2 Effective-Dated Entities with $expand

Know about the behaviors when you query effective-dated entities with $expand.

You can use one of the following ways to query effective-dated entities with $expand.

● asOfDate query: Returns one single effective record as of the specified date. If no asOfDate parameter or
date range parameter is specified, by default asOfDate = Today (the current date of the query) is applied to
the query.
● fromDate and toDate query (date range query): Returns records effective between the specified date range.

For a Picklist field, the navigated entity is PicklistValue. When expanding a Picklist field, the
effectiveStartDate/effectiveEndDate of the Picklist entity are used, because PicklistValue is not
effective-dated.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

36 PUBLIC About Employee Central OData APIs
1.8.1.2.1 Navigation from Effective-Dated Entities

Know about the behaviors when you query effective-dated entities with $expand.

Date Range Query

A few notes that apply:

● The date range parameters fromDate and toDate can only apply to the root entity.
● ○ If all the navigated entities are effective dated, each navigated entity applies an query in which asOfDate =
effective start date of its parent entity.
○ If one or more navigated entities are not effective dated, each navigated entities before the first non
effective-dated entity applies an query in which asOfDate = effective start date of its parent entity, and the
other effective-dated entities apply an query in which asOfDate = Today (current date of the query).

Example 1: Navigation from EmpJob to FODepartment (both are effective-dated entities)

An employee whose User ID is "cgrant" has three EmpJob records as follows:

Record User ID StartDate EndDate

3 cgrant 2020-03-08 9999-12-31

2 cgrant 2020-02-05 2020-03-07

1 cgrant 2020-01-08 2020-02-04

The user has four FODepartment records as follows:

Record User ID StartDate EndDate

4 cgrant 2020-03-01 9999-12-31

3 cgrant 2020-01-29 2020-02-29

2 cgrant 2020-01-20 2020-01-28

1 cgrant 2020-01-02 2020-01-19

Request

https://<API-Server>/odata/v2/EmpJob?fromDate=2020-03-15&toDate=2020-03-30&
$expand=departmentNav

Result

EmpJob record 1 + FODepartment record 1, EmpJob record 2 + FODepartment record 3, EmpJob record 3 +
FODepartment record 4.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

About Employee Central OData APIs PUBLIC 37
The following diagram explains how these parameters work:

Example 2: Navigation from EmpJob to FODepartment and from FODepartment to

FOCostCenter (all are effective-dated entities)

Request

https://<API-Server>/odata/v2/EmpJob?fromDate=2020-03-15&toDate=2020-03-30&
$expand=departmentNav,departmentNav/costCenterNav

Result

This will return the same EmpJob and FOCostCenter records as in example 1. Each FODepartment record has
one single FOCostCenter record that is effective as of the start date of the parent entity.

asOfDate Query

In a asOfDate query, the asOfDate parameter applies to all effective-dated objects in the request.

Example 3: Navigation from EmpJob to FODepartment (both are effective-dated entities)

Request

https://<API-Server>/odata/v2/EmpJob?asOfDate=2020-03-30&$expand=departmentNav

Result

EmpJob record 3 + FODepartment record 4

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

38 PUBLIC About Employee Central OData APIs
1.8.1.2.2 Navigation from Non-Effective-Dated Entities

Know about the behaviors when you query non-effective-dated entities with $expand.

Date Range Query

A few notes that apply:

● The date range parameters fromDate and toDate can only apply to the first effective-dated entity in a
navigation path.
● For the entities after the first effective-dated entity in the navigation path:
○ If all the navigated entities are effective dated, then each navigated entity applies a query in which
asOfDate = effective start date of its parent entity.
○ If not all navigated entities are effective dated, then each navigated entity before the first non-effective-
dated entity applies a query in which asOfDate = effective start date of its parent entity, and the other
effective-dated entities apply a query in which asOfDate = Today (current date of the query).

Example 1: Navigation from EmpEmployment (non-effective-dated entity) to EmpJobRelationships

(effective-dated entity)

Request

https://<API-Server>/odata/v2/EmpEmployment?fromDate=2020-03-15&toDate=2020-03-30&
$expand= empJobRelationshipNav

Result

This request returns the non-effective-dated EmpEmployment record, and the EmpJobRelationships records
effective between 2020-03-15 and 2020-03-30.

Example 2: Navigation from PerPerson (non-effective-dated entity) to EmpEmployment (non-

effective-dated entity) and then to EmpJobRelationships (effective-dated entity)

Request

https://<API-Server>/odata/v2/PerPerson?&$expand=employmentNav, employmentNav/
empJobRelationshipNav$fromDate=2020-03-03&toDate=2020-03-27

Result

This request returns the non-effective-dated PerPerson and the non-effective-dated EmpEmployment records,
with the EmpJobRelationships records effective between 2020-03-03 and 2020-03-27.

asOfDate Query

The asOfDate parameter applies to the effective-dated entities in the navigation path.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

About Employee Central OData APIs PUBLIC 39
Example 1: Navigation from EmpEmployment (non-effective-dated entity) to EmpJobRelationships
(effective-dated entity)
Request
https://<API-Server>/odata/v2/EmpEmployment?asOfDate=2020-03-15&
$expand=empJobRelationshipNav

This request returns the non-effective-dated EmpEmployment record and the EmpJobRelationships record
effective as of 2020-03-15.

1.8.1.3 Multiple Changes Per Day (MCPD) Entities

Some effective-dated entities support multiple changes per day (MCPD).

If you update an MCPD entity multiple times in one day, each update is assigned a sequence number, which
provides a history of all changes made to the entity for that day. The folllowing entities support MCPD:

● EmpJob
● EmpCompensation
● EmpPayComponentsRecurring

To see the MCPD entities in your own instance, you can check whether the entity has the business key seqNumber.

If you want to filter all history records for MCPD entities, make sure to enable the seqNumber property by setting
enabled="Yes" in BCUI. For more information about using BCUI to modify your data model, see Setting Up and
Using Business Configuration UI (BCUI).

 Note

If seqNumber is disabled for MCPD entities, when you query history records, only one record is returned
randomly of the day.

When you query MCPD entities:

● In date range query, all records on the same day will be returned. Please note that there might be gaps in
sequence numbers if records have been deleted.
● In asOfDate query, only the record with the largest sequence number of the day will be returned.

Examples

The user "cgrant" has four EmpJob records and four EmpCompensation records as follows.

EmpJob Records

Record User ID StartDate EndDate SeqNumber

1 cgrant 2017-11-14 9999-12-31 1

2 cgrant 2017-11-02 2017-11-13 2

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

40 PUBLIC About Employee Central OData APIs
 Record User ID StartDate EndDate SeqNumber

3 cgrant 2017-11-02 2017-11-02 1

4 cgrant 2005-09-01 2017-11-01 1

EmpCompensation Records

Record User ID StartDate EndDate SeqNumber

1 cgrant 2017-11-14 9999-12-31 1

2 cgrant 2017-11-02 2017-11-13 2

3 cgrant 2017-11-02 2017-11-02 1

4 cgrant 2005-09-01 2017-11-01 1

Example 1: Date range query of EmpJob

Request: https://<api-server>/odata/v2/EmpJob?userId+eq+'cgrant'&
$fromDate=2017-03-15&toDate=2020-03-30

Result: Record 1, 2, 3, and 4

Example 2: asOfDate query of EmpJob

Request: https://<api-server>/odata/v2/EmpJob?userId+eq+'cgrant'&$asOfDate=2017-11-02

Result: Record 2

Example 3: Date range query with navigation from EmpEmpEmployment (non-effective-dated

entity) to EmpJob (MCPD entity)

Request: https://<api-server>/odata/v2/EmpEmployment?
fromDate=2017-03-15&toDate=2020-03-30&$expand=jobInfoNav

Result: One EmpEmployment record with the EmpJob records 1, 2, 3, and 4

Example 4: Date range query with navigation from EmpCompensation (MCPD entity) to EmpJob
(MCPD entity)

Request: https://<api-server>/odata/v2/EmpCompensation?userId+eq+'cgrant'&
$fromDate=2017-03-15&toDate=2020-03-30&$expand=jobInfoNav

Result: The EmpCompensation record 1, 2, 3, and 4 with the the EmpJob records 1, 2, 4.

 Note

Both entities have multiple records on 2017-11-02. For EmpCompensation, the date range parameter are
applied, so all records are returned. For EmpJob, the asOfDate parameters are applied, so only the record with
the largest sequence number is returned.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

About Employee Central OData APIs PUBLIC 41
1.8.1.4 Last Modified Queries and Effective Dated Entities

Learn about how to query the last modified information of effective dated entities.

The fields lastModifiedOn and lastModifiedDateTime store the date and time of the last change or creation
in two different formats. lastModifiedOn with the DateTime format represents the date information in UTC time,
and lastModifiedDateTime with the DateTimeOffset format represents the date information with timezone
offset information. For more information about the two formats, see the Related Information.

When you to create a last modified date query for an effective dated entity, you can use one of the following:

lastModifiedDateTime with date time offset 'YYYY-MM-DDTHH:MM:SSZ'

Or

lastModifiedOn with date time 'YYYY-MM-DDTHH:MM:SS'

Related Information

Using the DateTime Format

Using the DateTimeOffset Format

1.8.1.4.1 lastModifiedDateTime and $filter

You can specify the lastModifiedDateTime field in a filter to query effective dated records based on the last
modified date and time. The behavior and usage of lastModifiedOn is the same. Filters on both parameters work
in the same way for all Employee Central effective dated entities.

How does it work?

When the lastModifiedDateTime is part of a filter, without the fromDate and toDate query options, the
system handles the query using the asOfDate eq (today's date) option by default. That is, if any of the
employee's records was updated or deleted, and the date satisfies the lastModifiedDateTime filter, the
response contains only the current effective dated record of the employee. See Example 2 in the Examples section.
For more information about using asOfDate, see asOfDate Query [page 36].

When you use the lastModifiedDateTime filter together with the fromDate or toDate query options, all the
records that are effective in the fromDate or toDate time interval are returned. That is, if any of the employee's
records was updated or deleted, and the date satisfies the lastModifiedDateTime filter, the response contains
all the records that are effective in the time interval specified by the fromDate or toDate query options. See
Example 3 in the Examples section. For more information about using fromDate and toDate, see fromDate and
toDate (Date Range) Query [page 35].

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

42 PUBLIC About Employee Central OData APIs
Put lastModifiedDateTime on the left or right?

To meet various needs for individual users, the behavior of lastModifiedDateTime is different, depending on
whether you put the lastModifiedDateTime parameter on the left or right. For example, two queries that
contain $filter=lastModifiedDateTime+ge+datetime'2018-03-01T00:00:00' and
$filter=datetime'2018-03-01T00:00:00'+le+lastModifiedDateTime return different results, even
though the criteria looks the same. With lastModifiedDateTime in different positions, the search scope is as
follows:

Position of lastModifiedDateTime Search Scope Corresponding Example

Left Both entity records and audit log Example 4

Right Only entity records Example 5

Examples

An employee whose User ID is "cgrant" has four EmpJob records:

LastModifiedDate­
Record User ID StartDate EndDate SeqNumber Time

1 cgrant 2017-11-14 9999-12-31 1 2018-02-06T05:17:

20

2 cgrant 2017-11-02 2017-11-13 2 2017-11-03T04:40:

27

3 cgrant 2017-11-02 2017-11-02 1 2017-11-03T03:32:

06

4 cgrant 2005-09-01 2017-11-01 1 2011-10-11T09:44:5

6

Example 1
Request: https://<hostname>/odata/v2/EmpJob?userId+eq+'cgrant'

Result: record 1.

The result contains only the current effective dated record, which is record 1.

Example 2
Request: https://<hostname>/odata/v2/EmpJob?$filter=lastModifiedDateTime+gt
+datetimeoffset'2011-01-01T00:00:00Z'+and+userId+eq+'cgrant'

Result: record 1.

The asOfDate eq (today's date) option is used by default. The result contains only the current effective
dated record, which is record 1.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

About Employee Central OData APIs PUBLIC 43
Example 3
Request: https://<hostname>/odata/v2/EmpJob?$filter=lastModifiedDateTime+gt
+datetimeoffset'2018-01-01T00:00:00Z'+and+userId+eq+'cgrant'&fromDate=1990-01-01

Result: record 1, record 2, record 3, record 4.

You can use fromDate and toDate to retrieve history records.

Then assume that the last record was deleted on March 2, 2018.

Example 4
After the last record was deleted on March 2, 2018, run the following query:

Request: https://<hostname>/odata/v2/EmpJob?$filter=lastModifiedDateTime+gt
+datetimeoffset'2018-03-01T00:00:00Z'+and+userId+eq+'cgrant'

Result: record 1.

Because the lastModifiedDateTime parameter is on the left side, the system first checks the entity records and
finds that there is no record satisfying the filter. Then, the system checks the audit log and finds that the last data
change happened on March 2, 2018, which satisfies the filter. So the current effective dated record of "cgrant" is
returned, which is record 1.

Example 5
Request: https://<hostname>/odata/v2/EmpJob?
$filter=datetimeoffset'2018-03-01T00:00:00Z'+le+lastModifiedDateTime+and+userId+eq
+'cgrant'

Result: no record.

Because the lastModifiedDateTime parameter is on the right side, the system checks only the entity records,
where no record satisfies the filter.

 Note

● If an effective dated record is deleted, it cannot be found in the entity records, but it still exists in the audit
log.
● If all records of the employee were deleted, no record is returned in the response, no matter whether the
lastModifiedDateTime parameter is on left or right. Because the entity is empty, no record can be
returned by using the asOfDate option.

1.8.2 Getting your time zones right

It’s crucial that you do not mix and match the different time zones otherwise you’ll end up with inconsistencies so
please take a minute to familiarize yourself with how we handle time zones. Different fields, for example,
<lastmodifedDateTime>,< lastmodifiedDate>, and so on represent different time zones and you need to be
able to tell the difference.

What time zones do we have?

We represent the following time zones in our entities:

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

44 PUBLIC About Employee Central OData APIs
 ● UTC (Universal Time Clock)
● Server Time

Recommendation

To avoid inconsistencies, we recommend that you always use the UTC time zone.

How can I tell if a field is in the UTC or server time zone?

To know which field is in which time zone, you also need to know the oData protocol type that supports the field. We
use:

● Edm.DateTime = server time zone

● Edm.DateTimeOffset = UTC

Edm.DateTime (= server time zone)

Usually, but not always, the following fields are of the type Edm.DateTime and are in the server time zone.

● <createdDate>
● <createdOn>
● <lastModifiedDate>
● <lastModifiedOn>

 Note

<createdOn> and <lastModifiedOn> will represent UTC time after the server migrates to UTC.

Examples of exceptions

Here are few examples of exceptions where the fields createdDate, createdOn, or lastModifiedDate are not of the
type Edm.DateTime but are of the type Edm.DateTimeOffset.

You must be sure to check entities on a case-by-case basis yourself. This list of exceptions is not exhaustive.

Entity Field That is Not Edm.DateTime but EdmDateTimeOffset

Attachment createdDate

Background_* lastModifiedDate

Edm.DateTimeOffset (=UTC)

Usually, but not always, the following fields are of the type Edm.DateTimeOffset and are in the UTC time zone.

● <createdDateTime>
● <lastModifiedDateTime>
● <lastModifiedDatewithTZ>
● < lastModifiedWithTZ>

Although there are currently no known exceptions to this rule, we recommend that you check the entities on a
case-by-case basis yourself.

Example: PerPhone

Take a look at the snippet of code below – here you can clearly see that the different time zones are available in the
entity as represented by the <createdOn>, <createdDateTime>,< lastModifiedOn>, and
<lastModifiedDateTime>.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

About Employee Central OData APIs PUBLIC 45
  Sample Code

<m:properties>
<d:personIdExternal>achin1</d:personIdExternal>
<d:phoneType>5845</d:phoneType>
<d:extension m:null="true" />
<d:createdOn m:type="Edm.DateTime">2011-03-17T21:39:02</d:createdOn>
<d:isPrimary m:type="Edm.Boolean">true</d:isPrimary>
<d:phoneNumber>661 2000</d:phoneNumber>
<d:createdBy>admin</d:createdBy>
<d:lastModifiedBy>admin</d:lastModifiedBy>
<d:createdDateTime m:type="Edm.DateTimeOffset">2011-03-18T01:39:02Z</
d:createdDateTime>
<d:lastModifiedOn m:type="Edm.DateTime">2011-03-17T21:39:02</
d:lastModifiedOn>
<d:lastModifiedDateTime m:type="Edm.DateTimeOffset">2011-03-18T01:39:02Z</
d:lastModifiedDateTime>
</m:properties>

1.9 Employee Central Entity Properties

Employee Central Entities allow you to create and manipulate employee data. Navigation in an entity represents
associations between entities. Each entity can have the following properties.

● Effective dating
● Business keys
● Required/nullable attribute
● Processing parameters for upsert

You can determine the mapping relationship between the properties and HRIS fields by the property names and
field identifiers. Converted from the identifiers of the corresponding HRIS fields, property names are generated by
removing the underscores or hyphens in the field identifiers and capitalizing the first letters after underscores or
hyphens. For example, the property birthName corresponds to the HRIS field birth-name.

1.9.1 Retrieving changes to records

If you need to retrieve changed records, then you will be wanting to use the lastmodifeddate in your query.

Business Case

You might need to retrieve changes to records when you are synchronizing systems using APIs, for example from a
SF instance to a client local database.

How do I do that?

You can use a last modified query. Take a look at the example below

If you need to retrieve changes to records, then you will be wanting to use last modified query. For example if you
want to sync EmpJob

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

46 PUBLIC About Employee Central OData APIs
Show me a use case

Operation GET

URI http://<Hostname>/odata/v2/EmpJob?
fromDate=01-01-1900&
$filter=lastModifiedDateTime+gt
+datetimeoffset'2016-02-01T12:40:03Z'

 Sample Code

Extract from response to the above query focussing on the last modified information. Take note that the query
is for records changed after 2016-02-01T12:40:03Z but that the request has returned last modified information
that predates this.

<m:properties>
<d:startDate m:type="Edm.DateTime">2015-08-01T00:00:00</d:startDate>
<d:userId>215</d:userId>
.....
<d:lastModifiedDateTime m:type="Edm.DateTimeOffset">2015-08-13T14:01:06Z</
d:lastModifiedDateTime>
.....
<d:lastModifiedOn m:type="Edm.DateTime">2015-08-13T10:01:06</
d:lastModifiedOn>
....
</m:properties>

Why has this happened?

1.9.2 Business keys

Business keys are a set of fields that uniquely identify a record for an entity. Each entity, at minimum, uses the
following fields to make up a business key:

Entity Type Business Keys

Person Entity person id external + effective start date

Employment Entity user id + effective start date + sequence number

Foundation Entity external code + effective start date

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

About Employee Central OData APIs PUBLIC 47
An individual entity can have additional fields that make up its business key. Fields that make up business keys are
required fields and cannot be marked as nullable for all entities. A list of business keys for Employee Central objects
is shown below:

Entity Business Keys Business key in Imports Special Keys

PerAddress person_id_external + effec- person_id_external + effec-

tive_start_date + ad­ tive_start_date + ad­
dress_type dress_type

PerEmail person_id_external + person_id_external+

email_type email_type

PerEmergencyContacts person_id_external + name + person_id_external + name +

relationship relationship

PerNationalID person_id_external + country person_id_external+ country

+ national_id_card_type + national_id_card_type

PerPerson person_id_external user_sys_id + Person_id_ex­

ternal

Note for imports:

● When user_id is given, it

should be considered as
the business key.
● When user_id is not
given, it should consider
Person_id_external as the
business key.
● &&NO_OVERWRITE&& is
supported for Per­
son_id_external only
when User_ID is given for
existing users.

PerPersonal person_id_external + effec- person_id_external + effec- First_Name + Last_Name

tive_start_date tive_start_date

PerPhone person_id_external + person_id_external +

phone_type phone_type

PerSocialAccount person_id_external + domain person_id_external + domain

(yahoo, skype etc) (yahoo, skype etc)

PayComponentsNonRecur­ user_id + pay_compo­ In the Incremental Load mode,

ring nent_code + pay_date if the sequence number field,

<allow-import>=false:
user_id + pay_date +
pay_comp_code is the busi­
ness key.
<allow-import>=true:
user_id + sequence_number
(when the sequence number
is included) is the business
key.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

48 PUBLIC About Employee Central OData APIs
 Entity Business Keys Business key in Imports Special Keys

PayComponentsRecurring user_id + effective_start_date user_ sys _id + effec-

+ transaction_sequence_num­ tive_start_date + transac­
ber + pay_component_code tion_sequence_number + pay-
component-code

PerDirectDeposit person_id_external + de­ person_id_external+ de­

posit_type + routing_number posit_type + routing_number
+ process_type + ac­ + process_type + ac­
count_number count_type

PerGlobalInfo person_id_external + effec-

tive_start_date + country

EmpCompensation user_sys_id+ effec- user_ sys _id + effec-

tive_start_date + transac­ tive_start_date + transac­
tion_sequence_number tion_sequence_number

EmpEmployment person_id_external + person_id_external +

user_sys_id user_sys_id

EmpJob user_sys_id + effec- user_sys_id + effec-

tive_start_date + transac­ tive_start_date + transac­
tion_sequence_number tion_sequence_number

EmpJobRelationships user_sys_id + Relation­ user_sys_id + relation­

ship_type, effec- ship_type, effec-
tive_start_date tive_start_date

EmpEmploymentTermination Person_id_external + user_sys_id + effec-

user_sys_id + effec- tive_start_date
tive_start_date

EmpWorkPermitInfo users_sys_id+ country+docu­ users_sys_id+ country+docu­

mentType+documentNumber mentType+documentNumber

FOPayGroup external_code + effec-

tive_start_date

FOPayCalendar paygroup_Code+ pay_pe­ paygroup_Code+ pay_pe­

riod_begin_date+pay_pe­ riod_begin_date+pay_pe­
riod_end_date+off_cycle riod_end_date+off_cycle

FOPayComponent external_code + effec-

tive_start_date

FOPayComponentGroup external_code + effec-

tive_start_date

FOFrequency external_code

FOCompany external_code + effec-

tive_start_date

FOLegalEntityLocal external_code + effec-

tive_start_date + country

FOBusinessUnit external_code + effec-

tive_start_date

FOCostCenter external_code + effec-

tive_start_date

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

About Employee Central OData APIs PUBLIC 49
Entity Business Keys Business key in Imports Special Keys

FODepartment external_code + effec-

tive_start_date

FOJobCode external_code + effec-

tive_start_date

FOLocalJobClassification FO­ external_code + effec-

JobClassLocal tive_start_date + country

FOJobFunction external_code + effec-

tive_start_date

FOPayRange external_code + effec-

tive_start_date

FOGeozone external_code + effec-

tive_start_date

FOLocationGroup external_code + effec-

tive_start_date

FOReason FOEventReason external_code + effec-

tive_start_date

FOPayGrade external_code + effec-

tive_start_date

FODivision external_code + effec-

tive_start_date

FOWorkflowStepConfig external_code + step_number

(this may change in 1207)

FOWfConfig external_code

FODynamicRole external_code

FOLocation external_code + effec-

tive_start_date

 Note

It is important that the business keys be unique. It is recommended that business keys in data models be
defined as required=true. In case, duplicate records are found, only one record will be returned and others
ignored.

1.9.3 Property Attribute Configuration

For Employee Central entities, some property attributes can be configured by data model, but other property
attributes are set by default and cannot be configured.

 Note

Please note these rules apply to most cases but not to all. You might be able to configure the same property
attributes for some fields but not for other fields.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

50 PUBLIC About Employee Central OData APIs
Entity-Level Configurable Property Attributes

● Label

Field-Level Configurable Property Attributes

● Label
● Required (This attribute is always set to "true" for business keys, which is different from the Employee Central
SFAPI behavior.)
● Visible
● Upsertable
● Max length
● Picklist

Other Property Attributes

● Nullable (By default this attribute is set to "false" for business keys, and set to "true" for the other fields.)

1.9.4 Processing Parameters for Upsert

The Employee Central Upsert API supports the purgeType parameter to update a record incrementally or by full
purge. If no parameters are provided, the system checks whether the entity being updated supports incremental
update. If it does, an incremental update is performed. Else, the system performs a full purge on the record.

For more information, see purgeType.

1.9.5 suppressUpdateOfIdenticalData

Many a times, during replication, the source system does not have information about changes to a field or entity
level. As a result, more than necessary data is transferred; in some cases, a full replication is triggered from the
third-party system into Employee Central. This results in an update of records in Employee Central even if those
records are not changed. If other integration transferring data out of Employee Central are based on the audit
information in Employee Central they will always get data even if there was no change.

OData supports a mode called suppressUpdateOfIdenticalData which can be enabled to ensure that records are
updated only if needed. This means that data will not be updated by imports/OData API calls if there is no change
i.e. if the payload and the data in the system is the same. In such a case, there is no update to last_modified dates,
no creation of audit information and no change to entity data.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

About Employee Central OData APIs PUBLIC 51
It is available in full purge and incremental mode for the following entities:

● PerPerson
● PerPersonal
● EmpEmployment
● EmpJobInformation

A typical request with the suppressUpdateOfIdenticalData parameter would look like this:

http://<hostname>/odata/v2/upsert?purgeType=full&suppressUpdateOfIdenticalData=true

1.9.6 fileLocale

What is it?

A new url parameter, fileLocale, is now available for upserts. en_US is currenty supported so in other words, like the
UI and the import engine, OData APIs now support the internationalization of floating decimal points.

What's the benefit?

You’ll be able to avoid roundtrip inconsistencies that arise when your API user locale is not en_US. Up to now, you
could only address this problem by changing the user locale which in many cases is impractical.

How does it work?

When you|re replicating data from 3rd party systems, the Employee Central system by default will always read data
as if the locale is en_US. This is not problematic if the API user locale is also en_US and the upserted data uses US
decimal notation.

If however, your API user locale is not en_US and is for example de_DE, you’d end up with roundtrip inconsistencies.
This is because when an application reads data in a productive system using an OData API query and subsequently
copies it into another system using an upsert statement, the number fields are rendered in the locale of the API
user and in the case of user locale = de_DE, you'll end up with inconsistencies because en_US and de_DE use a
different decimal notation.. fileLocale=en_US will solve this problem.

Good to know

If you API users locale is en_US, you will not need to use fileLocale=en_US.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

52 PUBLIC About Employee Central OData APIs
How can I use it?

Add fileLocale=en_US to your upsert queries when your user locale is not en_US.

Show me a use case

Your API user locale is de_DE. So, when upserting, make sure to use the following:

Query: https://<hostname>.com/odata/v2/upsert?fileLocale=en_US

Payload:

 Sample Code

{
"__metadata": { "uri":"EmpEmployment" },
"personIdExternal": "aaaa",
"userId": "aaaa", "InitialOptionGrant": "224.8",
"InitialStockGrant": "31,000"
}

1.10 Pagination

You can avoid lost or duplicated records by using cursor-based and snapshot-based pagination in some of the
Employee Central entities.

 Note

For more information about pagination options of OData API, see Pagination.

Cursor-Based Pagination

You can use this feature for the following Employee Central entities:

EmpJob

EmpEmployment

EmpCompensation

EmpPayCompRecurring

EmpPayCompNonRecurring

FOLocation

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

About Employee Central OData APIs PUBLIC 53
Order of the records
$orderby is no longer supported for these entities. Instead paging=cursor ensures that the primary key field is
used to order records. This primary key is unique and ensures that records are not lost or duplicated during the call.
The criteria for this primary key are as follows:

● It is unique and non-nullable

● It maps to a single column of the database table
● It is of the type integer, short, long, BigDecimal, or String

The following table shows what the primary key is for the entity along with the additional information of the table
name and its type.

Entity Name Table name Primary key Name/type

EmpJob EMP_JOB_INFO_T JOB_INFO_ID internalId / Long

EmpEmployment EMP_EMPLOYMENT_INFO EMPLOYMENT_ID internalId / Long

EmpCompensation EMP_COMP_INFO_T COMP_INFO_ID internalId / Long

EmpPayCompRecurring EMP_PAYCOMP_RECUR­ EMP_PAYCOMP_RECUR_ID internalId / Long

RING_T

EmpPayCompNonRecurring EMP_PAYCOMP_NON_RE­ PAY_COMP_NON_RC_ID InternalId / Long

CURRING

FOLocation FO_LOCATION_T OBJECT_ID objectId / Long

Snapshot-Based Pagination

Snapshot-based pagination is supported by all Employee Central entities. Entity types with multiple business keys
might be slower if they are not optimized for snapshot-based pagination.
As of 1H 2020 Release, the following Employee Central entities have been optimized for snapshot-based
pagination:

● PerPersonal
● EmpJob
● EmpEmployment
● FOLocation
● FOPayGrade
● MDF Foundation Objects

Use Cases

Below are examples of using snapshot-based and cursor-based pagination.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

54 PUBLIC About Employee Central OData APIs
Query EmpJob with Snapshot-based Pagination
Request:

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/EmpJob?
$format=json&customPageSize=3&
$select=userId &paging=snapshot

Response:

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpJob(seqNumber=1L,startDate=datetime'2007-07-01T00%3A00%3A00',userId='dselig1')"
},
"userId": "dselig1"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpJob(seqNumber=1L,startDate=datetime'2002-03-01T00%3A00%3A00',userId='sproctor1')"
},
"userId": "sproctor1"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpJob(seqNumber=1L,startDate=datetime'2002-10-01T00%3A00%3A00',userId='tbotts1')"
},
"userId": "tbotts1"
}
],
"__next": "https://<API-Server>/odata/v2/EmpJob?customPageSize=3&
$skiptoken=eyJzdGFydFJvdyI6MywiZW5kUm93Ijo2LCJwYWdpbmciOiJzbmFwc2hvdCIsInBhZ2VTaXplI
jozLCJzbmFwc2hvdE5hbWUiOiJzbmFwc2hvdF8wYWVlMTAzZl8xNTRiXzQwNTVfOTM5MF84N2VlNTk2ZDkxZ
mZfcHM0YnNmYXBpNTN0XzM4NCJ9&paging=snapshot&$format=json&$select=userId"
}
}

Query FOLocation with Cursor-based Pagination

Request:

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/FOLocation?
$format=json&customPageSize=3&
$select=externalCode &paging=cursor

Response:

{
"d": {
"results": [

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

About Employee Central OData APIs PUBLIC 55
 {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FOLocation(externalCode='US_ATL',startDate=datetime'1990-01-01T00:00:00')"
},
"externalCode": "US_ATL"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FOLocation(externalCode='US_CHI',startDate=datetime'1990-01-01T00:00:00')"
},
"externalCode": "US_CHI"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FOLocation(externalCode='US_DAL',startDate=datetime'1990-01-01T00:00:00')"
},
"externalCode": "US_DAL"
}
],
"__next": "https://<API-Server>/odata/v2/FOLocation?$format=json&
$select=externalCode&customPageSize=3&
$skiptoken=eyJwYWdpbmciOiJjdXJzb3IiLCJwYWdlU2l6ZSI6MywiY3Vyc29yUHJvcGVydHlOYW1lIjpud
WxsLCJjdXJzb3JWYWx1ZSI6NX0%3D&paging=cursor"
}
}

1.11 Use &&NO_OVERWRITE&& When Upserting Entities

When you import employee data, you can perform a partial import, which is updating specific fields without
overwriting the values of the other fields. In this case, you enter &&NO_OVERWRITE&& in the fields whose value
you don't intend to modify.

Example: Upsert PerPersonal Without Overwriting the Values of the

preferredName Field

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

56 PUBLIC About Employee Central OData APIs
 Payload
{
"__metadata": {
"uri": "https://
<API-Server>/odata/v2/
PerPersonal(personIdExternal='109031',st
artDate=datetime'2019-10-22T00:00:00')",
"type":
"SFOData.PerPersonal"
},
"personIdExternal":
"109031",
"startDate": "/
Date(1571702400000)/",
"preferredName":
"&&NO_OVERWRITE&&"
}

Response

{
"d": [
{
"key": "PerPersonal/personIdExternal=109031,PerPersonal/
startDate=2019-10-22T00:00:00.000-04:00",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

 Note

You can use &&NO_OVERWRITE&& only in string-type fields.

You can check whether an entity supports the use of &&NO_OVERWRITE&& in the HRIS Element Information
section of the entity-level topic. Or you can find object information that cannot be uploaded using partial import on
Which object information cannot be uploaded using the Partial Import (&&NO_OVERWRITE&&)?.

1.12 External Users' Access to Employee Central OData APIs

Now, external users are able to access some commonly used Employee Central entities.

External users, relative to internal users, aren’t yet employees but still require access to SAP SuccessFactors HXM
Suite. External users are represented by status e (active_external_suite) and d (inactive_external_suite).

External users with required field-level permissions from User Permission Employee Data can access the
following Employee Central entities:

● PerPersonal
● PerPersonRelationship

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

About Employee Central OData APIs PUBLIC 57
● PerGlobalInfoXXX
● EmpEmployment
● EmpJob
● EmpJobRelationship
● EmpCompensation
● EmpGlobalAssignment

 Note

Only external user data are returned. External users cannot access internal user data via Employee Central
OData APIs.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

58 PUBLIC About Employee Central OData APIs
2 Advances

2.1 AdvancesAccumulation

This entity records the accumulation of the requested advance and remaining eligibility for the user. It is not an
effective dated entity in the Advances module. This entity is created when an advance is approved by the
superviser.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Use Case: Get details of the accumulation of the requested advance and
remaining eligibility for the user

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
AdvancesAccumulation

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
AdvancesAccumulation('125_Acting Allowance (Acting Allowance)_01202018_1')",
"type": "SFOData.AdvancesAccumulation"
},
"externalCode": "125_Acting Allowance (Acting
Allowance)_01202018_1",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Advances PUBLIC 59
 "lastModifiedDateTime": "/Date(1516448120000+0000)/",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"createdDateTime": "/Date(1516448120000+0000)/",
"mdfSystemVersionId": null,
"periodEndDate": "/Date(253402214400000)/",
"numberOfOccurances": "1",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"remainingNumberOfOccurances": null,
"accumulatedAmount": "1000",
"advanceType": "Acting Allowance",
"mdfSystemStatus": "A",
"mdfSystemEntityId": "294C819A05224541B233BF617BE16D10",
"remainingEligibleAmount": "11345",
"currency": null,
"mdfSystemObjectType": "AdvancesAccumulation",
"periodStartDate": "/Date(1469145600000)/",
"lastModifiedDate": "/Date(1516448120000)/",
"lastModifiedBy": "sriadmin",
"currencyGO": "USD",
"lastModifiedDateWithTZ": "/Date(1516448120000+0000)/",
"mdfSystemRecordStatus": "N",
"userSysId": "125",
"mdfSystemTransactionSequence": "1",
"createdDate": "/Date(1516448120000)/",
"createdBy": "sriadmin",
"mdfSystemRecordId": "B617909D5590461485EB78B16E1A1B40",
"userSysIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesAccumulation('125_Acting Allowance (Acting Allowance)_01202018_1')/
userSysIdNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesAccumulation('125_Acting Allowance (Acting Allowance)_01202018_1')/
mdfSystemStatusNav"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesAccumulation('125_Acting Allowance (Acting Allowance)_01202018_1')/
createdByNav"
}
},
"currencyGONav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesAccumulation('125_Acting Allowance (Acting Allowance)_01202018_1')/
currencyGONav"
}
},
"advanceTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesAccumulation('125_Acting Allowance (Acting Allowance)_01202018_1')/
advanceTypeNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesAccumulation('125_Acting Allowance (Acting Allowance)_01202018_1')/
lastModifiedByNav"
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

60 PUBLIC Advances
 "mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesAccumulation('125_Acting Allowance (Acting Allowance)_01202018_1')/
mdfSystemRecordStatusNav"
}
},
"currencyNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesAccumulation('125_Acting Allowance (Acting Allowance)_01202018_1')/
currencyNav"
}
},
"nonRecurringPayments": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesAccumulation('125_Acting Allowance (Acting Allowance)_01202018_1')/
nonRecurringPayments"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesAccumulation('125_Acting Allowance (Acting Allowance)_01202018_1')/
wfRequestNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Advances

2.2 AdvancesEligibility

This entity is used to configure different advances that a company offers to its employees. It is also used to
configure the recovery of the advance.

Permissions

● Administrator Permissions Manage Advances Advances Eligibility .

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Advances PUBLIC 61
Supported Operations

Query

Use Case: Get details of different advances that a company offers to its
employees

Request

Operation Query

HTTP GET

URI https://<api-server>/odata/v2/
AdvancesEligibility

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')",
"type": "SFOData.AdvancesEligibility"
},
"externalCode": "MedicalAdvances",
"effectiveStartDate": "/Date(1451606400000)/",
"lastModifiedDateTime": "/Date(1636556304000+0000)/",
"recoveryMode": null,
"createdDateTime": "/Date(1456224371000+0000)/",
"mdfSystemVersionId": null,
"unitOfPeriod": "YEARS",
"validityPeriod": "1",
"payComponentType": "AMOUNT",
"defaultWorkflow": null,
"advanceType": "MedicalAdvances",
"basePayComponent": null,
"externalName": "MedicalAdvances: MedicalAdvances",
"mdfSystemEntityId": "DBBC3A70A23142B6A423CA0E351F5180",
"occuranceOfDay": null,
"eligibilityAmount": "5000",
"deductionDateFormat": "AS_PER_DATE",
"currencyGO": "USD",
"mdfSystemRecordStatus": "N",
"eligibilityRule": "AdvanceEligibility",
"effectiveStatus": "A",
"monthDate": "ONE",
"firstOccurenceStartDate": "/Date(1451606400000)/",
"mdfSystemCreatedDate": "/Date(1456224371000)/",
"exceptionWorkflow": null,
"deductionPayCompOTD": "2703",
"effectiveEndDate": "/Date(253402214400000)/",
"deductionPayCompRD": "5515",
"mdfSystemLastModifiedDateWithTZ": "/Date(1636556304000+0000)/",
"mdfSystemCreatedBy": "admin",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

62 PUBLIC Advances
 "installmentAmount": null,
"interestType": "NOTAPPLICABLE",
"dayOfDeduction": null,
"exceptionForNumberOfInstallments": false,
"mdfSystemLastModifiedBy": "sriadmin",
"periodEndDate": null,
"basePayComponentGroup": null,
"installmentFrequency": "ANN",
"numberOfOccurences": "2",
"enableAutoRecovery": "YES",
"company": "ACE_Brazil",
"currency": null,
"department": null,
"interestRate": null,
"maximumEligibilityAmount": null,
"mdfSystemObjectType": "AdvancesEligibility",
"periodStartDate": null,
"mdfSystemLastModifiedDate": "/Date(1636556304000)/",
"lastModifiedBy": "sriadmin",
"isUnlimitedAmount": false,
"recoveryModeEditableByEmployee": null,
"mdfSystemTransactionSequence": "1",
"numberOfInstallmentsEditableByEmployee": "NO",
"exceptionForRequestedAmount": false,
"createdBy": "admin",
"numberOfInstallments": "1",
"calculationPercentageOn": null,
"mdfSystemRecordId": "0F870070907C4657922C44684F5A1216",
"defaultWorkflowNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/defaultWorkflowNav"
}
},
"recoveryModeEditableByEmployeeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/recoveryModeEditableByEmployeeNav"
}
},
"calculationPercentageOnNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/calculationPercentageOnNav"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/createdByNav"
}
},
"dayOfDeductionNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/dayOfDeductionNav"
}
},
"currencyGONav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/currencyGONav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Advances PUBLIC 63
 }
},
"occuranceOfDayNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/occuranceOfDayNav"
}
},
"exceptionWorkflowNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/exceptionWorkflowNav"
}
},
"companyNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/companyNav"
}
},
"currencyNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/currencyNav"
}
},
"recoveryModeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/recoveryModeNav"
}
},
"effectiveStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/effectiveStatusNav"
}
},
"unitOfPeriodNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/unitOfPeriodNav"
}
},
"departmentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/departmentNav"
}
},
"interestTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/interestTypeNav"
}
},
"deductionDateFormatNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

64 PUBLIC Advances
 "uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/deductionDateFormatNav"
}
},
"payComponentTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/payComponentTypeNav"
}
},
"enableAutoRecoveryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/enableAutoRecoveryNav"
}
},
"advanceTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/advanceTypeNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/mdfSystemRecordStatusNav"
}
},
"monthDateNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/monthDateNav"
}
},
"basePayComponentGroupNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/basePayComponentGroupNav"
}
},
"installmentFrequencyNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/installmentFrequencyNav"
}
},
"numberOfInstallmentsEditableByEmployeeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/numberOfInstallmentsEditableByEmployeeNav"
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Advances PUBLIC 65
 "basePayComponentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/basePayComponentNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
AdvancesEligibility(effectiveStartDate=datetime'2016-01-01T00:00:00',externalCode='M
edicalAdvances')/wfRequestNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Advances

2.3 NonRecurringPayment

This entity is used to register an advance that is requested by an employee.

Supported Operations

Query

Use Case: Get details on registering an advance that is requested by an

employee

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
NonRecurringPayment

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

66 PUBLIC Advances
Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
NonRecurringPayment('125_Acting Allowance (Acting Allowance)_01202018_1')",
"type": "SFOData.NonRecurringPayment"
},
"externalCode": "125_Acting Allowance (Acting
Allowance)_01202018_1",
"lastModifiedDateTime": "/Date(1516448120000+0000)/",
"notes": null,
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"createdDateTime": "/Date(1516448120000+0000)/",
"mdfSystemVersionId": null,
"templateId": null,
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"payComponentType": null,
"payComponentCode": "Acting Allowance",
"mdfSystemStatus": "A",
"mdfSystemEntityId": "C6C74A94F8B841988383E8DE7752607B",
"payComponentGroupId": null,
"sentToPayroll": null,
"formId": null,
"mdfSystemObjectType": "NonRecurringPayment",
"lastModifiedDate": "/Date(1516448120000)/",
"lastModifiedBy": "sriadmin",
"currencyGO": "USD",
"nonRecurringPayPeriodStartDate": null,
"lastModifiedDateWithTZ": "/Date(1516448120000+0000)/",
"payCompValue": "1000",
"userSysId": "125",
"mdfSystemTransactionSequence": "1",
"taxTreatment": null,
"createdDate": "/Date(1516448120000)/",
"recordStatus": "N",
"createdBy": "sriadmin",
"nonRecurringPayPeriodEndDate": null,
"mdfSystemRecordId": "563CD98B7BEF4803873E6D45DFA7D356",
"currencyCode": null,
"payDate": "/Date(1516406400000)/",
"userSysIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
NonRecurringPayment('125_Acting Allowance (Acting Allowance)_01202018_1')/
userSysIdNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
NonRecurringPayment('125_Acting Allowance (Acting Allowance)_01202018_1')/
mdfSystemStatusNav"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
NonRecurringPayment('125_Acting Allowance (Acting Allowance)_01202018_1')/
createdByNav"
}
},
"advance": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Advances PUBLIC 67
 "uri": "https://<api-server>/odata/v2/
NonRecurringPayment('125_Acting Allowance (Acting Allowance)_01202018_1')/advance"
}
},
"currencyGONav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
NonRecurringPayment('125_Acting Allowance (Acting Allowance)_01202018_1')/
currencyGONav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
NonRecurringPayment('125_Acting Allowance (Acting Allowance)_01202018_1')/
lastModifiedByNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
NonRecurringPayment('125_Acting Allowance (Acting Allowance)_01202018_1')/
wfRequestNav"
}
},
"recordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
NonRecurringPayment('125_Acting Allowance (Acting Allowance)_01202018_1')/
recordStatusNav"
}
},
"payComponentCodeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
NonRecurringPayment('125_Acting Allowance (Acting Allowance)_01202018_1')/
payComponentCodeNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Employee Global Information

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

68 PUBLIC Advances
3 Apprentice Management

3.1 Apprentice

This entity provides a single and simple way of accessing the content from the Apprentice.

Supported Operations

Query, Insert, Merge, Replace, Upsert, Delete

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Permissions

Access to the Apprentice object is regulated by role-based permissions.

Use Case

API Call: http://<api-server>/odata/v2/Apprentice?$format=json&$filter=user eq 'charper1'

Description: Get apprentice from the user defined in the call

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/Apprentice('charper1')",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Apprentice Management PUBLIC 69
 "type": "SFOData.Apprentice"
},
"user": "charper1",
"startDate": "/Date(1442181600000+0000)/",
"assignedAddSupervisor": "pjuvan1",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "Apprentice",
"mdfSystemVersionId": null,
"endDate": "/Date(1443823200000+0000)/",
"lastModifiedDateTime": "/Date(1441103482000+0000)/",
"assignedGroup": "6596",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "0A4A26BA750D403EB74162322E21BC15",
"mdfSystemEntityId": "E740930CC9A54ACEA541AB16197E03D6",
"name": "Harper, Catherine",
"mdfSystemStatus": "A",
"year": "2014",
"lastModifiedDateWithTZ": "/Date(1441103482000+0000)/",
"createdDate": "/Date(1441103482000)/",
"note": "sdfghjkl",
"mdfSystemRecordStatus": "N",
"assignedSchool": "6597",
"activeStatus": "ACTIVE",
"createdBy": "root",
"createdDateTime": "/Date(1441103482000+0000)/",
"lastModifiedBy": "root",
"lastModifiedDate": "/Date(1441103482000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"assignedAddSupervisorNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/Apprentice('charper1')/
assignedAddSupervisorNav"
}
},
"assignedGroupNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/Apprentice('charper1')/
assignedGroupNav"
}
},
"assignedSchoolNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/Apprentice('charper1')/
assignedSchoolNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/Apprentice('charper1')/
mdfSystemRecordStatusNav"
}
},
"userNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/Apprentice('charper1')/userNav"
}
},
"activeStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/Apprentice('charper1')/
activeStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/Apprentice('charper1')/
mdfSystemStatusNav"
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

70 PUBLIC Apprentice Management
 }
}
]
}
}

Related Information

SAP API Business Hub: Employee Global Information

3.2 ApprenticeEventType

This entity provides a single and simple way of accessing the content from the Apprentice Event Type.

Supported Operations

Query, Insert, Merge, Replace, Upsert, Delete

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Permissions

Access to the Apprentice Event Type object is regulated by role-based permissions.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Apprentice Management PUBLIC 71
Use Case: Get ApprenticeEventType from external code

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/ApprenticeEventType?
$format=json&$filter=externalCode eq '6602'

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/ApprenticeEventType(6602L)",
"type": "SFOData.ApprenticeEventType"
},
"externalCode": "6602",
"mdfSystemObjectType": "ApprenticeEventType",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"eventTypeDescription_pl_PL": null,
"eventTypeDescription_fi_FI": null,
"lastModifiedDateTime": "/Date(1447833758000+0000)/",
"eventTypeDescription_en_GB": "Internal Training",
"mdfSystemTransactionSequence": "1",
"eventTypeDescription_it_IT": null,
"eventTypeDescription_en_RTL": null,
"eventTypeDescription_nl_NL": null,
"mdfSystemRecordId": "126C466C5390482EAD0468CFC456412E",
"mdfSystemEntityId": "B4FA1A0DEE2D4198A3A1A683E211F981",
"eventTypeDescription_de_DE": null,
"mdfSystemStatus": "A",
"apprenticeEventTypeCategory": "TRAINING",
"lastModifiedDateWithTZ": "/Date(1447833758000+0000)/",
"eventTypeDescription_es_ES": null,
"createdDate": "/Date(1439452260000)/",
"eventTypeDescription_ja_JP": null,
"mdfSystemRecordStatus": "N",
"eventTypeDescription_fr_FR": null,
"eventTypeDescription_es_MX": null,
"eventTypeDescription_en_US": null,
"eventTypeDescription_da_DK": null,
"eventTypeDescription_en_SAP_SLS": null,
"createdBy": "admin",
"createdDateTime": "/Date(1439452260000+0000)/",
"eventTypeDescription_ko_KR": null,
"eventTypeDescription_zh_CN": null,
"lastModifiedBy": "admin",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDate": "/Date(1447833758000)/",
"eventTypeDescription_defaultValue": "English Training",
"eventTypeDescription_zh_TW": null,
"apprenticeEventTypeCategoryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/ApprenticeEventType(6602L)/
apprenticeEventTypeCategoryNav"
}
},
"mdfSystemRecordStatusNav": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

72 PUBLIC Apprentice Management
 "__deferred": {
"uri": "https://<api-server>/odata/v2/ApprenticeEventType(6602L)/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/ApprenticeEventType(6602L)/
mdfSystemStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Employee Global Information

3.3 ApprenticeInternalTrainingEvent

This entity provides a single and simple way of accessing the content from the Apprentice Internal Training Event.

Supported Operations

Query, Insert, Merge, Replace, Upsert, Delete

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Permissions

Access to the Apprentice Internal Training Event object is regulated by role-based permissions.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Apprentice Management PUBLIC 73
Use Case: Get ApprenticeInternalTainingEvent from the external code

API Call: http://<api-server>/odata/v2/ApprenticeInternalTrainingEvent?$format=json&$filter=externalCode eq

'6723'

Code Example:
{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
ApprenticeInternalTrainingEvent(6723L)",
"type": "SFOData.ApprenticeInternalTrainingEvent"
},
"externalCode": "6723",
"startDateAndTime": "/Date(1445637600000+0000)/",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "ApprenticeInternalTrainingEvent",
"mdfSystemVersionId": null,
"shareStatus": "SHARED",
"location": null,
"eventType": "6602",
"lastModifiedDateTime": "/Date(1445942436000+0000)/",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "CE036E7EA8704F18B3F9708695E4FD70",
"mdfSystemEntityId": "E0E4F78A984441F0B581E8B1FBA2CFEE",
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/Date(1445942436000+0000)/",
"learningItem": null,
"createdDate": "/Date(1445602964000)/",
"note": null,
"mdfSystemRecordStatus": "N",
"isAllDayEvent": true,
"endDateAndTime": "/Date(1446242400000+0000)/",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1445602964000+0000)/",
"lastModifiedDate": "/Date(1445942436000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"eventName": "zum test",
"assignedApprenticeGroups": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
ApprenticeInternalTrainingEvent(6723L)/assignedApprenticeGroups"
}
},
"shareStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
ApprenticeInternalTrainingEvent(6723L)/shareStatusNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
ApprenticeInternalTrainingEvent(6723L)/mdfSystemRecordStatusNav"
}
},
"assignedApprentices": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
ApprenticeInternalTrainingEvent(6723L)/assignedApprentices"
}
},
"mdfSystemStatusNav": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

74 PUBLIC Apprentice Management
 "__deferred": {
"uri": "https://<api-server>/odata/v2/
ApprenticeInternalTrainingEvent(6723L)/mdfSystemStatusNav"
}
},
"eventTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
ApprenticeInternalTrainingEvent(6723L)/eventTypeNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Employee Global Information

3.4 ApprenticePracticalTrainingEvent

This entity provides a single and simple way of accessing the content from the Apprentice Practical Training Event.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Permissions

Access to the Apprentice Practical Training Event object is regulated by role-based permissions.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Apprentice Management PUBLIC 75
Use Case: Get ApprenticePracticalTrainingEvent from external Code

API call: http://<api-server>/odata/v2/ApprenticePracticalTrainingEvent?$format=json&$filter=externalCode eq

'6967'

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
ApprenticePracticalTrainingEvent(6967L)",
"type": "SFOData.ApprenticePracticalTrainingEvent"
},
"externalCode": "6967",
"startDateAndTime": "/Date(1453158000000+0000)/",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "ApprenticePracticalTrainingEvent",
"mdfSystemVersionId": null,
"shareStatus": "SHARED",
"department": "de2",
"eventType": "6747",
"lastModifiedDateTime": "/Date(1453466572000+0000)/",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "B2EE3F0E932E40C1872F2F86F520B36F",
"mdfSystemEntityId": "F6053DBE61594048900C5CF29D692ADE",
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/Date(1453466572000+0000)/",
"createdDate": "/Date(1453380236000)/",
"note": null,
"mdfSystemRecordStatus": "N",
"isAllDayEvent": true,
"endDateAndTime": "/Date(1453503599000+0000)/",
"createdBy": "admin",
"createdDateTime": "/Date(1453380236000+0000)/",
"lastModifiedBy": "admin",
"lastModifiedDate": "/Date(1453466572000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"eventName": "de2",
"departmentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
ApprenticePracticalTrainingEvent(6967L)/departmentNav"
}
},
"assignedApprenticeGroups": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
ApprenticePracticalTrainingEvent(6967L)/assignedApprenticeGroups"
}
},
"shareStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
ApprenticePracticalTrainingEvent(6967L)/shareStatusNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
ApprenticePracticalTrainingEvent(6967L)/mdfSystemRecordStatusNav"
}
},
"assignedApprentices": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

76 PUBLIC Apprentice Management
 "uri": "https://<api-server>/odata/v2/
ApprenticePracticalTrainingEvent(6967L)/assignedApprentices"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
ApprenticePracticalTrainingEvent(6967L)/mdfSystemStatusNav"
}
},
"eventTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
ApprenticePracticalTrainingEvent(6967L)/eventTypeNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Employee Global Information

3.5 ApprenticeSchool

This entity provides a single and simple way of accessing the content from the Apprentice School.

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Permissions

Access to the Apprentice School object is regulated by role-based permissions.

Related Information

SAP API Business Hub: Employee Global Information

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Apprentice Management PUBLIC 77
3.6 ApprenticeSchoolEvent

This entity provides a single and simple way of accessing the content from the Apprentice School Event.

Supported Operations

Query, Insert, Merge, Replace, Upsert, Delete

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Permissions

Access to the Apprentice School object is regulated by role-based permissions.

Use Case

API Call: http://<hostname>/odata/v2/ApprenticeSchoolEvent?$format=json&$filter=externalCode eq '6822'

Description: Get ApprenticeSchoolEvent from externalCode

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://mo-e40605f30.mo.sap.corp:443/odata/v2/
ApprenticeSchoolEvent(6822L)",
"type": "SFOData.ApprenticeSchoolEvent"
},
"externalCode": "6822",
"startDateAndTime": "/Date(1448838000000+0000)/",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "ApprenticeSchoolEvent",
"mdfSystemVersionId": null,
"shareStatus": "NOT_SHARED",
"eventType": "6604",
"lastModifiedDateTime": "/Date(1448889138000+0000)/",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "90D6E02E7CE0445299AD625C5E9A1CA7",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

78 PUBLIC Apprentice Management
 "mdfSystemEntityId": "04213BA663004D05AECED2E6E80CDD69",
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/Date(1448889138000+0000)/",
"createdDate": "/Date(1448888089000)/",
"note": null,
"mdfSystemRecordStatus": "N",
"isAllDayEvent": true,
"school": null,
"endDateAndTime": "/Date(1449269999000+0000)/",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1448888089000+0000)/",
"lastModifiedDate": "/Date(1448889138000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"eventName": "School",
"schoolNav": {
"__deferred": {
"uri": "https://mo-e40605f30.mo.sap.corp:443/odata/v2/
ApprenticeSchoolEvent(6822L)/schoolNav"
}
},
"assignedApprenticeGroups": {
"__deferred": {
"uri": "https://mo-e40605f30.mo.sap.corp:443/odata/v2/
ApprenticeSchoolEvent(6822L)/assignedApprenticeGroups"
}
},
"shareStatusNav": {
"__deferred": {
"uri": "https://mo-e40605f30.mo.sap.corp:443/odata/v2/
ApprenticeSchoolEvent(6822L)/shareStatusNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://mo-e40605f30.mo.sap.corp:443/odata/v2/
ApprenticeSchoolEvent(6822L)/mdfSystemRecordStatusNav"
}
},
"assignedApprentices": {
"__deferred": {
"uri": "https://mo-e40605f30.mo.sap.corp:443/odata/v2/
ApprenticeSchoolEvent(6822L)/assignedApprentices"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://mo-e40605f30.mo.sap.corp:443/odata/v2/
ApprenticeSchoolEvent(6822L)/mdfSystemStatusNav"
}
},
"eventTypeNav": {
"__deferred": {
"uri": "https://mo-e40605f30.mo.sap.corp:443/odata/v2/
ApprenticeSchoolEvent(6822L)/eventTypeNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Apprentice Management PUBLIC 79
Related Information

SAP API Business Hub: Employee Global Information

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

80 PUBLIC Apprentice Management
4 Contingent Workforce

4.1 VendorInfo

You can use this entity to peform different operations on the vendor information of your contingent workforce.

Supported Operations

Query, Merge, Replace, Upsert, Delete

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Case 1: Get Vendor Information

A query operation on the VendorInfo entity returns all the information related to a given vendor.

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/VendorInfo?
$format=json&$top=1

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
VendorInfo(effectiveStartDate=datetime'2019-08-19T00:00:00',vendorCode='reee')",
"type": "SFOData.VendorInfo"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Contingent Workforce PUBLIC 81
 },
"effectiveStartDate": "/Date(1566172800000)/",
"vendorCode": "reee",
"mdfSystemLastModifiedDateWithTZ": "/Date(1566192139000+0000)/",
"lastModifiedDateTime": "/Date(1566192139000+0000)/",
"description_fr_FR": null,
"mdfSystemCreatedBy": "adminb1",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"createdDateTime": "/Date(1566192139000+0000)/",
"mdfSystemVersionId": null,
"description_de_DE": null,
"mdfSystemLastModifiedBy": "adminb1",
"description_pt_BR": null,
"description_es_ES": null,
"mdfSystemEntityId": "15E3B7DA6C814DD3946C40962A5D9304",
"description_nl_NL": null,
"mdfSystemObjectType": "VendorInfo",
"description_en_GB": null,
"mdfSystemLastModifiedDate": "/Date(1566192139000)/",
"lastModifiedBy": "adminb1",
"mdfSystemRecordStatus": "N",
"description_defaultValue": null,
"vendorName": null,
"effectiveStatus": "A",
"mdfSystemTransactionSequence": "1",
"createdBy": "adminb1",
"description_fr_CA": null,
"mdfSystemCreatedDate": "/Date(1566192139000)/",
"description_en_US": null,
"mdfSystemRecordId": "61077C27F7B24C9C9963F39CAFCBF663",
"description_localized": null,
"description_en_DEBUG": null,
"description_ru_RU": null,
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
VendorInfo(effectiveStartDate=datetime'2019-08-19T00:00:00',vendorCode='reee')/
createdByNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
VendorInfo(effectiveStartDate=datetime'2019-08-19T00:00:00',vendorCode='reee')/
lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
VendorInfo(effectiveStartDate=datetime'2019-08-19T00:00:00',vendorCode='reee')/
mdfSystemRecordStatusNav"
}
},
"effectiveStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
VendorInfo(effectiveStartDate=datetime'2019-08-19T00:00:00',vendorCode='reee')/
effectiveStatusNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
VendorInfo(effectiveStartDate=datetime'2019-08-19T00:00:00',vendorCode='reee')/
wfRequestNav"
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

82 PUBLIC Contingent Workforce
 "descriptionTranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
VendorInfo(effectiveStartDate=datetime'2019-08-19T00:00:00',vendorCode='reee')/
descriptionTranslationTextNav"
}
}
}
]
}
}

Use Case 2: Creating or Updating Vendor Information

The following example shows how you can create a vendor information record or update an existing one using the
VendorInfo entity.

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/odata/v2/
upsert

Payload {"__metadata": {
"uri": "https://
<API Server>/odata/v2/
VendorInfo(effectiveStartDate=datetime'2
019-08-19T00:00:00',vendorCode='reee')",
"type":
"SFOData.VendorInfo"
},
"effectiveStartDate": "/
Date(1566172800000)/",
"vendorCode": "reee",
"vendorName": null,
"effectiveStatus": "A"
}

Response

{
"feed": {
"entry": {
"content": {
"properties": {
"key": {
"_m:null": "true",
"__prefix": "d"
},
"status": {
"__prefix": "d",
"__text": "OK"
},
"editStatus": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Contingent Workforce PUBLIC 83
 "__prefix": "d",
"__text": "UPSERTED"
},
"message": {
"_m:null": "true",
"__prefix": "d"
},
"index": {
"_m:type": "Edm.Int32",
"__prefix": "d",
"__text": "0"
},
"httpCode": {
"_m:type": "Edm.Int32",
"__prefix": "d",
"__text": "200"
},
"inlineResults": {
"_m:type": "Bag(SFOData.UpsertResult)",
"__prefix": "d"
},
"__prefix": "m"
},
"_type": "application/xml"
}
},
"_xmlns": "http://www.w3.org/2005/Atom",
"_xmlns:m": "http://schemas.microsoft.com/ado/2007/08/dataservices/
metadata",
"_xmlns:d": "http://schemas.microsoft.com/ado/2007/08/dataservices"
}
}

4.2 WorkOrder

You can use this entity to perform various operations pertinent to work orders of contingent workforce in your
company.

Permissions

Permission System Required Setting Note

Role-based Work Order For information about setting up permis­

sions, see Setting Permissions for Work
Orders.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

84 PUBLIC Contingent Workforce
Supported Operations

Operation Description

Query Query a work order.

Insert Create a work order.

Merge Update a work order by merging property values.

Replace Update a work order by replacing property values.

Upsert Create new or update existing work orders.

Delete Delete a work order.

Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Case 1: Query a Single Work Order

A query operation on the WorkOrder entity returns all the information related to a given work order.

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/WorkOrder?
$format=json&$top=1

Response

 Sample Code

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
WorkOrder(effectiveStartDate=datetime'2016-01-02T00:00:00',userSysId='TEST02CW')"
,
"type": "SFOData.WorkOrder"
},
"effectiveStartDate": "/Date(1451692800000)/",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Contingent Workforce PUBLIC 85
 "userSysId": "TEST02CW",
"effectiveEndDate": "/Date(253402214400000)/",
"workerType": null,
"workOrderOwnerId": "USAuto12017Oct050245",
"lastModifiedDateTime": "/Date(1517220105000+0000)/",
"billingRate": "MON",
"endDate": "/Date(253402214400000)/",
"createdDateTime": "/Date(1517220105000+0000)/",
"mdfSystemVersionId": null,
"vendor": "VEN01TEST",
"mdfSystemEntityId": "21B57E4F9B984E07888491D07BFE8B2E",
"currency": "USD",
"mdfSystemObjectType": "WorkOrder",
"billingAmount": "4000",
"lastModifiedDate": "/Date(1517220105000)/",
"lastModifiedBy": "GUNDALARAKES",
"lastModifiedDateWithTZ": "/Date(1517220105000+0000)/",
"mdfSystemRecordStatus": "N",
"effectiveStatus": "I",
"mdfSystemTransactionSequence": "1",
"createdDate": "/Date(1517220105000)/",
"createdBy": "GUNDALARAKES",
"workOrderName": "CW Two",
"mdfSystemRecordId": "03C723445F94479292A8CD5CFD8A0102",
"workOrderId": "TEST02CW02",
"startDate": "/Date(1451692800000)/",
"workOrderOwnerIdNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
WorkOrder(effectiveStartDate=datetime'2016-01-02T00:00:00',userSysId='TEST02CW')/
workOrderOwnerIdNav"
}
},
"userSysIdNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
WorkOrder(effectiveStartDate=datetime'2016-01-02T00:00:00',userSysId='TEST02CW')/
userSysIdNav"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
WorkOrder(effectiveStartDate=datetime'2016-01-02T00:00:00',userSysId='TEST02CW')/
createdByNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
WorkOrder(effectiveStartDate=datetime'2016-01-02T00:00:00',userSysId='TEST02CW')/
lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
WorkOrder(effectiveStartDate=datetime'2016-01-02T00:00:00',userSysId='TEST02CW')/
mdfSystemRecordStatusNav"
}
},
"billingRateNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
WorkOrder(effectiveStartDate=datetime'2016-01-02T00:00:00',userSysId='TEST02CW')/
billingRateNav"
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

86 PUBLIC Contingent Workforce
 "currencyNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
WorkOrder(effectiveStartDate=datetime'2016-01-02T00:00:00',userSysId='TEST02CW')/
currencyNav"
}
},
"workerTypeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
WorkOrder(effectiveStartDate=datetime'2016-01-02T00:00:00',userSysId='TEST02CW')/
workerTypeNav"
}
},
"effectiveStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
WorkOrder(effectiveStartDate=datetime'2016-01-02T00:00:00',userSysId='TEST02CW')/
effectiveStatusNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
WorkOrder(effectiveStartDate=datetime'2016-01-02T00:00:00',userSysId='TEST02CW')/
wfRequestNav"
}
},
"vendorNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
WorkOrder(effectiveStartDate=datetime'2016-01-02T00:00:00',userSysId='TEST02CW')/
vendorNav"
}
}
}
]
}
}

Use Case 2: Creating or Updating a Work Order in Incremental Mode

The following example shows how you can create or update a work order in incremental mode. When you update
work order information in incremental mode, only the information included in your payload will be updated in the
system. All other work order information remains unchanged.

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert?
purgeType=incremental

Headers Content-Type: application/json

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Contingent Workforce PUBLIC 87
Payload
 Sample Code

{
"__metadata":{

"uri":"WorkOrder(effectiveStartDate=d
atetime'2019-10-09T00:00:00',userSysI
d='cwkDemoKing')",
"type":"SFOData.WorkOrder"
},
"effectiveStartDate":"\/
Date(1569974400000)\/",
"userSysId":"cwkDemoKing",
"startDate":"\/
Date(1569974400000)\/",
"endDate":"\/
Date(1577817000000)\/",
"effectiveStatus":"A",
"workOrderOwnerId":"GUNDALARAKES",
"workOrderId":"WO_DemoKing_2",
"vendor":"VEN02TEST",
"workOrderName":"WO_DemoKing_2"
}

Response

 Sample Code

<?xml version="1.0" encoding="utf-8"?>

<feed xmlns="http://www.w3.org/2005/Atom" xmlns:m="http://
schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns:d="http://
schemas.microsoft.com/ado/2007/08/dataservices">
<entry>
<content type="application/xml">
<m:properties>
<d:key>WorkOrder/
effectiveStartDate=2019-10-02T00:00:00.000Z,WorkOrder/userSysId=cwkDemoKing</
d:key>
<d:status>OK</d:status>
<d:editStatus>UPSERTED</d:editStatus>
<d:message m:null="true"></d:message>
<d:index m:type="Edm.Int32">0</d:index>
<d:httpCode m:type="Edm.Int32">200</d:httpCode>
<d:inlineResults m:type="Bag(SFOData.UpsertResult)"></
d:inlineResults>
</m:properties>
</content>
</entry>
</feed>

Use Case 3: Creating or Updating a Work Order in Full Purge Mode

The following example shows how you can create or update a work order in full purge mode. When you update work
order information in full purge mode, all the existing work order information will be overwritten with the information
included in your payload. Existing person related entities, if any, remain unchanged whereas, Job Information and
Job Relationship information will be purged completely and must be imported again.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

88 PUBLIC Contingent Workforce
Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert?
purgeType=full

Headers Content-Type: application/json

Payload
 Sample Code

{
"__metadata":{

"uri":"WorkOrder(effectiveStartDate=d
atetime'2019-10-09T00:00:00',userSysI
d='cwkDemoKing')",
"type":"SFOData.WorkOrder"
},
"effectiveStartDate":"\/
Date(1569974400000)\/",
"userSysId":"cwkDemoKing",
"startDate":"\/
Date(1569974400000)\/",
"endDate":"\/
Date(1577817000000)\/",
"effectiveStatus":"A",
"workOrderOwnerId":"GUNDALARAKES",
"workOrderId":"WO_DemoKing_2",
"vendor":"VEN02TEST",
"workOrderName":"WO_DemoKing_2"
}

Response

 Sample Code

<?xml version="1.0" encoding="utf-8"?>

<feed xmlns="http://www.w3.org/2005/Atom" xmlns:m="http://
schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns:d="http://
schemas.microsoft.com/ado/2007/08/dataservices">
<entry>
<content type="application/xml">
<m:properties>
<d:key>WorkOrder/
effectiveStartDate=2019-10-02T00:00:00.000Z,WorkOrder/userSysId=cwkDemoKing</
d:key>
<d:status>OK</d:status>
<d:editStatus>UPSERTED</d:editStatus>
<d:message m:null="true"></d:message>
<d:index m:type="Edm.Int32">0</d:index>
<d:httpCode m:type="Edm.Int32">200</d:httpCode>
<d:inlineResults m:type="Bag(SFOData.UpsertResult)"></
d:inlineResults>
</m:properties>
</content>
</entry>
</feed>

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Contingent Workforce PUBLIC 89
5 Deductions

5.1 DeductionScreenId

This entity provides the Non screen IDs that are required for configuring the Deduction UI in Employee Central.

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Permissions

Permission System Required Setting

Role-based Assign relevant permissions for DeductionScreenId in User Permissions Miscellaneous

Permissions .

Use Cases

API Call Description

https://<api-server>/odata/v2/ Queries all instances of DeductionScreenId.

DeductionScreenId

Related Information

SAP API Business Hub: Compensation Information

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

90 PUBLIC Deductions
5.2 OneTimeDeduction

This entity creates non-recurring deductions for employees.

Permissions

Permission System Required Setting

Role-based Assign the relevant permissions for deductions in User Permissions Manage Deductions .

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Supported Operations

Operation Description

Query Query non-recurring deductions for employees.

Use Cases

API Call Description

https://<api-server>/odata/v2/ Queries all instances OneTimeDeduction.

OneTimeDeduction

Related Information

SAP API Business Hub: Compensation Information

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Deductions PUBLIC 91
5.3 RecurringDeduction

This entity subtracts recurring expenses from the gross income of employees.

Permissions

Permission System Required Setting

Role-based Assign relevant permissions for RecurringDeductions in User Permissions Miscellaneous

Permissions .

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Supported Operations

Operation Description

Query Query recurring expenses from the gross income of employ­

ees.

Use Cases

API Call Description

https://system-url/odata/v2/ Queries instances of RecurringDeduction.

RecurringDeduction

https://system-url/odata/v2/ Retrieves the child (recurring items) of RecurringDeduction.

RecurringDeduction? $expand=recurringItem&
$format=json

Related Information

SAP API Business Hub: Compensation Information

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

92 PUBLIC Deductions
6 Employment Objects

6.1 EmpBeneficiary

This entity contains the list of pension beneficiaries for an employee.

Supported Operations

Query, Upsert

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Related Information

SAP API Business Hub: Employment Information

Permission Settings [page 15]

6.2 EmpCompensation

This entity contains information about compensation for an employee.

HRIS Element Information

HRIS Element ID: compInfo

Business Keys: userId + startDate
Effective-date:true

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 93
 Foundation Type:false
Person Entity Element:false
Supports Incremental Load:true
Supports NO_OVERWRITE: true
Supports MCPD: true

Supported Operations

Operation Description

Query You can query the compensation information of an employee.

Upsert You can create or update the compensation information of an

employee.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

personIdExternal This property is a unique identifier for employees. You can use
this property to update or add the compensation information
of an employee with only one active employment.

operation To delete a record, use the upsert operation and set this prop­
erty to DELETE.

Anything else I need to know about the fields?

When you make a last modified query, take a look at how this entity behaves with $filter and lastModifiedOn:

lastModifiedDateTime and $filter [page 42]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

94 PUBLIC Employment Objects
Use Case 1: Query the Compensation Information by Pay Group and Creation
Date

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
EmpCompensation?$filter=payGroup eq
'NA_GROUP' and createdOn gt
datetime'2011-08-01T00:00:00'&$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/public/
EmpCompensation(seqNumber=1L,startDate=datetime'2011-08-15T00:00:00',userId='rallen1
')"
},
"startDate": "/Date(1313366400000)/",
"userId": "rallen1",
"seqNumber": "1",
"endDate": "/Date(253402300799000)/",
"isEligibleForCar": false,
"lastModifiedDateTime": "/Date(1325617370000+0000)/",
"benefitsRate": "0",
"event": "2294",
"payGrade": null,
"isHighlyCompensatedEmployee": null,
"eventReason": "PAYPRO",
"payGroup": "NA_GROUP",
"lastModifiedOn": "/Date(1325617370000)/",
"createdOn": "/Date(1313433937000)/",
"isInsider": null,
"createdBy": "eeee",
"createdDateTime": "/Date(1313433937000+0000)/",
"lastModifiedBy": "admin",
"payType": "1593",
"pensionableSalary": null,
"notes": null,
"isEligibleForBenefits": false,
"eventNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/public/
EmpCompensation(seqNumber=1L,startDate=datetime'2011-08-15T00:00:00',userId='rallen1
')/eventNav"
}
},
"employmentNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/public/
EmpCompensation(seqNumber=1L,startDate=datetime'2011-08-15T00:00:00',userId='rallen1
')/employmentNav"
}
},
"wfRequestNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 95
 "uri": "https://<API-Server>/odata/v2/public/
EmpCompensation(seqNumber=1L,startDate=datetime'2011-08-15T00:00:00',userId='rallen1
')/wfRequestNav"
}
},
"empPayCompRecurringNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/public/
EmpCompensation(seqNumber=1L,startDate=datetime'2011-08-15T00:00:00',userId='rallen1
')/empPayCompRecurringNav"
}
},
"payTypeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/public/
EmpCompensation(seqNumber=1L,startDate=datetime'2011-08-15T00:00:00',userId='rallen1
')/payTypeNav"
}
},
"eventReasonNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/public/
EmpCompensation(seqNumber=1L,startDate=datetime'2011-08-15T00:00:00',userId='rallen1
')/eventReasonNav"
}
},
"payGroupNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/public/
EmpCompensation(seqNumber=1L,startDate=datetime'2011-08-15T00:00:00',userId='rallen1
')/payGroupNav"
}
},
"userNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/public/
EmpCompensation(seqNumber=1L,startDate=datetime'2011-08-15T00:00:00',userId='rallen1
')/userNav"
}
}
}
]
}
}

Use Case 2: Upsert the Compensation Information of an Employee

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

96 PUBLIC Employment Objects
 Payload
{
"__metadata": {
"uri":
"EmpCompensation(seqNumber=1L,startDate=
datetime'2018-12-28T00:00:00',userId='us
erIdVVas101')"
},
"eventReason":"HIRNEW",
"payrollId" :"777",
"payrollSystemId":"USDDD"
}

Response

{
"d": [
{
"key": "EmpCompensation/seqNumber=1,EmpCompensation/
startDate=datetime'2018-12-28T00:00:00.000Z,EmpCompensation/userId=userIdVVas101",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}}

Use Case 3: Delete the Employee Record

This example shows how to delete an employee's record. With the Upsert operation, the value DELETE can be
passed to the operation field to delete the record.

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 97
Payload
{
"__metadata": {
"uri":
"EmpCompensation(seqNumber=1L,startDate=
datetime'2017-01-01T00:00:00',userId='80
300')"
},
"operation": "DELETE",
"eventReason": "DATACHG"
}

 Note
Remember to include the required property eventReason
in the payload.

Request

{
"d": [
{
"key": "EmpCompensation/seqNumber=1,EmpCompensation/
startDate=2017-01-01T00:00:00.000Z,EmpCompensation/userId=80300",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Then, you query the employee's record, and you will get the following response:

{
"error": {
"code": "NotFoundException",
"message": {
"lang": "en-US",
"value": "EmpCompensation with key
(seqNumber=1L,startDate=datetime'2017-01-01T00:00:00',userId='80300') not found!"
}
}
}

Use Case 4: Upsert the Compensation Information of an Employee with Multiple

User Ids

In case of an employee with multiple userIds, you can import the compensation information by using the
personIdExternal property.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

98 PUBLIC Employment Objects
Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert

Payload {
"__metadata": {
"uri": "https://<API-Server>/
odata/v2/EmpCompensation"
},
"userId":
"&&USE_PERSON_ID_EXTERNAL&&",
"startDate": "/
Date(1575936000000)/",
"personIdExternal": "107030",
"payGrade": "GR-12",
"payGroup": "D2"
}

Response

{
"d": [
{
"key": "EmpCompensation/
startDate=2019-12-10T00:00:00.000Z,EmpCompensation/
userId=&&USE_PERSON_ID_EXTERNAL&&",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}}

Related Information

SAP API Business Hub: Compensation Information

Permission Settings [page 15]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 99
6.2.1 EmpCompensationCalculated

This entity exposes a transient value that you see in the Compensation Information section.

Supported Operations

Query: This entity can only be queried by expanding the empCompensationCalculatedNav navigation property
of the EmpCompensation entity.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Case: Query the Calculated Compensation Information by User ID

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
EmpCompensation?$filter=userId eq
'TestUser'&
$expand=empCompensationCalculatedNav

Response

 Sample Code

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpCompensation(seqNumber=1L,startDate=datetime'2008-07-01T00:00:00',userId='pluc
as1')",
"type": "SFOData.EmpCompensation"
},
"startDate": "/Date(1214870400000)/",
"userId": "plucas1",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

100 PUBLIC Employment Objects
 "seqNumber": "1",
"endDate": "/Date(253402214400000)/",
"isEligibleForCar": null,
"lastModifiedDateTime": "/Date(1263496137000+0000)/",
"benefitsRate": null,
"event": null,
"isHighlyCompensatedEmployee": null,
"eventReason": null,
"payGroup": null,
"lastModifiedOn": "/Date(1263496137000)/",
"createdOn": "/Date(1263496137000)/",
"createdBy": "admin",
"createdDateTime": "/Date(1263496137000+0000)/",
"lastModifiedBy": "admin",
"payType": "1597",
"notes": null,
"isEligibleForBenefits": null,
.....
"empCompensationCalculatedNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCompensation(seqNumber=1L,startDate=datetime'2008-07-01T00:00:00',userId='pluc
as1')/empCompensationCalculatedNav"
}
},
"userNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCompensation(seqNumber=1L,startDate=datetime'2008-07-01T00:00:00',userId='pluc
as1')/userNav"
}
}
}
]
}
}

Additional Information

This transient value is calculated by:

● GetCompaRatioByUserDateAndSeq - This calculates the Compa-Ratio field that you see in the Compensation
Information portlet.
● GetRangePenetrationByUserDateAndSeq - This calculates the Range Penetration field that you see on the
Compensation Information portlet.
Neither Compa-Ratio nor Range Penetration is stored on the database so both fields are treated as transient
fields. If you want to expose their values, you need to use empCompensationCalculated.

This API is designed for UI consumption and is not suitable for mass data replication.

Related Information

SAP API Business Hub: Compensation Information

Permission Settings [page 15]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 101
6.2.2 EmpCompensationGroupSumCalculated

This entity exposes a transient value that is calculated from the pay component group sums that are in the
compensation information record. It is calculated by GetEligiblePayComponentGroupsByUserDateAndSeq and is
for use in UI scenarios and is not suitable for mass data replication.

Supported Operations

Query

 Note

Transient values are not stored to the database so you can't query them directly. Instead you have to treat
EmpCompensationGroupSumCalculated as a child entity of EmpCompensation. In addition to $expand, you
can also use the operators $select and $format with the GET operation. Note that $filter,$orderby, $skip, and
$top are not supported.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

amount The value calculated by GetEligiblePayComponentGroupsByU­

serDateAndSeq

CurrencyCode Defines the currency being used

errorCode Error Code "Success" indicates that the call has been success­
ful and calculation results are returned.
errorMessage
Error Code "ErrorMximumRecord" indicates that the number
of records called exceeds the maximum of 50 and the calls
failed.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

102 PUBLIC Employment Objects
Use Case: Query the Calculated Group Sum of a User's Compensation
Information

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
EmpCompensation(startDate=datetime'1997-01
-01T00:00:00',userId='107030')?
$format=JSON&
$expand=empCompensationGroupSumCalculatedN
av

Response

 Sample Code

Response

{
"d": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpCompensation(startDate=datetime'1997-01-01T00:00:00',userId='107030')",
"type": "SFOData.EmpCompensation"
},
"userId": "107030",
"startDate": "/Date(852076800000)/",
"lastModifiedDateTime": "/Date(1442201986000+0000)/",
"endDate": "/Date(253402214400000)/",
"customDouble6": null,
"createdDateTime": "/Date(1442200148000+0000)/",
"customDouble7": null,
"createdOn": "/Date(1442185748000)/",
"customDouble5": null,
"bonusTarget": null,
"payGrade": "GR-06",
"payrollSystemId": null,
"event": "3669",
"benefitsRate": "0",
"isHighlyCompensatedEmployee": false,
"lastModifiedBy": "admindlr",
"customString5": null,
"eventReason": "HIRNEW",
"lastModifiedOn": "/Date(1442187586000)/",
"payGroup": "CN",
"isEligibleForCar": false,
"createdBy": "admindlr",
"isInsider": false,
"isEligibleForBenefits": false,
"employmentNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCompensation(startDate=datetime'1997-01-01T00:00:00',userId='107030')/
employmentNav"
}
},
"empPayCompRecurringNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 103
 "uri": "https://<API-Server>/odata/v2/
EmpCompensation(startDate=datetime'1997-01-01T00:00:00',userId='107030')/
empPayCompRecurringNav"
}
},
"eventReasonNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCompensation(startDate=datetime'1997-01-01T00:00:00',userId='107030')/
eventReasonNav"
}
},
"userNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCompensation(startDate=datetime'1997-01-01T00:00:00',userId='107030')/userNav"
}
},
"payGroupNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCompensation(startDate=datetime'1997-01-01T00:00:00',userId='107030')/
payGroupNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCompensation(startDate=datetime'1997-01-01T00:00:00',userId='107030')/
wfRequestNav"
}
},
"empCompensationGroupSumCalculatedNav": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpCompensationGroupSumCalculated(seqNumber=1L,startDate=datetime'1997-01-01T00:0
0:00',userId='107030')",
"type": "SFOData.EmpCompensationGroupSumCalculated"
},
"seqNumber": "1",
"userId": "107030",
"startDate": "/Date(852076800000)/",
"amount": "53593.08627508423",
"errorMessage": null,
"errorCode": "Success",
"currencyCode": "USD",
"payComponentGroupId": "Annual-USD"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpCompensationGroupSumCalculated(seqNumber=1L,startDate=datetime'1997-01-01T00:0
0:00',userId='107030')",
"type": "SFOData.EmpCompensationGroupSumCalculated"
},
"seqNumber": "1",
"userId": "107030",
"startDate": "/Date(852076800000)/",
"amount": "365880.0",
"errorMessage": null,
"errorCode": "Success",
"currencyCode": "CNY",
"payComponentGroupId": "AnnualizedSalary"
}
]
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

104 PUBLIC Employment Objects
 "eventNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCompensation(startDate=datetime'1997-01-01T00:00:00',userId='107030')/
eventNav"
}
},
"empCompensationCalculatedNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCompensation(startDate=datetime'1997-01-01T00:00:00',userId='107030')/
empCompensationCalculatedNav"
}
}
}
}

Additional Information

Take a look at the table here for additional information on some of the properties

Related Information

SAP API Business Hub: Compensation Information

Permission Settings [page 15]

6.3 EmpEmployment

The entity contains information such as the termination date, possibility of rehire, payroll information and so on.

HRIS Element Information

HRIS Element ID: employmentInfo

Business Keys: personIdExternal + userId
Effective-date:false
Foundation Type:false
Person Entity Element:false
Supports Incremental Load:true
Supports NO_OVERWRITE: true
Supports MCPD: false

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 105
Supported Operations

Operation Description

Query To query the employment information of a user

Upsert To create or update employment information of a user

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

personIdExternal Business key.

userId Business key.

assignmentClass The assignment class can take one of these values:

● ST: Standard
● GA: Global Assignment
● PP: Pension Payout
● BN: Beneficiary

assignmentClass isn’t upsertable. The value of this field will be

propagated depending on the type of employment created. For
example, when you create a new employment record using
EmpEmployment, the assignmentClass value is ST. When
you create a global assignment using
EmpGlobalAssignment, an EmpEmployment record will
also be created with assignmentClass GA.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

106 PUBLIC Employment Objects
 Property Description

assignmentIdExternal This property specifies an Assignment ID that is used to iden­

tify users across SAP SuccessFactors HXM Suite. The
assignmentIdExternal field is always included in the re­
sponse whether or not it is configured in Succession Data
Model.

When you create a new employment record, either leave this

field empty or maintain the same value as userId. Otherwise,
an error occurs.

You can change Assignment ID only through the convertAs­

signmentIdExternal function import, instead of upserting the
EmpEmployment entity.

 Caution
Before you change assignment IDs, we recommend that
you evaluate the risks associated with the inconsistencies.
If assignment ID is not supported in the SAP SuccessFac­
tors areas you've enabled, please don't make any changes
to assignment ID at this time.

For more information, see Assignment ID.

hiringNotCompleted This field indicates whether the employment record belongs to

an employee or a candidate created in Onboarding. Possible
values are:

● true: The user hasn't completed the onboarding proc­

ess. The employment record belongs to a candidate cre­
ated in Onboarding.
● false: The user has completed the onboarding process.
The employment record belongs to an employee.

 Note
This field is always "false" for the employment records cre­
ated via Add New Employee. You cannot access these em­
ployment records saved in the draft status via APIs.

custom-string1, custom-string2, custom-string3 These three custom string fields are filterable, so you can
query EmpEmployment with filters on these fields rather
than fetch all the records. In some cases they are used to store
external system IDs.

seniorityDate This filterable field specifies from which seniority starts.

originalStartDate If an employee has been working for the company before, this
filterable field specifies the start date of the first employment.

benefitsEligibilityStartDate This filterable field specifies from which benefits eligibility

starts.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 107
Property Description

costAssignmentNav You can use this property to navigate to

EmpCostAssignment.

costDistributionNav You can use this property to navigate to

EmpCostDistribution.

onboardingInfoNav You can use this property to navigate to OnboardingInfo.

Use Case 1: Query All Global Assignments of an Employee

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
EmpEmployment?$filter=personIdExternal eq
'mcolton1'&$expand=empGlobalAssignmentNav&
$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpEmployment(personIdExternal='mcolton1',userId='184')",
"type": "SFOData.EmpEmployment"
},
"personIdExternal": "mcolton1",
"userId": "184",
"startDate": "/Date(1420070400000)/",
"eligibleForStock": null,
"initialOptionGrant": null,
"payrollEndDate": null,
"serviceDate": null,
"professionalServiceDate": null,
"okToRehire": null,
"regretTermination": null,
"endDate": null,
"eligibleForSalContinuation": null,
"lastModifiedDateTime": "/Date(1418718010000+0000)/",
"StockEndDate": null,
"assignmentClass": "GA",
"lastDateWorked": null,
"salaryEndDate": null,
"originalStartDate": null,
"benefitsEndDate": null,
"lastModifiedOn": "/Date(1418700010000)/",
"initialStockGrant": null,
"bonusPayExpirationDate": null,
"createdOn": "/Date(1418700010000)/",
"createdBy": "admin",
"createdDateTime": "/Date(1418718010000+0000)/",
"lastModifiedBy": "admin",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

108 PUBLIC Employment Objects
 "customString1": null,
"seniorityDate": null,
"empPayCompNonRecurringNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpEmployment(personIdExternal='mcolton1',userId='184')/empPayCompNonRecurringNav"
}
},
"compInfoNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpEmployment(personIdExternal='mcolton1',userId='184')/compInfoNav"
}
},
"personNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpEmployment(personIdExternal='mcolton1',userId='184')/personNav"
}
},
"jobInfoNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpEmployment(personIdExternal='mcolton1',userId='184')/jobInfoNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpEmployment(personIdExternal='mcolton1',userId='184')/wfRequestNav"
}
},
"empJobRelationshipNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpEmployment(personIdExternal='mcolton1',userId='184')/empJobRelationshipNav"
}
},
"empGlobalAssignmentNav": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpGlobalAssignment('184')",
"type": "SFOData.EmpGlobalAssignment"
},
"userId": "184",
"startDate": "/Date(1420070400000)/",
"payrollEndDate": null,
"endDate": null,
"lastModifiedDateTime": "/Date(1418718010000+0000)/",
"lastModifiedOn": "/Date(1418700010000)/",
"createdOn": "/Date(1418700010000)/",
"assignmentClass": "GA",
"personIdExternal": "mcolton1",
"createdBy": "admin",
"assignmentType": "6130",
"plannedEndDate": "/Date(1433030400000)/",
"createdDateTime": "/Date(1418718010000+0000)/",
"lastModifiedBy": "admin",
"customString1": null,
"customString110": null,
"userNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpGlobalAssignment('184')/userNav"
}
},
"assignmentTypeNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 109
 "uri": "https://<API-Server>/odata/v2/
EmpGlobalAssignment('184')/assignmentTypeNav"
}
},
"employmentNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpGlobalAssignment('184')/employmentNav"
}
}
},
"userNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpEmployment(personIdExternal='mcolton1',userId='184')/userNav"
}
},
"empWorkPermitNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpEmployment(personIdExternal='mcolton1',userId='184')/empWorkPermitNav"
}
}
}
]
}
}

Use Case 2: Retrieve the Employment Records of All Candidates Created in

Onboarding

This query retrieves employment records for the candidates created in Onboarding:

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
EmpEmployment?$format=JSON&
$filter=hiringNotCompleted eq 'true'&
$select=personIdExternal,userId,hiringNotC
ompleted

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpEmployment(personIdExternal='214',userId='214')",
"type": "SFOData.EmpEmployment"
},
"personIdExternal": "214",
"userId": "214",
"hiringNotCompleted": true

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

110 PUBLIC Employment Objects
 },
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpEmployment(personIdExternal='215',userId='215')",
"type": "SFOData.EmpEmployment"
},
"personIdExternal": "215",
"userId": "215",
"hiringNotCompleted": true
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpEmployment(personIdExternal='216',userId='216')",
"type": "SFOData.EmpEmployment"
},
"personIdExternal": "216",
"userId": "216",
"hiringNotCompleted": true
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpEmployment(personIdExternal='217',userId='217')",
"type": "SFOData.EmpEmployment"
},
"personIdExternal": "217",
"userId": "217",
"hiringNotCompleted": true
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpEmployment(personIdExternal='229',userId='229')",
"type": "SFOData.EmpEmployment"
},
"personIdExternal": "229",
"userId": "229",
"hiringNotCompleted": true
}
]
}
}

Use Case 3: Update External User Record with Employment-Related Information

Request
Request:

Operation Upsert

HTTP Method POST

URI http://<API-Server>/odata/v2/upsert

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 111
Payload {
"__metadata": {
"uri":
"EmpEmployment(personIdExternal='userIdV
Vas101',userId='userIdVVas101')"
},
"startDate": "/
Date(1388534400000)/",
"personIdExternal": "userIdVVas101",
"userId": "userIdVVas101"
}

Response

{
"d": [
{
"key": "EmpEmployment/personIdExternal=userIdVVas101,EmpEmployment/
userId=userIdVVas101",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Related Information

SAP API Business Hub: Employment Information

Permission Settings [page 15]
EmpEmployment Upsert [page 828]
Filtering out external user data [page 832]

6.4 EmpEmploymentTermination

This entity contains employment or global assignment termination information for an employee.

HRIS Element Information

HRIS Element ID: employmentInfo

Business Keys: personIdExternal + userId + endDate
Effective-date:false
Foundation Type:false

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

112 PUBLIC Employment Objects
 Person Entity Element:false
Supports Incremental Load:true
Supports NO_OVERWRITE: true
Supports MCPD: false

Supported Operations

Operation Description

Query To query the termination information of an employment re­

cord.

Upsert To terminate the employment of an employee or to change the

termination information.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

endDate Termination date. This is a business key.

personIdExternal Person ID External. This is a business key.

userId User ID. This is a business key.

eventReason Reason for the employment termination. Event reasons are de­
fined by the FOEventReason entity. For more information,
see the related API documentation.

 Note
This is a required field when you upsert a record. It's not
viewable in query results.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 113
Use Case 1: Get All Employees Terminated in 2014

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/EmpEmploymentTermination?
$filter=endDate lt datetime'2014-12-31T00:00:00' and
endDate gt datetime'2014-01-01T00:00:00'&$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpEmploymentTermination(endDate=datetime'2014-12-09T00:00:00',personIdExternal='hmu
eller1',userId='189')",
"type": "SFOData.EmpEmploymentTermination"
},
"personIdExternal": "hmueller1",
"userId": "189",
"endDate": "/Date(1418083200000)/",
"payrollEndDate": null,
"benefitsEndDate": null,
"okToRehire": null,
"regretTermination": null,
"eligibleForSalContinuation": null,
"lastModifiedDateTime": "/Date(1418732822000+0000)/",
"lastModifiedOn": "/Date(1418714822000)/",
"bonusPayExpirationDate": null,
"StockEndDate": null,
"createdOn": "/Date(1418709564000)/",
"createdBy": "admin",
"createdDateTime": "/Date(1418727564000+0000)/",
"lastDateWorked": null,
"lastModifiedBy": "admin",
"salaryEndDate": null,
"notes": null,
"personNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpEmploymentTermination(endDate=datetime'2014-12-09T00:00:00',personIdExternal='hmu
eller1',userId='189')/personNav"
}
},
"userNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpEmploymentTermination(endDate=datetime'2014-12-09T00:00:00',personIdExternal='hmu
eller1',userId='189')/userNav"
}
},
"jobInfoNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpEmploymentTermination(endDate=datetime'2014-12-09T00:00:00',personIdExternal='hmu
eller1',userId='189')/jobInfoNav"
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

114 PUBLIC Employment Objects
 "employmentNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpEmploymentTermination(endDate=datetime'2014-12-09T00:00:00',personIdExternal='hmu
eller1',userId='189')/employmentNav"
}
}
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpEmploymentTermination(endDate=datetime'2014-04-01T00:00:00',personIdExternal='hmu
eller1',userId='186')",
"type": "SFOData.EmpEmploymentTermination"
},
"personIdExternal": "hmueller1",
"userId": "186",
"endDate": "/Date(1396310400000)/",
"payrollEndDate": null,
"benefitsEndDate": null,
"okToRehire": null,
"regretTermination": false,
"eligibleForSalContinuation": null,
"lastModifiedDateTime": "/Date(1418917414000+0000)/",
"lastModifiedOn": "/Date(1418899414000)/",
"bonusPayExpirationDate": null,
"StockEndDate": null,
"createdOn": "/Date(1418702808000)/",
"createdBy": "admin",
"createdDateTime": "/Date(1418720808000+0000)/",
"lastDateWorked": null,
"lastModifiedBy": "admin",
"salaryEndDate": null,
"notes": null,
"personNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpEmploymentTermination(endDate=datetime'2014-04-01T00:00:00',personIdExternal='hmu
eller1',userId='186')/personNav"
}
},
"userNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpEmploymentTermination(endDate=datetime'2014-04-01T00:00:00',personIdExternal='hmu
eller1',userId='186')/userNav"
}
},
"jobInfoNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpEmploymentTermination(endDate=datetime'2014-04-01T00:00:00',personIdExternal='hmu
eller1',userId='186')/jobInfoNav"
}
},
"employmentNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpEmploymentTermination(endDate=datetime'2014-04-01T00:00:00',personIdExternal='hmu
eller1',userId='186')/employmentNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 115
Use Case 2: Terminate Employment

You can terminate an employee by creating an EmpEmploymentTermination record using the upsert operation.

 Note

When you create a new termination record, an EmpJob record is also created automatically. The new job record
starts one day after the end date you specify in the termination payload.

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert

Payload {
"__metadata":{
"uri":"EmpEmploymentTermination"
},
"personIdExternal":"1234567",
"userId":"1234567",
"endDate":"/Date(1558556800000)/",
"eventReason":"TERRTMNT"
}

Use Case 3: Reporting No-Shows

For termination scenarios, the end date can be any date on and after the hire date, whereas for no-shows, it should
be always the same as hire date. We also include the event reason for these cases.

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

116 PUBLIC Employment Objects
 Payload
 Sample Code

{
"__metadata":{
"uri":"EmpEmploymentTermination"
},
"personIdExternal":"1234567",
"userId":"1234567",
"endDate":"/Date(1558556800000)/",
"eventReason":"NO_SHOW_EVENT_REASON"
}

Related Information

SAP API Business Hub: Employment Information

FOEventReason [page 221]
EmpJob [page 121]
Terminating an Employee
Reporting No-Show New Hires

6.5 EmpGlobalAssignment

This entity contains details about the global assignment for an employee. You can create a new global assignment
by upserting this entity.

HRIS Element Information

HRIS Element ID: globalAssignmentInfo

Business Keys: userId
Effective-date:false
Foundation Type:false
Person Entity Element:false
Supports Incremental Load:true
Supports NO_OVERWRITE: No
Supports MCPD: false

Supported Operations

Query, Upsert

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 117
Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

userId Business key.

assignmentClass Same field as in EmpEmployment except that the value for a

global assignment is always GA (Global Assignment). This field
is not upsertable.

assignmentType Assignment type.

assignmentIdExternal Assignment ID of the user. An assignment ID can be used to

identify a user record in the company. When you create a new
global assignment, either leave this field empty or maintain the
same value as <userId>. Otherwise an error will occur. You're
not allowed to change the value of this field by upserting
EmpGlobalAssignment.

 Caution
Before you change assignment IDs, we recommend that
you evaluate the risks associated with the inconsistencies.
If assignment ID is not supported in the SAP SuccessFac­
tors areas you've enabled, please don't make any changes
to assignment ID at this time.

For more information, see Assignment ID.

Use Case 1: Query Global Assignment Information by userId

Request

Operation Query

HTTP Method GET

URI https://<API-Server>.com/odata/v2/
EmpGlobalAssignment?$filter=userId eq
'183'&$format=JSON

Response

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

118 PUBLIC Employment Objects
 "d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpGlobalAssignment('183')",
"type": "SFOData.EmpGlobalAssignment"
},
"userId": "183",
"startDate": "/Date(1417392000000)/",
"payrollEndDate": null,
"endDate": null,
"lastModifiedDateTime": "/Date(1415696549000+0000)/",
"lastModifiedOn": "/Date(1415678549000)/",
"createdOn": "/Date(1415678549000)/",
"assignmentClass": "GA",
"personIdExternal": "ttest",
"createdBy": "admin",
"assignmentType": "6131",
"plannedEndDate": "/Date(1446336000000)/",
"createdDateTime": "/Date(1415696549000+0000)/",
"lastModifiedBy": "admin",
"customString1": null,
"customString110": null,
"userNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpGlobalAssignment('183')/userNav"
}
},
"assignmentTypeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpGlobalAssignment('183')/assignmentTypeNav"
}
},
"employmentNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpGlobalAssignment('183')/employmentNav"
}
}
}
]
}
}

Use Case 2: Create a New Global Assignment with Upsert

 Note

When you upsert this entity, a new global assignment is created, meaning that there is a new record in
EmpGlobalAssignment and a new entry in the User entity for this employee. Since EmpGlobalAssignment and
EmpEmployment share the same persistency, each global assignment appears as an Employment in
EmpEmployment with the type global assignment.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 119
Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert

Payload
{
"__metadata":{
"uri":"EmpGlobalAssignment"
},
"assignmentType":"10322",
"startDate":"/Date(1565172522000)/",
"plannedEndDate":"/
Date(1566172522000)/",
"personIdExternal":"cgrant",
"userId":"cgrant-0717"
}

Response

{
"d": [
{
"key": "EmpGlobalAssignment/userId=cgrant-0717",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Related Information

SAP API Business Hub: Global Assignment

Permission Settings [page 15]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

120 PUBLIC Employment Objects
6.6 EmpJob

This entity contains information such as the employee's manager, the department, or other information relating to
the employee's job.

HRIS element information

HRIS Element ID: jobInfo

Business Keys: userId + startDate + seqNumber
Effective-date:true
Foundation Type:false
Person Entity Element:false
Supports Incremental Load:yes
Supports NO_OVERWRITE: yes
Supports MCPD: true

Supported Operations

Query, Upsert

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

personIdExternal This property is a unique identifier for employees. You can use
this property to update or add the job information of an em­
ployee with only one active employment.

seqNumber This string is automatically generated to specify the sequence

of the record.

operation To delete a record, use the upsert operation and set this prop­
erty to DELETE.

effectiveLatestChange You can use this property to filter the record that is the last up­
dated one on that day in date range queries.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 121
Anything else I need to know about the fields?

When you make a last modified query, take a look at how this entity behaves with $filter and lastModifiedOn:

lastModifiedDateTime and $filter [page 42]

Use Case 1: Query the Job Information by Company and Manager

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/EmpJob?
$filter=company eq 'ACE_USA' and managerId
eq 'cgrant1'&$select=employmentNav/
personNav/personalInfoNav/
firstName,employmentNav/personNav/
personalInfoNav/lastName,company&
$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/public/
EmpJob(seqNumber=1L,startDate=datetime'2010-12-01T00:00:00',userId='rallen1')"
},
"company": "ACE_USA",
"employmentNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/public/
EmpJob(seqNumber=1L,startDate=datetime'2010-12-01T00:00:00',userId='rallen1')/
employmentNav"
}
}
}
]
}
}

Use Case 2: Update Job Related Information

Request

Operation Upsert

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

122 PUBLIC Employment Objects
 HTTP Method POST

URI https://<API-Server>/odata/v2/upsert

Payload
{
"__metadata": {
"uri":
"EmpJob(seqNumber=1L,startDate=datetime'
2018-12-28T00:00:00',userId='userIdVVas1
01')",
"type": "SFOData.EmpJob"
},
"userId": "userIdVVas101",
"seqNumber": "1",
"eventReason": "HIRNEW",
"company": "ACE IT",
"managerId" : "snadmin",
"timezone" : "IST"
}

Response

{
"d": [
{
"key": "EmpJob/seqNumber=1,EmpJob/
startDate=2018-12-28T00:00:00.000Z,EmpJob/userId=userIdVVas101",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Use Case 3: Delete the Employee Record

This example shows how to delete an employee's record. With the Upsert operation, the value DELETE can be
passed to the Operation field to delete the record.

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 123
Payload {
"__metadata": {
"uri":
"EmpJob(seqNumber=2L,startDate=datetime'
2017-01-01T00:00:00',userId='101028')"
},
"operation": "DELETE",
"eventReason": "DATACHG"
}

 Note
Remember to include the required property
eventReason in the payload.

Response

{
"d": [
{
"key": "EmpJob/seqNumber=2,EmpJob/
startDate=2017-01-01T00:00:00.000Z,EmpJob/userId=101028",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Then, if you query the employee's record, you will get the following response:

 Sample Code

{
"error": {
"code": "NotFoundException",
"message": {
"lang": "en-US",
"value": "EmpJob with key
(seqNumber=2L,startDate=datetime'2017-01-01T00:00:00',userId='101028') not
found!"
}
}
}

Use Case 4: Upsert Job Information of an Employee with Multiple User IDs

In case of an employee with multiple userIds, you can import the job information by using the
personIdExternal property.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

124 PUBLIC Employment Objects
Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert

Payload
 Sample Code

{
"__metadata": {
"uri":
"http://<API-Server>/odata/v2/
EmpJob",
},
"userId":
"&&USE_PERSON_ID_EXTERNAL&&",
"seqNumber": "2",
"startDate": "/
Date(858556800000)/",
"personIdExternal":
"103049",
"company": "1000",
"eventReason": "DATACHG",
"payGrade": "GR-11",
"jobCode": "50070999",
"jobTitle": "Management &
Planning",
"timezone": "Europe/
Berlin"
}

Response

{
"d": [
{
"key": "EmpJob/seqNumber=2,EmpJob/
startDate=1997-03-17T00:00:00.000Z,EmpJob/userId=&&USE_PERSON_ID_EXTERNAL&&",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Use Case 5: Get the Latest Job Information in One Day

EmpJob support multiple changes per day (MCPD). In case of an employee's job information is changed several
times in one day, you can get the latest one by using the effectiveLatestChange property.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 125
For example, the user "cgrant" has four EmpJob records as follows:

EmpJob Records

Record User ID StartDate EndDate SeqNumber

1 cgrant 2017-11-14 9999-12-31 1

2 cgrant 2017-11-02 2017-11-13 2

3 cgrant 2017-11-02 2017-11-02 1

4 cgrant 2005-09-01 2017-11-01 1

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/V2/EmpJob?
$filter=userId eq 'cgrant'&
$fromDate=2017-03-15&toDate=2020-03-30&
$filter=effectiveLatestChange eq 'Y'

Response
Record 1, 2, and 4 are returned.

Related Information

SAP API Business Hub: Employment Information

Permission Settings [page 15]

6.7 EmpJobRelationships

This entity contains the employee relationship information to one or more managers.

HRIS Element Information

HRIS Element ID: jobRelationsInfo

Business Keys: userId + relationshipType + startDate
Effective-date: true
Foundation Type:false
Person Entity Element:false
Supports Incremental Load: true
Supports NO_OVERWRITE: true
Supports MCPD: false

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

126 PUBLIC Employment Objects
Supported Operations

Query, Upsert

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

operation To delete a record, use the upsert operation and set this prop­
erty to DELIMIT.

Use Case 1: Query All Entries with the Same External Code

Request
The following example shows how to get all entries that have the external code "hr manager".

Operation Query

HTTP Request GET

URI https://<API-Server>.com/odata/v2/
EmpJobRelationships?
$filter=relationshipTypeNav/externalCode
eq 'hr manager'&
$expand=relationshipTypeNav&
$select=relationshipTypeNav/
externalCode,relationshipType&$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpJobRelationships(relationshipType='5777',startDate=datetime'2011-07-13T00:00:00',
userId='147')",
"type": "SFOData.EmpJobRelationships"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 127
 },
"relationshipType": "5777",
"relationshipTypeNav": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
PicklistOption(5777L)",
"type": "SFOData.PicklistOption"
},
"externalCode": "hr manager"
}
}
]
}
}

Use Case 2: Delimit the Job Relationship Between Users

Reqeust
The following example shows how to delimit the job relationship between user "4000021" and user "4000185".

Operation Upsert

HTTP Method POST

URI http://<API-Server>/odata/v2/upsert

Payload {
"__metadata":{

"uri":"EmpJobRelationships(relationshipT
ype='5777',startDate=datetime'2013-11-15
T00:00:00',userId='4000021')",

"type":"SFOData.EmpJobRelationships"
},
"startDate":"/Date(1384473600000)/",
"relationshipType":"5777",
"userId":"4000021",
"relUserId":"4000185",
"operation":"DELIMIT"
}

Response

{
"d": [
{
"key": "EmpJobRelationships/relationshipType=5777,EmpJobRelationships/
startDate=2013-11-15T00:00:00.000+08:00,EmpJobRelationships/userId=4000021",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

128 PUBLIC Employment Objects
Related Information

SAP API Business Hub: Employment Information

Permission Settings [page 15]

6.8 EmpPensionPayout

This entity contains information about how the pension will be paid to the employee.

HRIS Element Information

HRIS Element ID: pensionPayoutsInfo

Business Keys: userId
Effective-date:false
Foundation Type:false
Person Entity Element:false
Supports Incremental Load:true
Supports NO_OVERWRITE: No
Supports MCPD: false

Supported Operations

Query, Upsert

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Case: Query the Pension Payout of an Employee

Request

Operation Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 129
HTTP Method GET

URI https://<API-Server>/odata/v2/
EmpPensionPayout?$filter=userId eq
'TestUser'&
$expand=empCompensationCalculatedNav

Related Information

SAP API Business Hub: Employment Information

Permission Settings [page 15]

6.9 EmpWfRequest

This entity contains information about a workflow request.

HRIS Element Information

HRIS Element ID: N/A

Business Keys: empWfRequestId
Effective-date:false
Foundation Type:false
Person Entity Element:false
Supports Incremental Load:false
Supports NO_OVERWRITE: false
Supports MCPD: false

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

130 PUBLIC Employment Objects
 Property Description

empWfRequestId This is a business key.

actionType Specify how approvers are allowed to change content of a

workflow transaction:

● No Edit
Approvers do not have in-flight editing capability.
● Edit with Route Change
Approvers can edit a workflow and the workflow route will
be recalculated when they submit the request.
● Edit without Route Change
Approvers can edit a workflow but the workflow route will
not be recalculated when they submit the request.
● Edit Attachments Only
Approver can only edit the attachments of the workflow.

Use Case: Get All the Request Types and Event Reasons by Workflow Subject

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
EmpWfRequest?$filter=subjectId eq
'cgrant1'&$select=eventReason,subjectId&
$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/EmpWfRequest(307L)",
"type": "SFOData.EmpWfRequest"
},
"eventReason": "PAYMKT",
"subjectId": "cgrant1"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/EmpWfRequest(306L)",
"type": "SFOData.EmpWfRequest"
},
"eventReason": "PAYMKT",
"subjectId": "cgrant1"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/EmpWfRequest(305L)",
"type": "SFOData.EmpWfRequest"
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 131
 "eventReason": "PAYMKT",
"subjectId": "cgrant1"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/EmpWfRequest(304L)",
"type": "SFOData.EmpWfRequest"
},
"eventReason": "PAYMKT",
"subjectId": "cgrant1"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/EmpWfRequest(303L)",
"type": "SFOData.EmpWfRequest"
},
"eventReason": "PAYMKT",
"subjectId": "cgrant1"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/EmpWfRequest(302L)",
"type": "SFOData.EmpWfRequest"
},
"eventReason": "PAYMKT",
"subjectId": "cgrant1"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/EmpWfRequest(301L)",
"type": "SFOData.EmpWfRequest"
},
"eventReason": "PAYMKT",
"subjectId": "cgrant1"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/EmpWfRequest(41L)",
"type": "SFOData.EmpWfRequest"
},
"eventReason": null,
"subjectId": "cgrant1"
}
]
}
}

Related Information

SAP API Business Hub: Workflow

Permission Settings [page 15]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

132 PUBLIC Employment Objects
6.10 EmpWorkPermit

This entity contains information about work permits for an employee.

HRIS Element Information

HRIS Element ID: workPermitInfo

Business Keys: userId + country + documentType + documentNumber
Effective-date: false
Foundation Type: false
Person Entity Element: false
Supports Incremental Load: yes
Supports NO_OVERWRITE: false
Supports MCPD: false

Supported Operations

Query, Upsert

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

The information in this section is only appliable for customers who import work permits on the Centralized
services. Other customers are not affected.

Importing work permits on the Centralized services is based on user ID, instead of person ID. Because one person
can have multiple user accounts, so you could end up purging work permit information of multiple users when you
chose to purge data for one person. Now, with a user ID-based importing process, you only purge work permit
information for the particular user ID you selected.

The entity uses four fields to make up a business key: userId, country, documentType, and documentNumber.
Upserting a record with a duplicate business key will be blocked and trigger a validation error. Both the full-purge
mode and the incremental load mode are supported.

Property Description

userId Part of business key. Cannot be empty.

country Part of business key. Cannot be empty.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 133
Property Description

documentType Part of business key. Cannot be empty.

documentNumber Part of business key. Cannot be empty.

issueDate Cannot be empty.

Use Case 1: Query All Work Permits for USA

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
EmpWorkPermit?$filter=country eq 'USA'&
$format=JSON

Response

 Sample Code

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpWorkPermit(country='USA',documentNumber='gr',documentType='6148',userId='174')
",
"type": "SFOData.EmpWorkPermit"
},
"documentType": "6148",
"userId": "174",
"documentNumber": "gr",
"country": "USA",
"attachmentFileSize": "44711",
"attachmentStatus": "1",
"expirationDate": "/Date(1377129600000)/",
"attachmentFileName": "EmeprgencyBeforeImport.jpeg",
"issueDate": "/Date(1373328000000)/",
"attachmentMimeType": "image/jpeg",
"lastModifiedOn": "/Date(1377254694000)/",
"lastModifiedDateTime": "/Date(1377269094000+0000)/",
"attachment": "/9j/4AAQSkZJRgABAAEAYABgAAD//
gAfTEVBRCBUZWNobm9sb2dpZXMgSW5jLiBWMS4wMQD/2wCE\r
\nAAUFBQgFCAwHBwwMCQkJDA0MDAwMDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0N\r
\nDQ0NDQ0NDQ0BBQgICgcKDAcHDA0MCgwNDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0N\r
\nDQ0NDQ0NDQ0NDQ0NDQ0NDf/EAaIAAAEFAQEBAQEBAAAAAAAAAAABAgMEBQYHCAkKCwEAAwEBAQEB\r
\nAQEBAQAAAAAAAAECAwQFBgcICQoLEAACAQMDAgQDBQUEBAAAAX0BAgMABBEFEiExQQYTUWEHInEU\r
\nMoGRoQgjQrHBFVLR8CQzYnKCCQoWFxgZGiUmJygpKjQ1Njc4OTpDREVGR0hJSlNUVVZXWFlaY2Rl\r
\nZmdoaWpzdHV2d3h5eoOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK\r
\n0tPU1dbX2Nna4eLj5OXm5+jp6vHy8/T19vf4+foRAAIBAgQEAwQHBQQEAAECdwABAgMRBAUhMQYS\r
\nQVEHYXETIjKBCBRCkaGxwQkjM1LwFWJy0QoWJDThJfEXGBkaJicoKSo1Njc4OTpDREVGR0hJSlNU\r
\nVVZXWFlaY2RlZmdoaWpzdHV2d3h5eoKDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5\r
\nusLDxMXGx8jJytLT1NXW19jZ2uLj5OXm5+jp6vLz9PX29/j5+v/AABEIAJkEegMBEQACEQEDEQH/\r
\n2gAMAwEAAhEDEQA/AMeaZYIy5OFUE55zwCTnjOABmvZ9D5889vNXuLpyQzRpnhVJHHbOOp478Zzg\r
\nDOK3UUjFyfojLqyAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKA\r

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

134 PUBLIC Employment Objects
 \nCgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAK\r
\nACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoA\r
\nKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAo\r
\nAKACgAoAKACgAoAKACgAoAKACgAoAkhgkuHWKFWkkc4VEBZmJ7BRkk+wFJu2r2BK+i3Ny98J6vp0\r
\nP2m5s7iKIDJcxthR6vgfIPdsVCqQbspK/qaunOKu4tL0MOKeSA5iZkP+ySv8iPWrt3Mk7bHaaHqz\r
\n3WYZeXQZB6BhnHI6ZBIHHUEccEnGS5dVsbxd9Op0ZK9yf1/wqCjA8RyMkHBwScHrjB7U18S/roJ/\r
\nC/66o4Ouk5z2KTw3JElgNP0D+0ormztZZbgjUzullH7webDdJbx9uqBUzlhisOZe1qQqT9nCM0lr\r
\nFWjyQbleSezctdtPJnTy2pwlCHO3GTbtJ2kqlSKVotfZjF23d/M53WPB0Fs1xe2l3bDTkvJ7W2Mj\r
\nTO8rxBXEa+RDIrBlfaspZIiVJZ0DJuVGcn7KE43qTXMla14+0cOZ3a5dlKUb8yUko3adqq00nUlF\r
\nqEIOKld83JOVNTcVZSb5XzRu0/h113df+BJoJJZbm40/T4lvZbIAvdtGJowjFYx5M8xjIf5ZJCQN\r
\np81lJTeU6nNyRjzSlUTlFPlTaU3B32irNL5Nbu9pnTcVKcuWMYcik/ea9+mpq28m2t0ut7LlKOoe\r
\nB7vTVulae1kudOwbm2ieVpY0aRYw+4wiB1JdCRHM8iBwJEVg6qRqqSjKKfLKShd2SU2pe7K70s4y\r
\ni2k48y0bTTCVFwcoNx5oxc7XesI2fMna1nFqaUmpcvS+hC/hBxBNNBeWV1JZrG88MLzM8au6R5Dm\r
\nBbeUI7qrmCeUDqCw5rRSvKMUnaVRU1Jq0eZ81nZ2klLldny66d0Z8mj1XNGDqOGvNyxSclty80U7\r
\nuPNdWa3TRPqnge40s3cRubSe401d9zBCZzIieZHHuBe3SJwPNRmCSMUXO8KwKjNVk4qaT5HJQ5tL\r
\nKT59HrfSUHC9rOTjytp3NHRabhdcyhz8ut3Gylo7ct+SXNa97KWl1Y5zUtLl0poo5ypeaCKfapJK\r
\nLMu9FfIGHKFXwNw2uvOcgdEGpTcP5ZKL7Xsm0vRvlfaSkulzBxcYxn0nFyXopSjr68t1/dafkvUv\r
\nEXh2bS7yaGw8OC4s4gpScx6w4dfLVmcyR3ixkAlslQFGPauJTupOpU5GpVF9hWUZyUX7yf2Und6P\r
\nfY6+R+4qdPnvCm72m7ylCLkvdaXxNqyWm25yVh4GuNQSzf7VZ276oGNpFI8++RlkeIp8kEiRneoC\r
\nmV0RtygOWDhOiUuSUqaTlKEFNpW+Fx509XFXsnp3T6WbwUOdKq3GEZTcFfmsmpJW0UnZcy1103ZB\r
\nJ4KvCga0lt72T7THZyQ27SGSG4l3bI3MkUcbAlHXzYZJYcqf3m3DFKpFuNvgmpSjN6RcYJSk9feX\r
\nuy5veitE+1gdJxUk2uaHKpQ3kuaXKlouVvmtG0ZN3aViWPwPcXMkcVlc2l5vuo7OR4Wn2QTSkrH5\r
\npkgjJjcq4WWETRnYcNym5qd7OzScZyi3Zc3JHnkkm7qXLqlJR/CXKSpuHMm1zQcVKKvePNLkvtyt\r
\nKVlJxcrNro1eE+EGUzM97ZpBaFY57gm6MSTuzqtuAtqZZZf3bsWhjkhCKWM2MZSqKSjKKdpu1PZc\r
\n6UVJyV2uWKTjdz5NZJW1KdFxlKDcb0/4m/ue9yq+mt5XS5ea9m9k2S3Pga60+aeO9ntbaG0W3Mlw\r
\nzyvDuuYxJDEnkwyyyyMhJPlxMoCOxbYAxFUVtnfnnBRtZtw+P0UdLuTW6W7SF7JqzTTi4KpzK9lC\r
\nUnGLel/ea0STdtbWUrL/AMINdRrcTXFxa29vaG33Tu0xjkjulZ4JYRFBJJJHIFGAI/MXcN8ahZCg\r
\n6ijZNNSc50+XTmU4JOUXrZaO6d+VrVOzjcVJu9muVQjU5tbOMny6XV7qV4yTSakmrX0I5PBVzbSz\r
\nrcz21vbWqwO127TNA4uVD2/liOGSdzKmWAEGUVWMmzFNTWzTUueVPldr80L82t+VJLW7klZrW7SD\r
\n2T0aaceRVOZXtySfKnaylfm923Le6btypszbjw7PBBcXKSQTx2dyltIYJPMyZA5jlRlXY0Mnlsqt\r
\nu3bsKyAmnGXN7NWknUclFNWfNDlvF+b5rq11JRk07Wbhwtz2aapqMm09HGTaUldLROyknaUXKKlF\r
\nO9pE8NTDWY9Bd0E73EVuzplkR3KqwOQhJiLFXHHzKwBIwTUJRmnO/uR5233jDmvKPdSUW4vqmm7X\r
\nInF07J7tQaXnOMWk+zXMk+id91qasuoaBFcSWTWJ+xpvjW7SaY32V4WYq0y2bbmGTEIEGw7BJuHm\r
\nHnXtKkOdPkm43jGycU7XUZXTk10k007tyikrQOqShRqeylHnjGTjOV2pPVqUoWfKrbwUlK6SUm7u\r
\nRU0/wdc6jFCyzW8M16HNnbStIs1yEJXMe2N4kDurRx+fLCJHUhMgZrWc1T5tG+SKlO32Ytc13e17\r
\nR99qN5ctny6q+MYcyUk0oyk4QctOaSaXKrXSfM1G8moqTtze7K1mx8C3N7HaObm0gk1MN9khlaYS\r
\nSskjxGP5IHSNi6gKZXjjbcoDkhwilUUHKKTk4QVRqNvhcOdNXaT0T03un0s21TdlKbUE5un711aS\r
\nkotNJNrVq7tp1sWNS8IQW9vpphuoFmvopJJzM0saRbJZVZizwIqpGI/LKqZJXmDCJZVaMle0/eVI\r
\nr4IQhJNa3vFS0S95ud/cSjpFe+ou97dLlpxb0qOrODje1uWyav8AClDVzblbW8W4p8tMeCbmc2xs\r
\nZ7W8hvHmRZommSOI26rJMZvtEEDoI428wnYcoDt3Hgt1FHm504KMPaXdmnHmcdOVybfMrWte7ja9\r
\nyVScknTak3NU7K6fO1zRXvKKs1d3vZWfM1YvaB4QtL7UFtp761mt3tbm4WSBp8boY5CEdGthPGVZ\r
\nPMcSQx74QTCzsyAqc3GnVkotSgotXs17zS5rptNK9mr8ylbmjy3ZVOmpVaUHJOM52fLdPTVxs0mn\r
\nJWtK3K1dKSkmlwUihGKqwcKSAy7trAHG4bgrYPUblVsdQDxWyd0m1bydrrydm1p5Nrsznas2k00n\r
\nur2fmrpOz80n3QymIKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKAC\r
\ngAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKA\r
\nCgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAK\r
\nACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoA0tGs01C+gtJSwSaVI2K4DAMwBwSCM88ZBHt\r
\nVJb+UZOy7qLaXzaMaknCDkt13NW/0ZotkcVhfW0ksqxo1w4KMzZAQA2kHzMeh38AHg9RC1aV0r6u\r
\n/RLd+SW7dtEVzKPM3KMoxT1iui67y0t0/HvaXwzELfzUmjuX3XQJikZYwILfzf44N5YHJ4XZIuAr\r
\nrkuBuyTWicXK7/x04p23+27p2kt7WspSpPm5GnH3qcbPe83K97O3RWauk76PZY+u6bFpVwsMEgmU\r
\nwwyEjdwZIlcj5o4+CTuTAOEZQx3hgDaUo/yykl8nb7+j6X20KptyhGbVm76ekmtN+1t90+lm/cPg\r
\nro8H2W41QgGcym3VuCURUR22+hcyDd7IvYnPm4mTuodLX/r7j2sJFWc+t7emi/zOg8O3WpHXJrIX\r
\nU+pWUCPHdyTwpHHHcA8JCVABPPzKPl2knn5TWc1FQUrKMnsk9beZrTcvaOPM5RV1JtWSfZHhnxE0\r
\neHRNbnt7UBIW2Sqg6J5ihmUDsA27aBwFIA4Fd9GTlBN77fcebXioVGo7b27XOW05ilwhGeuOPetJ\r
\n/C/l+ZlD4vv/ACZ6iN3Yj9axNTmvEoxbr2G4celNfEvn+TB/C/l+aOGrpOY6LxFq8Orm0MIdfstj\r
\nb2z7wBl4lIYrhmyhz8pOCe6is1FqdWfSc+ZenJCOvneL76WNZSThTgt4Rkn6upUnp8pL539R7azC\r
\ndIttN2v5tvezXDHC7CkkcCqFO7cWBibIKgYIwx5xotK1Ot9mEOVrrf2jnp0tZ91r95F/3NSj1nOM\r
\nl2soSjr53fZ6G/4q8W2muKRbpMudTub351QfupkgVV+V2/eAxNuH3QCMMecc9CDozpTla1ODi7d3\r
\nWlU020s7a218tTetUVSFSEbpzdNq+3uUfZu//b2q307PQS58WWc1/rF35cpi1ZGWFSFBG65hmxLh\r
\nztBSNgShchiMAjJCp03ClTpuzcKsKjXRxi5trbd8y6W3+bnUUqjqRur0ZU07JtSdKME7XtZSV99u\r
\nnQ6C98e6e9vfW8Ml+YLyIJbWhiggs7ILNHKESGKcpISFZfPEcL9S6SNKzIo05RdNytJwq05ubvzy\r
\njB2sk78nu/ZTcW0kuVK7r2sUpKHNGLpTpqmrckZThK8m7pzfO95R5uWUm3JpIzdK1Fdd8Vz6hDFK\r
\n2n3Tzm73LjyrKdWjmkmKl1jEaPu3FiocLgk4ohBUaEo1bWSb06zTdSmle15OcY2jvJ6K4pTdStCV\r
\nFNy/dqz7KMadS/TlcXJSb0UXeVkcNr+p/wBsahPegbUlkJRf7kY+WJPokYVB7CtqCdOMfaayvzTf\r
\necnzTfzk2zKs4ym1T+BWhD/BBKEL+fLFX216LY6jxDfaB4gv5dRNzqEBnKkxiwt5ApVFTAf+0k3f\r
\ndznYvXpWUYzpppKL96cldtfHOUrfC9r2KlKE+VtyTUKcWlFP4IRhe/Mt+W+w218UWltc6LLtmKaO\r
\nR53yoGcC7kn/AHY8zBOxwMMy/NkZxhjpZ89WbsuekoJdpKk6bvotOZ7721tfQzk17OFKN/cqzndq\r
\n14ynCS0u9bRd1sn1e47w/wCM4/D6zSRxvJM+oWt5GpwqFIftG9HYMWRmEoClVYDk54GY9n7tKm9o\r

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 135
 \nRqRlZ2dqlJU7xfdWb1t0NpVV7SvVjf8AeOMoXS0cKyqrmV9tLO1+2m5sf8Jvbw3lvcm+1q+hivYr\r
\nhoLqQeXHDG+/YENzMLiXoEkJtlXbkod/yTGm4rlcYXUKkea2rlKm4RaVlybty96Wjsl1ZUqKfM1K\r
\na5pQahf3YpTU5Ju751olBcsdVzN9Cj4fgfxDY31gILuWBrqK6V7KKO5uIn/eoA9oZoneJ0chpUfb\r
\nDIqA7vMxT5fZxot2vDmjvaMlKMLpys+R3gnFyTUlzK11pfP7SpiORO1S0rac0UqknFqN1z/G4zim\r
\n+W8ZNrTm6XWfFsGkXl5pMM97YxFLAJcWUivPDNa2kcMkMoSe3SZfvJJiZNk0YIU8qM4xdVe00f76\r
\nvNae5ONSW6vey92MoSs7xfaVynJUFGl7y/cU4S6ThOLlPo7c3vuNSF0k7q6cbPjNV8Uw3tleWfmX\r
\n109xNZvFNeSLLIUt0nV97biY9zSho4lMoQZUysRubT2bvTaUY8s6kmo9pxjGOtlzSSj7ztHpZGXt\r
\nElNNzlzUoQTl/NGfPKyu+WO9lzSd9W9dL974r07VoJNPuhcw28kOnbZY445JEnsrcwN+5aeJXikV\r
\n5Np85GXCsUOSopwbm6i/5/VZpd4VVFNN/ZacIu6Ulo11ulGoowVPXWjClJ9nCpKonFdV7zTTcd7/\r
\nAGbOTwVc2tlfXl0kE8miRQlpDOQxDQss9oJXRFjEk1xCqJGOcSNGGfDOVUc40r3SrXTpW/5+X5Ul\r
\nf4uSFSTk7bJz5YrRFNRlWUUm6TjKNW+/snFuUmldRvKKlFe9aSjFSlKzfBQavc21+uqq2bpJxcBi\r
\nM5lD+ZkjuC3Ud+lb04qlFQS91R5bPrG3K1846X3MKknVlKctJSblp0bd7q99nqjq11Hw7HeHVvKu\r
\npX3GZdOkihNsJid2x7rzzJJbh8nYbRWdMRM3WQ86jOnD2VNp+7yxnLeKatzONmpSitnzRTklL3fh\r
\nOiU4VZ+1qcybblOMbWk9W0pN3gpO1/dk4ptJt2ZZ03xTpsbWF9dxzreaOGEcUKRmC52yvPBvkaVW\r
\nttskjK+yGcMgG0IeKqUZLndN/wASCg+Zv3WqfsnPq5PkSfK+X3l8VpaTzwkoxqKyhUlUSglqpVPa\r
\n+zs2lBc10pLmajL4W4e9DB4tt1utGupFlP8AZR3XGFTLk3klwfKG8A/K4HzlPmyOnJahyyqOPwyp\r
\nRpx7pxounr5X9XbpfQVSp7SEU/i9tUqSttac4ysuvR7+WrL1v4r0pmsZrqOZnsUu4SpggmjUTyXE\r
\nsNwiyylJJYXlUmCWMRsV3CUEAHNQnHm5HyuVKlHmV7xnS5Vps+WcY2ck4yhd2ubTqQm/ei3BV6tR\r
\nxaVp06u6b1tKMtUrSjJK0mle+pL8QrTy7aCWTUNR8p7xbia6KLI8F7biB/JXzpxCYvmKRF2RiN3m\r
\nJ5hRIdHmukowi6XJpq1KNSNSMndR5/ejrez5Uo3fxFKvyWneU5xrRqrmtGNuWcJQSTlyrllo0n70\r
\npPlSik+V0jVdH0HUIZrc3k0HkXMVxLJHCkh+0RSQqYbdZnVfLDgnfdN5hzgRAc7yjKpCpTlaKnFR\r
\nja8rNNSu9I6NpLlS0V3zNuy54yhSqUqsLycJqTvaOm1kk5a2u+ZtXbS5Uoty4qUIrsIizRhjtZlC\r
\nsVz8pZQzhSRglQ7AHgM3U6q9lzWTtqk7q/WzsrrzsvRGLtd8t2r6Nqzt0uruz8ru3djKYgoAKACg\r
\nAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKAC\r
\ngAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKA\r
\nCgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAK\r
\nACgAoAKACgAoAKACgC/pd7/Zt3Dd7d/kSLJtzt3bSDjODjOOuDj0NNaXT6xkv/AotfqZzjzxcL2u\r
\nXBqFpaSpc2MM8U8UiyK0twkqZVt2Ci20JOSP7/TPBpL3bLpqmu6aaavdWvff7tdUSTqcym1aV9la\r
\nzfXVv5edjRXxFbW0Xk2ts0an7STun3km4gMPB8pMLGDlQck9C2TuqWrpRvoouK76zpyu9tfctokr\r
\nNaK2q5W5e0m7y5oSdlZe45Oy1dk+Z92vNWSxdUv11GRJQhjZYYon+bcGMUaxhlG1SoKquVJchsnd\r
\nggCvtSl/NJy9Lu7/AB28u+5UVyRUO17dNG3LXzV3r100XXuvh347XwlI9tdqz2VwwYlOWikAxvC8\r
\nBgwwHGQcKpXJBVuWtS9prHSS/E76Fb2V1L4X+DPTbf4kaRpAu5zeNqBuJmlhgjtWhaNSOEZ2RFfH\r
\nALsxbC5AJOK5HRnKy5eWys23c7VXhDmfNzXd0lG1vK+n3nz7r2szeIL6XULjAeds7R0VQAqKPZVA\r
\nGe+MnkmvShFU4qK6HlTm6knN9SnYf8fEfb5hSn8L+X5oIfEvn+TPUMD+6T/n61ialC80a78QSRaf\r
\npyefczM2xdyJu2I0jDc7Kg2orHlhnGBkkClzKDUpaJf5FKLmnGK1fT53Hf8ACm/Fv/Ph/wCTNp/8\r
\nkVXt6f8AN+D/AMhfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58\r
\nP/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/h\r
\nTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/\r
\njH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/k\r
\nH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/\r
\nAJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8A\r
\nkij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/\r
\n8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN\r
\n+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+M\r
\nf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+Qf\r
\nV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8A\r
\nm/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCS\r
\nKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/y\r
\nZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34\r
\nt/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/\r
\nzD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9X\r
\nq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb\r
\n8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo\r
\n9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm\r
\n0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3\r
\n/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/M\r
\nP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er\r
\n/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvw\r
\nf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij2\r
\n9P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT\r
\n/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+\r
\nfD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/\r
\n4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8\r
\nv4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/\r
\n5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0\r
\n/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/\r
\nAJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58\r
\nP/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/h\r

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

136 PUBLIC Employment Objects
 \nTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/\r
\njH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/k\r
\nH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/\r
\nAJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8A\r
\nkij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/\r
\n8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN\r
\n+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+M\r
\nf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+Qf\r
\nV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8A\r
\nm/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCS\r
\nKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/y\r
\nZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34\r
\nt/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/\r
\nzD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9X\r
\nq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb\r
\n8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo\r
\n9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm\r
\n0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3\r
\n/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/M\r
\nP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er\r
\n/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvw\r
\nf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij2\r
\n9P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT\r
\n/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+\r
\nfD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/\r
\n4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8\r
\nv4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/\r
\n5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0\r
\n/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/\r
\nAJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58\r
\nP/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/h\r
\nTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/\r
\njH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/k\r
\nH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/\r
\nAJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8A\r
\nkij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/\r
\n8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN\r
\n+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+M\r
\nf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+Qf\r
\nV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8A\r
\nm/B/5B9Xq/y/jH/MP+FN+Lf+fD/yZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCS\r
\nKPb0/wCb8H/kH1er/L+Mf8w/4U34t/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/MP+FN+Lf+fD/y\r
\nZtP/AJIo9vT/AJvwf+QfV6v8v4x/zD/hTfi3/nw/8mbT/wCSKPb0/wCb8H/kH1er/L+Mf8w/4U34\r
\nt/58P/Jm0/8Akij29P8Am/B/5B9Xq/y/jH/Mr3Xwz8ReH4/7Q1C08m2hZN7+fbPje6xr8qTMxy7K\r
\nOFOM5OACal1YSXLF6+j7+hSo1IPmkrJX6rt5M1R/vY9uKZB1ngD/AJGbT+x3XHHp/olxXPW+E6qH\r
\nxr5/kfWVecesY/kj+9J/39k/+LoAPJH96T/v7J/8XQAeSP70n/f2T/4ugA8kf3pP+/sn/wAXQAeS\r
\nP70n/f2T/wCLoAPJH96T/v7J/wDF0AHkj+9J/wB/ZP8A4ugA8kf3pP8Av7J/8XQAeSP70n/f2T/4\r
\nugA8kf3pP+/sn/xdAB5I/vSf9/ZP/i6ADyR/ek/7+yf/ABdAB5I/vSf9/ZP/AIugA8kf3pP+/sn/\r
\nAMXQAeSP70n/AH9k/wDi6ADyR/ek/wC/sn/xdAB5I/vSf9/ZP/i6ADyR/ek/7+yf/F0AHkj+9J/3\r
\n9k/+LoAPJH96T/v7J/8AF0AHkj+9J/39k/8Ai6ADyR/ek/7+yf8AxdAB5I/vSf8Af2T/AOLoAPJH\r
\n96T/AL+yf/F0AHkj+9J/39k/+LoAPJH96T/v7J/8XQAeSP70n/f2T/4ugA8kf3pP+/sn/wAXQAeS\r
\nP70n/f2T/wCLoAPJH96T/v7J/wDF0AHkj+9J/wB/ZP8A4ugA8kf3pP8Av7J/8XQAeSP70n/f2T/4\r
\nugA8kf3pP+/sn/xdAB5I/vSf9/ZP/i6ADyR/ek/7+yf/ABdAB5I/vSf9/ZP/AIugA8kf3pP+/sn/\r
\nAMXQAeSP70n/AH9k/wDi6ADyR/ek/wC/sn/xdAB5I/vSf9/ZP/i6ADyR/ek/7+yf/F0AHkj+9J/3\r
\n9k/+LoAPJH96T/v7J/8AF0AHkj+9J/39k/8Ai6ADyR/ek/7+yf8AxdAB5I/vSf8Af2T/AOLoAPJH\r
\n96T/AL+yf/F0AHkj+9J/39k/+LoAPJH96T/v7J/8XQAeSP70n/f2T/4ugA8kf3pP+/sn/wAXQAeS\r
\nP70n/f2T/wCLoAPJH96T/v7J/wDF0AHkj+9J/wB/ZP8A4ugA8kf3pP8Av7J/8XQAeSP70n/f2T/4\r
\nugA8kf3pP+/sn/xdAB5I/vSf9/ZP/i6ADyR/ek/7+yf/ABdAB5I/vSf9/ZP/AIugA8kf3pP+/sn/\r
\nAMXQAeSP70n/AH9k/wDi6ADyR/ek/wC/sn/xdAB5I/vSf9/ZP/i6ADyR/ek/7+yf/F0AHkj+9J/3\r
\n9k/+LoAPJH96T/v7J/8AF0AHkj+9J/39k/8Ai6ADyR/ek/7+yf8AxdAB5I/vSf8Af2T/AOLoAPJH\r
\n96T/AL+yf/F0AHkj+9J/39k/+LoAPJH96T/v7J/8XQAeSP70n/f2T/4ugA8kf3pP+/sn/wAXQAeS\r
\nP70n/f2T/wCLoAPJH96T/v7J/wDF0AHkj+9J/wB/ZP8A4ugA8kf3pP8Av7J/8XQAeSP70n/f2T/4\r
\nugA8kf3pP+/sn/xdAB5I/vSf9/ZP/i6ADyR/ek/7+yf/ABdAB5I/vSf9/ZP/AIugA8kf3pP+/sn/\r
\nAMXQAeSP70n/AH9k/wDi6ADyR/ek/wC/sn/xdAB5I/vSf9/ZP/i6ADyR/ek/7+yf/F0AHkj+9J/3\r
\n9k/+LoAPJH96T/v7J/8AF0AHkj+9J/39k/8Ai6ADyR/ek/7+yf8AxdAB5I/vSf8Af2T/AOLoAPJH\r
\n96T/AL+yf/F0AHkj+9J/39k/+LoAPJH96T/v7J/8XQAeSP70n/f2T/4ugA8kf3pP+/sn/wAXQAeS\r
\nP70n/f2T/wCLoAPJH96T/v7J/wDF0AHkj+9J/wB/ZP8A4ugA8kf3pP8Av7J/8XQAeSP70n/f2T/4\r
\nugA8kf3pP+/sn/xdAB5I/vSf9/ZP/i6ADyR/ek/7+yf/ABdAB5I/vSf9/ZP/AIugA8kf3pP+/sn/\r

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 137
 \nAMXQAeSP70n/AH9k/wDi6ADyR/ek/wC/sn/xdAB5I/vSf9/ZP/i6ADyR/ek/7+yf/F0AHkj+9J/3\r
\n9k/+LoAPJH96T/v7J/8AF0AHkj+9J/39k/8Ai6ADyR/ek/7+yf8AxdAB5I/vSf8Af2T/AOLoAPJH\r
\n96T/AL+yf/F0AHkj+9J/39k/+LoAPJH96T/v7J/8XQAeSP70n/f2T/4ugA8kf3pP+/sn/wAXQAeS\r
\nP70n/f2T/wCLoAPJH96T/v7J/wDF0AHkj+9J/wB/ZP8A4ugA8kf3pP8Av7J/8XQAeSP70n/f2T/4\r
\nugA8kf3pP+/sn/xdAB5I/vSf9/ZP/i6ADyR/ek/7+yf/ABdAB5I/vSf9/ZP/AIugA8kf3pP+/sn/\r
\nAMXQAeSP70n/AH9k/wDi6ADyR/ek/wC/sn/xdAB5I/vSf9/ZP/i6ADyR/ek/7+yf/F0AHkj+9J/3\r
\n9k/+LoAuWibN2Cxzj7zM3r03E4/DrQBxHxV48M3fb5rX/wBLLetafxIxq/A/66nzKM/3QfxFeoeK\r
\ndX8P/wDkZdPx03XOPX/j0uOtc9b4TqofGvn+R9ZV5x6xx/iO5uLW0DWbiKZpreNWZQ4HmTxocqeo\r
\nIYg4IOOhBwQlfmgl1butrpQlK191e1rrVeew9FGbfSLem6810+/QqR6xNNdxIin/AI9rppbcbN3n\r
\nwyQLsDttH8bBSWVGVlc8EEPdScdVam430tzOaadr6pxtJK9nFpXe62UVKyfPyyava3JzXXWz0ktE\r
\n7NXtsVovFZdJ8Rwyy23kZW2ulmQ+fKYghk8uPZIrKSyFcY2/PycC1UXHXmnyJ/Zd1FqSfVa66X02\r
\nYP3W1LS0Zyt9pciu010e1tWr37aynxBdQswntkRYJ4YZmW4LgGcxiNogYFMgHmL5gcQlf4PM5w42\r
\nk4rbmcorvzRTfpytWs73u3eKtdp3jfyjz+sdb/8Aby5ZaWtove10LbxXDcah9gHlAGWSBcTqZ/Mi\r
\nBLF7faCkZKOEk3tkhcqocEKHvq67OStqrKVtX0bXvJfy3u01Ycvc084p30+JJpr+ZXcYvZ3b0aTZ\r
\n1lABQAUAFABQAUAFABQAUAFABQAUAFABQBzPiS9ltPsqxyzQLNOUkaCITS7RDK4CxmGcn5kXJEZI\r
\nXJ4GTSXxW1tySei6pwSvporN9itotq104rXzdn21tsZlp4ga1trq9aWS7s4TGsUtwiW7mYuYpImx\r
\nFCFjjfy90jQjaWkBL7MB30jsnKSUXfRwaXvN62s+ftdRVldpym3vNK/uxbkrapxu7JaXbjbTa9tV\r
\nd2ntvEbajJbCFohm7eCcQyLPEwFrLMuyXYuQfkJIVGDBkPAOWlrfW3JN2tZ80Zxj3821rZqSbs9E\r
\nm7KW106dtb6Sdn6dVZ66XWjTdPUvFVwkV1BEsEd1DbTTIEuUmki8ooCLiMRFYpAHDKgMqOyspcAb\r
\njK1s1bSdNO3w+9JppO26a5XorXutVZ6pJSUXs7pX0b91yi7fytK973Wl1rppRa5OvmReWHuTcpbx\r
\nxmUCLcbaOd8SCBXEarvbLRyOzDjAZUSt7KPV1HrpaMJyjfr15YpLurvRyMU9Ly25Kb06ubstO70c\r
\ntbJXsnbVf+EinlaOG2tlad1uDIrzGNI2tpFjkAcQuXVmb92wQbhgsqZO2G7JzXwqMZ9naXNpbX3k\r
\n42avbf3tFzaW1UXo3Pk8tYqSfezi77XTsrb2ZL4qA+zmOOMLdQxTKJrhYGcSnHlwBkKTSoOXQyRY\r
\n3R/N8/GvLacqfaSWm+v2uX+Xu029JJJtJSzvaHPaz9+66Jwto5d27paJaXva9mjXLq3u7hZI1ktY\r
\n7yG3D7wrp50cAULGIj5gEkm5meRCA3y7tuBEPeUU9OZ1En35XNq62StFRTve921bV1P3W3H7MIya\r
\n8m3dp97a20Wmjuwj1+5YxQW8H2iWd70AyTLGqi1n8vlkgPDAgJhCwO1XZstKEtUmltThN93zLZdH\r
\nK9v5U9X7trOmknJXtaagu2sOa/dJWfd9uiOlsLxb+3juUBUSoG2tjK5HKnBIyDwcEjI61TSWzurJ\r
\np901dP5ppkK+zVmm012abT/FMt0hhQAUAFABQAUAFABQAUAFABQBk69cyWWnXNxAdksUEjo2AcMq\r
\nkg4IIOD2II9RUvSy7ygnbV2cknbR9H2NIJOST8/yZyNxqd7bQzzWs13MkdpPIz3dqsAjlVVMXl7r\r
\nW28wn59ylZVAAJ28br2bVtOaml3bdRJxtfZxvd6WdrPXTOn73Jfd7pfDblbvfvzcqVnqnLR2utse\r
\nIJoFlS6gVLiJbcoiTb1kNy7RRKzmNNjeYpD4V1UfMrP0ot0jbm53C3TSMZNp2u0otv4U/d2u0iIv\r
\nRSls6bnfraPxK2ye1tbNytdWYP4guEK24t1N21x9nZPOIiBMBuFcSmHcyGMDP7kMG3AK2BuS963L\r
\n2k3fSzhKKadr7814tb3jflu3G37t3Lpy2trdTbin0taSafo2r6XrXPi5beCF2SGOaZp1Kz3IhiU2\r
\nzmOQCZozuJfAjHlqWBLNsCmldKzW3s41H/NaSVoqN9Zavql7urV0NK109LT5O61TabfSPKr7N3aV\r
\nt2uosbyPULeO6hz5cyLIueuGAIBxkZGcHnrVyjyNx7f1f5kRd1frs1e9mtGrrR2el1o+haqSgoAK\r
\nACgAoAKACgDh47i++xT6p9qkJt5LphAyW/ktHBNKuwkQrMMxpgP52Q+GO4AqUnyxpylqnGm5d/fS\r
\nva1tVe63Wlmncrl5pypx0s7R9eVNXvfS71tZ22aepZuPF0Fvei0PlBQ8Mb7p1SffOFKGO3KkyRrv\r
\nj3uJF25YhW2HNxV24/3pRVtdYq7b7Ju8Vu3JbJO5ne0FPvFT10XK207PrJJNtdrJNt2LFr4glnm2\r
\nvb+XbtczWqy+buYyRF8MY9igRv5ZAbeWEny7Cv7wwmuVSlpzQc11+FXkn2dlKSte8Y30bsVL3W0t\r
\neVwT6fGo2t3s5RT23ur2ZmW/jiGeOaRVicR28tzGkdwryMkRwVnQIDbyEMpC/vBgsC2UILV7J21v\r
\nTTSs0vaO2j2bi9JLRXas2ndVa0uTzlHXR80b9P5ZWk0+y1SbSel/wkEsAmS5gWOeJYDHGk28SfaX\r
\naKFWcxpsbzFxJhXVR8ys/SnZ7K3Nz8jXTSMZOSdrtKLb+FP3drtIhNaS2i4OafW0d1ba+1tbNu19\r
\nzOfxLcac1x9vWGJxcQwxI84SBd8IkLNcGFWCYDtloi2792F5BqU7pLq51E76WUYQl531fu9XzJu1\r
\nnarWb7KEZaa3cpyjfpbopdEotq/W1F4nkvVh+wwxzPNHO7ZuAsaG3kWNwsiRSeYrM37t1QbhtJCg\r
\nnaSfKpSs+WMIz10dpKWltfeXLZq9vi97Rcwuidrubhpqr25k79nHXa6bSave0uj6xcanev8AKq2j\r
\nWdrPGN3zqZvMJyPLHXaQf3hC7FKgmRgmnLy86e8ajin5csX8t79dW1sk3DfwWVm1PmXnGVnr5PTp\r
\ne7fRX6qoKCgAoAKACgAoAKACgAoAKAGSEqjEdQCf0rObcYSkt1FtfJFRV2k+6OK8N38l8lvLNdX8\r
\nkkkSu6PZrHblimWAmFjGNufuFZ/mwMM2ed5JRcrapJ76P9NfK3yM+6295rTXRSdu/Ra/oyzb+Ib2\r
\n58ny7SMfaomlh3XOBiPbv83EBKZ3jy9gl3ZG8R87c2+VNv7MVNr+61sv7ybV07Le0tEnb0bXTnlC\r
\n/wDeTlq1/K1GTum3eytrdVrvxvBbJDJtiUS2yXTrLOsTiNzjbCpRvPlG1/kBjB2qN2XAq7LncL6J\r
\nxV+vv7Pl6JKzk76J6KTTQrNLb3rzVul4aNc3S7dotqz1b5UjSfX5Fa52Qq0dtJHCjebhpZpRCY1C\r
\n+WQiEzANIXJUDIRhnEpOy0s3JxS/wykpSb6JKLl1bs1b4eYuum3Ipt/3Wm1ZdZNqyTstVrrZVrjx\r
\nO9jHILuKGCaO4S3G+5xAS8Qm3tO0KlECZ6xFiwChfmBpXT5bdXNa6W5Fdvre7aSS11TdtbO1r32U\r
\nYy01+KTgtNNmvefRXtey5iLxPJerD9hhjmeaOd2zcBY0NvIsbhZEik8xWZv3bqg3DaSFBO0k+VSl\r
\nZ8sYRnro7SUtLa+8uWzV7fF72i5hdE7Xc3DTVXtzJ37OOu102k1e9rMWvTXojNhb+dut4rmQPKIi\r
\nqTZ2LHlGWSTCPkM0SDC5k+bjRxtKUX8MZKN+t927dopxb1vraKbTIv7q6Salp0vHRpvzlpHSzs27\r
\nLe9Yat9uk8oIFKK5l+fPlusrRBPujdvKSENxgKODuyIWq5vKD+ck3KPrBpJ+q0RT0dvOS+S5XFv/\r
\nABKSaXrroZsI1DU45LuC4MDLLKkMHlxGEiGRowJyY2mJkKHeYpI9isAqllJdK6jGW7koyaeiSkk0\r
\nk1qmovd39+7s4+6N25nHZRfLdb3W8tdLX2Wl4papu6nm1ySCZl8lWggkhhnkEh3LLNswEi8v50Xz\r
\nY97mSMgMxVGKkGlZvTaUnGD726v+VNpxWr95fytSJd4rX4lHnkulru9n1aUZSs0rq1m27KqniK4l\r
\nYAW6JHLLc28Lmc7mlgEpyyCEhI28lvm3Oyn/AJZkYJybfI5LR+y9outl7t79Lrmut00lflbaWlrS\r
\ntuozjGXT4tmu+6T2d31SuUE8UXFhplteXqQEyW6yu8lykRkO3cVgTyv3kxX52jxEisyokj8svRJJ\r
\nVPZrTVJJavVpNpdYxutW032REU2nb+aS10Ss3ZN9L6paPSLbtsbc2rXTySpZW6ypbkRu7zeWwkaM\r
\nSfKhicNGgdC7bw3LbI5CoDYSbUJS2+Oz3+C92125k4re7WqUXccbPlt1UZW20k9r/wA1rya0Vre9\r
\nd2Vjw9dT3um21xdbfOlhR2KnIJZQd3CIAWGCVC4UkqCwAY7zSjJpdP6+fr+BCb1v/NJL5Nr8NvNa\r
\n7uxs1mUFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFAHIR+LIZr1rFfKH7yWFMTqZ/MiVixe22g\r
\npGSjhH3tkhcqA4xm23TlOO/JKatqrJ217Nq0krP3b3aasVblkk9rwTvp8aTVu61UXs029LJsxLbx\r
\nDfPp9kWk/wBJkng899ifNDI8GQBsCqWW5iGVAPDYOea6Gl7SMfs2mmv70edRv25uSU9PJbaPN6Rq\r

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

138 PUBLIC Employment Objects
 \nv+Xm5fJJN39Itcmv5nRyeITDfCwlSJDIzqgFyjXHyxvIJHtwhCROEO1vMZuU3IpYquF/dm+sYSlp\r
\nra1tG7WUmpJ7SXqaWs12bitdL8zS93ulJ2ez0bW2rNA1SbUJfnYmM2VnOqtsLB5vP3ksiRgkhFzh\r
\nVXIyqLkit2uXnXao4r05IPu+rfd+ZD0cbdfaX/7dmor8P+Dd6nVVmMKACgAoAKACgDktdvpYL23t\r
\nxNc28UkM7t9ltxcSFkeELlfs1yVUB2yQqjOAW6ApauW+ihbTTVzvd28lbXuU9IxatrJp+nK3p8/w\r
\nGWWr3ymG1kiMjyi4kEkxEEgt4pUVHeNYT+9ZJFOzZEMj5ljyQqk7RbejjTjKVnf3nzWS3V/dTd7p\r
\nNyX2UpJKz01TnyxurX91N32fLfmSdrtKL1vzEcfiS4FtHLFB5+2xivJWkmVG2sG3KNkG15fkJGFi\r
\njbnJjwAdJ+5KSfwxlFO2/vdUm+ltby7WvrZJN2jH4pSqJJ6L3JJbrvzK2jt1bNCPW5yZo3t1SWKK\r
\nOdF88bWjlZ1BldkRYjHsLShfNCrkxtKcAy/dTvZOMuWWvurRPmva7W/2U9NUk7oj73K1e003HT3n\r
\na3u22TfNG3vNXb1VtaUHil7pUW2ignme5Nt+7ut8GRAbjes6wksoX5WHlAh8jBxk0ldxWqTjKTv0\r
\nUZqLsut73jtrZOyvJJ6Xb6cu2vxtpX2s01qu2qvsbGn6sb6TyggVkVzLh93lusrRBPujcHKSEN8v\r
\nCj5Tu4larm6Wg/nJNyj6waSfqtED912e95L5Llaf/bykml2vfVGzQMKACgAoAKACgAoAKACgAoAK\r
\nACgAoAKACgAoAKACgAoAKALVt3/D+tAHDfFX/kWrvH961/8ASy3rWn8SMavwP+up8xZXuT+v+Feo\r
\neKdb4A/5GbT89d1xnrj/AI9LjpXPW+E6qHxr5/kfWVecesYF9YpfxrFIWAWSKUbcA7opFkUcg8Fl\r
\nAbuRnBB5oWjUuqvb5xcfyb+YdJR6STT9GZ134etby4kupN4aa3ktpFVsKySbdzEYz5mEVQ4IyoAY\r
\nEKuJtZSitpOL9HG7TV9OuqaadttXer6xfWDuvx0fkrtq1mm3qQx+G41LtLPPM0iwqS/krhbeTzYw\r
\nBFDGowxIPy5KkjPQjS+t+vMp+slpf5q1/wDCtne+drJRWyjKCXaM0k/utpfu730Ltxo0NwJQxcef\r
\nLDM2CvDQGMoFypwp8pdwOScnBHGJXu8rX2ZOS9WrfcU9b+cHD5Pm/H335badyDSFtrgzpNMIy7yC\r
\n33KIRJJ99sBBI24ln2PI0YdiwQNtIF7qtvo0r9E3ey9Nk3dqPuppaA9ddtU3brZcqv8AK2isnZN3\r
\nd29agAoAKACgAoAKACgAoAKACgAoAKACgAoAp3Nil1JDK5YNbSGRMYwWMbxkNkHI2yE8EHOOcZBF\r
\no7/3XH5Nxf3+6vxB6px6Np/+Au6KE2gwStOwaSMXexnVCoVZYyCk6ZUlZhtTJyUbYpZCRylorLS0\r
\nuZf3X1S/uyd3JO6d5dJSu93d/wAvI/70dVZ9dE2k007PfSNnpoygxNLNPO8ErTB5GTJZoniwQiIi\r
\noEc4WJYxuG45JYs9NracsovfVSak9d73VlrZLRKyVl3Xdxfpy2tZbdNdLvXUzU8JW6p5LTTvEsEt\r
\nsiEwgRxShQyqUhVmI2KQ0jO2Rli2Tk1762jrpf3GnB2tyrls7JK1m1a1rVez5l0k526Xlzc3nZ8z\r
\n632s1re3/wAI/GEYCWYStMk4mBi8xZUiSHco8ryvmjUh1MZU73wACAr7W0s5bdpttp3vdXenZqL3\r
\nSZCVtOnLGNvKLvHazunb1trdXvNbaFBaukiM5eOOZCWK5c3DpJLI+FHzs6Z+XagyQEA2hZaTjKG0\r
\nXGMbLoo81rXv/M7t3ber1veuqb1alz/O1reiWiStZJIqt4bjMKWgnuFt0hjgeINGUljjGBv3RMyM\r
\nw4doDCzDHOQpFt3lzv8AmUkuikrNNdd0na/LdbayvPRpaX5k35Tvddurs7Xs7X0VrcmiQSeZlnHn\r
\nXEVy2CvDw+VtA+X7h8ldwOScthhkYle7y2+y5Nf9v817/wDgbt8vm3rdd4KHyV/x1/4BmTeGm8+F\r
\nraeWBIftbM6Mnm7rqRJCAGieMoDvHzLuX5CCWG4JK109vZwgvNR79VpbWNnfsr3pvr1c1PyVoSjo\r
\nvmtHdWv5HSWttHZRJbxDbHEoRRnPCjAyTyT6k8k8mrbu77emiXkvJdCErK34vdt6tvzb1fmT1Iwo\r
\nAKACgAoAKACgAoAKACgAoAqX9mmo28lpKWVJ0aNiuAwDAg4JBGcHjII9qOz7OMvnFpr8VqUnyu6E\r
\nvrFL+2ks5CwjmjaNiuAwVhtJBIIzg8ZBHtQ9Wn2kpfNNSXyuiYfu7JdFbX0sU7nRILlpXZnDTxxR\r
\nkqQCnkO8kTp8vDq77sncuVX5cZBNttHz89+zsl9zSs073TaejsJJJRj0jGULd4y3va3TqrW6ajId\r
\nBhidJmeWWaOYztI5QNI5iaAbwkaIFWNgqrGqAbVJyd25r3dtFaSt/ikpSfe7a9EtErJJD1un15fk\r
\nou6S8r3b7tt7sjbw/GqKsE09vJG87rLGY9+LhzJKnzxOhQsQR8m4bEIbIJM2skuigoW2ula17a3V\r
\ntGrNXlaybKvq5d5KXo0uXRel1Z3Wu21tuKMQosYLEIAoLMWY4GMszElie5JJJ5NU3dt7X7aL5Epc\r
\nqtr89ySkMKACgAoAKACgAoA5tfDaANC1xcNbSSPI1ufIEbGSQyspZYFm2F2OV83lfkbKEqSPu8vX\r
\nk5eW/wDdXuvSydrJq+l0m0werk9ube3muV73tdaaa9VZ6l19IU3JuUlmiDsjyRRsqxyOg2qz/IZB\r
\n8oVWCSIjqiq6sMgi93zV20nsm1Z2/OzulJuSXNqD1VttErreyfMl5at6qzs2r2tbP03w81rK01xK\r
\n74ubi4jhDKYVMrvtfmMSbxG5BUuYwxZlXd81EfdjGL1ahya9LvW3r3d3ZtK0XYJe821om4v15YRW\r
\nvzV7Ky0i3qiYeHIhBLama4aCWJ4UiLoEhjfqsYEYyVGFRpjKyKNqkAsCLpfVpwd3u+R3V/X7TteX\r
\nVt2KvaXOtNZO3RuW7fXe7SvZXdki1caLBcPLI5cNPHDGcEDZ5DvJE6cZDq77snIyq/LjOTbbR83P\r
\nfqnZL0tZapppptO6diErKMekYyhbvGVr3tbp1VrdNbMqL4bRQ7G4uGnklSbzyYvMSRE8sFAIREAY\r
\n8oymIqVZuMnNC91JR0s5P150lJO97p2TS6OzVuWNn1bet4qNuloyco2tbVN387a3vK9yHSI4njla\r
\nSWWSKKWLdIwYsJmR3ZvlHzZQbQu1FBKqgUKFTSalHZSjGLt2imlvd3fM7t3bevce1vKTn83dW00S\r
\nV9ErDNP0SLTHR4XkwlvFbbWKEMsJby2b5A28bmHysqEMcoSFItu7k/5nzejsk7eqSve+2ltbzbby\r
\ncn/4G7tel9V182bNSMKACgAoAKACgAoAKACgAoARl3Aqe4x+dTJcycXs019407NNdDD07RH01Y4o\r
\n7y5eGBQixOtrt2qNqqWW2WTAGORIGOOSeatvmu5a3vf5rfS3r28raE27aa3+93e99/8AhizbaRDa\r
\n+RsLn7JG8SZI5V9mS2FGT8gxjA65B4xLV013gofJW/HT/gDev/gbn83zfh7789te9FPDcUKRRwTX\r
\nEAhiWBjGyBpYkOVWRjGSCpLYeExON7YYZGLv73N/hdul46J99VpLW0kkpJpJA9b925u/Ve0d5W6b\r
\n2tdNqys97y3mjhoblYAXku5Flw0nlhZEWJUZHWKQoU8pXXMcnzjkFTgRqlFR05ZNp9dZOT6NPdq1\r
\nrOLs92PS93/LyNd1Zq26et2m07rdaooWPh+YxSNezOLqSdZ1lidHeNkjWIYZoI4m3IGDD7MibXK7\r
\nCRvatEoqOluZvz5tGtb3Wz1+0k48qUUl1d9nGMbf4ZOSelrWk9lva8nJylfWh0iOJ45Wkllkiili\r
\n3SMGLCZkd2b5R82UG0LtRQSqoFChZaTUo7KUYxdu0U0t7u75ndu7b17j2t5Sc/m7q2miSvolYqL4\r
\ncihSNIJriDyoUt2MbIGlij+4sjGMlSMth4TE43thh8u273k5Pq1Jrpdde+qsmr2kkk07C6ed5NPq\r
\nud3aV9LXs1dO1tN3e3plg1o880ioslzLvIRmYBVVUUbmVCSdpdhtADuwG77zStIqPnKT7c0nd28t\r
\nlfS9r2WyT+JvyjFPq1G9m/PVrd6W1bu3Wn8PRymRVmuIredi8tvG0YjkLHMnLRtMgk/jWKWNTljg\r
\nMzFkkklF6xWyey1vbpdJ62d19m3J7pTbvzLSVkrrfRWT7J2srpJ6J3urkkugwyzebvkSMtG726lB\r
\nDI8OPLdgUMgK7Y+EkRW8tA6sAQaTafNu7uSv0clZteur1ulJuSSk7k205VouXl0/lTvy+mrTtZtN\r
\npu1knR6HBGIgC5EE81wuSvLz+dvDYUfKPObaBgjC5Y4OZtpy9PZ+z/7d938fdXlvoU3dyf8ANKMv\r
\nnG1reWiuZjeEYPKECz3CobcWr48gl4FL7EYtAduwOyho9jMMFy7ANTd22293GT6e9HaXrs7fDfaK\r
\nu7idmmtLOTXlztOS9G11189raJ0NBKZUmnjVyjSxoyKkrooUO5CeaCVVA4jkRHCgOrAsGHrdNaNy\r
\ndui51Z28tW0ndKT5rX1JS5UktGko362jsu3fVJPXfRWvabYrpltHaIzukKhFL7d20fdU7FQHaMKD\r
\njJABYs2Sabcnd79fN9/V+Vl2SC1m2urbt2u7u3W1+9y7UjCgAoAKACgAoAKACgAoAKACgAoAKACg\r
\nAoAKACgDHi0ZYJmlSacRszv5AZRCHkHztgIJDuJZ9jyNGHYuEB2kTb3XB7OLivJN3summybTaj7q\r
\nstB31Utmmm/NxXKr+VrXSsnZN3d26UXhW0hChWl/dpaoCWXpaOrofuY3OVQSkAblRQNuAa0v7zn1\r
\ncuZ+vI4W9Em2vNt+RLV1b+7OPynLmf47eW9x6+G4kmEomnCJNJcLF+62LJKHEh3eT5rbvMfh5WAz\r
\ngYAAGdrR5OnLKC8oy6dtHZptXuk23eV6bu29ruLfrDls/L4UrKys3ZLS1vTdGh0ogws5xBDb/MVP\r

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 139
 \nyQb9h4VfmPmHceh4wo5zo5Xv/elzP1aUfutFE228ub/yeXM/x28u5r1IwoAKACgAoAKAKb2KPcpe\r
\nEt5kUckQHG3bI0bMSMZyDGuMEDBOQeMC0vb7XLf/ALd5rf8ApTv8geqS7O/zs1+TGy2Ectwt0Swe\r
\nOKSIAEbdspjZiRjOQY1xyBycg8Ylq6lHpNJP5c23/gT/AAHf4f7suZetrfcUYvD9vDCbdWk2m0Wz\r
\nySufLQOA33cb/nOTjb0+Ud7l73Nf7TTfyvt94RfK4yX2XKS9ZtSf4xVv1C70CC8LM7SKzxwx5Ur8\r
\nv2eRpY2AZGUsHbJDhkYAApjOS7u5LRuanfs0raX8vmt000mpSUYqHRRlH1U1FO9rfyra3W91oMtv\r
\nD0VvKLh5ZppRP9oLOYhuk8g2/IjijUDyyOFC/MoOeoIvd27SX/gbjJ/+TRv/ANvS6WSHre/Xl/8A\r
\nJJOS/Oz8kut27OmWDWjzzyKiSXMu8hGLAKqqijcyocnaXYBQAzsBu+8yXuxUP8Un25pO7t5bK73t\r
\ney2TesnLyUV3ajezfnq1ppZLrdvWoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKALV\r
\nt3/D+tAHC/FX/kWbv/etf/Sy3rWn8SMavwP+up8zDdjgj9a9Q8U6r4f8eJtP7Ddccen+iXFc9b4T\r
\nqofGvn+R9ZV5x6xB9nX3/wA/hQAfZ19/8/hQAfZ19/8AP4UAH2dff/P4UAH2dff/AD+FAB9nX3/z\r
\n+FAB9nX3/wA/hQAfZ19/8/hQAfZ19/8AP4UAH2dff/P4UAH2dff/AD+FAB9nX3/z+FAB9nX3/wA/\r
\nhQAfZ19/8/hQAfZ19/8AP4UAH2dff/P4UAH2dff/AD+FAB9nX3/z+FAB9nX3/wA/hQAfZ19/8/hQ\r
\nAfZ19/8AP4UAH2dff/P4UAH2dff/AD+FAB9nX3/z+FAB9nX3/wA/hQAfZ19/8/hQAfZ19/8AP4UA\r
\nH2dff/P4UAH2dff/AD+FAB9nX3/z+FAB9nX3/wA/hQAfZ19/8/hQAfZ19/8AP4UAH2dff/P4UAH2\r
\ndff/AD+FAB9nX3/z+FAB9nX3/wA/hQAfZ19/8/hQAfZ19/8AP4UAH2dff/P4UAH2dff/AD+FAB9n\r
\nX3/z+FAB9nX3/wA/hQAfZ19/8/hQAfZ19/8AP4UAH2dff/P4UAH2dff/AD+FAB9nX3/z+FAB9nX3\r
\n/wA/hQAfZ19/8/hQAfZ19/8AP4UAH2dff/P4UAH2dff/AD+FAB9nX3/z+FAB9nX3/wA/hQAfZ19/\r
\n8/hQAfZ19/8AP4UAH2dff/P4UAH2dff/AD+FAB9nX3/z+FAB9nX3/wA/hQAfZ19/8/hQAfZ19/8A\r
\nP4UAH2dff/P4UAH2dff/AD+FAB9nX3/z+FAB9nX3/wA/hQAfZ19/8/hQAfZ19/8AP4UAH2dff/P4\r
\nUAH2dff/AD+FAB9nX3/z+FAB9nX3/wA/hQAfZ19/8/hQAfZ19/8AP4UAH2dff/P4UAH2dff/AD+F\r
\nAB9nX3/z+FAB9nX3/wA/hQAfZ19/8/hQAfZ19/8AP4UAH2dff/P4UAH2dff/AD+FAB9nX3/z+FAB\r
\n9nX3/wA/hQAfZ19/8/hQAfZ19/8AP4UAH2dff/P4UAH2dff/AD+FAB9nX3/z+FAB9nX3/wA/hQAf\r
\nZ19/8/hQAfZ19/8AP4UAH2dff/P4UAH2dff/AD+FAB9nX3/z+FAB9nX3/wA/hQAfZ19/8/hQAfZ1\r
\n9/8AP4UAH2dff/P4UAH2dff/AD+FAB9nX3/z+FAB9nX3/wA/hQAfZ19/8/hQAfZ19/8AP4UAH2df\r
\nf/P4UAH2dff/AD+FAB9nX3/z+FAB9nX3/wA/hQAfZ19/8/hQAfZ19/8AP4UAH2dff/P4UAH2dff/\r
\nAD+FAB9nX3/z+FAB9nX3/wA/hQAfZ19/8/hQAfZ19/8AP4UAH2dff/P4UAH2dff/AD+FAB9nX3/z\r
\n+FAB9nX3/wA/hQAfZ19/8/hQAfZ19/8AP4UAH2dff/P4UAH2dff/AD+FAB9nX3/z+FAB9nX3/wA/\r
\nhQAfZ19/8/hQAfZ19/8AP4UAH2dff/P4UAH2dff/AD+FAB9nX3/z+FAB9nX3/wA/hQAfZ19/8/hQ\r
\nAfZ19/8AP4UAH2dff/P4UAH2dff/AD+FAB9nX3/z+FAB9nX3/wA/hQBIkYj6d6AOA+Kv/ItXfb5r\r
\nX/0st61p/EjGr8D/AK6nzHgf3Sf8/WvUPFOs+H//ACM2n/71xzxz/olxx+Fc9b4TqofGvn+R9ZV5\r
\nx6xl6yt8bYnTJYLedfm3XFvJcxlQCSvlx3NqwY8YbzSBzlGzxjUk6cXUVrRUpNd7Juyd9Netn6Gk\r
\nEpPlfWyT7NtatW10vpda630s+I0LxXqEejWmr6v5V7NqqWptLTT7Y28pkniMrRbrrUJIpCqBnMjv\r
\nbKqROxySFHXViqVT2EU5T5p6qyXLGPM5NfZSs7vmd3KMUuZrmyjd88m0oQcovR7qp7NbX+OTikra\r
\nN3lLlTa1JPHMHk28lraXl5cXa3DfZIRbLcRfZHWK6EgnuYYt8EzLEyRSyu7nMKyRguM9no7wUI1H\r
\nNJtKE9YS5be0fMruyg5JpxklJqLpJ2d/daqKnZ2T5mpSWvw8rjByUm1FxcZJtO4/TPE1xqGvXOlG\r
\n2kjtILKzuo53VEYtcNOGV0abzlyIwqI1tG6PFOJSAYd9KPuzcrJwqumrNNNKEJXTV09ZXvdJxlC1\r
\n3zWluyoyin+8hKTTVnGzSSadrWv7y1d3G20rdpUDCgAoAKACgAoAKACgAoAKACgAoAKACgAoA5Lx\r
\nhrdzoVtFLa+VEJZ1jmu545Jbeyi2O7XFxHE8TGIFFiLGaCOIyiWWVY0YNF/ejFtRi1J8z2ul7sFq\r
\nknNuycmlpypSnKMXaXuylZtxStGO7vJJvZ6QTc5JJtqL+FXnHAtPHb2llFPeLHqpur42VnPpBheG\r
\n9ZonmVkR7yQW+1o5LeUS3LKksZlZ1hYtHra7hBRkpyjOXK7bQeslJ8qs4fvEt0lKHvSUeeP+fkua\r
\nLhBQd1e6c5RhyNK/vc8k1bRwlF6PmitZvHEDW8ElraXt1c3DXC/Yo1gW5iNo3l3Rl864igAgk2xl\r
\nkncSNJH5BlVw1Q2o639zkVRzSfLGDsrtW5ua7a5FFz9yp7vuStSTd0/damqdn1lJOUUmrxtKCc1J\r
\ntQ5be9dpNX8e6aLe5vIvNmgstOh1NnRV/eW84nKCMO6N5mLd9ySCMLlQWzuC6ODi+V7+2jR/7el7\r
\nOzutHD97F3XS7SelyEXNwilZzU3aSacXTajKMlupJu1tdU72LY8Vo+oHT4bW7mSKSOGe6iSFoIJZ\r
\nYlmRJV84XWDHJEWlS2eBPMG+VQspjUVzX6K81FvaThfmSavy2s0ufk5mko3coc2XNaMZrXmhCaS3\r
\nUZzcE2vVNvlvaKcnonZlr4xtrrUP7PWG4WNppraK8YRfZprm3UvNbxlZjOJIwkoLSQRxM0MqpIxA\r
\nDTD348y091zSe8oRn7NzW6tzNWu1KUZKcU4XktJ/u9HrZxUrfYc488ebbSScdVeKlOEG1N8p1tAg\r
\noAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgDyOL4g3w0rVrue\r
\nGGO608alLZYDmG4gsp5rcFxvDCWOSJRcIrgbZYZEZfMKRkPejRb+Kbw3tF0SxElyyh5OLkrNtxnB\r
\n8y5JU3PZQXt5UNeRaKXW6gpSi/NXUk7JSjJqN3Tm11lz4ztrO7+ySQ3DRRvbwz3iCL7Nbz3W3yIZ\r
\nN0yzl3MkPMUEscfnxGV0BYrUVzScVp70owv9uUI80lG3ZXV3aLnGVOLc1ynLFv2cast3TjUkle6g\r
\n21z6/ZTU20m5RjCUpJRs32FSaBQAUAFABQAUAFABQAUAFABQAUAFABQAUAFAEczmNGcdVUkfgM1l\r
\nVk6dOc1vGMmr7XSbLguaSi9m0vvZ5RpPj++vNCtdQuYYYdRmm0tZYwHMJg1G4hjSeHLB8NFI4G5m\r
\n8u4ikjbzVTc/Y4JVY0le3NOnPup06MqjS6OLajKL19yfK7VFNRz2Vd/8+41ZQfSSg2tfNSTjJaPR\r
\nTSUJwb66DxjbTX4sfJuEieeW1hvGEX2aa6hVmlt48TGcOnlzAvJBHCzwyIkrMFDYQ99XWj5XOKej\r
\nlCMuVzXS12mrtSlCSqRTheSqa9nvrZwUrfYc0pQ5ttJKUdY3ipTjFtSfKutoEFABQAUAFABQAUAF\r
\nABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQBwn\r
\niPxVc6Dq9naLEklhNb3VxeSfN5sMcMlrEsqYO1o42uN9wGGRCGkVsx7JHT96U4y0SVKMWv8An5Vn\r
\nOMVL+6+TluvhlKMpNU1OUXNctOM46ydTl5e8VFylb+8knJLVys4RTnKIg8ZNby30c0LXD2+ox2Fn\r
\nBahPOuC9lb3RGZ5o4dyiSaRnaSGNYYsn5h8yWsabSblN1bpbRVOpUjzO9rK0Em29ZyjFayjEckoy\r
\neqUFSpzbd3rUk4JaJ7y5UtNL3k1FNrqNG1eHW7VbuAOgLPG8cgAkilidopoZArMu+KRGRijuhK7k\r
\nd0KsaatZppxklKLV7OMldNXSa800mndSSaaI6uLTTi2mn96el01JNSi07OLTWjNSpGFABQAUAFAB\r
\nQAUAFABQAUAFAHGLfaxfXV6llJZxxWMyxJFLbzM8p+zwzHdOt0ix7jKUDC3k2ABtr/dPRanCnCpN\r
\nSk5c7fLJRso1JQ0TjK7tG+6u9NNzlk6kqsqVOUIqKg7yg5O81d7TjovQe3jO2SCGcQzyLJbLdzeW\r
\nIz9lgY4Mk2+SNioIfiFZZCI3YJgDN+wfPKmpRSUowjJ3SnKfwJWTs2rN3tGPNHmkk7i9vyxUnCTl\r
\nabcI2k17N2qW25uWTskvem/gi9bNtfE9xJNfRNZzyi0ukt4BAIS0oaCOUks1xsTG4vvlaCPy3iTJ\r
\nnLR1PslyU5cyTmpuV7pR5Zyj28lGy5pOSk0uSzD2r55xUW4xjTcXGz5uddPe21um7JJNyexV1Lxi\r
\nYrZ7i1QpIlnfz+TPGCVlsnSN0keOfA2yMVKxiRZB8yTIFHmXCjeSTacXLDq8W17tdvVJxvey68vK\r

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

140 PUBLIC Employment Objects
 \n91K+j9rto4v96nFpNpwhzrVStZ6O6crp20eptr4hU3X2NLe4lCNHHLPGsbRQySxrIquvm/aMbXQm\r
\nRYXiTeN8ihZCmfsrpy5kl73Kne8uS6dmlyp6NJScW2rRT5o80qtpD3ZNuNOUnFK0faPlV03zWvq3\r
\nFSUY+9JpKVuhrnOwKACgAoAKACgAoAKAPPPir/yLN33+a14/7fLetafxIxq/A/66nzIP97HtxXqH\r
\ninWeAP8AkZtP7Hdccen+iXFc9b4TqofGvn+R9ZV5x6wyVPMRk6bgRn0yMVnUj7SEqd7c0XG/a6tc\r
\nqL5ZKXZp/cefX3w/ivdBsNDkeCd9JFv5T3VotzbSPBCYCZrNpVDo8byYQTK0blXWTcgzvVl7Sr7d\r
\nJJ3ldNc2klqk9GmnyyUlZ3jZ3jKUWRfKqkdbVHJuzs1ep7VK9ndXSjJW96N0uVtNU7z4dtPplvpU\r
\nTaYYYPNMkNxo9vLZmWViwmt7WKa2NtJFudIm86XMbnzvOl/emJrnkruSSgoJ3/exsrOUKlrQctZS\r
\n9xxUlBwUFGSmQfs7tWu5uTVvckr6RnHVyUUkk+ZNq/M5Xjy9HpHhh9Hv/tkdw00R0+1snWZC8zta\r
\nNKY5zOHUZdZ5BKphYu211dAGVtXPmdRtJc9T2iS05W4qMl1urRjy7NPmu5XXLjGPLClBPWlGUb91\r
\nLle3Rpx7tW0tfU62sjQKACgAoAKACgAoAKACgAoAKACgAoAKACgDF1rTru+SNtPuTZXNvJ5iMyGa\r
\nCQFWRo7iBZYTLGVcsoWaJ0lWORX+Uqy1UlJWtZxaaumnZ3WqalFpOMk9uaLTjKSb0taSfdNOzTV7\r
\ndGnF3alFppp3XLOMJx4DVPBureZbXdtPC+oSaql7c3CWwjto1jsLi1Qi0e6Mrqw8qOUC7ady7Mkk\r
\nSKoiqHuSShpFRrN83vXlV5E0kuXlT5bxS0U7znzOUuZt80anN8ThRhFLTSnXjV1b5k2rzvteCUI2\r
\nkk3rjwZeWqwXNjeRRapEbszXMtoZYZhfOstwot1uYWjAljhMH+kOY0jCP525mM8qS9nG8aThySSa\r
\n5n7zn7RStZVHKdWTfI4N1ZNw0hyid7upq/aKouiXLB04xa1bgqVou0lJuMZOW6lmah8NZWtpLDTb\r
\n0WtvdaXHpdx51ubmV44RP5UscguIFjkJuJPN3RSq4wEERG6tOb3+Zpciq06qitLSp8iUU9fccadN\r
\nWtzKzfNeWjjJx5Jt3nF1HKWi5vbSjKbUVpGXMpOL1inLWMox5Xp3/geTUNWi1OWa1228kUkb/YEG\r
\noxrEAfs8WorMpW1kfcZYntpHeOWaLzQHUooPkk59Xz7e7zc8XG1XdT5VL3LKFuWk3zShJzwcf3So\r
\nX0UYLXWzhKLcoLeDlyK93LVytZNRUOm/Du30zWn1eMWOxp57lT/Z0P2/zbgMXV9RZ3kaEPJI0axw\r
\nxSqCkRnaJCjzS/dR5F0i4K3urlcrrmS+Jxj7id0pL3pqU/eNan7xpvvBu+vwQ5Eop/CnaMn8T503\r
\nFxUrL0igQUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQB5rqn\r
\nw6TUtDn0X7S0M0019NFdpEN0X26eeWSMxlyJIzHO0Lguu8ASL5cgQo4+66ElvRVGL7TjT5G0+yk6\r
\ncZLflnGMve5bPVTtOpUt8b5kv5ZKChGSfdWd9FeMpQekne9eeDJbi7kaO6WLT7ue1urq38gmaS4t\r
\nBEEMVyJ1WKKQW1uJo2t5WYI4SSMykq4vlab1UJznTW3K5p3Ut+aKnKVSOzU5aycIqBz2tTVNP3vZ\r
\nKjKXemnK9l0lKM5wbbklFx5UpR5n3lSWFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAMlTzEZOm4\r
\nEZ9MjFZ1I+0hKne3NFxv2urXKi+WSl2af3HnM/w7SXT9KsUuWim0Y2KtMsQxcxWckMphkjLnaskk\r
\nCOrB2aFxlSytIknU53rvEpWvzXj0d4VIxd+8PaSadtpTjb3rqHrCpT6z9paXWHtJNyXmmrKS0UnG\r
\nEt4RtftPB0ttepIblTp1vdz38FqsBSVbm4EvmeZc+cVlgD3FxIkQto3VnjDSsse1soe4lfWUYOnB\r
\n7KMG9LrrKMEqcZXXuXclKb51U3z3tpzuDqdeb2aikltypuEJy+KTlF2koycTuqQgoAKACgAoAKAC\r
\ngAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKA\r
\nMG70JbvVIdTdwVgtLq1aEpkOLmS2csWLYAUW+0oUbdvzkbcMklapCSuqigmvKHtL+vN7S3S1ut9K\r
\nbdoJaOFTnTW9+Rxt5Wve/l8zkLP4dyaXHKbO8/0hdRF/ZyTwectuBaJZC2kRZomuIxbB4w/mwyYZ\r
\nGZmeMs9c0kqet5RVSM5PV1I1Jym+bVWlzOEnJP3pwu1yylATtJz0tCUacVGNkoOnLnXLo0o82nLb\r
\n3YNwi1o12egaQdEtPs7yGeV5Jp5pduwPNcStNKUTc/lx73Ijj3uUjCqXcguzdkowgrRhFRjd3dl1\r
\nk7K8pO8pNJJtuySslOrcpyesnfRWSSSjFJa6RhGMbttu12222bVSMKACgAoAKACgAoAKACgAoAKA\r
\nPPpka1uLyS11WxtobuQySh4g80JjhaCTZL9tSNSi2Nw2ZLdxG0E+9WEMgHWkpQhSqU5vlulyvlup\r
\nz57fBJ6+0SumtGrWbRxSfLUlVp1KcbqKalHmtyKS/nj/ACyumvsy7MztV8NaNMYvLuNOjW1thaML\r
\nuG3u2SKBpzuiM0irDMnkXnmO6SoTDKZIj9nfG8KtRSlNxn781O0HKGuitdJtwknBWVmlbklFyu8J\r
\n0qThGCnC8Izjeoo1PivzTabX7xShKXM9LqfPGS2salpdpI11t1CzjimuFuGgnVZIcw28tvNFcoLm\r
\nETQBbOWTyz5QiktZmkMixOqZxlJKF4SbjzpPW/7yamnG6dpqU1aeuklZKTUjScYe9y1IRTjCLWll\r
\n7PmTTSlH3JQjKM4afDLXlUoFBfDVhbWr2jajaRKtvqVuQiRxRxC8leWQrH9oOxLdrO6HlluFhlDM\r
\nvkSGtPazclLkm3fDu7bbfsJNxu+XVzjOCbtvaVveSURpwp6c9NWlVk1FKMVz03CSS5nZRcJytd6J\r
\nxb91yNS/06zuNQS9nvrBVtXVwxihW8iFv5peFLwTKUgLWt0ZkeF22R3kZkARjHEJSgmlCd5c2zah\r
\nLnVk5ws1JpTjyNOOqpOzavJTpxajF1IWgoK7UeeHs3d+znzJwUnSlzpqf/LxJpaR9FrgPUCgAoAK\r
\nACgAoAKACgDzz4q8eGbvt81r/wCllvWtP4kY1fgf9dT5lGf7oP4ivUPFOr+H/wDyMun46brnHr/x\r
\n6XHWuet8J1UPjXz/ACPrKvOPWCgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACg\r
\nAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKAC\r
\ngAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKA\r
\nCgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAK\r
\nACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoA89+Kv/ItXeP71r/6WW9a0/iRjV+B\r
\n/wBdT5iyvcn9f8K9Q8U63wB/yM2n+u64z1x/x6XHSuet8J1UPjXz/I+sq849YzNXuL21tzJpsMFz\r
\nMpyUuLh7ZNgBLESR21024cYXygDk5cY5ynP2cXO3uxTctdbJN6K1m/Vr1LjHmfLezdktNLtpa66K\r
\n13dJ9ra3XKaL4zln0mLXNZgisbe8S3e2S1mub+eT7QoZYzDHYwyGXkfJAtxkb2JCoSempFUpeybv\r
\nPmlGyTafLFybT30jGTd4pKMb33tnG8nK1lGLkm20tYzcOtlZyso63k5KKjzNJ6lz410m1tYb1pJZ\r
\nIrpXeIQWt1cS7I8CVngggkniWFiEmMsaCGQiOXZIQpzfuuzatZS5rrkUZaxk6l+RRkvejJytKKck\r
\n2k2qinJXin8fs7dedOSceXdyvCSsl0Gad4ut9T1ifRoEdhb2ltdrcBJTDKtyZMBJPKEJAVEZGWZv\r
\nN3SKgzbzbbUXyzk1yuFR02no7qMXfWz3bTSTskpN2nG8tpKlKLvGrGUk12TVvvTvra2ifxRvhQfE\r
\nVJdN1S/a2aObR/tjCBpRi5htZZoVmjkCHaskkEiMChaF1IYMrRvJEfejRl1qOipR60/bySg33Ti+\r
\naL0UnGcE+anPl2UP3zw99tpW0fuqUl/ii2uZXdoyhJ/GkdJP4v0y1u1sJpHWdmijYrBcPBHLNt8q\r
\nKa6SJraGWTcmyOaVJH8yLap82PdSXNLljrrJLom4Jykot2UmkndRbaaa3VjnT/dxqyVlKCnbdqLd\r
\nuZpaqN7rmaUdG72TtSn+IGiW0zWzzS+YkkkHy2l26NcRFg9tHIkDRy3XykpbRM88i4aON1ZSYi+Z\r
\nJxu7ptaO7UZcsnFbyUXfncU1BKTlZRk1o1yu0rK3LfVWi5RUoqT2i5Jx5U2nJyjFXlKKc83jfSLe\r
\nzi1BpZWhuGkSNY7W7kn3Q7xMGto4GuY/IKMJjJEohYbZNpIBbtFqLaV4e0TuuXkfL77lfljH34Xl\r
\nJpJySbTCKcrpJ3UuWz0fM9oqLs3JpOSSTbinNJxVzp4J47mNZoWWSORQ6OpBVlYAqykcEEEEEcEH\r
\nNU04txkrNNpp7prdERkpxU4u8Wk0+6eqZLUlBQAUAFABQAUAFABQAUAFAGBr+tnRkhSCI3V3eTC3\r
\ntoN4jV5CjyFpJCG8qGOON5JZAkjhVxHFLIUjZK7koRtezk7uyjCNuaTaTe8oxiknecop2TcovSMZ\r
\nTlolZJdZSk7RjG7Su9W9VaEZS2izmtQ8bXmgW8sutWAtmhms03wTyXFq8V3cJbl45zawuZoCzNJb\r
\nNbq7AJ5bMJNytOLcY6puTi1y639nOpH2aV3U5nDksrTU9HGzpuorNKT0sqc5p309y14zbtyPVNN3\r

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 141
 \ni46ptxmo6yeMrK6EDWjZ8+5ktWSeO6tZkljtpbkoYJbYSLJsjDbZxbqYm8xZGJjjkmT5IyqWulSq\r
\nVVZrVU5qEl2VpXi/tJpe60240le62cZU4u6tb2jjyvvqpJxsmns3FXax7j4lWNlosGr3KOs11p/9\r
\noLbRpPMETylfE08MDpbxb2EYuLhYoyckfdYB4j9xKpCPvSp2/up8zkoK7ulKbjJRjdyk01FNjpx5\r
\n5Wk+Ve0lC+7tCXLKSitXGKtKbWkE1zNXTfe2dx9rgjnxt82NH25zjcobGcDOM4zgZ9K2qQ9lOVO9\r
\n+WUo32vZtXsc9OftIRqWtzRUrb2ur2LNZGoUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQ\r
\nAUAFABQAUAFABQAUAFABQAUegHCWHjN72eLT/suzUftc1vdW/mki2igAdroyeUC8Ukclu0H7tPMa\r
\n5jQlMOykPfUZL4XByk/5JRbg6fZydVNRu1zUozrRuo8rJ+5zLqpRUP78Za8600Uaak57qNWLo8zl\r
\nZmpZ+MtIvjOIpyos43lkeSKaGMxRsySTQyzRpHcQoykPNbvLGp25Yb1yk04KqtYtRatrK01en7i9\r
\n794r+z0/eWfJzNMrlfOqK+OTaS03i4qSvspRcoqcW7xbtJJ3LujeIbLXhJ9jMoaAqJI57e4tZU3r\r
\nuRjDdRQy7HGdkmzY5VgrEowF2aV+l2tGnZqzcXbaSTi7Oz5ZRla0k3mpJuy/lUl5xk5JNPZpuMld\r
\ndUzaqSgoAKACgAoAKACgAoAKACgAoAKACgAoAKAIp2kSN2hVZJQrFEZiis2DtVnCuVBOAWCNtHO0\r
\n4wYk2otwV2lor2u+1+lyopNpSdlfV2vZdXbS/ocXo/jaPWGhWOHygLaWfUDLIF/s9onaEwSfJh5T\r
\nPHOvJjURwSSk42K1ycYqdXm/cxhGam01zKa50rdHGmnKqr81OTpxcXz3jNpXjBr945uLgruyitZp\r
\n2V4yk4eydl7SE+eOkWi/a+NdJvLWW+jlkEVsYxIsltdRTfvseR5dvLClxKJywW3MUTid/kh3uCob\r
\nTja6d3JxsleSkrNxcVeUZRTUpKSTjBqbSjqC1bimnaPPdNcvJ73vqV+Vx9yVpJtOzsa+kaza65Cb\r
\nizZyiu0bLJFLBLG6H5klhnSOaJxkNtkjUlWVwCrKS2rJPSzV00009Wnqrq6knGS3jJOLs00JNXce\r
\nsWk1a1rxUl98ZJp9U0zTqRhQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUA\r
\nFABQAUAFABQAUAFABQAUAFABQAUAFABQBy2teKI/D13FFfoIrKeGd1u95ws0CmVoHj2cF4FkliYS\r
\nEuYpE2AhS0c1udWfNGKnGMVzOor8soxS+2pSp8sNXNSbXwMrlb5WtnLlk3ooXXuyk9lBtSjKTaUZ\r
\nci19orVv+E0tbGC1bWFewubyMSmAJPcfZ0Z1VWupYoDHbKC6q8k/lQrJvUSuI2etuX3/AGKac1yJ\r
\n2fu887pRjJ2UuacZxpbSqW0gm+VZ8yUHVekFztN6Nwhd8/L8StDlnNWfs+ZKTu1fRn8VabbXw0uS\r
\nRxcM6RZEFwYFlkXfHDJdLEbWKZ1KskMkyysHj2ofMj3TH3/h/vWvpzcqvLlvbn5Um5ct7cs725JW\r
\nqX7tJy0TUX30lP2cW7bJz91N21OhpAFABQAUAFABQAUAFABQAUAFAHItrmpTXN1FZWcE0VjKImLX\r
\nbRzSEwxTny4vsjx5xKFUPcIGYfMyKdw3UYRhGpUlJc3M9IqVlGcoNv3o/wArdknptdnNKc/aSpUo\r
\nxfKoO8puPxq9tIS273Lb+LNNiigmeRgl3GsyERSuFjYqBJM0aOsEYZgpkmZIwcjd8rYr2E+eVJJN\r
\nxaT1STbvyqN7czlZ8sV70uiE68IwVWd4pqTaabcVD43JRvZU9py+GLtd6q9aLxfamW7inWWL7Dcr\r
\nbDENw7Ts0SyDykWHdI3L/JEJT5SCc4idWpeybjTnGz51J2ulyqMmm3rorJXcrJSfI/eTQ3WjGc6b\r
\nTSgoO9pa89rJaau7SSTbl0WjG3/i+3trdrq22zqtpd3IRjLFITaFFeMo0B8sh22SCUpJGwAET/Ps\r
\ncaLclCWl5UY3VpK1ZtRldPVWV1y3T1u46XftYtJx6+0VmpRadOLk1Zq6f+Ll0aavsab+IrKK5Wzd\r
\n2WZyicRTGJZJF3JE9wIzAkrggrG8iu25MKd6boVKTTcdlzdUm1H4nGLd5JWd3FNK0r/DK0+3glBz\r
\nunKMHs2l7R8sVKSXLFuXurmabbWmqvt1idQUAFABQAUAFABQAUAeefFX/kWbv/etf/Sy3rWn8SMa\r
\nvwP+up8zDdjgj9a9Q8U6r4fjHibT+w3XPHp/olxXPW+E6qHxr5/kfWVecesRzIZEZB1ZSB+IxWVW\r
\nLqU5wW8oySvtdpouD5ZKT2TT+5nmV34Hu5vD2laYGR7zRhattS6urOOV4rZ7aRVvLVRdQgrK7pIk\r
\nZJZVWSPYziumrLnruvBaPnTTbi+Wa6WurqSjdO8XHmWjcZRmOkasHpzyk07KVv3yqpWdt7KLad4t\r
\n8y5uWzp3Hgi/i0+1t7WC1aaL7U8hXVNXtJoZbqXzWMWpJ9ou7iNmJ+0RzpGlzKqT4i2LCM5XbShL\r
\nlSpwgppJcriutL4Kkb6wjOfuKPK5T524uLtdzV06nM4tt3jFcsPfdnCUYLlbjGzUmkope/1OjaDf\r
\n6bqjXtzLHdpNptnazTEtHM1xaPcFpPJCNH5c4uGYnzlMbKFCOG3Lq5J+1UVyxlVdSCWtlKEYOL2t\r
\ny8iaavzczTUeVc2KTUKKk7ypxnGT78zi00927xs7pae9e+hy+rfD++vNAuNOtpoYdRkl1QxSEyGF\r
\noNRuZ5WhmwgfDRSRklVby7iKN18xUIfOPuug+lOOHjUX8youDbj/AHoyi3BtJ2coPljUkdamlUqV\r
\nOkpKcO6kqagr90/ejJXa5Zcy9+MWn+IvCOuavfK6yRSW0VzZXEBa+vLdYUtpLeWSB7CCA212ZJIX\r
\ndbi5mLoZVCIgiXLpvkqKpLpOV3veE1KNlF2jTlCM5NNXlNxSnNRklT5bONFUY7+wdN9LVHGScuZe\r
\n9KMvci4uyUbtRbcufoIfDNzF5GWi/cavc37YLcwzfa9qj5P9YPPTcDhRhsOcDMw932d/sQqRfrPn\r
\ntby95X267mk3ze1t9v2FvL2f1fmv6+yla1943td25S/+H1+wjuIDHLcQ3mrSCMahf6cph1G5+0Ix\r
\nurFPP8yPZEHhKNC+5/n3JG9QlaMYafwI0pN3a5oybTUbpThaUuaMuVt8rUo2kpaykpOV72c6M1or\r
\nv2dBUXG7+C7bkpJS0STj7z5fUND01dGsLbT0ChbWCOEBPM2DYgXCebJLLt4+XzJZHAwGdjyeipLn\r
\nnKSvZvS9r26Xskr23stzmgml7/xNuUrXd5SblJ3bb1be/wCGxqVkWFABQAUAFABQAUAFABQAUAc5\r
\n4i0q5vxb3WntGl5p8/nxLNuEUoMUkMkEjoGeNZI5WAlRJDE4RzFKqmN0rxlzpXvGUJJu14ycZaOz\r
\ns4zhCa0alyuLtzc0W7Si4PR6Si7X5ZxvZ2urpxcoS1T5Zya1SOdv9F17X4j9va0ttt3p0sVrBJJN\r
\nEiWl5FczSNcvawSyTSqhRIxCkSbVyzF2dbhaE4VG27Sk3pblTo1KajHX3m5T5pSlbS0YxXK3UTbc\r
\nakEklKlOC1veU7WctFyxilZJXespNu8Ywik8G3j6m18Hh8s6s9+Bufd5TaP/AGeFx5ePM875iN23\r
\nyvm37/krJr906XV0cTT8uatXVWL9FFWlpdPZNamspJu67Ydf+CajnL70/d7ve25jjwRrOm6Ytnp5\r
\nspbifRbfSbk3EsyxxNbxzKk8IW3kM6k3EgaJ1t8hUbeCWU1if9o9tTWlOrJzTfxJuKjKPVWlGMeW\r
\nSd6clKXLU5kolOXs5QqdadSrJLo1VqRmm/OHKrxt79+Xngopv1ewga1tooHwWiiRCR0yqhTjIBxk\r
\ncZA+lb1ZqpUnUjtKUpK+9m29TkpRdOnCm94xinba6SWhbrE2CgAoAKACgAoAKACgAoAKACgAoAKA\r
\nCgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgDl7TQWt9dvNYIi8u7s7O3XGfN3QSXbSFvlA2lZo\r
\nguHYkoQVAVczyr2VSk9PaVHJtfy+yhTV/NNSto0k/NocvedKS+xGcXf+9KMlby0d9tWcF4e+HV3o\r
\n0ckLpayiCxnsrV7i91O9SdZSn+us55EtbOJ0ijE8FsJgzH93JGkYjkptypyUkueSpXim0n7O7lao\r
\n+apG7f7p2bo6tuq9C5SvV9pFtL2lSrdKzjOTbhaCajL2fPNNuSdRW0puTa6/wbomoaN55vW8uKQx\r
\niG1F/eamIiisHkF1fRxTgS5Vfs4TyohEHRi0rgaN+7Zu8uaUrtJNJqKUbrWeqlPmlZ3m42tFN89r\r
\nSTVoxUFGy0TkpSfMo7QXK4xSjpZHbVmaBQAUAFABQAUAFABQAUAFABQAUAFABQAUAFAHBr4OMkWu\r
\n20rRxJr0shV4hl0SSwgtSZAVUFxIkjgBmBDA7gzMBnKP7mNGFlKMqk+qi5yqyqRb5Wpbcim01Kys\r
\nnombRnyV44hK/LGkmurdNy9dLNJfkc5p/ga/t7K7E0Fo11cJaRCOXU9XvFkjtpGkz9suW86zYM7P\r
\nam2gZrSUCXfOxATecrpct7+1dRq/K1eKimqiTk5rVydoqpFKnyxu6i54rktFP3Y03CLcVZuWk70r\r
\n8ihOEYxcU5W1d5RXJLt/CWl32k2jxahJud5neOL7TcXv2eMhQIvtl0qXNz8waXfKilPM8lQY40Yj\r
\natFLVpO7so3vKUlotPdi1Dm3mo8zs20kk1KUtovlsrt2tCKk9duaScrLRX0OoqCwoAKACgAoAKAC\r
\ngAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoA5j\r
\nxboTeIbSK1QREx3tjcnzc7dltdwzyAYV/naNHVRgAsQGZVJIcfdqU6j+xKUvNN06kItealJO+lrX\r
\nWtkN606tP+enKC7Xe1/K6v19Dk/GXga416/N5bhJY7q0WyuElv8AUbJURJJXDmKwZBfKyzyq9vPJ\r

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

142 PUBLIC Employment Objects
 \nCvyqEmQSSUqfuTd/hc6dS61acNJLlb5LtKPJLeEuZyVRcsY25PljyaTh7Rx6azULPnXvRUZU1dJP\r
\nnT3i4pu1deF9TbWVvbXybWDzoHe4hvb6OSSKJEV4bjTdrWN3LIqmAXcsyyxwmNlTfboGqm+Vtz2v\r
\nUfKtYyc00mk7Ki4ycZNw5ueVO/uqo4wwlH3FTh0jCMXs4KM1JrmTbnFrm5Yysl7Rp3s5S9JqSwoA\r
\nKACgAoAKACgAoAKACgAoA4wWOsWN1etZR2bxX0yypLLcTK8R+zwwkmBbV1k2mIuFFwm8EKWT7w6L\r
\n0504U5uUXHnT5Yp3Uqkp6NyjZ2lbZ2euuxytVI1ZVacYSUlBWlOUdYKz2hLR+qZi6j4FkIijtSJo\r
\nxZJYy+bd3lt8qMx8xks2UXQcSyb4JXiXhQkqBnrpjiFzSlJcqdSNRJRjO1klyrn0VlGPLNJtO7cZ\r
\naJYToT5Ycr5pxjUTblKneVRqTm/Z625026eiadlKPLd6FzoGpxPdfY2i8m5uYp9v2ia3kkjFqlvJ\r
\nC00cMklvh4klWWJnkkGYz5WSzYqpBqCqJ3j7RbJq8qjqRna65rOTi4O0dpNyXuFulOPN7KyThSit\r
\nWn7nuyje0muaG003KL0SvaayF8E6gbR7dnhDta6rCMzTy4a/mjmi3SyR+ZIE2sskjDe3yttYscbe\r
\n3gpJ66PCt2jGN1QlLmainZc0XFqK0Tur2SbmNGa3svequ3NKdlUpKCXNJXlyyurv7Nnv7q3J9Bv2\r
\n1FbmDyoI/MhZp4rm6R3jjVQ8c1iFNrcO4VohcPIrpGyFU3QruyhUhGLUrv4/dcYtNyvZqT96nZtS\r
\najzc0ottpTajLo1LRUbJxjSXOpTi48ji5pxS5aqklNR5uXlU7WbjzS7iuM9IKACgAoAKACgAoAKA\r
\nPPfir/yLV32+a1/9LLetafxIxq/A/wCup8x4H90n/P1r1DxTrPh//wAjNp/+9cc8c/6JccfhXPW+\r
\nE6qHxr5/kfWVecesFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQ\r
\nAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFAB\r
\nQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFA\r
\nBQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAF\r
\nABQAUAFAGa+i2Em7fbW7b927MMZ3b/P37srzv+03O7P3vtE+c+bJu055raTVvN9LW+7lj/4CuyMv\r
\nZwe8Y636LrzX6deaV/8AFLuwfRbCTdvtrdt+7dmGM7t/n792V53/AGm53Z+99onznzZNxzzW0mre\r
\nb6Wt93LH/wABXZB7OD3jHW/Rdea/TrzSv/il3YPothJu321u2/duzDGd2/z9+7K87/tNzuz977RP\r
\nnPmybjnmtpNW830tb7uWP/gK7IPZwe8Y636LrzX6deaV/wDFLuwfRbCTdvtrdt+7dmGM7t/n792V\r
\n53/abndn732ifOfNk3HPNbSat5vpa33csf8AwFdkHs4PeMdb9F15r9OvNK/+KXdg+i2Em7fbW7b9\r
\n27MMZ3b/AD9+7K87/tNzuz977RPnPmybjnmtpNW830tb7uWP/gK7IPZwe8Y636LrzX6deaV/8Uu7\r
\nNKszUKACgAoAKACgAoAKAPPPir/yLN33+a14/wC3y3rWn8SMavwP+up8yD/ex7cV6h4p1ngDjxNp\r
\n/Y7rjj0/0S4rnrfCdVD418/yPrKvOPWMzV7i9tbcyabDBczKclLi4e2TYASxEkdtdNuHGF8oA5OX\r
\nGOcpz9nFzt7sU3LXWyTeitZv1a9S4x5ny3s3ZLTS7aWuuitd3Sfa2t1ymi+M5Z9Ji1zWYIrG3vEt\r
\n3tktZrm/nk+0KGWMwx2MMhl5HyQLcZG9iQqEnpqRVKXsm7z5pRsk2nyxcm099Ixk3eKSjG997Zxv\r
\nJytZRi5JttLWM3DrZWcrKOt5OSio8zSepc+NdJtbWG9aSWSK6V3iEFrdXEuyPAlZ4IIJJ4lhYhJj\r
\nLGghkIjl2SEKc37rs2rWUua65FGWsZOpfkUZL3oycrSinJNpNqopyV4p/H7O3XnTknHl3crwkrJd\r
\nBmneLrfU9Yn0aBHYW9pbXa3ASUwyrcmTASTyhCQFRGRlmbzd0ioM28221F8s5NcrhUdNp6O6jF31\r
\ns9200k7JKTdpxvLaSpSi7xqxlJNdk1b70762ton8Ub9bUDCgAoAKACgAoAKACgAoAKACgAoAKACg\r
\nAoA5rxN4gbQY7dYYkmuL65S1gWWb7PAJHV3HnT+XMY1KxsqbIZXkmaOJU+csqV5TVONrtTlq7aQV\r
\n2lo3KXaKWylJtRjJqrJRlUk7Rja9ld3lJQj1VlzSXM29Fe15Wi84eM00yAv4hhbTZxdfZFSNZ7uO\r
\n4laIzxfZJI7ZJLgSRgqALdH89XtwpkC760fLyXbak+W3vLklyy91X93VTUl/y7fO1HlmozZrmbso\r
\nxUZc11a0moq97Wkpvlcd9mrxlFu5N410mC0hv/NkkhumdYlhtrqeYtFu84NbQwvcRmAoyziSJfIc\r
\nbJdj4FJ2i1FtK8edO65eT3ffc78ih78PfbUfeWuo4pyuktYy5GnpLn19xRdm5Ozaik24pyS5U2WZ\r
\nfFelwRzzNcKY7O0jvpnRXdRayiUxzKyKwkVxDIQIy7YXO35lzXK0+Vqz9oqVno1UfJaP/k8ddtdX\r
\no7KHv8nJr7ROUfNRtf0tdaOzGy+LNNgvV015HE7ukeRBcGBZZE3xwyXQiNrFM6FWSGSZZWDx7UPm\r
\nR7lFOTaW65t9L8qbly3tz8qUnLkvblnf4JWltKMaj+GSjJP+7OXJFtbpSn7qvbUfB4p0641BtJjk\r
\nY3SF15hnWJnjVXkijuWjFtLNGrBpIY5WlQBiyDY+1R99OUdlfydoz9nJpPVxjP3JSScVJqLabSdS\r
\n9yylpdpLrq4uaTt8LcE5pSs3G0ldNN9BQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQA\r
\nUAFABQAUAFABQAUAFABQB5rB8RUl03VL9rZo5tH+2MIGlGLmG1lmhWaOQIdqySQSIwKFoXUhgytG\r
\n8hH3o0ZdajoqUetP28koN904vmi9FJxnBPmpz5dVD988PfbaVtH7qlJf4otrmV3aMoSfxpHUTeK9\r
\nNtrxNNmkZbiTyxxDO0KNNnyo5blYzbQyykYiillSSQlAisZEDNLmcow1cW4vpdxiptK/xSUGpuMb\r
\ntR95qybOZS/dxrS0Uoxla92lJqKbS1UXJ8qk0ouSaTunboqRoFABQAUAFABQAUAFABQAUAFABQAU\r
\nAFABQAUAMlfy0Z+u0E4+gzWdSXs4SqWvyxcrbXsr2KiuaSj3aX3nnOl/ERNS0W31j7M0M089jBLa\r
\nvKN0X26aCOOQSBCJEMU6TxkKu9f3beVIHVOpwtUhSv8AE5Rk/wCScKUqk4Nd04pdOaEoVY3hKPNF\r
\n7e270lOXlNRbSafZtOLeqjOM4auLOph8U6bPftpUcjfaUZk5hnWFpEUO8Udy0YtpZkQ7nhjleVFV\r
\nyyARvtxj76cobK/k7RlySaT1cYz9yUknFStFtNpNy9y3Npdpd7OUXKKlb4XKK5oqVm42krppvoKA\r
\nCgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAK\r
\nACgAoAKACgAoA4/W/FyaFqtlpk0LNDfRzO9yGAW38uS3iQyIRkpJLcJGXVv3bFWdfL3vGQ9+UoPT\r
\nlUOV/wA06kpKNPyclCXL/NPlpr35xTc/cpqruufla6pcrk5ekUry2UYKU27RYv8AwmNrbm+N4rQp\r
\np95HZL5ay3Ek7yW9vOvlwQRNMzk3G3y40lbbG0hIXcFV1y05dajqJRSbf7uVRPb+7TlN6JRV77XG\r
\n48snDSypwm22klzuUUtdL3SS1vKUlFK7SfRadqNvq1ul3aP5kMoO04ZSCCVZXRwrxyIwKSRyKskb\r
\nqyOqspAtpx0dtk000001dNNXTTTTTTaaaadiE73S3TcWmmmnF2aaeqaaLtSMKACgAoAKACgAoAKA\r
\nCgAoAKAORbXNSmubqKys4JorGURMWu2jmkJhinPlxfZHjziUKoe4QMw+ZkU7huowjCNSpKS5uZ6R\r
\nUrKM5QbfvR/lbsk9Nrs5pTn7SVKlGL5VB3lNx+NXtpCW3e5bfxZpsUUEzyMEu41mQiKVwsbFQJJm\r
\njR1gjDMFMkzJGDkbvlbFewnzypJJuLSeqSbd+VRvbmcrPlivel0QnXhGCqzvFNSbTTbiofG5KN7K\r
\nntOXwxdrvVXrReL7Uy3cU6yxfYblbYYhuHadmiWQeUiw7pG5f5IhKfKQTnETq1L2Tcac42fOpO10\r
\nuVRk029dFZK7lZKT5H7yaG60YznTaaUFB3tLXntZLTV3aSSbcui0Y2/8X29tbtdW22dVtLu5CMZY\r
\npCbQorxlGgPlkO2yQSlJI2AAif59jjRbkoS0vKjG6tJWrNqMrp6qyuuW6et3HS79rFpOPX2is1KL\r
\nTpxcmrNXT/xcujTV9jTfxFZRXK2buyzOUTiKYxLJIu5InuBGYElcEFY3kV23JhTvTdCpSabjsubq\r
\nk2o/E4xbvJKzu4ppWlf4ZWn28EoOd05Rg9m0vaPlipSS5Yty91czTba01V9usTqCgAoAKACgAoAK\r
\nACgDzz4q8eGbvt81r/6WW9a0/iRjV+B/11PmUZ/ug/iK9Q8U6v4f/wDIy6fjpuucev8Ax6XHWuet\r
\n8J1UPjXz/I+sq849YjmQyIyDqykD8RisqsXUpzgt5Rklfa7TRcHyyUnsmn9zPMrvwPdzeHtK0wMj\r
\n3mjC1bal1dWccrxWz20ireWqi6hBWV3SRIySyqskexnFdNWXPXdeC0fOmm3F8s10tdXUlG6d4uPM\r
\ntG4yjMdI1YPTnlJp2UrfvlVSs7b2UW07xb5lzctnTuPBF/Fp9rb2sFq00X2p5CuqavaTQy3UvmsY\r
\ntST7Rd3EbMT9ojnSNLmVUnxFsWEZyu2lCXKlThBTSS5XFdaXwVI31hGc/cUeVynztxcXa7mrp1OZ\r

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 143
 \nxbbvGK5Ye+7OEowXK3GNmpNJRS9/qdG0G/03VGvbmWO7SbTbO1mmJaOZri0e4LSeSEaPy5xcMxPn\r
\nKY2UKEcNuXVyT9qorljKq6kEtbKUIwcXtbl5E01fm5mmo8q5sUmoUVJ3lTjOMn35nFpp7t3jZ3S0\r
\n9699DtKyNAoAKACgAoAKACgAoAKACgAoAKACgAoAKAOd8S2N5f2wjsltrgbiJ7S8H+jXcDoyPDJI\r
\nIZ2iwWEiusMoYp5TxlJCyw1dq6Uo2d09LO6lGadnrGUdmrNSeqkoyVLS+ri+jWvRpxauvdknZtNN\r
\nOz96KlTn5ldeFtU0gWLafaWkT/2ylylhbvMdPs410+6ifEy2yGFZ5PnaVLKOOOeZf3Ur7nm1g3Gc\r
\ndXK1Ov70tOVTUEqcX7ztH3nFNty5pwXJBxUE0nCroo3jRVlrzyhiISc2vd1cbRlu1Gmpty+FdDF4\r
\nZ1fTTb6laCzn1FTqH2iCWeaK1A1CaO4byZktppCYHhiQFrdPPUyO3ksQBny2i6EX+7lTUJSavJSU\r
\npT51G9nG9Wr+7claPs4qaUHzO/Nd1NP3sZpR6xhTdGMW3azcOWTnytKaklC07rEvvh7qtrZTabpb\r
\n2k0d7osGlyy3EksDRPbi5CzRwxQTLIkv2kgoZIjFtBBl+7W/NeeqtBVqVZa80rU/Zpwd7JtxoxtO\r
\n+8pXjor1GbUoVZ2506zml8P7+cZtxu7vkfNaLtzLlXPFtyW/c+GNUfWVvbbyLWLzoJJLmG8vY3ki\r
\niRFeG40wIbG6kkVTALuSVJI4WjKx7rdA0QfLJuXw3qPl+JS500tH/CcW4yk4OTnKnfRVWoc3K1Sj\r
\nTT96MKcU9nDlkpS95azi/f5YyUUvaNWdnKVTSvAdxp+tG8cI9ol5dX0crahqLOJLoSkoum7k0+Fk\r
\na4lT7QDKZIhgwLLI0iql+7goveNN01bW650025XcfcS5oxTTqe9FwiuQ2qvnd4/adPmXwpKnCMbe\r
\n78bcqcJpytZXi4y5U36rSEFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQAUAFABQA\r
\nUAFABQAUAeR6t8P7680C4062mhh1GSXVDFITIYWg1G5nlaGbCB8NFJGSVVvLuIo3XzFQh3H3XQfS\r
\nnHDxqL+ZUXBtx/vRlFuDaTs5QfLGpI3U0qlSp0lJTh3UlTUFfun70ZK7XLLmXvxi1pX/AIT1Ce6n\r
\nghNv/Z2oXdlezyvJJ9piktBbAxRQeS0UiSizhCyNPC0JkkYRybEBqDtKLltTnOcLby5+aSjLbltU\r
\nnKTlG/NBRp8q1m+VJxpqK+P2CoP+VL31Ka6tuFSSUbRSklNuXM4r0qoLCgAoAKACgAoAKACgAoAK\r
\nACgAoAKACgAoAKAI5kMiMg6spA/EYrKrF1Kc4LeUZJX2u00XB8slJ7Jp/czyibwBfDTNItbeaGO6\r
\n04aXFe5LmG4gsZoZyIyFDCWN43NuzIAVllRwvmB4+1zTxDrq/s25yceqk6VSEZLpf3+WauuaPK22\r
\n6cEZv+HVgvil7bkfS1WTbUvK3K76uMo2j7sp82pZ+FdQhvYopDbjTbPUbrUoZRJI11JJdC4Jgkha\r
\nERxrHJdynz0uJGdI40MSl3ZcKb5VFz+KFN0opbOOkYyk9GmqcUpRs1Ko3UvFJQLqPm5uX/l46Tnf\r
\nTlVNQ0jZu/NKlB3fKoxcoKLspHo9IkKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACg\r
\nAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgDldT8PHUtWhvJfLezSwvbOaNi25/tUloww\r
\nAuCmyCQOS4YFlwDklUlpVTuudUuVp2adN1XdNWaac4uLWqavo0r25WVNR3hU59drcko+d9WtGrWv\r
\n6HHWXgrV9N826E1ve3cOrC+tfNkliWaAWCadsupFilKT+TvcyxxTK0qq2xVkZEtScVT0XMo1o1Ps\r
\np+1qSqc0ElaL5lBuNrJc9OL+GamSTc4q6puFGMOso+yn7Tld2uaN/cUnJu1pyUpRtLuvDGkzaNZm\r
\nK5KG4nnuLqURZ8tJLmd52jjYqjOkZfYJGRGk2+YyIWKAdoxhTjdqEFFNqzdt3a7UbttqKbUVaN3a\r
\n7m7lKU5WTk1ZLW0YxjTir6XfLCPM7JOV7JKyOhqRhQAUAFABQAUAFABQAUAFABQBxgsdYsbq9ayj\r
\ns3ivpllSWW4mV4j9nhhJMC2rrJtMRcKLhN4IUsn3h0XpzpwpzcouPOnyxTupVJT0blGztK2zs9dd\r
\njlaqRqyq04wkpKCtKco6wVntCWj9UzF1HwLIRFHakTRiySxl827vLb5UZj5jJZsoug4lk3wSvEvC\r
\nhJUDPXTHELmlKS5U6kaiSjGdrJLlXPorKMeWaTad24y0SwnQnyw5XzTjGom3KVO8qjUnN+z1tzpt\r
\n09E07KUeW70LnQNTie6+xtF5NzcxT7ftE1vJJGLVLeSFpo4ZJLfDxJKssTPJIMxnyslmxVSDUFUT\r
\nvH2i2TV5VHUjO11zWcnFwdo7SbkvcLdKceb2VknClFatP3PdlG9pNc0NppuUXole01kL4J1A2j27\r
\nPCHa11WEZmnlw1/NHNFulkj8yQJtZZJGG9vlbaxY429vBST10eFbtGMbqhKXM1FOy5ouLUVondXs\r
\nk3MaM1vZe9VduaU7KpSUEuaSvLlldXf2bPf3VuT6DftqK3MHlQR+ZCzTxXN0jvHGqh45rEKbW4dw\r
\nrRC4eRXSNkKpuhXdlCpCMWpXfx+64xablezUn71Ozak1Hm5pRbbSm1GXRqWio2TjGkudSnFx5HFz\r
\nTily1VJKajzcvKp2s3Hml3FcZ6QUAFABQAUAFABQAUAee/FX/kWrvH961/8ASy3rWn8SMavwP+up\r
\n8xZXuT+v+FeoeKdX4DcReJdPZuPnmBPOMtazqoH/AAIgVhW+E6qGk18/yPrSvNPWCgAoAKACgAoA\r
\nKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAo\r
\nAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgA\r
\noAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACg\r
\nAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgAoAKACgDNfRbCTdvtrdt+7dmGM7\r
\nt/n792V53/abndn732ifOfNk3ac81tJq3m+lrfdyx/8AAV2Rl7OD3jHW/Rdea/TrzSv/AIpd2D6L\r
\nYSbt9tbtv3bswxndv8/fuyvO/wC03O7P3vtE+c+bJuOea2k1bzfS1vu5Y/8AgK7IPZwe8Y636Lrz\r
\nX6deaV/8Uu7B9FsJN2+2t237t2YYzu3+fv3ZXnf9pud2fvfaJ8582Tcc81tJq3m+lrfdyx/8BXZB\r
\n7OD3jHW/Rdea/TrzSv8A4pd2D6LYSbt9tbtv3bswxndv8/fuyvO/7Tc7s/e+0T5z5sm455raTVvN\r
\n9LW+7lj/AOArsg9nB7xjrfouvNfp15pX/wAUu7B9FsJN2+2t237t2YYzu3+fv3ZXnf8Aabndn732\r
\nifOfNk3HPNbSat5vpa33csf/AAFdkHs4PeMdb9F15r9OvNK/+KXdmlWZqFABQAUAFABQAUAFAHnn\r
\nxWIHhq6B7tbADucXcBwPwBP4VrT+JGNXSD/rqfMw3Y4I/WvUPFEWSW3dJ7cmOaB1kjI6o6ncG9xk\r
\ndDwRweDSaurMqL5Wmj6S8O/FDSdVhAv5Y9OulA8xJ2EcZOOWilchGUnoCwcdCvQnzJU3H0PXhUjJ\r
\nb2Z0P/CdeHR/zFNOH/b7bf8Axys7Psa3XdB/wnfhz/oK6b/4G23/AMcos+w7rug/4Tvw5/0FdN/8\r
\nDbb/AOOUWfYLrug/4Trw7/0FdN/8Dbb/AOOUWfYLrug/4Trw5/0FdN/8Dbb/AOOUWfYV13Qf8J14\r
\nd/6Cum/+Btt/8cos+wXXdB/wnXh3/oK6d/4G23/xyiz7Bdd0H/Cd+HP+grpv/gbbf/HKLPsF13Qf\r
\n8J14d/6Cunf+Btt/8cos+w7rug/4Trw7/wBBXTv/AANtv/jlFn2C67oP+E68O/8AQV07/wADbb/4\r
\n5RZ9hXXdB/wnXh3/AKCunf8Agbbf/HKLPsF13Qf8J14d/wCgrp3/AIG23/xyiz7Bdd0H/CdeHf8A\r
\noKad/wCBtt/8cos+wXXdB/wnXh3/AKCunf8Agbbf/HKLPsF13Qf8J14d/wCgrp3/AIG23/xyiz7B\r
\ndd0H/CdeHf8AoKad/wCBtt/8cos+wXXdB/wnXh3/AKCunf8Agbbf/HKLPsF13Qf8J14d/wCgpp3/\r
\nAIG23/xyiz7Bdd0H/CdeHf8AoKad/wCBtt/8cos+wXXdB/wnXh3/AKCmnf8Agbbf/HKLPsF13Qv/\r
\nAAnXh3/oKad/4G23/wAcos+wXXdCf8J14d/6Cmnf+Btt/wDHKLPsF13Qv/CdeHf+gpp3/gbbf/HK\r
\nLPsF13Qf8J14d/6Cmnf+Btt/8cos+wXXdB/wnXh3/oKad/4G23/xyiz7Bdd0H/CdeHf+gpp3/gbb\r
\nf/HKLPsF13Qf8J14d/6Cmnf+Btt/8cos+wXXdB/wnXh3/oKad/4G23/xyiz7Bdd0H/CdeHf+gpp3\r
\n/gbbf/HKLPsF13Qf8J14d/6Cmnf+Btt/8cos+wXXdB/wnXh3/oKad/4G23/xyiz7Bdd0H/CdeHf+\r
\ngpp3/gbbf/HKLPswuu6D/hOvDv8A0FNO/wDA22/+OUWfZhdd0H/CdeHf+gpp3/gbbf8Axyiz7MLr\r
\nug/4Trw7/wBBTTv/AANtv/jlFn2YXXdB/wAJ14d/6Cmnf+Btt/8AHKLPswuu6D/hOvDv/QU07/wN\r
\ntv8A45RZ9mF13Qf8J14d/wCgpp3/AIG23/xyiz7MLrug/wCE68O/9BTTv/A22/8AjlFn2YXXdB/w\r
\nnXh3/oKad/4G23/xyiz7MLrug/4Trw7/ANBTTv8AwNtv/jlFn2YXXdB/wnXh3/oKad/4G23/AMco\r
\ns+zC67oP+E68O/8AQU07/wADbb/45RZ9mF13Qf8ACdeHf+gpp3/gbbf/AByiz7MLrug/4Trw7/0F\r

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

144 PUBLIC Employment Objects
 \nNO/8Dbb/AOOUWfZhdd0H/CdeHf8AoKad/wCBtt/8cos+zC67oP8AhOvDv/QU07/wNtv/AI5RZ9mF\r
\n13Qf8J14d/6Cmnf+Btt/8cos+zC67oP+E68O/wDQU07/AMDbb/45RZ9mF13Qf8J14d/6Cmnf+Btt\r
\n/wDHKLPswuu6D/hOvDv/AEFNO/8AA22/+OUWfZhdd0H/AAnXh3/oKad/4G23/wAcos+zC67oP+E6\r
\n8O/9BTTv/A22/wDjlFn2YXXdB/wnXh3/AKCmnf8Agbbf/HKLPswuu6D/AITrw7/0FNO/8Dbb/wCO\r
\nUWfZhdd0H/CdeHf+gpp3/gbbf/HKLPswuu6D/hOvDv8A0FNO/wDA22/+OUWfZhdd0H/CdeHf+gpp\r
\n3/gbbf8Axyiz7MLrug/4Trw7/wBBTTv/AANtv/jlFn2YXXdB/wAJ14d/6Cmnf+Btt/8AHKLPswuu\r
\n6D/hOvDv/QU07/wNtv8A45RZ9mF13Qf8J14d/wCgpp3/AIG23/xyiz7MLrug/wCE68O/9BTTv/A2\r
\n2/8AjlFn2YXXdB/wnXh3/oKad/4G23/xyiz7MLrug/4Trw7/ANBTTv8AwNtv/jlFn2YXXdB/wnXh\r
\n3/oKad/4G23/AMcos+zC67oP+E68O/8AQU07/wADbb/45RZ9mF13Qf8ACdeHf+gpp3/gbbf/AByi\r
\nz7MLrug/4Trw7/0FNO/8Dbb/AOOUWfZhdd0H/CdeHf8AoKad/wCBtt/8cos+zC67oP8AhOvDv/QU\r
\n07/wNtv/AI5RZ9mF13Qf8J14d/6Cmnf+Btt/8cos+zC67oP+E68O/wDQU07/AMDbb/45RZ9mF13Q\r
\nf8J14d/6Cmnf+Btt/wDHKLPswuu6D/hOvDv/AEFNO/8AA22/+OUWfZhdd0H/AAnXh3/oKad/4G23\r
\n/wAcos+zC67oP+E68O/9BTTv/A22/wDjlFn2YXXdB/wnXh3/AKCmnf8Agbbf/HKLPswuu6D/AITr\r
\nw7/0FNO/8Dbb/wCOUWfZhdd0H/CdeHf+gpp3/gbbf/HKLPswuu6D/hOvDv8A0FNO/wDA22/+OUWf\r
\nZhdd0H/CdeHf+gpp3/gbbf8Axyiz7MLrug/4Trw7/wBBTTv/AANtv/jlFn2YXXdB/wAJ14d/6Cmn\r
\nf+Btt/8AHKLPswuu6D/hOvDv/QU07/wNtv8A45RZ9mF13Qf8J14d/wCgpp3/AIG23/xyiz7MLrug\r
\n/wCE68O/9BTTv/A22/8AjlFn2YXXdB/wnXh3/oKad/4G23/xyiz7MLrug/4Trw7/ANBTTv8AwNtv\r
\n/jlFn2YXXdB/wnXh3/oKad/4G23/AMcos+zC67oP+E68O/8AQU07/wADbb/45RZ9mF13Qf8ACdeH\r
\nf+gpp3/gbbf/AByiz7MLrug/4Trw7/0FNO/8Dbb/AOOUWfZhdd0H/CdeHf8AoKad/wCBtt/8cos+\r
\nzC67oP8AhOvDv/QU07/wNtv/AI5RZ9mF13Qf8J14d/6Cmnf+Btt/8cos+zC67oP+E68O/wDQU07/\r
\nAMDbb/45RZ9mF13Qf8J14d/6Cmnf+Btt/wDHKLPswuu6D/hOvDv/AEFNO/8AA22/+OUWfZhdd0H/\r
\nAAnXh3/oKad/4G23/wAcos+zC67oP+E68O/9BTTv/A22/wDjlFn2YXXdB/wnXh3/AKCmnf8Agbbf\r
\n/HKLPswuu6D/AITrw7/0FNO/8Dbb/wCOUWfZhdd0H/CdeHf+gpp3/gbbf/HKLPswuu6D/hOvDv8A\r
\n0FNO/wDA22/+OUWfZhdd0H/CdeHf+gpp3/gbbf8Axyiz7MLrug/4Trw7/wBBTTv/AANtv/jlFn2Y\r
\nXXdB/wAJ14d/6Cmnf+Btt/8AHKLPsF13Qf8ACdeHf+gpp3/gbbf/AByiz7Bdd0H/AAnXh3/oKad/\r
\n4G23/wAcos+wXXdB/wAJ14d/6Cmnf+Btt/8AHKLPsF13Qf8ACdeHf+gpp3/gbbf/AByiz7Bdd0H/\r
\nAAnXh3/oKad/4G23/wAcos+wXXdB/wAJ14d/6Cmnf+Btt/8AHKLPsF13Qf8ACdeHf+gpp3/gbbf/\r
\nAByiz7Bdd0H/AAnXh3/oKad/4G23/wAcos+wXXdCf8J14d/6Cmnf+Btt/wDHKLPsF13Qv/CdeHf+\r
\ngpp3/gbbf/HKLPsF13Qn/CdeHf8AoKad/wCBtt/8cos+wXXdB/wnXh3/AKCmnf8Agbbf/HKLPsF1\r
\n3Qf8J14d/wCgpp3/AIG23/xyiz7Bdd0H/CdeHf8AoK6d/wCBtt/8cos+wXXdB/wnXh0f8xTTv/A2\r
\n2/8AjlFn2C67oP8AhOvDv/QV07/wNtv/AI5RZ9guu6D/AITrw7/0FdO/8Dbb/wCOUWfYLrug/wCE\r
\n68O/9BXTv/A22/8AjlFn2C67oP8AhOvDv/QV07/wNtv/AI5RZ9guu6D/AITrw7/0FdO/8Dbb/wCO\r
\nUWfYLrug/wCE68O/9BXTv/A22/8AjlFn2C67oP8AhOvDv/QV07/wNtv/AI5RZ9h3XdB/wnXh3/oK\r
\n6d/4G23/AMcos+wrrug/4Tvw5/0FdN/8Dbb/AOOUWfYLrug/4Trw7/0FdO/8Dbb/AOOUWfYLrug/\r
\n4Trw7/0FdN/8Dbb/AOOUWfYLrug/4Trw5/0FdN/8Dbb/AOOUWfYLrug/4Trw5/0FdN/8Dbb/AOOU\r
\nWfYd13Qf8J34c/6Cum/+Btt/8cos+wXXdB/wnfhz/oK6b/4G23/xyiz7Bdd0DeOvDyqXGp2DBRnC\r
\nXULsfoqOzMfZQSfSnyvomLmS6o8K8e+OF8WOlpYB0sIGLl2G0zSAEK208rGoJ2hsMxbLKCq47aVP\r
\nl1e551arze7HY4Agf3Sf8/Wuo4hR/k8c+1ADHhSQYYA+2B8tFgvbYr/2fb/3F/IfNSsiuZ9w/s+3\r
\n/uL9cDj2osuwuZ9xf7Ot/wDnmv0wPzosuwcz7gNOt/7i/XA59qLLsHM+4v8AZ1uP+Wa/kPlosuwc\r
\nz7h/Z1v/AM81/IfNRZdg5n3D+zrf+4v1wOPanZdg5n3F/s63/wCea/TA/Oiy7BzPuH9nW/8AcX64\r
\nHPtRZdg5n3F/s63/AOea/kPlosuwcz7h/Z1v/wA81+mB81Fl2DmfcX+zrf8AuL9cDj2osg5n3D+z\r
\nrf8A55r/ALuB+dFl2DmfcX+zrf8AuL9cDn2osuwuZ9w/s63/AOeaj8B8tFl2DmfcP7Ot/wDnmv5D\r
\n5qOVdg5n3F/s63/uL9cDj2o5V2DmfcX+zrf/AJ5r/u4H50cq7BzPuH9nW39xfrgc+1HKuwcz7h/Z\r
\n1uP+Waj2wPlo5V2DmfcX+zrf/nmv0wPmp8q7BzPuH9nW39xfrgce1HKg5n3F/s23/wCea/7uB69a\r
\nOVdg5n3D+zrb+4v1wOfajlXYXM+4v9m23/PNR7YHy0cq7BzPuH9m23/PNfpgfNRyrsHM+4f2bbf3\r
\nFHvgce1HKuwcz7i/2bbf881/3cD86OVdg5n3D+zbb+4v1wvPtRyrsHM+4v8AZtt/zzUe2F+WjlXY\r
\nOZ9w/s22/wCea/TA+ajlXYOZ9xf7Ntv7i/XA49qOVdg5n3D+zbb/AJ5r/u4Hr96nyrsHM+4f2bbf\r
\n3F+uBz7Ucq7BzPuH9m23/PNR7YX5aOVdg5n3D+zbb/nmv0wvzUcq7BzPuH9m239xfrgce1HKuwcz\r
\n7h/Ztt/zzX/dwPX71HKuwcz7h/Ztt/cX64HPtRyrsHM+4f2bbf8APNR7YX5aOVdg5n3D+zbb/nmv\r
\n0wvzUcq7BzPuH9m239xfrgce1HKuwcz7h/Ztt/zzX/dwPX71HKuwcz7h/Ztt/cX64HPtRyrsHM+4\r
\nf2bbf881Hthflo5V2DmfcP7Ntv8Anmv0wvzUcq7BzPuH9m239xfrgce1HKuwcz7h/Ztt/wA81/3c\r
\nD1+9RyrsHM+4f2bbf3F+uBz7Ucq7BzPuH9m23/PNR7YX5aOVdg5n3D+zbb/nmv0wvzUcq7BzPuH9\r
\nm239xfrgce1HKuwcz7h/Ztt/zzX/AHcD1+9RyrsHM+4f2bbf3F+uBz7Ucq7BzPuH9m23/PNR7YX5\r
\naOVdg5n3D+zbb/nmv0wvzUcq7BzPuH9m239xfrgce1HKuwcz7h/Ztt/zzX/dwPX71HKuwcz7h/Zt\r
\nt/cX64HPtRyrsHM+4f2bbf8APNR7YX5aOVdg5n3D+zbb/nmv0wvzUcq7BzPuH9m239xfrgce1HKu\r
\nwcz7h/Ztt/zzX/dwPX71HKuwcz7h/Ztt/cX64HPtRyrsHM+4f2bbf881Hthflo5V2DmfcP7Ntv8A\r
\nnmv0wvzUcq7BzPuH9m239xfrgce1HKuwcz7h/Ztt/wA81/3cD1+9RyrsHM+4f2bbf3F+uBz7Ucq7\r
\nBzPuH9m23/PNR7YX5aOVdg5n3D+zbb/nmv0wvzUcq7BzPuH9m239xfrgce1HKuwcz7h/Ztt/zzX/\r
\nAHcD1+9RyrsHM+4f2bbf3F+uBz7Ucq7BzPuH9m23/PNR7YX5aOVdg5n3D+zbb/nmv0wvzUcq7BzP\r
\nuH9m239xfrgce1HKuwcz7h/Ztt/zzX/dwPX71HKuwcz7h/Ztt/cX64HPtRyrsHM+4f2bbf8APNR7\r
\nYX5aOVdg5n3D+zbb/nmv0wvzUcq7BzPuH9m239xfrgce1HKuwcz7h/Ztt/zzX/dwPX71HKuwcz7h\r
\n/Ztt/cX64HPtRyrsHM+4f2bbf881Hthflo5V2DmfcP7Ntv8Anmv0wvzUcq7BzPuH9m239xfrgce1\r
\nHKuwcz7h/Ztt/wA81/3cD1+9RyrsHM+4f2bbf3F+uBz7Ucq7BzPuH9m23/PNR7YX5aOVdg5n3D+z\r
\nbb/nmv0wvzUcq7BzPuH9m239xfrgce1HKuwcz7h/Ztt/zzX/AHcD1+9RyrsHM+4f2bbf3F+uBz7U\r
\ncq7BzPuH9m23/PNR7YX5aOVdg5n3D+zbb/nmv0wvzUcq7BzPuH9m239xfrgce1HKuwcz7h/Ztt/z\r
\nzX/dwPX71HKuwcz7h/Ztt/cX64HPtRyrsHM+4f2bbf8APNR7YX5aOVdg5n3D+zbb/nmv0wvzUcq7\r
\nBzPuH9m239xfrgce1HKuwcz7h/Ztt/zzX/dwPX71HKuwcz7h/Ztt/cX64HPtRyrsHM+4f2bbf881\r
\nHthflo5V2DmfcP7Ntv8Anmv0wvzUcq7BzPuH9m239xfrgce1HKuwcz7h/Ztt/wA81/3cD160cq7B\r

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 145
 \nzPuH9m239xfrgc+1LlXYOZ9xP7Nth/yzUe2B8tHKuwcz7if2bbf881+mF+ajlXYOZ9w/s22H8C/X\r
\nC8e1HKuwcz7h/Ztt/wA81/3cD86LLsHM+4n9nW39xfrgc+1HKuwcz7h/Ztt/zzUe2B8tHKuwcz7i\r
\nf2bbf881+mB81HKuwcz7h/Z1t/cX64HHtRyrsPmfcP7Nt/8Anmv+7gfnRyrsHM+4n9nW39xfrgc+\r
\n1HKg5n3D+zrcf8s1H4D5aOVdg5n3E/s63/55r+Q+alyrsHM+4f2dbf3F+uBx7Ucq7BzPuH9nW/8A\r
\nzzX/AHcD86OVdg5n3E/s63/uL9cDn2o5V2DmfcT+zrf/AJ5qPbA+WjlXYOZ9w/s63/55r+Q+aiy7\r
\nBzPuJ/Z1v/cX64HHtRZdh8z7h/Z1v/zzX/dwPXrRZdg5n3E/s63/ALi/XA59qLLsHM+4f2dbj/lm\r
\no/AfLRZdg5n3D+zrf/nmv5D5qLLsHM+4n9nW4/gX64HHtRZdg5n3D+zrf/nmv+7gfnRyrsHM+4n9\r
\nnW/9xfrgc+1KyDmfcP7Ot/8Anmo/AfLRZdg5n3E/s63/AOea/kPmosuwcz7h/Z1v/cX64HHtRZBz\r
\nPuH9nW//ADzX6YH50WXYOZ9xP7Pt/wC4v1wOfaiyDmfccllDGcqijHsPloskF2WcAcD8uPmpiD/g\r
\nWPbjigBB90fWgB3976UAA/h/z2pgIfun60CH/wAX4UANH3R9aAHd2+lAAP4aAE/hP1oAk/i/CgBg\r
\n+6PrQA7+99P6UAKOq/T+lMQn8J+tAD/4vwoAaPur9aAF7t9P6UAKOq/T+lACH7rfWgCT+L8KAGD7\r
\nq/WgQ7u30/pQAo6r9P6UDEP3W+tAh/8AF+FMBg+6v1oAf/e+n9KAAdV+n9KAEP3W+tAEn8f4UAMH\r
\n3V+tADu7fT+lAAOq/T+lAhD91vrQBJ/F+FMCMfdX60gHHq30/pQADqv0/pQA0/db60ASfxfhTAjH\r
\n3V+tIBx6t9P6UAA6r9P6UANP3W+tAEn8X4UwIx91frSAcerfT+lAAOq/T+lADT91vrQBJ/F+FMCM\r
\nfdX60gHHq30/pQADqv0/pQA0/db60ASfxfhTAjH3V+tIBx6t9P6UAA6r9P6UANP3W+tAEn8X4UwI\r
\nx91frSAcerfT+lAAOq/T+lADT91vrQBJ/F+FMCMfdX60gHHq30/pQADqv0/pQA0/db60ASfxfhTA\r
\njH3V+tIBx6t9P6UAA6r9P6UANP3W+tAEn8X4UwIx91frSAcerfT+lAAOq/T+lADT91vrQBJ/F+FM\r
\nCMfdX60gHHq30/pQADqv0/pQA0/db60ASfxfhTAjH3V+tIBx6t9P6UAA6r9P6UANP3W+tAEn8X4U\r
\nwIx91frSAcerfT+lAAOq/T+lADT91vrQBJ/F+FMCMfdX60gHHq30/pQADqv0/pQA0/db60ASfxfh\r
\nTAjH3V+tIBx6t9P6UAA6r9P6UANP3W+tAEn8X4UwIx91frSAcerfT+lAAOq/T+lADT91vrQBJ/F+\r
\nFMCMfdX60gFPVvp/SgAHVfp/SgY0/db60CHfxfhQMYPur9aAFPVvp/SgBO6/T+lADT91vrQA/wDi\r
\n/CgBg+6v1pAB6t9P6UDAdV+n9KBDT90/WgY7+L8KAGD7q/WgBT1b6f0oAQdV+n9KAEP3W+tADv4v\r
\nwoAZ/CPrQAvdvp/SkAn93/PagY0/dP1oAf8AxfhQBGPuj60AL/e+lAB/d+n9KAGn7p+tADv4vwoA\r
\nYPuj60AKerfT+lAxB/D9KQETdTQB/9k=\r\n",
"createdOn": "/Date(1373615304000)/",
"attachmentId": "841",
"createdBy": "admin",
"lastModifiedBy": "admin",
"isValidated": false,
"createdDateTime": "/Date(1373629704000+0000)/",
"documentTitle": "Tres",
"attachmentFileType": "jpeg",
"notes": null,
"issuePlace": null,
"issuingAuthority": null,
"countryNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpWorkPermit(country='USA',documentNumber='gr',documentType='6148',userId='174')
/countryNav"
}
},
"documentTypeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpWorkPermit(country='USA',documentNumber='gr',documentType='6148',userId='174')
/documentTypeNav"
}
},
"userNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpWorkPermit(country='USA',documentNumber='gr',documentType='6148',userId='174')
/userNav"
}
},
"employmentNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpWorkPermit(country='USA',documentNumber='gr',documentType='6148',userId='174')
/employmentNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

146 PUBLIC Employment Objects
Use Case 2: Upsert a Work Permit Entry for User afong1

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>//odata/v2/upsert

Payload
{
"__metadata": {
"uri": "EmpWorkPermit"
},
"country": "6057",
"documentType": "6345",
"documentNumber": "1234567",
"userId": "afong1",
"isValidated": true,
"documentTitle": null,
"issueDate": "/Date(1585699200000)/"
}

Response

 Sample Code

{
"d": [
{
"key": "EmpWorkPermit/country=6057,EmpWorkPermit/
documentNumber=1234567,EmpWorkPermit/documentType=6345,EmpWorkPermit/
userId=afong1",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Related Information

SAP API Business Hub: Employment Information

Permission Settings [page 15]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 147
6.11 EmpPayCompNonRecurring

This entity contains information about non-recurring components of an employee's pay.

HRIS Element Information

HRIS Element ID: payComponentNonRecurring

Business Keys:userId+ payComponentCode + payDate
Effective-date:false
Foundation Type:false
Person Entity Element:false
Supports Incremental Load:true
Supports NO_OVERWRITE: true
Supports MCPD:false

Supported Operations

Query, Upsert

Additional Business Key

Each payment record is associated with a sequence number, which enables you to have more than one pay
component on the same pay date. It can be defined as an additional business key via data model configuration.
With or without the seqNumber property being enabled, the business key and required fields for the entity are
different.

seqNumber enabled? Business Key Required Fields

No user_sys_id user_sys_id

pay-component-code pay-component-code

pay_date pay_date

Yes user_sys_id user_sys_id

seqNumber pay-component-code

pay_date

seqNumber

Enabling Multiple Non-Recurring Pay Components on the Same Pay Date

When an employee is due more than one non-recurring pay components on the same pay date, you can enable the
additional business key sequenceNumber to EmpPayCompNonRecurring to allow multiple pay components.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

148 PUBLIC Employment Objects
To enable seqNumber, add the following attributes to the seqNumber property in the data model from Provisioning:

<hris-field id="sequence-number" visibility="view" allow-import="true">

 Remember

As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.

 Caution

Once sequenceNumber is introduced as a business key, its value must be maintained. If the value is not
maintained in integrations that rely on the uniqueness of the pay component, these integrations could break.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

operation To delete a record, use the upsert operation and set this prop­
erty to DELIMIT.

Use Case: Query Payment Details Higher than $5,000

Request

The following request queries the value and the date of the payment, and first and last name of all payments higher
than $5000.

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
EmpPayCompNonRecurring?$filter=value gt
'5000' and currencyCode eq 'USD'&
$select=value,employmentNav/personNav/
personalInfoNav/firstName,employmentNav/
personNav/personalInfoNav/lastName&
$expand=employmentNav/personNav/
personalInfoNav&$format=JSON

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 149
Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/public/
EmpPayCompNonRecurring(payComponentCode='BNS-
USA',payDate=datetime'2011-05-09T00:00:00',userId='mbarista1')",
"type": "SFOData.EmpPayCompNonRecurring"
},
"value": "20000",
"employmentNav": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/public/
EmpEmployment(personIdExternal='mbarista1',userId='mbarista1')",
"type": "SFOData.EmpEmployment"
},
"personNav": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/public/
PerPerson('mbarista1')",
"type": "SFOData.PerPerson"
},
"personalInfoNav": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
public/
PerPersonal(personIdExternal='mbarista1',startDate=datetime'1990-01-01T00:00:00')",
"type": "SFOData.PerPersonal"
},
"lastName": "Barista",
"firstName": "Marcia"
}
]
}
}
}
}
]
}
}

Related Information

SAP API Business Hub: Compensation Information

Permission Settings [page 15]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

150 PUBLIC Employment Objects
6.12 EmpPayCompRecurring

You can use this entity to manage the recurring component of an employee's compensation, such as base salary,
hourly wage or house allowance.

HRIS Element Information

HRIS Element ID: empPayComponentRecurring

Business Keys: userId + payComponent + startDate + seqNumber
Effective-date:true
Foundation Type:false
Person Entity Element:false
Supports Incremental Load:true
Supports NO_OVERWRITE: true
Supports MCPD:true

Supported Operations

Query, Upsert

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

personIdExternal This property is a unique identifier for employees. You can use
this property to update or add the recurring compensation in­
formation of an employee with only one active employment.

seqNumber This property is automatically generated to specify the se­

quence of the record.

no-changes-until-date This property shows how long a pay component is valid for. It is
a transient field which is not stored in database, so it is not visi­
ble in OData API Data Dictionary. To configure this field, go to
Admin Center > Manage Business Configuration.

operation To delete a record, use the upsert operation and set this prop­
erty to DELIMIT.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 151
Use Case 1: Query the Record of an Annual Base Salary over 100000 USD

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
EmpPayCompRecurring?$filter=payComponent
eq 'Base Salary' and paycompvalue ge
'100000' and currencyCode eq 'USD' and
frequency eq 'ANN'&$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpPayCompRecurring(payComponent='Base
Salary',seqNumber=1L,startDate=datetime'2011-03-19T00:00:00',userId='wsown1')"
},
"startDate": "/Date(1300492800000)/",
"payComponent": "Base Salary",
"userId": "wsown1",
"seqNumber": "1",
"paycompvalue": "100000",
"currencyCode": "USD",
"endDate": "/Date(253402300799000)/",
"frequency": "ANN",
"lastModifiedDateTime": "/Date(1304284880000+0000)/",
"lastModifiedOn": "/Date(1304284880000)/",
"createdOn": "/Date(1304284880000)/",
"createdBy": "wsown1",
"createdDateTime": "/Date(1304284880000+0000)/",
"lastModifiedBy": "wsown1",
"notes": null,
"frequencyNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpPayCompRecurring(payComponent='Base
Salary',seqNumber=1L,startDate=datetime'2011-03-19T00:00:00',userId='wsown1')/
frequencyNav"
}
},
"payComponentNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpPayCompRecurring(payComponent='Base
Salary',seqNumber=1L,startDate=datetime'2011-03-19T00:00:00',userId='wsown1')/
payComponentNav"
}
},
"compensationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpPayCompRecurring(payComponent='Base
Salary',seqNumber=1L,startDate=datetime'2011-03-19T00:00:00',userId='wsown1')/
compensationNav"
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

152 PUBLIC Employment Objects
 "userNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpPayCompRecurring(payComponent='Base
Salary',seqNumber=1L,startDate=datetime'2011-03-19T00:00:00',userId='wsown1')/
userNav"
}
},
"employmentNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpPayCompRecurring(payComponent='Base
Salary',seqNumber=1L,startDate=datetime'2011-03-19T00:00:00',userId='wsown1')/
employmentNav"
}
}
}
]
}
}

Use Case 2: Upsert the Recurring Pay Component of an Employee with Multiple
User Ids

In case of an employee with multiple userIds, you can import the recurring compensation information by using
the personIdExternal property.

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert

Payload {
"__metadata": {
"uri": "https://<API-Server>/
odata/v2/EmpPayCompRecurring"
},
"userId":
"&&USE_PERSON_ID_EXTERNAL&&",
"seqNumber": "1",
"startDate": "/
Date(1272672000000)/",
"personIdExternal": "104038",
"payComponent": "BASIC_BZ",
"frequency": "MON",
"paycompvalue": "15000"
}

Response

{
"d": [
{
"key": "EmpPayCompRecurring/payComponent=BASIC_BZ,EmpPayCompRecurring/
seqNumber=1,EmpPayCompRecurring/

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 153
 startDate=2010-05-01T00:00:00.000Z,EmpPayCompRecurring/
userId=&&USE_PERSON_ID_EXTERNAL&&",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Related Information

SAP API Business Hub: Compensation Information

lastModifiedDateTime and $filter [page 42]

6.13 EmpTimeAccountBalance

The EmpTimeAccountBalance entity provides time account balance information, enabling external systems like
payrolls to capture this data. The most common use case for deriving time account balance information is to enrich
the employee’s pay slip with time off data.

Context Information

A prerequisite for this API is a configured Employee Central Time Off solution.

As the balance is not stored in Employee Central Time Off, the API needs to calculate the balance as of the
specified date (balance as of date). The API therefore needs to determine the valid time accounts of the respective
user (that is, employment) and time account type and calculate the balance by summing up the time account
details.

The API currently returns only calculated data based on accrual runs already performed. Simulated data is not
returned by the API.

For details, check the corresponding Implementation Information for Time Off available at http://help.sap.com/
cloud4hr?current=on-demand#section5.

How is the balance calculated?

● Determination of valid time accounts
Balance is calculated based on time accounts for the requested time account type. The validity of a time
account is derived from the bookable period. Time accounts are selected if the parameter balanceAsOfDate
falls into the bookable period. Closed accounts are considered.

 Note

Example

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

154 PUBLIC Employment Objects
 Vacation 2013 (Bookable period 1.1.2017-31.03.2018) Balance 5 days7

Vacation 2018 (Bookable period 1.1.2018-31.03.2019) Balance 18 days

If the service is called with a balance as of date 1.3.2018, the system identifies two valid time accounts and
returns both results. Result would be 2 records as above.

If the service is called with a balance as of date 1.8.2018, the system identifies only one valid time account.
Result would be 18 days. One record is returned only.

● The balance considers all positive and negative bookings up to the selected date. This includes:
○ All accruals and entitlements
○ Manual adjustments (deduction and adding)
○ Carry forward values from period end processing (negative or positive)
○ All recalculation values for example due to an FTE change (negative and positive)
○ All taken leave up to the selected day
○ And all other bookings

Supported Operations

Query

Parameters

The entity has two required filters, to be used in $filter, which support IN and EQ operators only. The second
optional parameter is a normal URL parameter which requires a date in format YYYY-MM-DD.

Name Required Description

timeAccountType as part of Yes List of time account types. Error if no

$filter time account type is provided.

 Caution
The external code of the time ac­
count type is case sensitive. Make
sure that the external code is cor­
rect.

balanceAsOfDate URL parameter No Balances as of Date If no date is passed,

today will be used as the default effective
date

userId as part of $filter Yes List of users. Error if no user is provided.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 155
  Caution

When you use this entity in middleware or Integration Center, bulk data abstraction is not possible because
userId is a mandatory field and giving all userId in the filter criteria will lead to a large query that would result in
a failure.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

The following properties are returned for each record. The API might return several records per user and time
account type provided in the filter. The unique key of the returned records is neither the userId nor the
timeAccountType but the unique UUID of the TimeAccount Entity. This means that the API returns the balance for
all relevant time accounts of the given users and adds additional information based on the returned time account.

Property Description

timeAccount Unique ID of the selected time accounts

timeAccountType Time account type of the selected time accounts

timeUnit Either days or hours

balance Values as described below

userId User ID from User Entity

accountClosed Boolean value that indicates whether the corresponding ac­

count is closed already and can no longer be booked.

Use Case 1: Payroll Integration: Provide Time Account Balance Information for
Payslip

Request

Operation Query

HTTP Method GET

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

156 PUBLIC Employment Objects
 URI https://<API-Server>/odata/v2/
EmpTimeAccountBalance?$filter=userId in
'btassimo','bwfapproval' and
timeAccountType in
'bgs_tacct_irregularWorkSchedule_hours',
'bgs_tacct_WF_NoStep_CcRole-
Person','bgs_tacct_WF_stepEM_CcEMM','bgs_t
acct_WF_NoStep_CcDynamicGroup',
'bgs_tacct_WF_NoStep_CcDynamicRole'&
$format=JSON&balanceAsOfDate=2014-09-01

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpTimeAccountBalance('168c659421714e16bcd1963d9937731b')",
"type": "SFOData.EmpTimeAccountBalance"
},
"timeAccount": "168c659421714e16bcd1963d9937731b",
"balance": "240",
"userId": "btassimo",
"timeUnit": "HOURS",
"accountClosed": false,
"timeAccountType": "bgs_tacct_irregularWorkSchedule_hours"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpTimeAccountBalance('b081c83b83c6472fa0920bd47057f74c')",
"type": "SFOData.EmpTimeAccountBalance"
},
"timeAccount": "b081c83b83c6472fa0920bd47057f74c",
"balance": "-4.2166666667",
"userId": "bwfapproval",
"timeUnit": "HOURS",
"accountClosed": false,
"timeAccountType": "bgs_tacct_WF_stepEM_CcEMM"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpTimeAccountBalance('03f7b8cd4fac41f08a0d44f3f38eb015')",
"type": "SFOData.EmpTimeAccountBalance"
},
"timeAccount": "03f7b8cd4fac41f08a0d44f3f38eb015",
"balance": "39.75",
"userId": "bwfapproval",
"timeUnit": "DAYS",
"accountClosed": false,
"timeAccountType": "bgs_tacct_WF_NoStep_CcRole-Person"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpTimeAccountBalance('168c659421714e16bcd1963d9937731b')",
"type": "SFOData.EmpTimeAccountBalance"
},
"timeAccount": "168c659421714e16bcd1963d9937731b",
"balance": "240",
"userId": "btassimo",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 157
 "timeUnit": "HOURS",
"accountClosed": false,
"timeAccountType": "bgs_tacct_irregularWorkSchedule_hours"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpTimeAccountBalance('b081c83b83c6472fa0920bd47057f74c')",
"type": "SFOData.EmpTimeAccountBalance"
},
"timeAccount": "b081c83b83c6472fa0920bd47057f74c",
"balance": "-4.2166666667",
"userId": "bwfapproval",
"timeUnit": "HOURS",
"accountClosed": false,
"timeAccountType": "bgs_tacct_WF_stepEM_CcEMM"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpTimeAccountBalance('03f7b8cd4fac41f08a0d44f3f38eb015')",
"type": "SFOData.EmpTimeAccountBalance"
},
"timeAccount": "03f7b8cd4fac41f08a0d44f3f38eb015",
"balance": "39.75",
"userId": "bwfapproval",
"timeUnit": "DAYS",
"accountClosed": false,
"timeAccountType": "bgs_tacct_WF_NoStep_CcRole-Person"
}
]
}
}

Error Handling

Invalid userIds or Time Account Types are not reported as errors and will lead to an empty result.

Related Information

SAP API Business Hub: Time Off

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

158 PUBLIC Employment Objects
6.14 HireDateChange

This entity contains information about changing the hire date of an employee in Employee Central.

Permissions

Metadata Framework Hire Date Correction

Supported Operations

Query

Use Case 1: Query the Hire Date Change of an Employee

In the following example, the hire date of an employee is changed.

Request

Operation Query

HTTP Method GET

URI https://<API-SErver>/odata/v2/HireDateChange?
$filter=usersSysId eq 'testUserSysID’&$format=json

Response

 Sample Code

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/HireDateChange?
$filter=usersSysId eq 'testUserSysID’&$format=json",
"type": "SFOData.HireDateChange"
},
"code": "testCode",
"originalHireDate": "/Date(1696723200000)/",
"lastModifiedDateTime": "/Date(1571150956000+0000)/",
"lastModifiedBy": "testUserSysID",
"createdDateTime": "/Date(1571150956000+0000)/",
"mdfSystemRecordStatus": "N",
"newHireDate": "/Date(2011737600000)/",
"processingStatus": "SUCCESSFUL",
"usersSysId": "testUserSysID",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 159
 "createdBy": "testUserSysID",
"usersSysIdNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/restricted/
HireDateChange('testCode')/usersSysIdNav"
}
},
"processingStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/restricted/
HireDateChange('testCode')/processingStatusNav"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/restricted/
HireDateChange('testCode')/createdByNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/restricted/
HireDateChange('testCode')/wfRequestNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/restricted/
HireDateChange('testCode')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/restricted/
HireDateChange('testCode')/mdfSystemRecordStatusNav"
}
}
}
]
}
}

Related Information

Changing an Employee's Hire Date in Employee Central

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

160 PUBLIC Employment Objects
6.15 EmpCostDistribution

This entity allows you to create an alternative cost distribution for employees.

Permissions

Permission System Required Setting

Role-based User Permissions -> Miscellaneous Permissions -> Alternative

Cost Distribution

Supported Operations

Query, Upsert, Insert, Merge, Replace, Delete

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Navigation Property Related Entity Description

items EmpCostDistributionItem Child entity that has a one-to-many asso­

ciation with its parent. It stores all the de­
tails of cost distribution.

mdfSystemRecordStatusNav MDFEnumValue The ENUM data type values maintained

by the MDF team for that entity.

mdfSystemStatusNav MDFEnumValue The ENUM data type values maintained

by the MDF team for that entity.

createdByNav User Navigates to the User entity.

lastModifiedByNav User Navigates to the User entity.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 161
Navigation Property Related Entity Description

usersSysIdNav User Navigates to the User entity.

Use Case 1: Querying Alternate Cost Distribution

Query continuous requests about the alternate cost distribution for an employee.

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/EmpCostDistribution?
$filter=usersSysId eq <User-ID>&$expand=items&$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpCostDistribution(effectiveStartDate=datetime'2021-03-26T00:00:00',usersSysId='<Us
er-ID>')",
"type": "SFOData.EmpCostDistribution"
},
"usersSysId": <User-ID>,
"effectiveStartDate": "/Date(1616716800000)/",
"effectiveEndDate": "/Date(253402214400000)/",
"lastModifiedDateTime": "/Date(1616733672000+0000)/",
"lastModifiedBy": "223344",
"createdDateTime": "/Date(1616733672000+0000)/",
"mdfSystemRecordStatus": "N",
"createdBy": "223344",
"usersSysIdNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostDistribution(effectiveStartDate=datetime'2021-03-26T00:00:00',usersSysId='<Us
er-ID>')/usersSysIdNav"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostDistribution(effectiveStartDate=datetime'2021-03-26T00:00:00',usersSysId='<Us
er-ID>')/createdByNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostDistribution(effectiveStartDate=datetime'2021-03-26T00:00:00',usersSysId='<Us
er-ID>')/wfRequestNav"
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

162 PUBLIC Employment Objects
 "lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostDistribution(effectiveStartDate=datetime'2021-03-26T00:00:00',usersSysId='<Us
er-ID>')/lastModifiedByNav"
}
},
"items": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpCostDistributionItem(EmpCostDistribution_effectiveStartDate=datetime'2021-03-26T0
0:00:00',EmpCostDistribution_usersSysId='<User-ID>',externalCode=147843L)",
"type": "SFOData.EmpCostDistributionItem"
},
"externalCode": "147843",
"EmpCostDistribution_usersSysId": "<User-ID>",
"EmpCostDistribution_effectiveStartDate": "/
Date(1616716800000)/",
"lastModifiedDateTime": "/Date(1616733672000+0000)/",
"costCenter": "MC_240001",
"lastModifiedBy": "223344",
"createdDateTime": "/Date(1616733672000+0000)/",
"mdfSystemRecordStatus": "N",
"createdBy": "223344",
"percentage": "1",
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostDistributionItem(EmpCostDistribution_effectiveStartDate=datetime'2021-03-26T0
0:00:00',EmpCostDistribution_usersSysId='<User-ID>',externalCode=147843L)/
createdByNav"
}
},
"costCenterNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostDistributionItem(EmpCostDistribution_effectiveStartDate=datetime'2021-03-26T0
0:00:00',EmpCostDistribution_usersSysId='<User-ID>',externalCode=147843L)/
costCenterNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostDistributionItem(EmpCostDistribution_effectiveStartDate=datetime'2021-03-26T0
0:00:00',EmpCostDistribution_usersSysId='<User-ID>',externalCode=147843L)/
lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostDistributionItem(EmpCostDistribution_effectiveStartDate=datetime'2021-03-26T0
0:00:00',EmpCostDistribution_usersSysId='<User-ID>',externalCode=147843L)/
mdfSystemRecordStatusNav"
}
}
}
]
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostDistribution(effectiveStartDate=datetime'2021-03-26T00:00:00',usersSysId='<Us
er-ID>')/mdfSystemRecordStatusNav"
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 163
 }
}
]
}
}

Use Case 2: Upserting Alternative Cost Distribution

Insert or update alternate cost distribution for an employee.

Request

Operation Upsert

HTTP Method POST

URI https://<api-server>/odata/v2/upsert?

Payload {
"__metadata": {
"uri": "/
EmpCostDistribution(effectiveStartDate=datetime'2021-03-
26T00:00:00',usersSysId='<User-Id>')",
"type":
"SFOData.EmpCostDistribution"
},
"usersSysId": <User-Id>,
"effectiveStartDate": "/
Date(1616716800000)/",
"items": [
{
"__metadata": {
"uri": "https://<API-
Server>/odata/v2/
EmpCostDistributionItem(EmpCostDistribution_effectiveSta
rtDate=datetime'2021-03-26T00:00:00',EmpCostDistribution
_usersSysId='438',externalCode=147843L)",
"type":
"SFOData.EmpCostDistributionItem"
},

"EmpCostDistribution_usersSysId": <User-Id>,

"EmpCostDistribution_effectiveStartDate": "/
Date(1616716800000)/",
"lastModifiedDateTime": "/
Date(1616733672000+0000)/",
"costCenter": "MC_240001",
"lastModifiedBy": "223344",
"createdDateTime": "/
Date(1616733672000+0000)/",
"mdfSystemRecordStatus":
"N",
"createdBy": "223344",
"percentage": "1"
}
]
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

164 PUBLIC Employment Objects
Response

{
"d": [
{
"key": "EmpCostDistribution/
effectiveStartDate=2021-03-26T00:00:00.000Z,EmpCostDistribution/usersSysId=<User-
Id>",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Use Case 3: Modifying Alternative Cost Distribution

Change alternate cost distribution for an employee.

Request

Operation Merge

HTTP Method POST

URI https://<api-server>/odata/v2/
EmpCostDistribution(effectiveStartDate=datetime'2021-03-26T
00:00:00',usersSysId='<User-Id>')

Header x-http-method: MERGE

Content-Type: application/json

Payload {
"__metadata": {
"uri": "/
EmpCostDistribution(effectiveStartDate=datetime'2021-03-
26T00:00:00',usersSysId='<User-Id>')",
"type":
"SFOData.EmpCostDistribution"
},
"usersSysId": "<User-Id>",
"effectiveStartDate": "/
Date(16167168004559)/",
}

Use Case 4: Creating Alternative Cost Distribution

Insert alternative cost distribution for an employee

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 165
Request

Operation Insert

HTTP Method POST

URI https://<api-server>/odata/v2/EmpCostDistribution

Payload {
"__metadata": {
"uri": "/
EmpCostDistribution(effectiveStartDate=datetime'2021-03-
29T00:00:00',usersSysId='<User-Id>')",
"type":
"SFOData.EmpCostDistribution"
},
"usersSysId": "<User-Id>",
"effectiveStartDate": "/
Date(16167164004879)/",
"items": [
{
"__metadata": {
"uri": "https://<API-
Server>/odata/v2/
EmpCostDistributionItem(EmpCostDistribution_effectiveSta
rtDate=datetime'2021-03-29T00:00:00',EmpCostDistribution
_usersSysId='<User-Id>',externalCode=147843L)",
"type":
"SFOData.EmpCostDistributionItem"
},

"EmpCostDistribution_usersSysId": "<User-Id>",

"EmpCostDistribution_effectiveStartDate": "/
Date(16167164004879)/",
"costCenter": "MC_240001",
"lastModifiedBy": "223344",
"percentage": "48"
}
]
}

Response

{
"d": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpCostDistribution(effectiveStartDate=datetime'2482-04-25T00:00:00',usersSysId='<Us
er-Id>')",
"type": "SFOData.EmpCostDistribution"
},
"usersSysId": "<User-Id>",
"effectiveStartDate": "/Date(16167081600000)/",
"items": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpCostDistributionItem(EmpCostDistribution_effectiveStartDate=datetime'2021-03-29T0
0:00:00',EmpCostDistribution_usersSysId='<User-Id>',externalCode=147843L)",
"type": "SFOData.EmpCostDistributionItem"
},
"EmpCostDistribution_usersSysId": "<User-Id>",
"EmpCostDistribution_effectiveStartDate": "/Date(16167164004879)/",
"costCenter": "MC_240001",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

166 PUBLIC Employment Objects
 "lastModifiedBy": "223344",
"percentage": "48"
}
}
}

Use Case 5: Deleting Alternative Cost Distribution

Delete alternative cost distribution for an employee.

Request

Operation Delete

HTTP Method DELETE

URI https://<api-server>/odata/v2/
EmpCostDistribution(effectiveStartDate=datetime'2021-04-01T
00:00:00',usersSysId='<User-Id>')

6.15.1 EmpCostDistributionItem

The EmpCostDistributionItem entity is a composite child entity of the EmpCostDistribution entity and contains the
individual alternative cost distribution for each employee.

Prerequisites

You've created the parent entity EmpCostDistribution [page 161].

Permissions

Permission System Required Setting

Role-based Administrator Permissions -> Metadata Framework -> Access

to non-secured objects

Supported Operations

Query, Upsert, Insert, Merge, Replace, Delete

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 167
Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Navigation Property Related Entity Description

mdfSystemRecordStatusNav MDFEnumValue The ENUM data type values maintained

by the MDF team for that entity.

mdfSystemStatusNav MDFEnumValue The ENUM data type values maintained

by the MDF team for that entity.

createdByNav User Navigates to the User entity.

lastModifiedByNav User Navigates to the User entity.

costCenterNav FOCostCenter Represents the generic MDF object Cost­

Center.

Use Case 1: Querying Alternate Cost Distribution Item

Query continuous requests about the alternate cost distribution item for an employee.

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/EmpCostDistributionItem?
$filter=EmpCostDistribution_usersSysId eq <User-Id> &
$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpCostDistributionItem(EmpCostDistribution_effectiveStartDate=datetime'2021-03-26T0
0:00:00',EmpCostDistribution_usersSysId='<User-Id>',externalCode=147843L)",
"type": "SFOData.EmpCostDistributionItem"
},
"externalCode": "147843",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

168 PUBLIC Employment Objects
 "EmpCostDistribution_usersSysId": "<User-Id>",
"EmpCostDistribution_effectiveStartDate": "/Date(1616716800000)/",
"lastModifiedDateTime": "/Date(1616733672000+0000)/",
"costCenter": "MC_240001",
"lastModifiedBy": "223344",
"createdDateTime": "/Date(1616733672000+0000)/",
"mdfSystemRecordStatus": "N",
"createdBy": "223344",
"percentage": "1",
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostDistributionItem(EmpCostDistribution_effectiveStartDate=datetime'2021-03-26T0
0:00:00',EmpCostDistribution_usersSysId='<User-Id>',externalCode=147843L)/
createdByNav"
}
},
"costCenterNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostDistributionItem(EmpCostDistribution_effectiveStartDate=datetime'2021-03-26T0
0:00:00',EmpCostDistribution_usersSysId='<User-Id>',externalCode=147843L)/
costCenterNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostDistributionItem(EmpCostDistribution_effectiveStartDate=datetime'2021-03-26T0
0:00:00',EmpCostDistribution_usersSysId='<User-Id>',externalCode=147843L)/
lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostDistributionItem(EmpCostDistribution_effectiveStartDate=datetime'2021-03-26T0
0:00:00',EmpCostDistribution_usersSysId='<User-Id>',externalCode=147843L)/
mdfSystemRecordStatusNav"
}
}
}
]
}
}

Use Case 2: Upserting Alternative Cost Distribution Item

Insert or update alternate cost distribution item for an employee.

Request

Operation Upsert

HTTP Method POST

URI https://<api-server>/odata/v2/upsert?

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 169
Payload {
"__metadata": {
"uri": "https://<API-Server>/
odata/v2/
EmpCostDistributionItem(EmpCostDistribution_effectiveSta
rtDate=datetime'2021-03-26T00:00:00',EmpCostDistribution
_usersSysId='<User-Id>',externalCode=147843L)",
"type":
"SFOData.EmpCostDistributionItem"
},
"EmpCostDistribution_usersSysId":
"<User-Id>",

"EmpCostDistribution_effectiveStartDate": "/
Date(1616716800000)/",
"costCenter": "MC_240001",
"percentage": "1"
}

Response

{
"d": [
{
"key": "EmpCostDistributionItem/
EmpCostDistribution_effectiveStartDate=2021-03-26T00:00:00.000Z,EmpCostDistributionI
tem/EmpCostDistribution_usersSysId=<User-Id>,EmpCostDistributionItem/
externalCode=147843",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Use Case 3: Modifying Alternative Cost Distribution Item

Change alternate cost distribution item for an employee

Request

Operation Merge

HTTP Method POST

URI https://<api-server>/odata/v2/
EmpCostDistributionItem(EmpCostDistribution_effectiveStartD
ate=datetime'2021-04-01T00:00:00',EmpCostDistribution_users
SysId='<User-Id>',externalCode=419336L)

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

170 PUBLIC Employment Objects
 Header x-http-method: MERGE

Content-Type: application/json

Payload {
"percentage": "55"
}

Use Case 4: Creating Alternative Cost Distribution Item

Insert alternative cost distribution item for an employee

Request

Operation Insert

HTTP Method POST

URI https://<api-server>/odata/v2/EmpCostDistributionItem

Payload {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpCostDistributionItem(EmpCostDistribution_effectiveSta
rtDate=datetime'2021-04-01T00:00:00',EmpCostDistribution
_usersSysId='<User-Id>')",
"type": "SFOData.EmpCostDistributionItem"
},
"EmpCostDistribution_usersSysId": "<User-Id>",
"EmpCostDistribution_effectiveStartDate": "/
Date(1617235200000)/",
"percentage": "1",
"costCenter": "7500-1110"
}

Response

{
"d": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpCostDistributionItem(EmpCostDistribution_effectiveStartDate=datetime'2021-04-01T0
0:00:00',EmpCostDistribution_usersSysId='<User-Id>',externalCode=419337L)",
"type": "SFOData.EmpCostDistributionItem"
},
"percentage": "1",
"costCenter": "7500-1110",
"externalCode": "419337",
"EmpCostDistribution_usersSysId": "<User-Id>",
"EmpCostDistribution_effectiveStartDate": "/Date(1617235200000)/"
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 171
Use Case 5: Deleting Alternative Cost Distribution Item

Delete alternative cost distribution item for an employee.

Request

Operation Delete

HTTP Method DELETE

URI https://<api-server>/odata/v2/
EmpCostDistributionItem(EmpCostDistribution_effectiveStartD
ate=datetime'2021-04-01T00:00:00',EmpCostDistribution_users
SysId='<User-Id>',externalCode=419337L)

6.16 SecondaryAssignments

You use this entity to differentiate primary from secondary employments during concurrent employment
replications.

Supported Operations

Query, Insert, Merge, Replace, Upsert, Delete

Use Cases: Query the Secondary Assignments of a Person

Request
Request Information

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/PerPerson?
$format=json&$filter=personIdExternal%20eq
%20'jsmith'&
$expand=secondaryAssignmentsNav/
allSfProcesses

Reponse

{
"d": {
"results": [

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

172 PUBLIC Employment Objects
 {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/PerPerson('jsmith')",
"type": "SFOData.PerPerson"
},
"personIdExternal": "jsmith",
"dateOfBirth": null,
"lastModifiedOn": "/Date(1303743709000)/",
"lastModifiedDateTime": "/Date(1303743709000+0000)/",
"dateOfDeath": null,
"createdOn": "/Date(1303743708000)/",
"countryOfBirth": null,
"createdBy": "v4admin",
"regionOfBirth": null,
"createdDateTime": "/Date(1303743708000+0000)/",
"lastModifiedBy": "v4admin",
"personId": "11",
"personRerlationshipNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('jsmith')/
personRerlationshipNav"
}
},
"emergencyContactNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('jsmith')/
emergencyContactNav"
}
},
"phoneNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('jsmith')/
phoneNav"
}
},
"personalInfoNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('jsmith')/
personalInfoNav"
}
},
"homeAddressNavDEFLT": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('jsmith')/
homeAddressNavDEFLT"
}
},
"secondaryAssignmentsNav": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
SecondaryAssignments(effectiveStartDate=datetime'2016-06-24T00:00:00',externalCode='
jsmith')",
"type": "SFOData.SecondaryAssignments"
},
"effectiveStartDate": "/Date(1466726400000)/",
"externalCode": "jsmith",
"mdfSystemObjectType": "SecondaryAssignments",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1467020470000+0000)/",
"mdfSystemTransactionSequence": "1",
"effectiveEndDate": "/Date(1468108800000)/",
"createdBy": "admin",
"mdfSystemRecordId": "566D79D0BE2340BC83CC882FF39AAE62",
"mdfSystemEntityId": "BD0ABACF60354252BFC0E4EDB7F2BE02",
"createdDateTime": "/Date(1467020470000+0000)/",
"lastModifiedBy": "admin",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 173
 "mdfSystemStatus": "A",
"lastModifiedDate": "/Date(1467020470000)/",
"lastModifiedDateWithTZ": "/Date(1467020470000+0000)/",
"createdDate": "/Date(1467020470000)/",
"mdfSystemRecordStatus": "N",
"wfRequestNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
SecondaryAssignments(effectiveStartDate=datetime'2016-06-24T00:00:00',externalCode='
jsmith')/wfRequestNav"
}
},
"allSfProcesses": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
SecondaryAssignmentsItem(SecondaryAssignments_effectiveStartDate=datetime'2016-06-24
T00:00:00',SecondaryAssignments_externalCode='jsmith',externalCode='c95d6999d02e4687
8dcad5ef2a02397c')",
"type":
"SFOData.SecondaryAssignmentsItem"
},
"SecondaryAssignments_externalCode":
"jsmith",
"SecondaryAssignments_effectiveStartDate":
"/Date(1466726400000)/",
"externalCode":
"c95d6999d02e46878dcad5ef2a02397c",
"mdfSystemEffectiveEndDate": "/
Date(253402214400000)/",
"mdfSystemObjectType":
"SecondaryAssignmentsItem",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/
Date(1467020470000+0000)/",
"usersSysId": "181",
"mdfSystemTransactionSequence": "1",
"createdBy": "admin",
"mdfSystemRecordId":
"448E51556F414997A79F1360D837CD29",
"mdfSystemEntityId":
"DCAF412BC16D46408FB7D3EEDB7DDF63",
"createdDateTime": "/
Date(1467020470000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"lastModifiedDate": "/Date(1467020470000)/",
"mdfSystemEffectiveStartDate": "/
Date(-2208988800000)/",
"lastModifiedDateWithTZ": "/
Date(1467020470000+0000)/",
"createdDate": "/Date(1467020470000)/",
"mdfSystemRecordStatus": "N",
"usersSysIdNav": {
"__deferred": {
"uri": "https://<API-Server>/
odata/v2/
SecondaryAssignmentsItem(SecondaryAssignments_effectiveStartDate=datetime'2016-06-24
T00:00:00',SecondaryAssignments_externalCode='jsmith',externalCode='c95d6999d02e4687
8dcad5ef2a02397c')/usersSysIdNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/
odata/v2/
SecondaryAssignmentsItem(SecondaryAssignments_effectiveStartDate=datetime'2016-06-24

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

174 PUBLIC Employment Objects
 T00:00:00',SecondaryAssignments_externalCode='jsmith',externalCode='c95d6999d02e4687
8dcad5ef2a02397c')/mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/
odata/v2/
SecondaryAssignmentsItem(SecondaryAssignments_effectiveStartDate=datetime'2016-06-24
T00:00:00',SecondaryAssignments_externalCode='jsmith',externalCode='c95d6999d02e4687
8dcad5ef2a02397c')/mdfSystemStatusNav"
}
}
}
]
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
SecondaryAssignments(effectiveStartDate=datetime'2016-06-24T00:00:00',externalCode='
jsmith')/mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
SecondaryAssignments(effectiveStartDate=datetime'2016-06-24T00:00:00',externalCode='
jsmith')/mdfSystemStatusNav"
}
}
}
]
},
"nationalIdNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('jsmith')/
nationalIdNav"
}
},
"countryOfBirthNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('jsmith')/
countryOfBirthNav"
}
},
"emailNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('jsmith')/
emailNav"
}
},
"socialAccountNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('jsmith')/
socialAccountNav"
}
},
"employmentNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('jsmith')/
employmentNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 175
Related Information

SAP API Business Hub: Global Assignment

Permission Settings [page 15]
SecondaryAssignmentsItem [page 176]
Differentiating primary from secondary employment during concurrent employment replication [page 844]

6.16.1 SecondaryAssignmentsItem

A composite child of SecondaryAssignments. It can only be upserted with SecondaryAssignments. Along with
SecondaryAssignments, it captures concurrent employment information. To be precise, the PerPerson entity has a
navigation secondayAssignmentsNav that lets you navigate to the entity SecondaryAssignments.

Supported Operations

Query, Insert, Merge, Replace, Upsert, Delete

 Note

Although all operations are supported, the only one that makes any business sense is upsert.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Case: Upsert a Secondary Assignment

There is not often a business case for this operation but it has been provided to support the cloning or transfer of
data between similar instances in a different environment. In this example, user system ID (represented by the
externalcode) for the primary employment is PrimaryEmployment and the userSysID for secondary employment is
represented by 301 (a number automatically generated when a secondary employment is created).

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

176 PUBLIC Employment Objects
Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert

Payload {
"__metadata": { "uri":
"SecondaryAssignments"},
"effectiveStartDate" : "/
Date(1420066800000)/",
"externalCode" : "mjaschob",
"allSfProcesses": {
"__metadata": { "uri":
"SecondaryAssignmentsItem"},

"SecondaryAssignments_effectiveStartDate
" : "/Date(1420066800000)/",

"SecondaryAssignments_externalCode" :
"mjaschob",
"externalCode" :
"myexternalcode55",
"usersSysId" : "301"
}
}

Additional Information

You can see an example of SecondaryAssigmentsItem in use in Differentiating primary from secondary
employment during concurrent employment replication [page 844]

Related Information

SAP API Business Hub: Global Assignment

SecondaryAssignments [page 172]
Differentiating primary from secondary employment during concurrent employment replication [page 844]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employment Objects PUBLIC 177
7 Employee Central for Public Sector

7.1 HDTempAssignment

The HDTempAssignment API allows you to retrieve or store Higher Duty or Temporary Assignment position,
responsibility, and allowance details.

Supported Operations

Query, Insert, Upsert.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Navigation Property Related Entity Description

usersSysIdNav User Quick card of user

Entity Relationship Diagram

Use Case 1: Query Higher Duties/Temporary Assignment specific information

List all the Higher Duty/Temporary assignments of type “Fully Responsibility".

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

178 PUBLIC Employee Central for Public Sector
Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/HDTempAssignment?
$filter=responsibilityType eq ‘FULL_RESPONSIBILITY’

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-server>/odata/v2/
HDTempAssignment(mdfSystemEffectiveStartDate=datetime'2020-01-27T00:00:00',usersSysI
d='cgrant1')",
"type": "SFOData.HDTempAssignment"
},
"mdfSystemEffectiveStartDate": "/Date(1580083200000)/",
"usersSysId": "cgrant1",
"effectiveEndDate": "/Date(253402214400000)/",
"lastModifiedDateTime": "/Date(1580117557000+0000)/",
"createdDateTime": "/Date(1580117557000+0000)/",
"percentageAllowance": null,
"discardLessThanHalfDay": false,
"substantiveReferenceSalary": "66.76",
"hdTempAmtsCurrency": null,
"percentageHDTemp": "88.88",
"responsibilityType": "FULL_RESPONSIBILITY",
"countingRule": null,
"substantiveRefSalaryPayComp": null,
"lastModifiedBy": "admin",
"substantiveAmtsCurrency": null,
"substantiveRefSalaryAdjustedAmt": null,
"hdTempRefSalaryAdjustedAmt": null,
"hdTempRefSalaryPayComp": null,
"s17Indicator": false,
"mdfSystemRecordStatus": "N",
"hdTempReferencePosition": "MGR_ACTNE",
"createdBy": "admin",
"allowanceBasis": "NOT_APPLICABLE",
"hdTempReferenceSalaryFromPerson": false,
"subReferenceUserID": null,
"costAssignment": "DEFAULT_FROM_POSITION",
"hdTempReferenceSalary": null,
"hdTempReferenceUserID": null,
"usersSysIdNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
HDTempAssignment(mdfSystemEffectiveStartDate=datetime'2020-01-27T00:00:00',usersSysI
d='cgrant1')/usersSysIdNav"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
HDTempAssignment(mdfSystemEffectiveStartDate=datetime'2020-01-27T00:00:00',usersSysI
d='cgrant1')/createdByNav"
}
},
"hdTempRefSalaryPayCompNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employee Central for Public Sector PUBLIC 179
 "uri": "https://<API-server>/odata/v2/
HDTempAssignment(mdfSystemEffectiveStartDate=datetime'2020-01-27T00:00:00',usersSysI
d='cgrant1')/hdTempRefSalaryPayCompNav"
}
},
"costAssignmentNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
HDTempAssignment(mdfSystemEffectiveStartDate=datetime'2020-01-27T00:00:00',usersSysI
d='cgrant1')/costAssignmentNav"
}
},
"substantiveAmtsCurrencyNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
HDTempAssignment(mdfSystemEffectiveStartDate=datetime'2020-01-27T00:00:00',usersSysI
d='cgrant1')/substantiveAmtsCurrencyNav"
}
},
"countingRuleNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
HDTempAssignment(mdfSystemEffectiveStartDate=datetime'2020-01-27T00:00:00',usersSysI
d='cgrant1')/countingRuleNav"
}
},
"hdTempReferenceUserIDNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
HDTempAssignment(mdfSystemEffectiveStartDate=datetime'2020-01-27T00:00:00',usersSysI
d='cgrant1')/hdTempReferenceUserIDNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
HDTempAssignment(mdfSystemEffectiveStartDate=datetime'2020-01-27T00:00:00',usersSysI
d='cgrant1')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
HDTempAssignment(mdfSystemEffectiveStartDate=datetime'2020-01-27T00:00:00',usersSysI
d='cgrant1')/mdfSystemRecordStatusNav"
}
},
"subReferenceUserIDNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
HDTempAssignment(mdfSystemEffectiveStartDate=datetime'2020-01-27T00:00:00',usersSysI
d='cgrant1')/subReferenceUserIDNav"
}
},
"hdTempReferencePositionNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
HDTempAssignment(mdfSystemEffectiveStartDate=datetime'2020-01-27T00:00:00',usersSysI
d='cgrant1')/hdTempReferencePositionNav"
}
},
"substantiveRefSalaryPayCompNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
HDTempAssignment(mdfSystemEffectiveStartDate=datetime'2020-01-27T00:00:00',usersSysI
d='cgrant1')/substantiveRefSalaryPayCompNav"
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

180 PUBLIC Employee Central for Public Sector
 "allowanceBasisNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
HDTempAssignment(mdfSystemEffectiveStartDate=datetime'2020-01-27T00:00:00',usersSysI
d='cgrant1')/allowanceBasisNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
HDTempAssignment(mdfSystemEffectiveStartDate=datetime'2020-01-27T00:00:00',usersSysI
d='cgrant1')/wfRequestNav"
}
},
"responsibilityTypeNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
HDTempAssignment(mdfSystemEffectiveStartDate=datetime'2020-01-27T00:00:00',usersSysI
d='cgrant1')/responsibilityTypeNav"
}
},
"hdTempAmtsCurrencyNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
HDTempAssignment(mdfSystemEffectiveStartDate=datetime'2020-01-27T00:00:00',usersSysI
d='cgrant1')/hdTempAmtsCurrencyNav"
}
}
}
]
}
}

Use Case 2: Create a new Higher Duty/Temporary Assignment

Create a new Higher Duty/Temporary Assignment MDF or a new time-slice of the same assignment for a Higher
Duty/Temporary Assignment employment.

Request

Operation Insert

HTTP Method POST

URI https://<API-Server>/odata/v2/HDTempAssignment

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employee Central for Public Sector PUBLIC 181
Payload {
"__metadata": {
"uri":
"HDTempAssignment(usersSysId='293',mdfSystemEffectiveSta
rtDate=datetime'2020-07-10T00:00:00')"
},
"usersSysId": "293",
"percentageHDTemp": "97",
"hdTempReferencePosition": "ACC_MGR_SC1",
"allowanceBasis": "NOT_APPLICABLE",
"responsibilityType": "INDIVIDUAL_CONTRIBUTOR",
"subReferenceUserID": "AMKOHNE",
"costAssignment": "MAINTAIN_MANUALLY",
"hdTempReferencePositionNav": {
"__metadata": {
"uri":
"Position(code='ACC_MGR_SC1',effectiveStartDate=datetime
'2020-06-10T00:00:00')",
"type": "SFOData.Position"
}
}
}

Additional Information

7.2 EmpCostAssignment

The EmpCostAssignment API allows you to define the primary assignment and secondary/alternative assignment
of the cost center, fund, grant, functional area, budget period, and funds center for an employee.

Permissions

Permission System Required Setting

Permission Role Administrator Permissions -> Industry MDF Permissions ->

Employee Cost Assignment

Supported Operations

Query, Insert, Upsert, Merge.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

182 PUBLIC Employee Central for Public Sector
Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Navigation Property Related Entity Description

items EmpCostAssignmentItem Contains individual cost assignment for

an employee. Permission must set in Ad­
ministrator Permissions -> Industry MDF
Permissions -> Employee Cost Assign­
ment.Cost Assignment (Employee Cost
Assignment Item).

wrokerNav User

mdfSystemRecordStatusNav MDFEnumValue

createdByNav User

lastModifiedByNav User

Entity Relationship Diagram

Use Case 1: Query the Employee Cost Assignment record for a user

Query the Employee Cost Assignment record for a user.

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/EmpCostAssignment?
$expand=items&$filter=worker eq <User-ID>&$format=json

Response

{
"d": {
"results": [
{
"__metadata": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employee Central for Public Sector PUBLIC 183
 "uri": "https://<API-Server>/odata/v2/
EmpCostAssignment(effectiveStartDate=datetime'2020-07-23T00:00:00',worker=<User-
ID>)",
"type": "SFOData.EmpCostAssignment"
},
"effectiveStartDate": "/Date(1595462400000)/",
"worker": "<User-ID>",
"companyCode": null,
"effectiveEndDate": "/Date(253402214400000)/",
"lastModifiedDateTime": "/Date(1596178338000+0000)/",
"cust_temp1": null,
"lastModifiedBy": "<LastModifiedBy-User-ID>",
"createdDateTime": "/Date(1596178338000+0000)/",
"mdfSystemRecordStatus": "N",
"createdBy": "<CreatedBy-User-ID>",
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignment(effectiveStartDate=datetime'2020-07-23T00:00:00',worker=<User-
ID>)/createdByNav"
}
},
"workerNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignment(effectiveStartDate=datetime'2020-07-23T00:00:00',worker=<User-
ID>)/workerNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignment(effectiveStartDate=datetime'2020-07-23T00:00:00',worker=<User-
ID>)/lastModifiedByNav"
}
},
"items": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2020-07-23T00:00
:00',EmpCostAssignment_worker=<User-ID>,externalCode=12523L)",
"type": "SFOData.EmpCostAssignmentItem"
},
"externalCode": "12523",
"EmpCostAssignment_worker": "<User-ID>",
"EmpCostAssignment_effectiveStartDate": "/Date(1595462400000)/",
"defaultAssignment": false,
"lastModifiedDateTime": "/Date(1596178338000+0000)/",
"costCenter": "35105",
"lastModifiedBy": "<LastModifiedBy-User-ID>",
"createdDateTime": "/Date(1596178338000+0000)/",
"fundCenter": null,
"mdfSystemRecordStatus": "N",
"createdBy": "<CreatedBy-User-ID>",
"fund": "FUND0617/0001",
"functionalArea": "FA1",
"budgetPeriod": "BP1",
"percentage": "25",
"grant": null,
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2020-07-23T00:00
:00',EmpCostAssignment_worker=<User-ID>,externalCode=12523L)/createdByNav"
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

184 PUBLIC Employee Central for Public Sector
 "costCenterNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2020-07-23T00:00
:00',EmpCostAssignment_worker=<User-ID>,externalCode=12523L)/costCenterNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2020-07-23T00:00
:00',EmpCostAssignment_worker=<User-ID>,externalCode=12523L)/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2020-07-23T00:00
:00',EmpCostAssignment_worker=<User-ID>,externalCode=12523L)/
mdfSystemRecordStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2020-07-23T00:00
:00',EmpCostAssignment_worker=<User-ID>,externalCode=12524L)",
"type": "SFOData.EmpCostAssignmentItem"
},
"externalCode": "12524",
"EmpCostAssignment_worker": "<User-ID>",
"EmpCostAssignment_effectiveStartDate": "/Date(1595462400000)/",
"defaultAssignment": true,
"lastModifiedDateTime": "/Date(1596178338000+0000)/",
"costCenter": "35105",
"lastModifiedBy": "<LastModifiedBy-User-ID>",
"createdDateTime": "/Date(1596178338000+0000)/",
"fundCenter": null,
"mdfSystemRecordStatus": "N",
"createdBy": "<CreatedBy-User-ID>",
"fund": "FUND0617/0001",
"functionalArea": "FA1",
"budgetPeriod": "BP1",
"percentage": "75",
"grant": null,
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2020-07-23T00:00
:00',EmpCostAssignment_worker=<User-ID>,externalCode=12524L)/createdByNav"
}
},
"costCenterNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2020-07-23T00:00
:00',EmpCostAssignment_worker=<User-ID>,externalCode=12524L)/costCenterNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2020-07-23T00:00
:00',EmpCostAssignment_worker=<User-ID>,externalCode=12524L)/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employee Central for Public Sector PUBLIC 185
 "__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2020-07-23T00:00
:00',EmpCostAssignment_worker=<User-ID>,externalCode=12524L)/
mdfSystemRecordStatusNav"
}
}
}
]
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignment(effectiveStartDate=datetime'2020-07-23T00:00:00',worker=<User-
ID>)/mdfSystemRecordStatusNav"
}
}
}
]
}
}

Use Case 2: Upsert Cost Assignment information for an employee

Upsert Cost Assignment information for an employee.

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert?purgeType=record

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

186 PUBLIC Employee Central for Public Sector
 Payload {
"__metadata": {
"uri": "/
EmpCostAssignment(effectiveStartDate=datetime'2020-07-23
T00:00:00',worker=<User-ID>), /EmpCostAssignmentItem",
"type": "SFOData.EmpCostAssignment"
},
"effectiveStartDate": "/Date(1595462400000)/",
"worker": "<User-ID>",
"items": [
{
"EmpCostAssignment_worker": "<User-ID>",
"EmpCostAssignment_effectiveStartDate": "/
Date(1595462400000)/",
"defaultAssignment": false,
"costCenter": "35105",
"fundCenter": null,
"fund": "FUND0617/0001",
"functionalArea": "FA1",
"budgetPeriod": "BP1",
"percentage": "25",
"grant": null
},
{
"EmpCostAssignment_worker": "<User-ID>",
"EmpCostAssignment_effectiveStartDate": "/
Date(1595462400000)/",
"defaultAssignment": true,
"costCenter": "35105",
"fundCenter": null,
"fund": "FUND0617/0001",
"functionalArea": "FA1",
"budgetPeriod": "BP1",
"percentage": "75",
"grant": null
}
]
}

Response

{
"d": [
{
"key": "EmpCostAssignment/
effectiveStartDate=2020-07-23T00:00:00.000Z,EmpCostAssignment/worker=<User-ID>",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employee Central for Public Sector PUBLIC 187
Additional Information

7.3 EmpCostAssignmentItem

The EmpCostAssignmentItem entity is a composite child entity of the EmpCostAssignment entity containing
individual cost assignment for an employee.

Supported Operations

Query, Insert, Upsert, Merge.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Navigation Property Related Entity Description

costCenterNav CostCenter Cost Center

fundNav Fund Fund

fundCenterNav FundCenter Fund Center

grantNav Grant Grant

functionalAreaNav FunctionalArea Functional Area

budgetPeriodNav BudgetPeriod Budget Period

mdfSystemRecordStatusNav MDFEnumValue

createdByNav User

lastModifiedByNav User

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

188 PUBLIC Employee Central for Public Sector
Entity Relationship Diagram

Use Case 1: Query all the cost assignments for a user for a given effective start
date

Query all the cost assignments for a user for a given effective start date.

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/EmpCostAssignmentItem?
$filter=EmpCostAssignment_effectiveStartDate eq
datetime'2020-07-23T00:00:00' and EmpCostAssignment_worker
eq <User-ID>

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2020-07-23T00:00
:00',EmpCostAssignment_worker=<User-ID>,externalCode=12523L)",
"type": "SFOData.EmpCostAssignmentItem"
},
"externalCode": "12523",
"EmpCostAssignment_worker": "<User-ID>",
"EmpCostAssignment_effectiveStartDate": "/Date(1595462400000)/",
"defaultAssignment": false,
"lastModifiedDateTime": "/Date(1596178338000+0000)/",
"costCenter": "35105",
"lastModifiedBy": "<LastModifiedBy-User-ID>",
"createdDateTime": "/Date(1596178338000+0000)/",
"fundCenter": null,
"mdfSystemRecordStatus": "N",
"createdBy": "<CreatedBy-User-ID>",
"fund": "FUND0617/0001",
"functionalArea": "FA1",
"budgetPeriod": "BP1",
"percentage": "25",
"grant": null,
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2020-07-23T00:00
:00',EmpCostAssignment_worker=<User-ID>,externalCode=12523L)/createdByNav"
}
},
"costCenterNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2020-07-23T00:00
:00',EmpCostAssignment_worker=<User-ID>,externalCode=12523L)/costCenterNav"
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employee Central for Public Sector PUBLIC 189
 "lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2020-07-23T00:00
:00',EmpCostAssignment_worker=<User-ID>,externalCode=12523L)/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2020-07-23T00:00
:00',EmpCostAssignment_worker=<User-ID>,externalCode=12523L)/
mdfSystemRecordStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2020-07-23T00:00
:00',EmpCostAssignment_worker=<User-ID>,externalCode=12524L)",
"type": "SFOData.EmpCostAssignmentItem"
},
"externalCode": "12524",
"EmpCostAssignment_worker": "<User-ID>",
"EmpCostAssignment_effectiveStartDate": "/Date(1595462400000)/",
"defaultAssignment": true,
"lastModifiedDateTime": "/Date(1596178338000+0000)/",
"costCenter": "35105",
"lastModifiedBy": "<LastModifiedBy-User-ID>",
"createdDateTime": "/Date(1596178338000+0000)/",
"fundCenter": null,
"mdfSystemRecordStatus": "N",
"createdBy": "<CreatedBy-User-ID>",
"fund": "FUND0617/0001",
"functionalArea": "FA1",
"budgetPeriod": "BP1",
"percentage": "75",
"grant": null,
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2020-07-23T00:00
:00',EmpCostAssignment_worker=<User-ID>,externalCode=12524L)/createdByNav"
}
},
"costCenterNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2020-07-23T00:00
:00',EmpCostAssignment_worker=<User-ID>,externalCode=12524L)/costCenterNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2020-07-23T00:00
:00',EmpCostAssignment_worker=<User-ID>,externalCode=12524L)/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2020-07-23T00:00
:00',EmpCostAssignment_worker=<User-ID>,externalCode=12524L)/
mdfSystemRecordStatusNav"
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

190 PUBLIC Employee Central for Public Sector
 }
]
}
}

Additional Information

7.4 FundGO

An employee cost assignment refers to assignment of accounting objects for an employee. Fund is one of the
standard accounting objects supported.

Permissions

Administrator Permissions Configure Public Sector Management Cost Objects

Supported Operations

Query, Insert, Upsert, Merge, Replace, Delete.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Navigation Property Related Entity Description

createdByNav User

effectiveStatusNav MDFEnumValue

fundDescriptionTranslationTextNav MDFLocalizedValue

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employee Central for Public Sector PUBLIC 191
Navigation Property Related Entity Description

lastModifiedByNav User

mdfSystemRecordStatusNav MDFEnumValue

wfRequestNav WfRequest

Use Case 1: Query Employee Cost Assignment items information for a user

List the employee cost assignment items record for a user.

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
EmpCostAssignment(effectiveStartDate=datetime'2021-07-21T00
:00:00',worker=’<userid>’)/items?$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)",…
},
"externalCode": "15344",
"EmpCostAssignment_worker": "196",
"EmpCostAssignment_effectiveStartDate": "/Date(1626825600000)/",
"defaultAssignment": true,
"lastModifiedDateTime": "/Date(1626870986000+0000)/",
"costCenter": "35106",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1626870917000+0000)/",
"fundCenter": null,
"mdfSystemRecordStatus": "N",
"createdBy": "admin",
"fund": "100/f1",
"functionalArea": "fun2Test",
"budgetPeriod": "Bud1Test",
"percentage": "50",
"grant": "GRANT1TEST",
"budgetPeriodNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/budgetPeriodNav"…
},
"fundNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

192 PUBLIC Employee Central for Public Sector
 "uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/fundNav"…
},
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/createdByNav"…
},
"grantNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/grantNav"…
},
"functionalAreaNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/functionalAreaNav"…
},
"fundCenterNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/fundCenterNav"…
},
"costCenterNav": {
"__deferred": {
"uri": "https://<api-server>/
odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/costCenterNav"…
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/
odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/lastModifiedByNav"…
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-
server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/mdfSystemRecordStatusNav"…
}
},
{
"__metadata": {
"uri": "https://<api-
server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)",…
},
"externalCode": "15362",
"EmpCostAssignment_worker":
"196",

"EmpCostAssignment_effectiveStartDate": "/Date(1626825600000)/",
"defaultAssignment": false,
"lastModifiedDateTime": "/
Date(1626870986000+0000)/",
"costCenter": "35106",
"lastModifiedBy": "admin",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employee Central for Public Sector PUBLIC 193
 "createdDateTime": "/
Date(1626870986000+0000)/",
"fundCenter": null,
"mdfSystemRecordStatus": "N",
"createdBy": "admin",
"fund": "100/f1",
"functionalArea": "fun1Test",
"budgetPeriod": "Bud2Test",
"percentage": "50",
"grant": "GRANT2TEST",
"budgetPeriodNav": {
"__deferred": {
"uri": "https://<api-
server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/budgetPeriodNav"…
},
"fundNav": {
"__deferred": {
"uri": "https://
<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/fundNav"…
},
"createdByNav": {
"__deferred": {
"uri": "https://
<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/createdByNav"…
},
"grantNav": {
"__deferred": {
"uri":
"https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/grantNav"…
},

"functionalAreaNav": {

"__deferred": {
"uri":
"https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/functionalAreaNav"…
},

"fundCenterNav": {

"__deferred": {

"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/fundCenterNav"…
},

"costCenterNav": {

"__deferred": {

"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/costCenterNav"…
},

"lastModifiedByNav": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

194 PUBLIC Employee Central for Public Sector
 "__deferred": {

"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/lastModifiedByNav"…

},

"mdfSystemRecordStatusNav": {

"__deferred": {

"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/mdfSystemRecordStatusNav"…

}
]
}
}

7.5 FundCenterGO

An employee cost assignment refers to assignment of accounting objects for an employee. These entities are
controlled via a provisioning switch. Fund center is one of the standard accounting objects supported.

Permissions

Administrator Permissions Configure Public Sector Management Cost Objects

Supported Operations

Query, Insert, Upsert, Merge, Replace, Delete.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employee Central for Public Sector PUBLIC 195
Navigation Properties

Navigation Property Related Entity Description

createdByNav User

effectiveStatusNav MDFEnumValue

fundCenterDescriptionTranslationText­ MDFLocalizedValue
Nav

lastModifiedByNav User

mdfSystemRecordStatusNav MDFEnumValue

wfRequestNav WfRequest

Use Case 1: Query Employee Cost Assignment items information for a user

List the employee cost assignment items record for a user.

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
EmpCostAssignment(effectiveStartDate=datetime'2021-07-21T00
:00:00',worker=’<userid>’)/items?$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)",…
},
"externalCode": "15344",
"EmpCostAssignment_worker": "196",
"EmpCostAssignment_effectiveStartDate": "/Date(1626825600000)/",
"defaultAssignment": true,
"lastModifiedDateTime": "/Date(1626870986000+0000)/",
"costCenter": "35106",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1626870917000+0000)/",
"fundCenter": null,
"mdfSystemRecordStatus": "N",
"createdBy": "admin",
"fund": "100/f1",
"functionalArea": "fun2Test",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

196 PUBLIC Employee Central for Public Sector
 "budgetPeriod": "Bud1Test",
"percentage": "50",
"grant": "GRANT1TEST",
"budgetPeriodNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/budgetPeriodNav"…
},
"fundNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/fundNav"…
},
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/createdByNav"…
},
"grantNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/grantNav"…
},
"functionalAreaNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/functionalAreaNav"…
},
"fundCenterNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/fundCenterNav"…
},
"costCenterNav": {
"__deferred": {
"uri": "https://<api-server>/
odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/costCenterNav"…
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/
odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/lastModifiedByNav"…
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-
server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/mdfSystemRecordStatusNav"…
}
},
{
"__metadata": {
"uri": "https://<api-
server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)",…
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employee Central for Public Sector PUBLIC 197
 "externalCode": "15362",
"EmpCostAssignment_worker":
"196",

"EmpCostAssignment_effectiveStartDate": "/Date(1626825600000)/",
"defaultAssignment": false,
"lastModifiedDateTime": "/
Date(1626870986000+0000)/",
"costCenter": "35106",
"lastModifiedBy": "admin",
"createdDateTime": "/
Date(1626870986000+0000)/",
"fundCenter": null,
"mdfSystemRecordStatus": "N",
"createdBy": "admin",
"fund": "100/f1",
"functionalArea": "fun1Test",
"budgetPeriod": "Bud2Test",
"percentage": "50",
"grant": "GRANT2TEST",
"budgetPeriodNav": {
"__deferred": {
"uri": "https://<api-
server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/budgetPeriodNav"…
},
"fundNav": {
"__deferred": {
"uri": "https://
<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/fundNav"…
},
"createdByNav": {
"__deferred": {
"uri": "https://
<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/createdByNav"…
},
"grantNav": {
"__deferred": {
"uri":
"https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/grantNav"…
},

"functionalAreaNav": {

"__deferred": {
"uri":
"https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/functionalAreaNav"…
},

"fundCenterNav": {

"__deferred": {

"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/fundCenterNav"…
},

"costCenterNav": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

198 PUBLIC Employee Central for Public Sector
 "__deferred": {

"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/costCenterNav"…
},

"lastModifiedByNav": {

"__deferred": {

"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/lastModifiedByNav"…

},

"mdfSystemRecordStatusNav": {

"__deferred": {

"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/mdfSystemRecordStatusNav"…

}
]
}
}

7.6 GrantGO

An employee cost assignment refers to assignment of accounting objects for an employee. Grant is one of the
standard accounting objects supported.

Permissions

Administrator Permissions Configure Public Sector Management Cost Objects

Supported Operations

Query, Insert, Upsert, Merge, Replace, Delete.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employee Central for Public Sector PUBLIC 199
Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Navigation Property Related Entity Description

createdByNav User

effectiveStatusNav MDFEnumValue

grantDescTranslationTextNav MDFLocalizedValue

lastModifiedByNav User

mdfSystemRecordStatusNav MDFEnumValue

wfRequestNav WfRequest

Use Case 1: Query Employee Cost Assignment items information for a user

List the employee cost assignment items record for a user.

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
EmpCostAssignment(effectiveStartDate=datetime'2021-07-21T00
:00:00',worker=’<userid>’)/items?$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)",…
},
"externalCode": "15344",
"EmpCostAssignment_worker": "196",
"EmpCostAssignment_effectiveStartDate": "/Date(1626825600000)/",
"defaultAssignment": true,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

200 PUBLIC Employee Central for Public Sector
 "lastModifiedDateTime": "/Date(1626870986000+0000)/",
"costCenter": "35106",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1626870917000+0000)/",
"fundCenter": null,
"mdfSystemRecordStatus": "N",
"createdBy": "admin",
"fund": "100/f1",
"functionalArea": "fun2Test",
"budgetPeriod": "Bud1Test",
"percentage": "50",
"grant": "GRANT1TEST",
"budgetPeriodNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/budgetPeriodNav"…
},
"fundNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/fundNav"…
},
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/createdByNav"…
},
"grantNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/grantNav"…
},
"functionalAreaNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/functionalAreaNav"…
},
"fundCenterNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/fundCenterNav"…
},
"costCenterNav": {
"__deferred": {
"uri": "https://<api-server>/
odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/costCenterNav"…
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/
odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/lastModifiedByNav"…
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-
server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/mdfSystemRecordStatusNav"…

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employee Central for Public Sector PUBLIC 201
 }
},
{
"__metadata": {
"uri": "https://<api-
server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)",…
},
"externalCode": "15362",
"EmpCostAssignment_worker":
"196",

"EmpCostAssignment_effectiveStartDate": "/Date(1626825600000)/",
"defaultAssignment": false,
"lastModifiedDateTime": "/
Date(1626870986000+0000)/",
"costCenter": "35106",
"lastModifiedBy": "admin",
"createdDateTime": "/
Date(1626870986000+0000)/",
"fundCenter": null,
"mdfSystemRecordStatus": "N",
"createdBy": "admin",
"fund": "100/f1",
"functionalArea": "fun1Test",
"budgetPeriod": "Bud2Test",
"percentage": "50",
"grant": "GRANT2TEST",
"budgetPeriodNav": {
"__deferred": {
"uri": "https://<api-
server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/budgetPeriodNav"…
},
"fundNav": {
"__deferred": {
"uri": "https://
<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/fundNav"…
},
"createdByNav": {
"__deferred": {
"uri": "https://
<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/createdByNav"…
},
"grantNav": {
"__deferred": {
"uri":
"https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/grantNav"…
},

"functionalAreaNav": {

"__deferred": {
"uri":
"https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/functionalAreaNav"…
},

"fundCenterNav": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

202 PUBLIC Employee Central for Public Sector
 "__deferred": {

"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/fundCenterNav"…
},

"costCenterNav": {

"__deferred": {

"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/costCenterNav"…
},

"lastModifiedByNav": {

"__deferred": {

"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/lastModifiedByNav"…

},

"mdfSystemRecordStatusNav": {

"__deferred": {

"uri": "https://<api-server>/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/mdfSystemRecordStatusNav"…

}
]
}
}

7.7 BudgetPeriodGO

An employee cost assignment refers to assignment of accounting objects for an employee. Budget period is one of
the standard accounting objects supported.

Permissions

Administrator Permissions Configure Public Sector Management Cost Objects

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employee Central for Public Sector PUBLIC 203
Supported Operations

Query, Insert, Upsert, Merge, Replace, Delete.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Navigation Property Related Entity Description

createdByNav User

effectiveStatusNav MDFEnumValue

budgetPeriodDescriptionTranslationText­ MDFLocalizedValue
Nav

lastModifiedByNav User

mdfSystemRecordStatusNav MDFEnumValue

wfRequestNav WfRequest

Use Case 1: Query Employee Cost Assignment items information for a user

List the employee cost assignment items record for a user.

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
EmpCostAssignment(effectiveStartDate=datetime'2021-07-21T00
:00:00',worker=’<userid>’)/items?$format=JSON

Response

{
"d": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

204 PUBLIC Employee Central for Public Sector
 "results": [
{
"__metadata": {
"uri": "https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)",…
},
"externalCode": "15344",
"EmpCostAssignment_worker": "196",
"EmpCostAssignment_effectiveStartDate": "/Date(1626825600000)/",
"defaultAssignment": true,
"lastModifiedDateTime": "/Date(1626870986000+0000)/",
"costCenter": "35106",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1626870917000+0000)/",
"fundCenter": null,
"mdfSystemRecordStatus": "N",
"createdBy": "admin",
"fund": "100/f1",
"functionalArea": "fun2Test",
"budgetPeriod": "Bud1Test",
"percentage": "50",
"grant": "GRANT1TEST",
"budgetPeriodNav": {
"__deferred": {
"uri": "https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/budgetPeriodNav"…
},
"fundNav": {
"__deferred": {
"uri": "https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/fundNav"…
},
"createdByNav": {
"__deferred": {
"uri": "https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/createdByNav"…
},
"grantNav": {
"__deferred": {
"uri": "https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/grantNav"…
},
"functionalAreaNav": {
"__deferred": {
"uri": "https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/functionalAreaNav"…
},
"fundCenterNav": {
"__deferred": {
"uri": "https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/fundCenterNav"…
},
"costCenterNav": {
"__deferred": {
"uri": "https://localhost:443/
odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/costCenterNav"…
},
"lastModifiedByNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employee Central for Public Sector PUBLIC 205
 "uri": "https://localhost:443/
odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/lastModifiedByNav"…
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://localhost:
443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/mdfSystemRecordStatusNav"…
}
},
{
"__metadata": {
"uri": "https://localhost:
443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)",…
},
"externalCode": "15362",
"EmpCostAssignment_worker":
"196",

"EmpCostAssignment_effectiveStartDate": "/Date(1626825600000)/",
"defaultAssignment": false,
"lastModifiedDateTime": "/
Date(1626870986000+0000)/",
"costCenter": "35106",
"lastModifiedBy": "admin",
"createdDateTime": "/
Date(1626870986000+0000)/",
"fundCenter": null,
"mdfSystemRecordStatus": "N",
"createdBy": "admin",
"fund": "100/f1",
"functionalArea": "fun1Test",
"budgetPeriod": "Bud2Test",
"percentage": "50",
"grant": "GRANT2TEST",
"budgetPeriodNav": {
"__deferred": {
"uri": "https://
localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/budgetPeriodNav"…
},
"fundNav": {
"__deferred": {
"uri": "https://
localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/fundNav"…
},
"createdByNav": {
"__deferred": {
"uri": "https://
localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/createdByNav"…
},
"grantNav": {
"__deferred": {
"uri":
"https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/grantNav"…
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

206 PUBLIC Employee Central for Public Sector
 "functionalAreaNav": {

"__deferred": {
"uri":
"https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/functionalAreaNav"…
},

"fundCenterNav": {

"__deferred": {

"uri": "https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/fundCenterNav"…
},

"costCenterNav": {

"__deferred": {

"uri": "https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/costCenterNav"…
},

"lastModifiedByNav": {

"__deferred": {

"uri": "https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/lastModifiedByNav"…

},

"mdfSystemRecordStatusNav": {

"__deferred": {

"uri": "https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/mdfSystemRecordStatusNav"…

}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employee Central for Public Sector PUBLIC 207
7.8 FunctionalAreaGO

An employee cost assignment refers to assignment of accounting objects for an employee. Fund is one of the
standard accounting objects supported.

Permissions

Administrator Permissions Configure Public Sector Management Cost Objects

Supported Operations

Query, Insert, Upsert, Merge, Replace, Delete.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Navigation Property Related Entity Description

createdByNav User

effectiveStatusNav MDFEnumValue

functionalAreaDescriptionTranslation­ MDFLocalizedValue
TextNav

lastModifiedByNav User

mdfSystemRecordStatusNav MDFEnumValue

wfRequestNav WfRequest

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

208 PUBLIC Employee Central for Public Sector
Use Case 1: Query Employee Cost Assignment items information for a user

List the employee cost assignment items record for a user.

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
EmpCostAssignment(effectiveStartDate=datetime'2021-07-21T00
:00:00',worker=’<userid>’)/items?$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)",…
},
"externalCode": "15344",
"EmpCostAssignment_worker": "196",
"EmpCostAssignment_effectiveStartDate": "/Date(1626825600000)/",
"defaultAssignment": true,
"lastModifiedDateTime": "/Date(1626870986000+0000)/",
"costCenter": "35106",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1626870917000+0000)/",
"fundCenter": null,
"mdfSystemRecordStatus": "N",
"createdBy": "admin",
"fund": "100/f1",
"functionalArea": "fun2Test",
"budgetPeriod": "Bud1Test",
"percentage": "50",
"grant": "GRANT1TEST",
"budgetPeriodNav": {
"__deferred": {
"uri": "https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/budgetPeriodNav"…
},
"fundNav": {
"__deferred": {
"uri": "https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/fundNav"…
},
"createdByNav": {
"__deferred": {
"uri": "https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/createdByNav"…
},
"grantNav": {
"__deferred": {
"uri": "https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/grantNav"…

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employee Central for Public Sector PUBLIC 209
 },
"functionalAreaNav": {
"__deferred": {
"uri": "https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/functionalAreaNav"…
},
"fundCenterNav": {
"__deferred": {
"uri": "https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/fundCenterNav"…
},
"costCenterNav": {
"__deferred": {
"uri": "https://localhost:443/
odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/costCenterNav"…
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://localhost:443/
odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/lastModifiedByNav"…
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://localhost:
443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15344L)/mdfSystemRecordStatusNav"…
}
},
{
"__metadata": {
"uri": "https://localhost:
443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)",…
},
"externalCode": "15362",
"EmpCostAssignment_worker":
"196",

"EmpCostAssignment_effectiveStartDate": "/Date(1626825600000)/",
"defaultAssignment": false,
"lastModifiedDateTime": "/
Date(1626870986000+0000)/",
"costCenter": "35106",
"lastModifiedBy": "admin",
"createdDateTime": "/
Date(1626870986000+0000)/",
"fundCenter": null,
"mdfSystemRecordStatus": "N",
"createdBy": "admin",
"fund": "100/f1",
"functionalArea": "fun1Test",
"budgetPeriod": "Bud2Test",
"percentage": "50",
"grant": "GRANT2TEST",
"budgetPeriodNav": {
"__deferred": {
"uri": "https://
localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/budgetPeriodNav"…

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

210 PUBLIC Employee Central for Public Sector
 },
"fundNav": {
"__deferred": {
"uri": "https://
localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/fundNav"…
},
"createdByNav": {
"__deferred": {
"uri": "https://
localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/createdByNav"…
},
"grantNav": {
"__deferred": {
"uri":
"https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/grantNav"…
},

"functionalAreaNav": {

"__deferred": {
"uri":
"https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/functionalAreaNav"…
},

"fundCenterNav": {

"__deferred": {

"uri": "https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/fundCenterNav"…
},

"costCenterNav": {

"__deferred": {

"uri": "https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/costCenterNav"…
},

"lastModifiedByNav": {

"__deferred": {

"uri": "https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/lastModifiedByNav"…

},

"mdfSystemRecordStatusNav": {

"__deferred": {

"uri": "https://localhost:443/odata/v2/
EmpCostAssignmentItem(EmpCostAssignment_effectiveStartDate=datetime'2021-07-21T00:00
:00',EmpCostAssignment_worker='196',externalCode=15362L)/mdfSystemRecordStatusNav"…

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Employee Central for Public Sector PUBLIC 211
 }

}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

212 PUBLIC Employee Central for Public Sector
8 Fiscal Year Objects

8.1 FiscalYearVariant

This entity contains information about the fiscal year variant created for income tax declaration.

Supported Operations

Operation Description

Query You can query the fiscal year variant information.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

externalCode Business key

periods This field contains period information of the fiscal year variant.

Use Case: Get the Fiscal Year Variant Information

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
FiscalYearVariant?$top=10&$format=JSON

Response

{
"d": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Fiscal Year Objects PUBLIC 213
 "results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FiscalYearVariant('FYV1')",
"type": "SFOData.FiscalYearVariant"
},
"externalCode": "FYV1",
"lastModifiedDateTime": "/Date(1504073862000+0000)/",
"lastModifiedBy": "sfadmin",
"createdDateTime": "/Date(1504073862000+0000)/",
"description": "Fiscal Year Variant India",
"mdfSystemRecordStatus": "N",
"createdBy": "sfadmin",
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FiscalYearVariant('FYV1')/createdByNav"
}
},
"periods": {
"__deferred": {
"uri": "https://<API-Server><API-Server>/odata/v2/
FiscalYearVariant('FYV1')/periods"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FiscalYearVariant('FYV1')/wfRequestNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FiscalYearVariant('FYV1')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FiscalYearVariant('FYV1')/mdfSystemRecordStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Income Tax Declaration

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

214 PUBLIC Fiscal Year Objects
8.2 FiscalYearToCountryMap

This entity contains the mapping information between a fiscal year variant and a country or a region.

Supported Operations

Operation Description

Query You can query the fiscal year variant mapping information.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

externalCode Business key

fiscalYearVariant Fiscal year variant

country The mapped country of the fiscal year variant

Use Case: Get the Fiscal Year Variant Mapping Information

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
FiscalYearToCountryMap?$top=10&
$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FiscalYearToCountryMap('FYC_IN')",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Fiscal Year Objects PUBLIC 215
 "type": "SFOData.FiscalYearToCountryMap"
},
"externalCode": "FYC_IN",
"country": "IND",
"lastModifiedDateTime": "/Date(1504073922000+0000)/",
"lastModifiedBy": "sfadmin",
"createdDateTime": "/Date(1504073922000+0000)/",
"mdfSystemRecordStatus": "N",
"createdBy": "sfadmin",
"fiscalYearVariant": "FYV1",
"fiscalYearVariantNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FiscalYearToCountryMap('FYC_IN')/fiscalYearVariantNav"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FiscalYearToCountryMap('FYC_IN')/createdByNav"
}
},
"countryNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FiscalYearToCountryMap('FYC_IN')/countryNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FiscalYearToCountryMap('FYC_IN')/wfRequestNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FiscalYearToCountryMap('FYC_IN')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FiscalYearToCountryMap('FYC_IN')/mdfSystemRecordStatusNav"
}
}
}
]
}
}}

Related Information

SAP API Business Hub: Income Tax Declaration

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

216 PUBLIC Fiscal Year Objects
9 Foundation Objects

9.1 Foundation Object Structure in OData API

Flexible associations can be defined between two foundation objects in the Corporate Data Model. The example
below shows a one to one relationship between location and geozone; a one to many relationship is defined
between location and company. OData automatically creates navigations from the source entity to the target
entities, based on the relationship defined.

<hris-element id="location">
<hris-associations>
<association id="id" multiplicity="ONE_TO_ONE" destination-
entity="geozone"/>
<association id="id" multiplicity="ONE_TO_MANY" destination-
entity="company"/>
</hris-associations>
</hris-associations>

The diagram below shows the default relationships between the different OData entities.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 217
  Note

Changing the associations in the Corporate Data Model might cause OData APIs to fail, more so when the
association is deleted. This usually happens when association is already being used by the OData API.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

218 PUBLIC Foundation Objects
9.2 FODynamicRole

You can use this entity to query, create, or modify a dynamic role that can be used as approvers in Employee
Central workflows.

HRIS Element Information

HRIS Element ID: dynamicRole

Business Keys: dynamicRoleAssignmentId
Effective-date:false
Foundation Type:true
Person Entity Element:false
Supports Incremental Load:false
Supports NO_OVERWRITE: false
Supports MCPD: false

Supported Operations

Operation Description

Query You can get the information of dynamic roles with Job Info
as Base Object.

Upsert You can create a new dynamic role or modify an existing role.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

dynamicRoleAssignmentId This property is a unique ID for an dynamic role and is auto­

matically generated.

resolverType You can use this property to define the approver type in the
Employee Central workflows. There are three approver types:
Person, Dynamic Group, and Position.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 219
Use Case 1: Query the Dynamic Roles that Use Position as Approver Type

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
FODynamicRole?$format=JSON&
$filter=resolverType eq 'POSITION'&
$select=dynamicRoleAssignmentId,resolverTy
pe

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/FODynamicRole(6M)"
},
"dynamicRoleAssignmentId": "6",
"resolverType": "POSITION"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/FODynamicRole(21M)"
},
"dynamicRoleAssignmentId": "21",
"resolverType": "POSITION"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/FODynamicRole(22M)"
},
"dynamicRoleAssignmentId": "22",
"resolverType": "POSITION"
}

Use Case 2: Create a Dynamic Role

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

220 PUBLIC Foundation Objects
 Payload
{
"__metadata": {
"uri": "FODynamicRole"
},
"externalCode":"FACILITIES",
"resolverType": "POSITION",
"payGrade": "GR-10",
"eventReason": "TRANINTL",
"name": "New Dynamic Role (Test)",
"position": "50014360"
}

Response

{
"d": [
{
"key": "FODynamicRole/dynamicRoleAssignmentId=null",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Related Information

SAP API Business Hub: Foundation

9.3 FOEventReason

You can use this entity to define the event reasons why an event occurs, such as creating, changing, or deleting
employee data. An event reason can change the employee status of employees when an event occurs for them.

HRIS Element Information

HRIS Element ID: eventReason

Business Keys: externalCode + startDate
Effective-date:true
Foundation Type:true
Person Entity Element:false
Supports Incremental Load:true
Supports NO_OVERWRITE: true
Supports MCPD: false

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 221
Supported Operations

Operation Description

Query You can query the event reasons.

Upsert You can create or update the event reasons.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

event You can use this property to specify the event for which the
event reason is created. Events are defined in the
PicklistV2 entity.

emplStatus You can use this property to change the employee status after
the event occurs. For example, if you make a data change and
use the event reason with emplStatus as inactive, the status
of the employee becomes inactive after the data change.

Use Case: Query the Event Reason by External Code

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
FOEventReason?$filter=externalCode eq
'PAYMLA'&
$select=status,event,externalCode&
$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FOEventReason(externalCode='PAYMLA',startDate=datetime'1970-01-01T00:00:00')"
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

222 PUBLIC Foundation Objects
 "externalCode": "PAYMLA",
"status": "A",
"event": "2294"
}
]
}
}

Related Information

SAP API Business Hub: Foundation

9.4 FOFrequency

This entity is used to define how an employee is paid, such as monthly or weekly.

HRIS Element Information

HRIS Element ID: frequency

Business Keys: externalCode
Effective-date:false
Foundation Type:true
Person Entity Element:false
Supports Incremental Load:true
Supports NO_OVERWRITE: true
Supports MCPD:false

Supported Operations

Operation Description

Query You can query the pay frequency information.

Upsert You can create or update the pay frequency information.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 223
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

annualizationFactor You can use this property to define the times an employee is
paid in one year. For example, set this property as 12 if the em­
ployee is paid monthly.

Use Case: Query the Pay Frequency by External Code

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/FOFrequency?
$filter=externalCode eq 'DLY'&
$select=externalCode,name,description,annu
alizationFactor&$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/FOFrequency('DLY')"
},
"externalCode": "DLY",
"description": "Daily",
"name": "Daily",
"annualizationFactor": "365"
}
]
}
}

Related Information

SAP API Business Hub: Foundation

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

224 PUBLIC Foundation Objects
9.5 FOGeozone

This entity enables you to group multiple company locations within the same cost-of-living areas as a Geo Zone.
You can offset the impacts of higher or lower-than-average costs of living to pay range.

HRIS Element Information

HRIS Element ID: geozone

Business Keys: externalCode + startDate
Effective-date:true
Foundation Type:true
Person Entity Element:false
Supports Incremental Load:true
Supports NO_OVERWRITE: true
Supports MCPD: false

Supported Operations

Operation Description

Query You can query a Geo Zone。

Upsert You can create or update a Geo Zone.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

adjustmentPercentage You can use this property to define the adjustment percentage
of the Geo Zone compared to the average pay range, so as to
offset the impact of higher or lower cost-of-living on the pay
range.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 225
Use Case: Query the Geo Zone for APAC

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/FOGeozone?
$filter=externalCode eq 'APAC'&
$select=status,name,createdBy&$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FOGeozone(externalCode='APAC',startDate=datetime'1990-01-01T00:00:00')"
},
"createdBy": "admin",
"status": "A",
"name": "Asia Pacific"
}
]
}
}

Related Information

SAP API Business Hub: Foundation

9.6 FOLocation

This entity contains a company location.

HRIS Element Information

HRIS Element ID: location

Business Keys: externalCode + StartDate
Effective-date:true
Foundation Type:true
Person Entity Element:false
Supports Incremental Load:true
Supports NO_OVERWRITE: true
Supports MCPD:false

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

226 PUBLIC Foundation Objects
Supported Operations

Operation Description

Query You can query a company location.

Upsert You can create or update a company location.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Case 1: Query the Company Location by External Code and Expand the
Address

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/FOLocation?
$filter=externalCode eq 'KO_SEO'&
$expand=addressNavDEFLT&$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/public/
FOLocation(externalCode='KO_SEO',startDate=datetime'1990-01-01T00:00:00')"
},
"startDate": "/Date(631152000000)/",
"externalCode": "KO_SEO",
"status": "A",
"endDate": "/Date(253402300799000)/",
"lastModifiedDateTime": "/Date(1317104275000+0000)/",
"lastModifiedOn": "/Date(1317104275000)/",
"createdOn": "/Date(1300819181000)/",
"timezone": "Asia/Seoul",
"createdBy": "admin",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 227
 "geozoneFlx": "APAC",
"description": "Seoul, Korea",
"name": "Seoul",
"createdDateTime": "/Date(1300819181000+0000)/",
"lastModifiedBy": "admin",
"locationGroup": "APAC",
"standardHours": null,
"geozoneFlxNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/public/
FOLocation(externalCode='KO_SEO',startDate=datetime'1990-01-01T00:00:00')/
geozoneFlxNav"
}
},
"descriptionTranslationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/public/
FOLocation(externalCode='KO_SEO',startDate=datetime'1990-01-01T00:00:00')/
descriptionTranslationNav"
}
},
"locationGroupNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/public/
FOLocation(externalCode='KO_SEO',startDate=datetime'1990-01-01T00:00:00')/
locationGroupNav"
}
},
"addressNavDEFLT": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/public/
FOCorporateAddressDEFLT(314M)",
"type": "SFOData.FOCorporateAddressDEFLT"
},
"addressId": "314",
"startDate": "/Date(631152000000)/",
"state": null,
"address1": "#803, 8th FL., PAN-PACIFIC B/D, 197-21",
"address2": "Guro-dong, Guro-gu",
"endDate": "/Date(253402300799000)/",
"address3": null,
"lastModifiedDateTime": "/Date(1317104275000+0000)/",
"lastModifiedOn": "/Date(1317104275000)/",
"city": "Seoul",
"country": "KOR",
"createdOn": "/Date(1300819181000)/",
"createdBy": "admin",
"zipCode": "152-050",
"createdDateTime": "/Date(1300819181000+0000)/",
"lastModifiedBy": "admin",
"stateNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/public/
FOCorporateAddressDEFLT(314M)/stateNav"
}
},
"countryNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/public/
FOCorporateAddressDEFLT(314M)/countryNav"
}
}
},
"companyFlxNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/public/
FOLocation(externalCode='KO_SEO',startDate=datetime'1990-01-01T00:00:00')/
companyFlxNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

228 PUBLIC Foundation Objects
 }
},
"nameTranslationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/public/
FOLocation(externalCode='KO_SEO',startDate=datetime'1990-01-01T00:00:00')/
nameTranslationNav"
}
}
}
]
}
}

Use Case 2: Create a Company Location

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert

Payload
{
"__metadata":{

"uri":"FOLocation(externalCode='KO_SEO',
startDate=datetime'1990-01-01T00:00:00')
"
},
"status":"A",
"endDate":"/Date(253402300799000)/",
"timezone":"Asia/Seoul",
"geozoneFlx":"APAC",
"description":"Seoul, Korea",
"name":"Seoul",
"locationGroup":"APAC",
"addressCountry": "KOR"
}

Response

{
"d": [
{
"key": "FOLocation/externalCode=KO_SEO,FOLocation/
startDate=1990-01-01T00:00:00.000+08:00",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 229
Related Information

SAP API Business Hub: Foundation

9.7 FOLocationGroup

You can use this entity to group multiple company locations for reporting or filtering purposes.

HRIS Element Information

HRIS Element ID: location groupGroup

Business Keys: externalCode + startDate
Effective-date:true
Foundation Type:true
Person Entity Element:false
Supports Incremental Load:true
Supports NO_OVERWRITE: true
Supports MCPD: false

Supported Operations

Operation Description

Query You can query a location group.

Upsert You can create or update a location group.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

230 PUBLIC Foundation Objects
Use Case: Get the Location Group of APAC Effective Within a Period

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
FOLocationGroup?$filter=externalCode eq
'APAC'&
$select=status,name,createdBy&fromDate=201
3-01-01&toDate=2014-01-01&$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FOLocationGroup(externalCode='APAC',startDate=datetime'1990-01-01T00:00:00')"
},
"createdBy": "admin",
"status": "A",
"name": "APAC"
}
]
}
}

Related Information

SAP API Business Hub: Foundation

9.8 FOPayComponent

You can use this entity to assign a pay component, that is a payment or deduction, to an employee. You can define
the frequency and currency of the pay component.

HRIS Element Information

HRIS Element ID: payComponent

Business Keys: externalCode + startDate
Effective-date:true
Foundation Type:true

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 231
 Person Entity Element:false
Supports Incremental Load:true
Supports NO_OVERWRITE: true
Supports MCPD:false

Supported Operations

Operation Description

Query You can query a pay component.

Upsert You can create or update a pay component.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

payComponentType You cn use this property to specify the type of the pay compo­
nent as Amount or Percentage.

payComponentValue You can use this property to specify the value of the pay com­
ponent.

currency You can use this property to specify the currency in which the
pay component is paid. If no currency is specified, the local
currency for the employee is used as default.

isEarning You can use this property to define the pay component as an
earning or a deduction.

Use Case: Get the Pay Component for Base Salary

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
FOPayComponent?$filter=externalCode eq
'Base Salary'&$format=JSON

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

232 PUBLIC Foundation Objects
Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FOPayComponent(externalCode='Base Salary',startDate=datetime'1970-01-01T00:00:00')",
"type": "SFOData.FOPayComponent"
},
"startDate": "/Date(0)/",
"externalCode": "Base Salary",
"basePayComponentGroup": null,
"usedForCompPlanning": "COMP",
"payComponentType": "AMOUNT",
"endDate": "/Date(253370764800000)/",
"lastModifiedDateTime": "/Date(1304801484000+0000)/",
"currency": "USD",
"selfServiceDescription": null,
"isEarning": true,
"description": "Base Salary for USA",
"name": "Base Salary",
"recurring": true,
"status": "A",
"lastModifiedOn": "/Date(1304787084000)/",
"createdOn": "/Date(1299914597000)/",
"displayOnSelfService": true,
"createdBy": "v4admin",
"canOverride": true,
"frequencyCode": "ANN",
"payComponentValue": null,
"taxTreatment": null,
"createdDateTime": "/Date(1299932597000+0000)/",
"lastModifiedBy": "admin",
"target": false,
"basePayComponentGroupNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOPayComponent(externalCode='Base Salary',startDate=datetime'1970-01-01T00:00:00')/
basePayComponentGroupNav"
}
},
"taxTreatmentNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOPayComponent(externalCode='Base Salary',startDate=datetime'1970-01-01T00:00:00')/
taxTreatmentNav"
}
},
"frequencyCodeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOPayComponent(externalCode='Base Salary',startDate=datetime'1970-01-01T00:00:00')/
frequencyCodeNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 233
Related Information

SAP API Business Hub: Foundation

9.9 FOPayComponentGroup

This entity enables you to group multiple pay components for summations, totals, and annualizations. You can
group pay components of different currencies and frequencies in one pay component group.

HRIS element information

HRIS Element ID: payComponentGroup

Business Keys: externalCode + startDate
Effective-date:true
Foundation Type:true
Person Entity Element:false
Supports Incremental Load:true
Supports NO_OVERWRITE: true
Supports MCPD:false

Supported Operations

Operation Description

Query You can query a pay component group.

Upsert You can create or update a pay component group.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

useForComparatioCalc You can use this property to define whether the pay compo­
nent group is used for the comp ratio calculation.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

234 PUBLIC Foundation Objects
 Property Description

showOnCompUI You can use this property to define whether the pay compo­
nent group is displayed on the Comp UI.

useForRangePenetration You can use this property to define whether the pay compo­
nent group is used to determine how far an employee has pro­
gressed into a given pay range.

Use Case: Get the Pay Component Group for Base Salary

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
FOPayComponentGroup?$filter=externalCode
eq 'Base Salary'&$select=externalCode&
$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FOPayComponentGroup(externalCode='Base
Salary',startDate=datetime'1970-01-01T00:00:00')"
},
"externalCode": "Base Salary"
}
]
}
}

Related Information

SAP API Business Hub: Foundation

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 235
9.10 FOPayGrade

You can use this entity to define a pay level for employees. A pay grade generally relates to a pay range.

HRIS Element Information

HRIS Element ID: payGrade

Business Keys: externalCode + startDate
Effective-date:true
Foundation Type:true
Person Entity Element:false
Supports Incremental Load:true
Supports NO_OVERWRITE: true
Supports MCPD: false

Supported Operations

Operation Description

Query You can query a pay grade.

Upsert You can create or update a pay grade.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

paygradeLevel You can use a number to define the level of the pay grade.

Use Case: Get the Pay Grade for Grade One

Request

Operation Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

236 PUBLIC Foundation Objects
 HTTP Method GET

URI https://<API-Server>/odata/v2/FOPayGrade?
$filter=status eq 'A' and externalCode eq
'GR-1'&$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FOPayGrade(externalCode='GR-1',startDate=datetime'1990-01-01T00:00:00')"
},
"startDate": "/Date(631152000000)/",
"externalCode": "GR-1",
"createdOn": "/Date(1320750704000)/",
"createdBy": "admin",
"status": "A",
"description": null,
"paygradeLevel": "1",
"name": "Salary Grade 1",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1320768704000+0000)/",
"endDate": "/Date(253402214400000)/",
"lastModifiedOn": "/Date(1320750704000)/",
"lastModifiedDateTime": "/Date(1320768704000+0000)/"
}
]
}
}

Related Information

SAP API Business Hub: Foundation

9.11 FOPayRange

You can use this entity to define a pay range for a particular pay grade. A pay range can be used to calculate compa
ratio and range penetration.

HRIS Element Information

HRIS Element ID: payRange

Business Keys: externalCode + startDate
Effective-date:true
Foundation Type:true

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 237
 Person Entity Element:false
Supports Incremental Load: true
Supports NO_OVERWRITE: yes
Supports MCPD: false

Supported Operations

Operation Description

Query You can query a pay range.

Upsert You can create or update a pay range.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Case: Get the Pay Range with External Code

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/FOPayRange?
$filter=status eq 'A' and externalCode eq
'PR-1-EU'&$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FOPayRange(externalCode='PR-1-EU',startDate=datetime'1990-01-01T00:00:00')"
},
"startDate": "/Date(631152000000)/",
"externalCode": "PR-1-EU",
"minimumPay": "7146",
"status": "A",
"endDate": "/Date(253402214400000)/",
"lastModifiedOn": "/Date(1311238423000)/",
"lastModifiedDateTime": "/Date(1311252823000+0000)/",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

238 PUBLIC Foundation Objects
 "midPoint": "10718.5",
"companyFlx": null,
"currency": "USD",
"createdOn": "/Date(1300225256000)/",
"createdBy": "admin",
"payGradeFlx": "GR-12",
"geozoneFlx": "EMEA",
"description": null,
"frequencyCode": "ANN",
"name": "Pay Range 1-3",
"createdDateTime": "/Date(1300239656000+0000)/",
"lastModifiedBy": "admin",
"maximumPay": "14291",
"geozoneFlxNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOPayRange(externalCode='PR-1-EU',startDate=datetime'1990-01-01T00:00:00')/
geozoneFlxNav"
}
},
"frequencyCodeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOPayRange(externalCode='PR-1-EU',startDate=datetime'1990-01-01T00:00:00')/
frequencyCodeNav"
}
},
"payGradeFlxNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOPayRange(externalCode='PR-1-EU',startDate=datetime'1990-01-01T00:00:00')/
payGradeFlxNav"
}
},
"companyFlxNav": {
"__deferred": {
"uri": "<API-Server>/odata/v2/FOPayRange(externalCode='PR-1-
EU',startDate=datetime'1990-01-01T00:00:00')/companyFlxNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Foundation

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 239
9.12 FOWfConfig

This entity contains workflow configuration information, such as role and type of the workflow approver, .

HRIS element information

HRIS Element ID: wfConfig

Business Keys: externalCode
Effective-date:false
Foundation Type:true
Person Entity Element:false
Supports Incremental Load:true
Supports NO_OVERWRITE: false
Supports MCPD: false

Supported Operations

Operation Description

Query You can query the workflow configuration information.

Upsert You can create or update the workflow configuration informa­

tion.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

approverType The type of the approver of the workflow step.

For more information about workflow approvers, see Workflow

Participant Types.

approverRole The role of the approver of the workflow step.

For more information about workflow approvers, see Workflow

Participant Types.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

240 PUBLIC Foundation Objects
 Property Description

actionType Specify how approvers are allowed to change content of a

workflow transaction:

● No Edit
Approvers do not have in-flight editing capability.
● Edit with Route Change
Approvers can edit a workflow and the workflow route will
be recalculated when they submit the request.
● Edit without Route Change
Approvers can edit a workflow but the workflow route will
not be recalculated when they submit the request.
● Edit Attachments Only
Approver can only edit the attachments of the workflow.

isDelegateSupported You can set this property to Yes or No to enable or disable

manual delegation or auto delegation of workflows.

skipType You can defines how the system react when there is an empty
position or dynamic group. Possible values are Stop the
Workflow and Skip this Step.

Use Case: Get All the Workflow Configuration Information by External Code

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/FOWfConfig?
$filter=externalCode eq 'GRT_TEST'&
$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/FOWfConfig('GRT_TEST')",
"type": "SFOData.FOWfConfig"
},
"externalCode": "GRT_TEST",
"createdOn": "/Date(1379578155000)/",
"futureDatedAlternateWorkflow": null,
"createdBy": "admin",
"description": "GRT_TEST",
"name": "GRT_TEST",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1379592555000+0000)/",
"lastModifiedOn": "/Date(1379578155000)/",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 241
 "lastModifiedDateTime": "/Date(1379592555000+0000)/",
"futureDatedAlternateWorkflowNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOWfConfig('GRT_TEST')/futureDatedAlternateWorkflowNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Foundation

9.13 FOWfConfigStepApprover

This entity contains information of step approver in a workflow.

Supported Operations

Operation Description

Query You can get the information of approver for a workflow step.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

externalCode Business key.

stepNum Business key. The order of the step in a workflow.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

242 PUBLIC Foundation Objects
 Property Description

approverType The type of the approver of the workflow step.

For more information about workflow approvers, see Workflow

Participant Types.

approverRole The role of the approver of the workflow step.

For more information about workflow approvers, see Workflow

Participant Types.

actionType Specifies how approvers are allowed to change content of a

workflow transaction:

● No Edit
Approvers do not have in-flight editing capability.
● Edit with Route Change
Approvers can edit a workflow and the workflow route will
be recalculated when they submit the request.
● Edit without Route Change
Approvers can edit a workflow but the workflow route will
not be recalculated when they submit the request.
● Edit Attachments Only
Approver can only edit the attachments of the workflow.

skipType Determines how the system react when there is an empty posi­
tion or dynamic group. Possible values are Stop the
Workflow and Skip this Step.

relationshipToApprover Specifies whether the approver is determined based on the

subject user of the workflow (employee) or the workflow initia­
tor. It is relevant only for approver types Role and Position Rela­
tionship. For more information about how it works with these
two approver types, see Workflow Participant Types.

Use Case: Get the Approver Information of the First Step in the Leave of
Absence Workflow

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
FOWfConfigStepApprover?
$filter=externalCode eq 'LOA' and stepNum
eq 1&$format=JSON

Response

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 243
 "d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FOWfConfigStepApprover(externalCode='LOA',stepNum=1L)",
"type": "SFOData.FOWfConfigStepApprover"
},
"externalCode": "LOA",
"stepNum": "1",
"lastModifiedDateTime": "/Date(1440443609000+0000)/",
"lastModifiedBy": "admindlr",
"createdDateTime": "/Date(1440443609000+0000)/",
"relationshipToApprover": null,
"respectRBP": false,
"actionType": "NO_EDIT",
"emailConfiguration": null,
"createdBy": "admindlr",
"approverPositionRelationship": null,
"context": null,
"skipType": "SKIP",
"approverRole": null,
"approverType": "DYNAMIC_GROUP",
"relationshipToPosition": null,
"approverDynamicRoleNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOWfConfigStepApprover(externalCode='LOA',stepNum=1L)/approverDynamicRoleNav"
}
},
"approverGroupNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOWfConfigStepApprover(externalCode='LOA',stepNum=1L)/approverGroupNav"
}
},
"approverPositionNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOWfConfigStepApprover(externalCode='LOA',stepNum=1L)/approverPositionNav"
}
}
}
]
}
}

Additional Information

You can either query this entity directly as described above or via $expand=wfStepApproverNav from FOWfConfig.

Related Information

SAP API Business Hub: Foundation

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

244 PUBLIC Foundation Objects
9.14 Working with Migrated Foundation Objects (MDF FOs)

Contains information on working with FO (Foundation Objects) that have been migrated to MDF (Metadata
Framework)

As part of the phased migration of Foundation Objects (FO) to Metadata Framework (MDF), the FOs Cost Center,
Business Unit, Division, Department, Legal Entity, Job Classification, Job Function, Job Family, Pay Group, and
PayCalendar have been migrated. After migration, these FOs are now Generic Objects.

For these newly created GOs, you can influence the way the fields behave in API queries. For example, if Division
was not mapped, it would be displayed as any other MDF OData source, and you would still have the field
effectiveStartDate in the API query. In element field mapping, effectiveStartDate is mapped to the HRIS element ID
start-date. Here, we are telling the system that the original field name for effectiveStartDate is startdate. Likewise,
effectiveStatus is mapped to status, cust_string1 is mapped to custom_string1, cust_string2 is mapped to
custom_string2, and so on.

Let’s see how it works for the various fields. The system searches the object definition and then the element type
map. If there is a mapping in the Element Type Map (see Element Field Map for EC Migration section), it displays the
field name from the map. For example, you define a new custom field called cust_string7.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 245
You can map cust_string7 to custom-string7 now. Hence, the field will be available in OData as custom-string7. If
you do not map it, it will appear with the same name as in MDF definition. However, if it is mapped in the Element
Type mapping, it will appear under the element map name.

There are a few special handlings. In object definition, if you map a field that is translatable, for example, name or
description, the behavior is the same as it was earlier. You will also have the field with the element map name.
Additionally, you will have this field with the suffix for the language.

You have a picklist field and now you define a field in the object definition, for example, cust_string4 is mapped to
custom-string4.

Now you will have four attributes in OData. This entry means that you will have the following four fields:

● cust_string4 (external code of picklist option)

● customString4 (ECV2 option ID of picklist option)
● cust_string4Nav (navigation to MDF picklist option)
● customString4Nav (navigation to ECV2 picklist option)

The cust_string4 and cust_string4Nav coming from the MDF object definition will be available even if you do not
have an entry in the element type map.

If the element type map does not have cust_string4, that is, if it is not mapped there, you still have the cust_string4
and cust_string4Nav

The customString4 gives the optionID of picklist option from ECV2 and customString4Nav provides navigation to
the old ECV2 picklist option as illustrated in the screenshot below. If you do not have an element type map , a
default mapping is made available.

To delete a cust_string, select Take Action Make Correction , and delete cust_string4.

The two extra fields will not be available now since there is no mapping.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

246 PUBLIC Foundation Objects
Translations in OData API

Before the migration, migrated FOs exposed language-independent texts for Name and Description. In addition, it
provided two links to FOTranslation to find the language-dependent texts for both fields. For example, the OData
entities FOJobFunction and FOPayGroup provided the navigation attributes nameTranslationNav and
descriptionTranslationNav to FoTranslation, if the translation of FOs is activated in Provisioning.

 Remember

As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.

After the migration, Name and Description will still be available for migrated FOs,to expose language-independent
texts. In addition, the two navigation attributes will also be available. However, they will not be really linked to
FOTranslation, but will always return an empty value. So the language-dependent texts will be integrated as
additional attributes into the migrated FO Odata entity (for example FOJobFunction, FOPayGroup) in the standard
MDF way.

Here is the work-around:

If you are not using FOTranslation for migrated FOs, de-select the FOTranslation navigation in Boomi. In case you
are using FOTranslation for migrated FOs, you need to adapt the UI.

9.14.1 Basic Tasks

9.14.1.1 Viewing the Element Type Mapping

The element type mapping shows the mapping between HRIS field names and field names for the GOs. The steps
to view the element type mapping for a migrated Foundation Object are described here

1. Navigate to Admin Center.

2. In the Tools Search field, enter Manage Data. The Manage Data page is displayed.
3. In the Search field, select Element Type Map for EC Migration.
4. Select the Foundation Object for which the mapping information is required. Now, the element map is available.

 Note

Not everyone can view the element Element Type Mapping. Grant the relevant permissions in User
Permissions Miscellaneous Permissions as follows:

● Element Type Map for EC Migration: Select View, Edit, Import/Export

● Element Type Map for EC Migration. Element Association Map for EC Migration (Element Association Map
for EC Migration): Select View, Correct, Adjust Order, Delete, Import/Export
● Element Type Map for EC Migration. Element Field Map for EC Migration (Element Field Map for EC
Migration): Select View, Correct, Adjust Order, Delete, Import/Export
● Element Type Map for EC Migration to EC2MDFElement FieldLocalizationMap (Element Localization Map
for EC Migration): Select View, Correct, Adjust Order, Delete, Import/Export

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 247
9.14.1.2 Viewing the Object Definition

Describes how to view the object definition

1. Navigate to Admin Center.

2. In the Tools Search field, type Configure Object Definitions. The Configure Object Definitions page is
displayed.
3. From the Search dropdown, select Object Definition.
4. Select the Foundation Object for which the information is required.

9.14.2 Associations

Let’s say, in the object definition you have an association defined. The association is called cust_toLegalEntity and
the definition is called Legal Entity. In the Element Type map (under Element Association Map for EC Migration
section), you have the association name cust_toLegalEntity, which is mapped to HRIS destination entity company.
This association is handled in the same way as an association for an FO is defined in the Corporate Data Model.
This means that you have the fields companyFlx and companyFlxNav in OData object definition. These fields will be
available only if the association defined in the object definition is added to the Association Element Type map.

For GO associations, if the field is not in the association mapping, you will only have the field that has the same
name as the association, for example, cust_toLegalEntity. This field can be queried and upserted. If this field is
added to the element association map, you will have the fields companyFlxNav and companyFlx for query and
upsert respectively.

If you want to add an association or a field, and want the field to behave in the same way as before the migration,
you must manually adjust the mapping objects.

9.14.3 Country/region-Specific Fields

Country/region-specific fields are fields of an object that are only relevant for specific countries or regions. For
example, for legal entities in the US, you have to specify a Federal Reserve Bank ID, which is not relevant for legal
entities in other countries or regions.

The only migrated FOs, which have country/region-specific fields, are Legal Entity (company) and Job
Classification (jobCode).

In OData (as well as the MDF object model), these fields are not stored directly in the main entity (FO Company or
FO Job Code). Instead, they are part of additional country/region-specific entities (see the sections
LegalEntity<Country/region> and JobClassification<Country/region>). These country/region-specific entities can
be reached from the main entity using navigation attributes.

Points to note:

● For FOCompany, the navigation attributes for the delivered country or region specializations follow the naming
conventions toLegalEntity<Country/region> (see the section FOCompany).
● For FOJobCode, there is an intermediate entity JobClassificationCountry (see section
JobClassificationCountry).

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

248 PUBLIC Foundation Objects
So for example, you can reach the France-specific fields of a job classification along the path FOJobCode/
toJobClassificationCountry/toJobClassificationFRA.

These navigation attributes and entity names differ from the legacy names. To ensure backward compatibility, you
can activate the old behavior for individual countries or regions by maintaining the localization map in the element
type map.

The following is an example of the element type map of Legal Entity (company):

Here, the localization map is maintained for two countries (USA and Germany). The effect of this is that, for these
two countries, additional navigation attributes and target entities will be available in addition to the standard
navigation attributes and entities described above. For USA, the effects are as follows:

● In addition to the standard entity LegalEntityUSA, there will be the backward-compatible entity
FOLegalEntityLocalUSA. This means that the MDF object LegalEntityUSA has two different OData
representations.
● In addition to the standard navigation attribute toLegalEntityUSA (with a target LegalEntityUSA), there is a
navigation attribute localNavUSA (with a target FOLegalEntityLocalUSA).

Similarly, if you maintain the localization map for USA in the element type map of Job Classification (jobCode), the
effects are as follows:

● In addition to the standard entity JobClassificationUSA, there will be the backward-compatible entity
FOJobCodeLocalUSA. These are different representations of the same MDF object JobClassificationUSA.
● In addition to the standard navigation chain toJobClassificationCountry/toJobClassificationUSA
(with target JobClassificationUSA), there is a shortcut navigation attribute called localNavUSA (with target
FOJobClassLocalUSA).

If you do not maintain an element type map, you have the following localization mapping that is used (as a fall
back):

For Legal Entity (company)

GO Association Country/Region

toLegalEntityARG ARG

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 249
GO Association Country/Region

toLegalEntityDEU DEU

toLegalEntityESP ESP

toLegalEntityFRA FRA

toLegalEntityUSA USA

For Job Classification (jobCode)

GO Association Country/Region

toJobClassificationCountry.toJobClassificationAUS AUS

toJobClassificationCountry.toJobClassificationBRA BRA

toJobClassificationCountry.toJobClassificationCAN CAN

toJobClassificationCountry.toJobClassificationFRA FRA

toJobClassificationCountry.toJobClassificationGBR GBR

toJobClassificationCountry.toJobClassificationITA ITA

toJobClassificationCountry.toJobClassificationUSA USA

To add country/region-specific fields for a new country or region, refer to the section Adding Country/region-
Specific Fields for a New Country or Region.

If you need the backward-compatible OData representation for a country added in this way, you must do the
following:

● Maintain an entry in the localization map of the host element type map.
For this, you must add the association name for the new country or region and the ISO country code for it.
● Create an element type map for the new MDF object that you have created.
If you want to map the new country/region-specific fields to the legacy field names (for example,
genericString1), you must maintain an element field map.

In the example for India (as in section Adding Country/region-Specific Fields for a New Country or Region), you must
add the following:

● Localization Map of the Element Type Map of LegalEntity (company)

○ Association name: cust_toLegalEntityIND
○ Country: ITA
● Element Type Map for the new object cust_LegalEntityIND
○ HRIS element ID: legalEntityLocal#IND
○ Country code for country-specific object: IND
○ GO object type: cust_LegalEntityIND

Adding Country/Region-Specific Fields for a New Country or Region (For Legal Entity) [page 251]

Adding Country/Region-Specific Fields for a New Country or Region (For Job Classification) [page 256]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

250 PUBLIC Foundation Objects
9.14.3.1 Adding Country/Region-Specific Fields for a New
Country or Region (For Legal Entity)

Assume that you want to add country/region-specific fields for a new country or region, let us take India for
example. You need to follow these steps:

1. Create a new MDF object that holds the country/region-specific fields.

2. Assign this new object as a child object to LegalEntity.

Parent topic: Country/region-Specific Fields [page 248]

Related Information

Adding Country/Region-Specific Fields for a New Country or Region (For Job Classification) [page 256]

9.14.3.1.1 Step 1: Create a New MDF Object for the Country/

Region-Specific Fields

Procedure

1. Navigate to the Admin Center.

2. In the Tools Search field, type Configure Object Definitions. The Configure Object Definitions page is
displayed.
3. From the Create New dropdown, select Object Definition.
4. In the Code field, specify a code for the new object. It is recommended that you follow this naming convention:
cust_LegalEntity<Country Code>. So, for this example, let's specify the code as
cust_LegalEntityIND.
5. From the Effective Dating dropdown, select From Parent.
6. In the Label field, specify a unique name. For this example, let's specify Legal Entity India.
7. Set API Visibility to Editable.
8. In the Fields section, click Details against externalCode.
9. Change the externalCode data type to Number and set its Visibility to Not Visible.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 251
10. Set Default Value to 1.
11. Click Done to go back to the previous page.
12. Specify settings for the externalName field. Click Details next to externalName.
13. Set the externalName field visibility to Not Visible.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

252 PUBLIC Foundation Objects
 14. Define the custom fields. For this example, we will add a string type field by the name of cust_IndiaField1.
15. Add a label. This will be displayed on the UI.
16. Click Save. This will add a number of pre-defined MDF fields.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 253
 SAP SuccessFactors Employee Central OData API: Reference Guide (V2)
254 PUBLIC Foundation Objects
9.14.3.1.2 Step 2: Assign the New Object to Legal Entity

To assign the new country or region object to Legal Entity, the steps are as follows:

Procedure

1. Navigate to the Admin Center.

2. In the Tools Search field, type Configure Object Definitions. The Configure Object Definitions page is
displayed.
3. From the Search dropdown, select Object Definition.
4. Select LegalEntity from the field next to it.

5. Select Take Action Make Correction .

6. Scroll down to the associations section and add a new association. We suggest following this naming
convention: cust_toLegalEntity<CountryCode>. Following this naming convention, let's specify the name
as cust_toLegalEntityIND.

1. Multiplicity: One to One

2. Destination Object: your newly created object (for example, Legal Entity India)
3. Type: Composite
4. Details:
1. Condition fieldID: countryOfRegistration.code
2. Condition Values: <Country Code>, in our example: IND

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 255
7. Click Done to save your changes.

9.14.3.2 Adding Country/Region-Specific Fields for a New

Country or Region (For Job Classification)

Assume that you want to add country/region-specific fields for a new country or region, let us take Spain for
example. You need to follow these steps:

1. Create a new MDF object that holds the country/region-specific fields.

2. Assign this new object as a child object to JobClassificationCountry.

Parent topic: Country/region-Specific Fields [page 248]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

256 PUBLIC Foundation Objects
Related Information

Adding Country/Region-Specific Fields for a New Country or Region (For Legal Entity) [page 251]

9.14.3.2.1 Step 1: Create a New MDF Object for the Country/

Region-Specific Fields

Procedure

1. Navigate to the Admin Center.

2. In the Tools Search field, type Configure Object Definitions. The Configure Object Definitions page is
displayed.
3. From the Create New dropdown, select Object Definition.
4. In the Code field, specify a code for the new object. It is recommended that you follow this naming convention:
cust_JobClassification<Country Code>. So, for this example, let's specify the code as
cust_JobClassificationESP.
5. From the Effective Dating dropdown, select From Parent.
6. In the Label field, specify a unique name. For this example, let's specify Job Classification Spain.
7. Set API Visibility to Editable.
8. In the Fields section, click Details against externalCode.
9. Change the externalCode data type to Number and set its Visibility to Not Visible.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 257
10. Set Default Value to 1.
11. Click Done to go back to the previous page.
12. We will now specify settings for the externalName field. Click Details next to externalName.
13. Set the externalName field visibility to Not Visible.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

258 PUBLIC Foundation Objects
 14. Define the custom fields. For this example, we will add a string type field by the name of cust_spain1.
15. Add a label. This wiill be displayed on the UI.
16. Click Save. This will add a number of pre-defined MDF fields.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 259
 SAP SuccessFactors Employee Central OData API: Reference Guide (V2)
260 PUBLIC Foundation Objects
9.14.3.2.2 Step 2: Assign the New Object to
JobClassificationCountry

To assign the new country or region object to JobClassificationCountry, the steps are as follows:

Procedure

1. Navigate to the Admin Center.

2. In the Tools Search field, type Configure Object Definitions. The Configure Object Definitions page is
displayed.
3. From the Search dropdown, select Object Definition.
4. Select JobClassificationCountry from the field next to it.

5. Select Take Action Make Correction .

6. Scroll down to the associations section and add a new association. We suggest following this naming
convention: cust_toJobClassification<CountryCode>. Following this naming convention, let's specify
the name as cust_toJobClassificationESP.

1. Multiplicity: One to One

2. Destination Object: your newly created object (for example, Job Classification Spain)
3. Type: Composite
4. Details:
1. Condition fieldID: country.code
2. Condition Values: <Country Code>, in our example: ESP

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 261
7. Click Done to save your changes.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

262 PUBLIC Foundation Objects
9.14.4 Difference Between FO Upsert and MDF Upsert

Let's take an example. The FO Business Unit is associated to Legal Entity and you have an association to company
1. You do an upsert by specifying the start date and external code of the business unit. In this case, either the
business unit is changed or a new one is created. Additionally, you list down the field that you want to change, for
example, companyFlx for company 2 and a pipe-separated list of the association target for company 3. Now the
existing association to company 1 is replaced and you have an association to company 2.

However, if you do an upsert through the MDF field cust_toLegalEntity, and specify company 1 and company 2, you
will have three associations. The upsert through the MDF field will only add or merge the existing ones.

Hence for example, Position will behave in the MDF way (merge behavior), and Job Classification, which is not on
MDF, will behave in the other manner (replacement).

9.14.5 CurrencyExchangeRate

This entity contains information about currency conversions based on the MDF object Currency Exchange Rate.

An example of the usage is given below:

The source currency is 1 unit of USD and the target currency is 1 unit of CAD. The exchange rate shows how much
of the target currency (CAD) is needed to purchase one unit of the source currency (USD). Therefore, if the
exchange rate is 1.0950, it costs 1.0950 Canadian dollars to purchase 1 U.S. dollar.

The currency exchange rate type DEFAULT corresponds to the Compensation legacy currency conversion table
ECT_CONV_TABLE. The currency exchange rate type is defined as a picklist.

Object Information

MDF Object:CurrencyExchangeRate
Business Keys:sourceCurrency,targetCurrency,currencyExchangeRateType
Required
Fields:sourceCurrency,targetCurrency,effectiveStartDate,exchangeRate,currencyExchang
eRateType
Full Purge:Yes
Incremental Purge:Yes
Effective-date:true

Supported Operations

Operation Description

Query Query currency exchange rate information.

Upsert Create or update currency exchange rate information.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 263
Operation Description

Insert Insert currency exchange rate information.

Merge Update currency exchange rate information.

Replace Replace existing currency exchange rate information with new

information.

Delete Delete currency exchange rate information.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Case 1: Query Currency Exchange Rate Records

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
CurrencyExchangeRate?$format=json&
$select=externalCode&$top=3

Response

{
"d": {
"results": [{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
CurrencyExchangeRate(effectiveStartDate=datetime'1900-01-01T00:00:00',externalCode='
DEFAULT-ARS-MYR')",
"type": "SFOData.CurrencyExchangeRate"
},
"externalCode": "DEFAULT-ARS-MYR"
}, {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
CurrencyExchangeRate(effectiveStartDate=datetime'1900-01-01T00:00:00',externalCode='
DEFAULT-HKD-EUR')",
"type": "SFOData.CurrencyExchangeRate"
},
"externalCode": "DEFAULT-HKD-EUR"
}, {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
CurrencyExchangeRate(effectiveStartDate=datetime'1900-01-01T00:00:00',externalCode='
DEFAULT-HKD-SGD')",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

264 PUBLIC Foundation Objects
 "type": "SFOData.CurrencyExchangeRate"
},
"externalCode": "DEFAULT-HKD-SGD"
}]
}
}

Use Case 2: Get the Currency Exchange Rate USD to EUR

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
CurrencyExchangeRate(externalCode='DEFAULT
-USD-
EUR',effectiveStartDate=datetime'1900-01-0
1T00:00:00')?$format=json

Response

{
"d": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
CurrencyExchangeRate(effectiveStartDate=datetime'1900-01-01T00:00:00',externalCode='
DEFAULT-USD-EUR')",
"type": "SFOData.CurrencyExchangeRate"
},
"effectiveStartDate": "\/Date(-2208988800000)\/",
"externalCode": "DEFAULT-USD-EUR",
"exchangeRate": "1.125",
"targetCurrency": "EUR",
"effectiveStatus": "A",
"sourceCurrency": "USD",
"currencyExchangeRateType": "DEFAULT",
"sourceCurrencyNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
CurrencyExchangeRate(effectiveStartDate=datetime'1900-01-01T00:00:00',externalCode='
DEFAULT-USD-EUR')/sourceCurrencyNav"
}
},
"targetCurrencyNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
CurrencyExchangeRate(effectiveStartDate=datetime'1900-01-01T00:00:00',externalCode='
DEFAULT-USD-EUR')/targetCurrencyNav"
}
},
"currencyExchangeRateTypeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
CurrencyExchangeRate(effectiveStartDate=datetime'1900-01-01T00:00:00',externalCode='
DEFAULT-USD-EUR')/currencyExchangeRateTypeNav"
}
},
"effectiveStatusNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 265
 "uri": "https://<API-Server>/odata/v2/
CurrencyExchangeRate(effectiveStartDate=datetime'1900-01-01T00:00:00',externalCode='
DEFAULT-USD-EUR')/effectiveStatusNav"
}
}
}
}

Use Case 3: Update the Currency Exchange Rate USD to EUR

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert

Payload
{
"__metadata": {
"uri": "https://<API-
Server>/odata/v2/
CurrencyExchangeRate(effectiveStartDate=
datetime'1900-01-01T00:00:00',externalCo
de='DEFAULT-USD-EUR')",
"type":
"SFOData.CurrencyExchangeRate"
},
"exchangeRate": "1.125",
"targetCurrency": "EUR",
"effectiveStatus": "A",
"sourceCurrency": "USD",
"currencyExchangeRateType":
"DEFAULT"
}

Response

{
"d": [
{
"key": "CurrencyExchangeRate/
effectiveStartDate=1900-01-01T00:00:00.000-05:00,CurrencyExchangeRate/
externalCode=DEFAULT-ZAR-ARS",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

266 PUBLIC Foundation Objects
Use Case 4: Delete the Currency Exchange Rate USD to EUR

Request

Operation Delete

HTTP Method DELETE

URI https://<API-Server>/odata/v2/
CurrencyExchangeRate(effectiveStartDate=da
tetime'1900-01-01T00:00:00',externalCode='
DEFAULT-USD-EUR')

Error Messages

The table below lists the error messages generated when using this API:

Error Message Description

WORKSTRUCTURE_VALIDATION_EXCHANGE_RATE_MUST_ An exchange rate with source currency USD and target

BE_GREATER_THAN_ZERO
currency EUR must be greater than zero.

WORKSTRUCTURE_VALIDATION_IDENTICAL_SOURCE_TAR Exchange rate with the same source currency and target
GET_CURRENCIES_NOT_ALLOWED
currency is not allowed.

WORKSTRUCTURE_VALIDATION_REVERSE_RATE_OF_CURR A reverse exchange rate with source currency USD and target
ENCY_PAIR_ALREADY_EXISTS
currency EUR of currency exchange rate type DEFAULT
already exists.

WORKSTRUCTURE_VALIDATION_RATE_OF_CURRENCY_PAI An exchange rate with source currency USD and target

R_ALREADY_EXISTS
currency EUR of currency exchange rate type DEFAULT
already exists.

Related Information

SAP API Business Hub: Employee Global Information

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 267
9.14.6 FOBusinessUnit

The FOBusinessUnit entity represents the Generic Object Business Unit.

Object Information

MDF Object:BusinessUnit
Business Keys: externalCode + startDate
Effective-date:true

Supported Operations

Operation Description

Query Query business unit information.

Upsert Create or update business unit information.

Insert Insert business unit information.

Merge Update business unit information.

Replace Replace existing business unit information with new informa­

tion.

Delete Delete business unit information.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

mdfSystemRecordId This property represents an MDF system field used as an iden­

tifier of an MDF record.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

268 PUBLIC Foundation Objects
Use Case 1: Query the Information of Retail Business Unit

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/FOBusinessUnit?
$filter=externalCode eq 'RETAIL'&$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FOBusinessUnit(externalCode='RETAIL',startDate=datetime'1900-01-01T00:00:00')",
"type": "SFOData.FOBusinessUnit"
},
"externalCode": "RETAIL",
"startDate": "/Date(-2208988800000)/",
"description_ko_KR": null,
"lastModifiedDateTime": "/Date(1508375121000+0000)/",
"name_localized": "Retail",
"description_th_TH": null,
"endDate": "/Date(253402214400000)/",
"entityUUID": "57A51193D2B440C9B94A62FD67712362",
"name_ko_KR": "소매",
"createdDateTime": "/Date(1487286780000+0000)/",
"name_th_TH": null,
"description_ar_SA": null,
"description_pt_BR": null,
"description_es_ES": null,
"name_pt_BR": "Varejo",
"description_nl_NL": null,
"name_nl_NL": null,
"description_defaultValue": null,
"name_ar_SA": null,
"name_de_DE": "Einzelhandel",
"name_zh_TW": "零售",
"name": "Retail",
"name_es_ES": "Comercio",
"description_en_US": null,
"description_en_DEBUG": null,
"description_ru_RU": null,
"status": "A",
"name_ru_RU": "Розничная торговля",
"description_ja_JP": null,
"description_fr_FR": null,
"name_pt_PT": null,
"description": null,
"description_de_DE": null,
"name_fr_FR": "Commerce de détail",
"name_en_DEBUG": null,
"name_ja_JP": "小売",
"createdOn": "/Date(1487268780000)/",
"headOfUnit": null,
"name_en_US": "Retail",
"description_iw_IL": null,
"description_zh_TW": null,
"name_zh_CN": "零售",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 269
 "name_defaultValue": "Retail",
"description_en_GB": null,
"lastModifiedBy": "sfadmin",
"name_en_GB": "Retail",
"name_iw_IL": null,
"lastModifiedOn": "/Date(1508360721000)/",
"description_zh_CN": null,
"createdBy": "sfadmin",
"description_localized": null,
"description_pt_PT": null,
"nameTranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>om:443/odata/v2/
FOBusinessUnit(externalCode='RETAIL',startDate=datetime'1900-01-01T00:00:00')/
nameTranslationTextNav"
}
},
"headOfUnitNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOBusinessUnit(externalCode='RETAIL',startDate=datetime'1900-01-01T00:00:00')/
headOfUnitNav"
}
},
"descriptionTranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOBusinessUnit(externalCode='RETAIL',startDate=datetime'1900-01-01T00:00:00')/
descriptionTranslationTextNav"
}
},
"statusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOBusinessUnit(externalCode='RETAIL',startDate=datetime'1900-01-01T00:00:00')/
statusNav"
}
},
"descriptionTranslationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOBusinessUnit(externalCode='RETAIL',startDate=datetime'1900-01-01T00:00:00')/
descriptionTranslationNav"
}
},
s
"nameTranslationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOBusinessUnit(externalCode='RETAIL',startDate=datetime'1900-01-01T00:00:00')/
nameTranslationNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

270 PUBLIC Foundation Objects
Use Case 2: Upate the Status of Business Unit

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert

Payload
{
"__metadata": {

"uri":"FOBusinessUnit(startDate=datetime'2014-09-11T00:0
0:00',externalCode='20000')" },
"status":"A" }

Response

{
"d": [
{
"key": "FOBusinessUnit/externalCode=20000,FOBusinessUnit/
startDate=2014-09-11T00:00:00.000-05:00",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Error Codes

The table below lists different error codes generated when using this API.

AFFECTED_EXTERNAL_CODE_ERROR This record cannot be saved since one or more records of this
Code have reported errors.

END_DATE_EARLIER_THAN_START_DATE Start date cannot be greater than end date.

INVALID_LEGACY_PICKLIST_OPTION_ID This is an invalid picklist value in import file or database for

String.

Related Information

SAP API Business Hub: Foundation

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 271
Business Unit

9.14.7 FOCostCenter

The FOCostCenter entity represents the Generic Object Cost Center.

Object Information

MDF Object: CostCenter

Business Keys: externalCode + startDate
Effective-date:true

Supported Operations

Operation Description

Query You can query a cost center record.

Upsert You can create or update a cost center record.

Insert You can create a new cost center record.

Merge You can update an existing cost center record.

Replace You can replace an existing cost center record with a new re­
cord.

Delete You can delete a cost center record.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

externalCode This is a business key.

startDate This is a business key.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

272 PUBLIC Foundation Objects
 Property Description

entityUUID This property is the same as the mdfSystemEntityId field

in Generic Object Cost Center. You can use this property
as a unique identifier of FOCostCenter entries during sys­
tem integration.

entityOID This property stores the One Domain Model (ODM) object ID
that is used in master data integration.

mdfSystemRecordId This property represents an MDF system field used as an iden­

tifier of an MDF record.

Use Case 1: Query a Cost Center Record by External Code and Start Date

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
FOCostCenter?$filter=externalCode eq
'aaaa' and startDate eq '/
Date(1398124800000)/'&$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FOCostCenter(externalCode='aaaa',startDate=datetime'2014-04-22T00:00:00')"
},
"startDate": "\/Date(1398124800000)\/",
"externalCode": "aaaa",
"costcenterManager": null,
"description_de_DE": null,
"endDate": "\/Date(253402214400000)\/",
"lastModifiedDateTime": "\/Date(1398306271000+0000)\/",
"name_ja_JP": null,
"businessUnitFlx": null,
"description": null,
"name_defaultValue": "aaaa",
"name_en_US": "aaaa",
"glStatementCode": "SA49163",
"description_en_US": null,
"status": "A",
...
...
"customString1Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCostCenter(externalCode='aaaa',startDate=datetime'2014-04-22T00:00:00')/
customString1Nav"
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 273
 },
"customDouble2Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCostCenter(externalCode='aaaa',startDate=datetime'2014-04-22T00:00:00')/
customDouble2Nav"
}
},
"descriptionTranslationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCostCenter(externalCode='aaaa',startDate=datetime'2014-04-22T00:00:00')/
descriptionTranslationNav"
}
},
"statusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCostCenter(externalCode='aaaa',startDate=datetime'2014-04-22T00:00:00')/statusNav"
}
},
"costcenterManagerNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCostCenter(externalCode='aaaa',startDate=datetime'2014-04-22T00:00:00')/
costcenterManagerNav"
}
},
"departmentFlxNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCostCenter(externalCode='aaaa',startDate=datetime'2014-04-22T00:00:00')/
departmentFlxNav"
}
},
"nameTranslationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCostCenter(externalCode='aaaa',startDate=datetime'2014-04-22T00:00:00')/
nameTranslationNav"
}
},
"businessUnitFlxNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCostCenter(externalCode='aaaa',startDate=datetime'2014-04-22T00:00:00')/
businessUnitFlxNav"
}
},
...
...
}
]
}

Use Case 2: Update the Status of Cost Center

 Note

Any custom navigations and fields added after migration without any mapping maintained by the customer will
be returned as cust_<type><number>. For example, cust_string1Nav. For existing ones with mapping, the field
and navigation will be returned as–is. For example, customString1.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

274 PUBLIC Foundation Objects
Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert?
$format=json

Payload
{
"__metadata":{

"uri":"FOCostCenter(startDate=datetime'2
014-09-11T00:00:00',externalCode='20000'
)"
},
"status":"A"
}

Response

{
"d": [
{
"key": "FOCostCenter/externalCode=20000,FOCostCenter/
startDate=2014-09-11T00:00:00.000Z",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Error Codes

The table below lists different error codes generated when using this API.

AFFECTED_EXTERNAL_CODE_ERROR This record cannot be saved since one or more records of this
Code have reported errors.

END_DATE_EARLIER_THAN_START_DATE Start date cannot be greater than end date.

INVALID_LEGACY_PICKLIST_OPTION_ID This is an invalid picklist value in import file or database for

String.

Related Information

SAP API Business Hub: Foundation

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 275
9.14.8 FOCompany

The FOCompany entity represents the Generic Object Legal Entity.

Object Information

MDF Object:LegalEntity
Business Keys: externalCode + startDate
Effective-date:true

Supported Operations

Query, Insert, Merge, Replace, Upsert, Delete

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

localNavDEFLT Do not use this navigation property because it navigates to the

empty entity FOLegalEntityLocalDEFLT.

entityOID This property stores the One Domain Model (ODM) object ID
that is used in master data integration.

mdfSystemRecordId This property represents an MDF system field used as an iden­

tifier of an MDF record.

Use Case 1: Get the Company Record by External Code

Request

Operation Query

HTTP Method GET

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

276 PUBLIC Foundation Objects
 URI https://<API-Server>/odata/v2/FOCompany?
$format=json&$filter=externalCode eq
'1000'

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FOCompany(externalCode='1000',startDate=datetime'1900-01-01T00:00:00')",
"type": "SFOData.FOCompany"
},
"externalCode": "1000",
"startDate": "/Date(-2208988800000)/",
"country": "DEU",
"description_ko_KR": "BestRun 독일",
"lastModifiedDateTime": "/Date(1611298654000+0000)/",
"name_localized": "BestRun Germany",
"description_th_TH": null,
"endDate": "/Date(253402214400000)/",
"name_ko_KR": "BestRun 독일",
"createdDateTime": "/Date(1443727091000+0000)/",
"name_th_TH": null,
"description_ar_SA": null,
"description_pt_BR": "BestRun Alemanha",
"description_es_ES": "BestRun Alemania",
"name_pt_BR": "BestRun Alemanha",
"description_nl_NL": null,
"name_nl_NL": null,
"standardHours": "40",
"description_defaultValue": "BestRun Germany",
"name_ar_SA": null,
"name_de_DE": "BestRun Deutschland",
"name_zh_TW": "BestRun 德國",
"name": "BestRun Germany",
"name_es_ES": "BestRun Alemania",
"description_en_US": "BestRun Germany",
"description_en_DEBUG": null,
"description_ru_RU": "BestRun Германия",
"status": "I",
"name_ru_RU": "BestRun Германия",
"description_ja_JP": "BestRun ドイツ",
"description_fr_FR": "BestRun Allemagne",
"name_pt_PT": null,
"description": "BestRun Germany",
"description_de_DE": "BestRun Deutschland",
"name_fr_FR": "BestRun Allemagne",
"name_en_DEBUG": null,
"name_ja_JP": "BestRun ドイツ",
"createdOn": "/Date(1443712691000)/",
"name_en_US": "BestRun Germany",
"description_iw_IL": null,
"currency": "EUR",
"description_zh_TW": "BestRun 德國",
"name_zh_CN": "BestRun 德国",
"name_defaultValue": "BestRun Germany",
"description_en_GB": "BestRun Germany",
"lastModifiedBy": "sfadmin",
"defaultPayGroup": null,
"name_en_GB": "BestRun Germany",
"name_iw_IL": null,
"lastModifiedOn": "/Date(1611280654000)/",
"description_zh_CN": "BestRun 德国",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 277
 "createdBy": "sfadmin",
"description_localized": "BestRun Germany",
"description_pt_PT": null,
"defaultLocation": null,
"nameTranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCompany(externalCode='1000',startDate=datetime'1900-01-01T00:00:00')/
nameTranslationTextNav"
}
},
"defaultLocationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCompany(externalCode='1000',startDate=datetime'1900-01-01T00:00:00')/
defaultLocationNav"
}
},
"localNavARG": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCompany(externalCode='1000',startDate=datetime'1900-01-01T00:00:00')/localNavARG"
}
},
"currencyNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCompany(externalCode='1000',startDate=datetime'1900-01-01T00:00:00')/currencyNav"
}
},
"toLegalEntityARG": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCompany(externalCode='1000',startDate=datetime'1900-01-01T00:00:00')/
toLegalEntityARG"
}
},
"descriptionTranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCompany(externalCode='1000',startDate=datetime'1900-01-01T00:00:00')/
descriptionTranslationTextNav"
}
},
"statusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCompany(externalCode='1000',startDate=datetime'1900-01-01T00:00:00')/statusNav"
}
},
"descriptionTranslationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCompany(externalCode='1000',startDate=datetime'1900-01-01T00:00:00')/
descriptionTranslationNav"
}
},
"localNavESP": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCompany(externalCode='1000',startDate=datetime'1900-01-01T00:00:00')/localNavESP"
}
},
"localNavUSA": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCompany(externalCode='1000',startDate=datetime'1900-01-01T00:00:00')/localNavUSA"
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

278 PUBLIC Foundation Objects
 },
"localNavDEU": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCompany(externalCode='1000',startDate=datetime'1900-01-01T00:00:00')/localNavDEU"
}
},
"localNavFRA": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCompany(externalCode='1000',startDate=datetime'1900-01-01T00:00:00')/localNavFRA"
}
},
"toLegalEntityRUS": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCompany(externalCode='1000',startDate=datetime'1900-01-01T00:00:00')/
toLegalEntityRUS"
}
},
"toLegalEntityUSA": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCompany(externalCode='1000',startDate=datetime'1900-01-01T00:00:00')/
toLegalEntityUSA"
}
},
"toLegalEntityESP": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCompany(externalCode='1000',startDate=datetime'1900-01-01T00:00:00')/
toLegalEntityESP"
}
},
"nameTranslationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCompany(externalCode='1000',startDate=datetime'1900-01-01T00:00:00')/
nameTranslationNav"
}
},
"localNavDEFLT": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCompany(externalCode='1000',startDate=datetime'1900-01-01T00:00:00')/
localNavDEFLT"
}
},
"countryNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCompany(externalCode='1000',startDate=datetime'1900-01-01T00:00:00')/countryNav"
}
},
"defaultPayGroupNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCompany(externalCode='1000',startDate=datetime'1900-01-01T00:00:00')/
defaultPayGroupNav"
}
},
"toLegalEntityFRA": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCompany(externalCode='1000',startDate=datetime'1900-01-01T00:00:00')/
toLegalEntityFRA"
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 279
 "countryOfRegistrationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCompany(externalCode='1000',startDate=datetime'1900-01-01T00:00:00')/
countryOfRegistrationNav"
}
},
"toLegalEntityDEU": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOCompany(externalCode='1000',startDate=datetime'1900-01-01T00:00:00')/
toLegalEntityDEU"
}
}
}
]
}
}

Use Case 2: Update the Status of Company

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert?
$format=json

Payload
{
"__metadata":{

"uri":"FOCompany(startDate=datetime'2014
-09-11T00:00:00',externalCode='20000')"
},
"status":"A"
}

Response

{
"d": [
{
"key": "FOCompany/externalCode=20000,FOCompany/
startDate=2014-09-11T00:00:00.000-05:00",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

280 PUBLIC Foundation Objects
Error Codes

The table below lists different error codes generated when using this API.

AFFECTED_EXTERNAL_CODE_ERROR This record cannot be saved since one or more records of this
Code have reported errors.

END_DATE_EARLIER_THAN_START_DATE Start date cannot be greater than end date.

INVALID_LEGACY_PICKLIST_OPTION_ID This is an invalid picklist value in import file or database for

String.

Related Information

SAP API Business Hub: Foundation

9.14.9 FODepartment

The FODepartment entity represents the Generic Object Department.

Object Information

MDF Object:Department
Business Keys: externalCode + startDate
Effective-date:true

Supported Operations

Query, Insert, Merge, Replace, Upsert, Delete

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 281
Property Description

mdfSystemRecordId This property represents an MDF system field used as an iden­

tifier of an MDF record.

Use Case 1: Get the Department Record by External Code

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
FODepartment?$format=json&
$filter=externalCode eq '50150016'

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FODepartment(externalCode='50150016',startDate=datetime'1900-01-01T00:00:00')",
"type": "SFOData.FODepartment"
},
"externalCode": "50150016",
"startDate": "/Date(-2208988800000)/",
"parent": "50150011",
"description_ko_KR": "자산 관리 US",
"lastModifiedDateTime": "/Date(1508375230000+0000)/",
"name_localized": "Asset Management US",
"description_th_TH": null,
"endDate": "/Date(253402214400000)/",
"entityUUID": "F7F2CC007EAB4C2A938F6506DCDF8C17",
"name_ko_KR": "자산 관리 US",
"createdDateTime": "/Date(1443996398000+0000)/",
"name_th_TH": null,
"description_ar_SA": null,
"description_pt_BR": "Gestão de ativos - US",
"description_es_ES": "Gestión de activos fijos (EE. UU.)",
"name_pt_BR": "Gestão de ativos - US",
"description_nl_NL": null,
"name_nl_NL": null,
"costCenter": "US10_RDGEN",
"description_defaultValue": "Asset Management US",
"name_ar_SA": null,
"name_de_DE": "Anlagenmanagement (US)",
"name_zh_TW": "資產管理 - 美國",
"name": "Asset Management US",
"name_es_ES": "Gestión de activos fijos (EE....",
"description_en_US": "Asset Management US",
"description_en_DEBUG": null,
"description_ru_RU": "Управление активами (США)",
"status": "A",
"name_ru_RU": "Управление активами (США)",
"description_ja_JP": "資産管理 (US)",
"description_fr_FR": "Gestion des ressources US",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

282 PUBLIC Foundation Objects
 "name_pt_PT": null,
"description": "Asset Management US",
"description_de_DE": "Anlagenmanagement (US)",
"name_fr_FR": "Gestion des ressources US",
"name_en_DEBUG": null,
"name_ja_JP": "資産管理 (US)",
"createdOn": "/Date(1443981998000)/",
"headOfUnit": null,
"name_en_US": "Asset Management US",
"description_iw_IL": null,
"description_zh_TW": "資產管理 - 美國",
"name_zh_CN": "资产管理 - 美国",
"name_defaultValue": "Asset Management US",
"description_en_GB": "Asset Management US",
"lastModifiedBy": "sfadmin",
"name_en_GB": "Asset Management US",
"name_iw_IL": null,
"lastModifiedOn": "/Date(1508360830000)/",
"description_zh_CN": "资产管理 - 美国",
"createdBy": "admindlr",
"description_localized": "Asset Management US",
"description_pt_PT": null,
"cust_toLegalEntity": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FODepartment(externalCode='50150016',startDate=datetime'1900-01-01T00:00:00')/
cust_toLegalEntity"
}
},
"nameTranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FODepartment(externalCode='50150016',startDate=datetime'1900-01-01T00:00:00')/
nameTranslationTextNav"
}
},
"headOfUnitNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FODepartment(externalCode='50150016',startDate=datetime'1900-01-01T00:00:00')/
headOfUnitNav"
}
},
"divisionFlxNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FODepartment(externalCode='50150016',startDate=datetime'1900-01-01T00:00:00')/
divisionFlxNav"
}
},
"descriptionTranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FODepartment(externalCode='50150016',startDate=datetime'1900-01-01T00:00:00')/
descriptionTranslationTextNav"
}
},
"statusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FODepartment(externalCode='50150016',startDate=datetime'1900-01-01T00:00:00')/
statusNav"
}
},
"descriptionTranslationNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 283
 "uri": "https://<API-Server>/odata/v2/
FODepartment(externalCode='50150016',startDate=datetime'1900-01-01T00:00:00')/
descriptionTranslationNav"
}
},
"cust_toDivision": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FODepartment(externalCode='50150016',startDate=datetime'1900-01-01T00:00:00')/
cust_toDivision"
}
},
"costCenterNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FODepartment(externalCode='50150016',startDate=datetime'1900-01-01T00:00:00')/
costCenterNav"
}
},
"nameTranslationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FODepartment(externalCode='50150016',startDate=datetime'1900-01-01T00:00:00')/
nameTranslationNav"
}
},
"toDepartmentApprenticeDetail": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FODepartment(externalCode='50150016',startDate=datetime'1900-01-01T00:00:00')/
toDepartmentApprenticeDetail"
}
},
"parentNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FODepartment(externalCode='50150016',startDate=datetime'1900-01-01T00:00:00')/
parentNav"
}
}
}
]
}
}

Use Case 2: Update the Status of Department

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert?&
$format=json

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

284 PUBLIC Foundation Objects
 Payload
{
"__metadata":{

"uri":"Department(startDate=datetime'201
4-09-11T00:00:00',externalCode='20000')"
},
"status":"A"
}

Response

{
"d": [
{
"key": "FODepartment/externalCode=20000,FODepartment/
startDate=2014-09-11T00:00:00.000-05:00",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Error Codes

The table below lists different error codes generated when using this API.

AFFECTED_EXTERNAL_CODE_ERROR This record cannot be saved since one or more records of this
Code have reported errors.

END_DATE_EARLIER_THAN_START_DATE Start date cannot be greater than end date.

INVALID_LEGACY_PICKLIST_OPTION_ID This is an invalid picklist value in import file or database for

String.

Related Information

SAP API Business Hub: Foundation

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 285
9.14.10 FODivision

The FODivision entity represents the Generic Object Division.

Object Information

MDF Object:Division
Business Keys: externalCode + startDate
Effective-date:true

Supported Operations

Query, Insert, Merge, Replace, Upsert, Delete

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

mdfSystemRecordId This property represents an MDF system field used as an iden­

tifier of an MDF record.

Use Case 1: Get the Information of the Inside Sales Division

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/FODivision?
$format=json&$filter=externalCode eq
'INSIDE_SALES'

Response

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

286 PUBLIC Foundation Objects
 "d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FODivision(externalCode='INSIDE_SALES',startDate=datetime'1990-01-01T00:00:00')",
"type": "SFOData.FODivision"
},
"externalCode": "INSIDE_SALES",
"startDate": "/Date(631152000000)/",
"parent": null,
"description_ko_KR": "내부 영업",
"lastModifiedDateTime": "/Date(1508375259000+0000)/",
"name_localized": "Inside Sales",
"description_th_TH": null,
"endDate": "/Date(253402214400000)/",
"entityUUID": "17EA14CF87E7248BE0530B28080A6EAB",
"name_ko_KR": "내부 영업",
"createdDateTime": "/Date(1443997324000+0000)/",
"name_th_TH": null,
"description_ar_SA": null,
"description_pt_BR": "Vendas internas",
"description_es_ES": "Ventas internas",
"name_pt_BR": "Vendas internas",
"description_nl_NL": null,
"name_nl_NL": null,
"description_defaultValue": "Inside Sales",
"name_ar_SA": null,
"name_de_DE": "Vertriebssupport",
"name_zh_TW": "內部銷售",
"name": "Inside Sales",
"name_es_ES": "Ventas internas",
"description_en_US": "Inside Sales",
"description_en_DEBUG": null,
"description_ru_RU": "Дистанционные продажи",
"status": "A",
"name_ru_RU": "Дистанционные продажи",
"description_ja_JP": "インサイドセールス本部",
"description_fr_FR": "Ventes internes",
"name_pt_PT": null,
"description": "Inside Sales",
"description_de_DE": "Vertriebssupport",
"name_fr_FR": "Ventes internes",
"name_en_DEBUG": null,
"name_ja_JP": "インサイドセールス本部",
"createdOn": "/Date(1443982924000)/",
"headOfUnit": null,
"name_en_US": "Inside Sales",
"description_iw_IL": null,
"description_zh_TW": "內部銷售",
"name_zh_CN": "内部销售",
"name_defaultValue": "Inside Sales",
"description_en_GB": null,
"lastModifiedBy": "sfadmin",
"name_en_GB": null,
"name_iw_IL": null,
"lastModifiedOn": "/Date(1508360859000)/",
"description_zh_CN": "内部销售",
"createdBy": "admindlr",
"description_localized": "Inside Sales",
"description_pt_PT": null,
"nameTranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FODivision(externalCode='INSIDE_SALES',startDate=datetime'1990-01-01T00:00:00')/
nameTranslationTextNav"
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 287
 "headOfUnitNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FODivision(externalCode='INSIDE_SALES',startDate=datetime'1990-01-01T00:00:00')/
headOfUnitNav"
}
},
"cust_toBusinessUnit": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FODivision(externalCode='INSIDE_SALES',startDate=datetime'1990-01-01T00:00:00')/
cust_toBusinessUnit"
}
},
"descriptionTranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FODivision(externalCode='INSIDE_SALES',startDate=datetime'1990-01-01T00:00:00')/
descriptionTranslationTextNav"
}
},
"businessUnitFlxNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FODivision(externalCode='INSIDE_SALES',startDate=datetime'1990-01-01T00:00:00')/
businessUnitFlxNav"
}
},
"statusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FODivision(externalCode='INSIDE_SALES',startDate=datetime'1990-01-01T00:00:00')/
statusNav"
}
},
"descriptionTranslationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FODivision(externalCode='INSIDE_SALES',startDate=datetime'1990-01-01T00:00:00')/
descriptionTranslationNav"
}
},
"nameTranslationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FODivision(externalCode='INSIDE_SALES',startDate=datetime'1990-01-01T00:00:00')/
nameTranslationNav"
}
},
"parentNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FODivision(externalCode='INSIDE_SALES',startDate=datetime'1990-01-01T00:00:00')/
parentNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

288 PUBLIC Foundation Objects
Use Case 2: Update the Status of Division

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert?&
$format=json

Payload
{
"__metadata":{

"uri":"FODivision(startDate=datetime'201
4-09-11T00:00:00',externalCode='20000')"
},
"status":"A"
}

Response

{
"d": [
{
"key": "FODivision/externalCode=20000,FODivision/
startDate=2014-09-11T00:00:00.000-05:00",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Error Codes

The table below lists different error codes generated when using this API.

AFFECTED_EXTERNAL_CODE_ERROR This record cannot be saved since one or more records of this
Code have reported errors.

END_DATE_EARLIER_THAN_START_DATE Start date cannot be greater than end date.

INVALID_LEGACY_PICKLIST_OPTION_ID This is an invalid picklist value in import file or database for

String.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 289
Related Information

SAP API Business Hub: Foundation

9.14.11 FOLegalEntityLocal<Country/Region>

This chapter covers several entities containing country/region-specific fields of legal entities. The country or region
identifier in the entity name is the country/region ISO Code. For example, for Germany, the name of this entity is
FOLegalEntityLocalDEU.

These entities are made available for backward-compatibility reasons only. For a particular country or region, the
corresponding entity exists if the following pre-requisites are fulfilled:

● There is an MDF object modeled that holds the country/region-specific legal entity fields for this country or
region.
● The API Visibility of the entity is different from Not Visible.
● The element type map contains information, which indicates that the backward-compatible entity should be
offered for this country or region.

For more information, see the Country/Region-Specific Fields section.

By default, five such country/region-specific entities are pre-shipped. These are FOLegalEntityLocalARG,
FOLegalEntityLocalDEU, FOLegalEntityLocalFRA, FOLegalEntityLocalESP, and FOLegalEntityLocalUSA.

Object Information

MDF Object:LegalEntity<Country/Region>
Business Keys: externalCode + startDate + country
Effective-date:true

Supported Operations

Query

Additional Country/Region-Specific Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

The country/region-specific properties for the five pre-shipped countries are listed below.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

290 PUBLIC Foundation Objects
For Argentina:

Property Name in OData Corresponding Field in Object Definition

genericString1 cuitCode

For Germany:

Property Name in OData Corresponding Field in Object Definition

genericString1 taxUnit

genericString2 socialAccidentInsurance

genericString3 socialAccidentInsuranceRegistrationNumber

For Spain:

Property Name in OData Corresponding Field in Object Definition

genericString1 certificadoDeIdentificacionFiscal

For France:

Property Name in OData Corresponding Field in Object Definition

genericNumber1 nafCode

genericNumber2 sirenCode

For USA:

Property Name in OData Corresponding Field in Object Definition Comments

genericNumber1 legalEntityType The option ID of the legal entity type

genericString1 federalReserveBankID

genericString2 fedReserveBankDistrict

genericString3 employerID

genericString4 eeoCompanyCode

legalEntityType legalEntityType The external code of the legal entity type

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 291
Use Case: Get the External Code of Legal Entities in Canada

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
FOLegalEntityLocalCAN?$format=json&
$select=externalCode&$top=3

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FOLegalEntityLocalCAN(country='CAN',externalCode='comTest2',startDate=datetime'2013-
12-02T00:00:00')",
"type": "SFOData.FOLegalEntityLocalCAN"
},
"externalCode": "comTest2"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FOLegalEntityLocalCAN(country='CAN',externalCode='SF2',startDate=datetime'2014-05-07
T00:00:00')",
"type": "SFOData.FOLegalEntityLocalCAN"
},
"externalCode": "SF2"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FOLegalEntityLocalCAN(country='CAN',externalCode='ADOBEIND',startDate=datetime'2015-
02-11T00:00:00')",
"type": "SFOData.FOLegalEntityLocalCAN"
},
"externalCode": "ADOBEIND"
}
]
}
}

Error Codes

The table below lists different error codes generated when using this API.

AFFECTED_EXTERNAL_CODE_ERROR This record cannot be saved since one or more records of this
code have reported errors.

END_DATE_EARLIER_THAN_START_DATE Start date cannot be greater than end date.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

292 PUBLIC Foundation Objects
 INVALID_LEGACY_PICKLIST_OPTION_ID This is an invalid picklist value in import file or database for
String.

Related Information

Country/region-Specific Fields [page 248]

9.14.11.1 LegalEntity<Country/Region>

This topic covers several entities containing country/region-specific fields of legal entities. The country or region
identifier in the entity name is the country/region ISO Code. For example, for USA, the name of this entity will be
LegalEntityUSA. Five such country/region-specific entities are pre-shipped. These are LegalEntityESP,
LegalEntityARG, LegalEntityUSA, LegalEntityDEU, and LegalEntityFRA.

Object information

MDF Object:LegalEntity<Country/Region>
Business Keys:LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode
Effective-date:true

Additional Country/Region-Specific Properties

The country/region-specific properties for the five pre-shipped countries are listed below.

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

For Argentina:

Property Name in OData Comments

cuitCode

For Germany:

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 293
Property Name in OData Comments

taxUnit

socialAccidentInsurance

socialAccidentInsuranceRegistrationNumber

For Spain:

Property Name in OData Comments

certificadoDeIdentificacionFiscal

For France:

Property Name in OData Comments

nafCode

sirenCode

For USA:

Property Name in OData Comments

legalEntityType

federalReserveBankID

fedReserveBankDistrict

employerID

eeoCompanyCode

Navigation Properties

For USA

Navigation Property Navigation Target

legalEntityTypeNav PickListValueV2

cust_string6Nav PickListValueV2

cust_string7Nav PickListValueV2

cust_string8Nav PickListValueV2

LegalEntityUSAPermissionsNav LegalEntityUSAPermissions

cust_employerIDNav PickListValueV2

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

294 PUBLIC Foundation Objects
 Navigation Property Navigation Target

cust_fedReserveBankDistrictNav PickListValueV2

For Germany

Navigation Property Navigation Target

cust_string6Nav PickListValueV2

cust_string7Nav PickListValueV2

cust_string8Nav PickListValueV2

LegalEntityDEUPermissionsNav LegalEntityDEUPermissions

For Argentina

Navigation Property Navigation Target

cust_string6Nav PickListValueV2

cust_string7Nav PickListValueV2

cust_string8Nav PickListValueV2

LegalEntityARGPermissionsNav LegalEntityARGPermissions

For Spain

Navigation Property Navigation Target

cust_string6Nav PickListValueV2

cust_string7Nav PickListValueV2

cust_string8Nav PickListValueV2

LegalEntityESPPermissionsNav LegalEntityESPPermissions

For France

Navigation Property Navigation Target

cust_string6Nav PickListValueV2

cust_string7Nav PickListValueV2

cust_string8Nav PickListValueV2

LegalEntityFRAPermissionsNav LegalEntityFRAPermissions

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 295
Use Cases

Example 1: Query Operation

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/LegalEntityUSA?$format=json

Response

 Sample Code

{
"d": {
"results": [{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
LegalEntityUSA(LegalEntity_effectiveStartDate=datetime'1990-01-01T00:00:00',Legal
Entity_externalCode='ACE_USA',externalCode=6596L)",
"type": "SFOData.LegalEntityUSA"
},
"LegalEntity_externalCode": "ACE_USA",
"LegalEntity_effectiveStartDate": "\/Date(631152000000)\/",
"externalCode": "6596",
"mdfSystemEffectiveEndDate": "\/Date(253402214400000)\/",
"mdfSystemObjectType": "LegalEntityUSA",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "\/Date(1341142694000+0000)\/",
"mdfSystemTransactionSequence": "1",
"cust_string1": null,
"mdfSystemRecordId": "159A8AB02B040C6EE050007F020046AE",
"mdfSystemEntityId": "159A8AB02B050C6EE050007F020046AE",
"mdfSystemStatus": "A",
"federalReserveBankID": "11-1231/2721",
"lastModifiedDateWithTZ": "\/Date(1341142694000+0000)\/",
"createdDate": "\/Date(1341171494000)\/",
"mdfSystemRecordStatus": "N",
"employerID": "44-98765",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "\/Date(1341142694000+0000)\/",
"lastModifiedDate": "\/Date(1341171494000)\/",
"mdfSystemEffectiveStartDate": "\/Date(-2208988800000)\/",
"fedReserveBankDistrict": "San Francisco",
"legalEntityType": "C",
"eeoCompanyCode": "123145-9",
"legalEntityTypeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
LegalEntityUSA(LegalEntity_effectiveStartDate=datetime'1990-01-01T00:00:00',Legal
Entity_externalCode='ACE_USA',externalCode=6596L)/legalEntityTypeNav"
}
},
"cust_string1Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
LegalEntityUSA(LegalEntity_effectiveStartDate=datetime'1990-01-01T00:00:00',Legal
Entity_externalCode='ACE_USA',externalCode=6596L)/cust_string1Nav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

296 PUBLIC Foundation Objects
 "uri": "https://<API-Server>/odata/v2/
LegalEntityUSA(LegalEntity_effectiveStartDate=datetime'1990-01-01T00:00:00',Legal
Entity_externalCode='ACE_USA',externalCode=6596L)/mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
LegalEntityUSA(LegalEntity_effectiveStartDate=datetime'1990-01-01T00:00:00',Legal
Entity_externalCode='ACE_USA',externalCode=6596L)/mdfSystemStatusNav"
}
}
}]
}
}

Example 2: Post Operation

Operation Upsert

HTTP Method POST

Request https://<API-Server>/odata/v2/upsert

Payload {
"__metadata": {
"uri":
"LegalEntityUSA(LegalEntity_effectiveStartDate=datetime'1990-01-01T00:
00:00',LegalEntity_externalCode='ACE_USA',externalCode=6596L)",
"type": "SFOData.LegalEntityUSA"
},
"LegalEntity_externalCode": "ACE_USA",
"LegalEntity_effectiveStartDate": "/Date(631152000000)/",
"externalCode": "6596"
}

Response

 Sample Code

<?xml version='1.0' encoding='utf-8'?>

<feed xmlns="http://www.w3.org/2005/Atom" xmlns:m="http://
schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns:d="http://
schemas.microsoft.com/ado/2007/08/dataservices">
<entry>
<content type="application/xml">
<m:properties>
<d:key m:null="true" />
<d:status>OK</d:status>
<d:editStatus>UPSERTED</d:editStatus>
<d:message m:null="true" />
<d:index m:type="Edm.Int32">0</d:index>
<d:httpCode m:type="Edm.Int32">200</d:httpCode>
<d:inlineResults m:type="Bag(SFOData.UpsertResult)" />
</m:properties>
</content>
</entry>
</feed>

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 297
Error Codes

The table below lists different error codes generated when using this API.

AFFECTED_EXTERNAL_CODE_ERROR This record cannot be saved since one or more records of this
Code have reported errors.

END_DATE_EARLIER_THAN_START_DATE Start date cannot be greater than end date.

INVALID_LEGACY_PICKLIST_OPTION_ID This is an invalid picklist value in import file or database for

String.

9.14.12 FOJobClassLocal<Country/Region>

Describes several entities containing country and region-specific fields of job classifications. The country identifier
in the entity name is the country/region ISO Code. For example, for Brazil, the name of this entity will be
FOJobClassLocalBRA.

These entities are made available for backward-compatibility reasons only. For a particular country or region, the
corresponding entity exists if the following prerequisites are fulfilled:

● There is an MDF object modeled that holds the country/region-specific job classification fields for this country
or region.
● The API Visibility of the entity is different from Not Visible.
● The element type map contains information, which indicates that the backward-compatible entity should be
offered for this country or region.

By default, seven such country-specific entities are pre-shipped. These are FOJobClassLocalAUS,
FOJobClassLocalBRA, FOJobClassLocalCAN, FOJobClassLocalGBR, FOJobClassLocalUSA, FOJobClassLocalITA,
and FOJobClassLocalFRA. For more information, see the Country/Region-Specific Fields section.

Object Information

MDF Object: JobClassification<Country/Region>

Business Keys: externalCode + startDate + country
Effective-date:true

Supported Operations

Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

298 PUBLIC Foundation Objects
Additional Country/Region-Specific Properties

The country/region-specific properties for the seven pre-shipped countries are listed below.

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

For Australia:

Property Name in OData Corresponding Field in Object Definition

genericString1 ascoCode

For Great Britain:

Property Name in OData Corresponding Field in Object Definition

genericNumber1 occupationalCode

For Canada:

Property Name in OData Corresponding Field in Object Definition

genericString1 occupationalClassification

For France:

Property Name in OData Corresponding Field in Object Definition

genericString1 inseeCode

genericNumber2 employeeCategory

genericNumber1 occupationalCode

For USA:

Property Name in OData Corresponding Field in Object Definition Comments

genericString1 localJobTitle

genericNumber1 eeo1JobCategory Option ID of eeo1JobCategory

genericNumber2 eeo4JobCategory Option ID of eeo4JobCategory

genericNumber3 eeo5JobCategory Option ID of eeo5JobCategory

genericNumber4 eeo6JobCategory Option ID of eeo6JobCategory

genericNumber5 eeoJobGroup Option ID of eeoJobGroup

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 299
Property Name in OData Corresponding Field in Object Definition Comments

genericNumber6 flsaStatusUSA Option ID of flsaStatusUSA

eeo1JobCategory eeo1JobCategory External code of eeo1JobCategory

eeo4JobCategory eeo4JobCategory External code of eeo4JobCategory

eeo5JobCategory eeo5JobCategory External code of eeo5JobCategory

eeo6JobCategory eeo6JobCategory External code of eeo6JobCategory

eeoJobGroup eeoJobGroup External code of eeoJobGroup

flsaStatusUSA flsaStatusUSA External code of flsaStatusUSA

For Brazil:

Property Name in OData Corresponding Field in Object Definition Comments

genericString1 occupationalCode Option ID of the occupational code

occupationalCode occupationalCode External code of the occupational code

For Italy:

Property Name in OData Corresponding Field in Object Definition

genericNumber1 inailCode

Navigation Properties

For USA

Navigation Property Navigation Target

genericNumber1Nav PicklistOption

genericNumber2Nav PicklistOption

genericNumber3Nav PicklistOption

genericNumber4Nav PicklistOption

genericNumber5Nav PicklistOption

genericNumber6Nav PicklistOption

eeo1JobCategoryNav PickListValueV2

eeo4JobCategoryNav PickListValueV2

eeo5JobCategoryNav PickListValueV2

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

300 PUBLIC Foundation Objects
 Navigation Property Navigation Target

eeo6JobCategoryNav PickListValueV2

eeoJobGroupNav PickListValueV2

flsaStatusUSANav PickListValueV2

For Brazil

Navigation Property Navigation Target

genericString1Nav PicklistOption

occupationalCodeNav PickListValueV2

Use Case: Get the External Code of Job Classes for Canada

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
FOJobClassLocalLocalCAN?$format=json&
$select=externalCode&$top=3

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FOJobClassLocalCAN(country='CAN',externalCode='PS',startDate=datetime'2013-10-17T00:
00:00')",
"type": "SFOData.FOJobClassLocalCAN"
},
"externalCode": "PS"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FOJobClassLocalCAN(country='CAN',externalCode='ACC',startDate=datetime'2015-09-03T00
:00:00')",
"type": "SFOData.FOJobClassLocalCAN"
},
"externalCode": "ACC"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FOJobClassLocalCAN(country='CAN',externalCode='JC1',startDate=datetime'2015-08-25T00
:00:00')",
"type": "SFOData.FOJobClassLocalCAN"
},
"externalCode": "JC1"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 301
 }
]
}
}

Error Codes

The table below lists different error codes generated when using this API.

AFFECTED_EXTERNAL_CODE_ERROR This record cannot be saved since one or more records of this
Code have reported errors.

END_DATE_EARLIER_THAN_START_DATE Start date cannot be greater than end date.

INVALID_LEGACY_PICKLIST_OPTION_ID This is an invalid picklist value in import file or database for

String.

Related Information

Country/region-Specific Fields [page 248]

9.14.13 JobClassificationCountry

This entity contains job classification information for a country.

Object information

MDF Object:JobClassificationCountry
Business Keys:JobClassification_effectiveStartDate, JobClassification_externalCode,
country
Effective-date:true

Supported Operations

Query, Insert, Merge, Replace, Upsert, Delete

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

302 PUBLIC Foundation Objects
Use Case 1: Query the Job Classification Information

Request
Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/JobClassificationCountry?$format=json

Response

{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
JobClassificationCountry(JobClassification_effectiveStartDate=datetime'1990-01-01T00
:00:00',JobClassification_externalCode='EXE-CEO',country='USA')",
"type": "SFOData.JobClassificationCountry"
},
"JobClassification_effectiveStartDate": "\/Date(631152000000)\/",
"JobClassification_externalCode": "EXE-CEO",
"country": "USA",
"mdfSystemEffectiveEndDate": "\/Date(253402214400000)\/",
"mdfSystemObjectType": "JobClassificationCountry",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "\/Date(1447406820000+0000)\/",
"effectiveStatus": "A",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "4FCA7B68851E41C1936B2AE1D5E25E4C",
"mdfSystemEntityId": "D5D533446DEA400FBC3388F5DDBA5C14",
"lastModifiedDateWithTZ": "\/Date(1447406820000+0000)\/",
"createdDate": "\/Date(1447435620000)\/",
"mdfSystemRecordStatus": "N",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "\/Date(1447406820000+0000)\/",
"lastModifiedDate": "\/Date(1447435620000)\/",
"mdfSystemEffectiveStartDate": "\/Date(-2208988800000)\/",
"toJobClassificationAUS": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
JobClassificationCountry(JobClassification_effectiveStartDate=datetime'1990-01-01T00
:00:00',JobClassification_externalCode='EXE-CEO',country='USA')/
toJobClassificationAUS"
}
},
"toJobClassificationGBR": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
JobClassificationCountry(JobClassification_effectiveStartDate=datetime'1990-01-01T00
:00:00',JobClassification_externalCode='EXE-CEO',country='USA')/
toJobClassificationGBR"
}
},
"countryNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
JobClassificationCountry(JobClassification_effectiveStartDate=datetime'1990-01-01T00
:00:00',JobClassification_externalCode='EXE-CEO',country='USA')/countryNav"
}
},
"toJobClassificationFRA": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
JobClassificationCountry(JobClassification_effectiveStartDate=datetime'1990-01-01T00

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 303
 :00:00',JobClassification_externalCode='EXE-CEO',country='USA')/
toJobClassificationFRA"
}
},
"toJobClassificationCAN": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
JobClassificationCountry(JobClassification_effectiveStartDate=datetime'1990-01-01T00
:00:00',JobClassification_externalCode='EXE-CEO',country='USA')/
toJobClassificationCAN"
}
},
"toJobClassificationITA": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
JobClassificationCountry(JobClassification_effectiveStartDate=datetime'1990-01-01T00
:00:00',JobClassification_externalCode='EXE-CEO',country='USA')/
toJobClassificationITA"
}
},
"toJobClassificationBRA": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
JobClassificationCountry(JobClassification_effectiveStartDate=datetime'1990-01-01T00
:00:00',JobClassification_externalCode='EXE-CEO',country='USA')/
toJobClassificationBRA"
}
},
"effectiveStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
JobClassificationCountry(JobClassification_effectiveStartDate=datetime'1990-01-01T00
:00:00',JobClassification_externalCode='EXE-CEO',country='USA')/effectiveStatusNav"
}
},
"cust_toJobClassificationCHN": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
JobClassificationCountry(JobClassification_effectiveStartDate=datetime'1990-01-01T00
:00:00',JobClassification_externalCode='EXE-CEO',country='USA')/
cust_toJobClassificationCHN"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
JobClassificationCountry(JobClassification_effectiveStartDate=datetime'1990-01-01T00
:00:00',JobClassification_externalCode='EXE-CEO',country='USA')/
mdfSystemRecordStatusNav"
}
},
"toJobClassificationUSA": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
JobClassificationCountry(JobClassification_effectiveStartDate=datetime'1990-01-01T00
:00:00',JobClassification_externalCode='EXE-CEO',country='USA')/
toJobClassificationUSA"
}
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

304 PUBLIC Foundation Objects
Use Case 2: Upsert a Record of Job Classification for CEO

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert?
$format=json

Payload
{
"__metadata": {
"uri":
"JobClassificationCountry(JobClassificat
ion_effectiveStartDate=datetime'1990-01-
01T00:00:00',JobClassification_externalC
ode='EXE-CEO',country='USA')",
"type":
"SFOData.JobClassificationCountry"
},

"JobClassification_effectiveStartDate":
"/Date(631152000000)/",
"JobClassification_externalCode":
"EXE-CEO",
"country": "USA"
}

Response

{
"d": [
{
"key": "JobClassificationCountry/country='USA',JobClassificationCountry/
JobClassificationCountry_externalCode='EXE_CEO',JobClassificationCountry/
JobClassification_effectiveStartDate=1990-01-01T00:00:00.000-05:00",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Error Codes

The table below lists different error codes generated when using this API.

AFFECTED_EXTERNAL_CODE_ERROR This record cannot be saved since one or more records of this
Code have reported errors.

END_DATE_EARLIER_THAN_START_DATE Start date cannot be greater than end date.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 305
INVALID_LEGACY_PICKLIST_OPTION_ID This is an invalid picklist value in import file or database for
String.

Related Information

SAP API Business Hub: Foundation

9.14.14 FOJobFunction

The FOJobFunction entity represents the Generic Object Job Function.

Object Information

MDF Object:JobFunction
Business Keys: externalCode + startDate
Effective-date:true

Supported Operations

Query, Insert, Merge, Replace, Upsert, Delete

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

mdfSystemRecordId This property represents an MDF system field used as an iden­

tifier of an MDF record.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

306 PUBLIC Foundation Objects
Use Case 1: Get the Job Function Information by External Code

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
FOJobFunction?$format=json&
$filter=externalCode eq '50070898'

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FOJobFunction(externalCode='50070898',startDate=datetime'1900-01-01T00:00:00')",
"type": "SFOData.FOJobFunction"
},
"externalCode": "50070898",
"startDate": "/Date(-2208988800000)/",
"description_ko_KR": "고객 관리자(영업)",
"lastModifiedDateTime": "/Date(1440392298000+0000)/",
"name_localized": "Account Managers (Sales)",
"description_th_TH": null,
"endDate": "/Date(253402214400000)/",
"name_ko_KR": "고객 관리자(영업)",
"createdDateTime": "/Date(1440392298000+0000)/",
"name_th_TH": null,
"description_ar_SA": null,
"type": "3578",
"description_pt_BR": "Gerentes de conta (Vendas)",
"description_es_ES": "Supervisores de cuentas (Ventas)",
"name_pt_BR": "Gerentes de conta (Vendas)",
"description_nl_NL": null,
"parentFunctionCode": null,
"name_nl_NL": null,
"description_defaultValue": "Account Managers (Sales)",
"name_ar_SA": null,
"name_de_DE": "Kundenbetreuer (Vertrieb)",
"name_zh_TW": null,
"name": "Account Managers (Sales)",
"name_es_ES": "Supervisores de cuentas (Ventas)",
"description_en_US": "Account Managers (Sales)",
"description_en_DEBUG": null,
"description_ru_RU": "Менеджеры по работе с клиентами (сбыт)",
"status": "A",
"name_ru_RU": "по работе с клиентами (сбыт)...",
"description_ja_JP": "アカウントマネージャー (販売)",
"description_fr_FR": "Gestionnaires de comptes (ventes)",
"name_pt_PT": null,
"description": "Account Managers (Sales)",
"description_de_DE": "Kundenbetreuer (Vertrieb)",
"name_fr_FR": "ionnaires de comptes (ventes)...",
"name_en_DEBUG": null,
"name_ja_JP": "アカウントマネージャー (販売)",
"createdOn": "/Date(1440377898000)/",
"name_en_US": "Account Managers (Sales)",
"description_iw_IL": null,
"description_zh_TW": null,
"name_zh_CN": "客户经理（销售）",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 307
 "name_defaultValue": "Account Managers (Sales)",
"description_en_GB": null,
"lastModifiedBy": "admindlr",
"name_en_GB": null,
"jobFunctionType": "PR",
"name_iw_IL": null,
"lastModifiedOn": "/Date(1440377898000)/",
"description_zh_CN": "客户经理（销售）",
"createdBy": "admindlr",
"description_localized": "Account Managers (Sales)",
"description_pt_PT": null,
"nameTranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobFunction(externalCode='50070898',startDate=datetime'1900-01-01T00:00:00')/
nameTranslationTextNav"
}
},
"typeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobFunction(externalCode='50070898',startDate=datetime'1900-01-01T00:00:00')/
typeNav"
}
},
"descriptionTranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobFunction(externalCode='50070898',startDate=datetime'1900-01-01T00:00:00')/
descriptionTranslationTextNav"
}
},
"statusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobFunction(externalCode='50070898',startDate=datetime'1900-01-01T00:00:00')/
statusNav"
}
},
"descriptionTranslationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobFunction(externalCode='50070898',startDate=datetime'1900-01-01T00:00:00')/
descriptionTranslationNav"
}
},
"parentFunctionCodeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobFunction(externalCode='50070898',startDate=datetime'1900-01-01T00:00:00')/
parentFunctionCodeNav"
}
},
"jobFunctionTypeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobFunction(externalCode='50070898',startDate=datetime'1900-01-01T00:00:00')/
jobFunctionTypeNav"
}
},
"nameTranslationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobFunction(externalCode='50070898',startDate=datetime'1900-01-01T00:00:00')/
nameTranslationNav"
}
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

308 PUBLIC Foundation Objects
 ]
}
}

Use Case 2: Update the Status of Job Function

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert?&
$format=json

Payload
{
"__metadata":{

"uri":"FOJobFunction(startDate=datetime'
2014-09-11T00:00:00',externalCode='20000
')"
},
"status":"A"
}

Response

{
"d": [
{
"key": "FOJobFunction/externalCode=20000,FOJobFunction/
startDate=2014-09-11T00:00:00.000-05:00",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Error Codes

The table below lists different error codes generated when using this API.

AFFECTED_EXTERNAL_CODE_ERROR This record cannot be saved since one or more records of this
Code have reported errors.

END_DATE_EARLIER_THAN_START_DATE Start date cannot be greater than end date.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 309
INVALID_LEGACY_PICKLIST_OPTION_ID This is an invalid picklist value in import file or database for
String.

Related Information

SAP API Business Hub: Foundation

9.14.15 FOJobCode

The FO JobCode entity represents the Generic Object Job Classification.

Special Notes on FOJobCode Translation

Before the migration, you could handle the translatable fields in two ways. You would do translations for Job Code
using Legacy Translations and FOTranslations. This is replaced with the MDF standard translation approach. Now
translatable fields are handled in the same way as translatable fields in other migrated objects. This means that
you have these additional fields such as name_en_US, name_en_GB, and so on in the object structure. To maintain
backward compatibility, the old navigations to translations are maintained. However, they come with certain
restrictions. Have a look:

Important changes to FOJobCode – name, description and custom string fields in APIs

● Used locale to return data: During migration of Job Code Translations, the Corporate Locale will be used to
copy translations to the new persistency. While copying, the corporate language will be used to copy a default
translations into the translatable fields of FO Job Code (such as name, description or custom string). After
enabling the new translation feature, the SOAP and OData API will return those default values in the corporate
language while it returned the values in the language of the API user before activating the feature. In case this
corporate locale differs from the locale of the API user (can be seen in Employee Central UI through options for
this user), the result of the translatable fields could differ. To avoid this, ensure that corporate language and API
user language are the same before migrating or activating the new Job Code Translation feature in
Provisioning. This is described later below.
● Before the migration, every custom string field of type worker was regarded as translatable if legacy translation
was used. Thus, for every worker field, a navigation attribute was added leading to LocalizedData. After the
migration, navigation attribute is still available, but this will not lead to any instance data.
● Filters and sort on translation navigation: After switching to the new Job Code Translation, the OData API will
no longer support filter, and order by for the navigations of translatable fields in FO Job Code. Filter is still
supported for default translation in field name. This means queries such as /odata/v2/FOJobCode?
$filter=nameTranslatioNav/localizedDataTranslation+eq+'My Job Code' will no longer be possible. Query such
as /odata/v2/FOJobCode?$filter=name+eq+'My Job Code'&$expand=nameTranslationNav will still work.
● Custom user ID fields: If a custom string field was configured as of type user, the corresponding user ID was
added to the translation table. With the new feature enabled, this user ID will now be returned in the
corresponding field itself and is not available anymore in the translation table.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

310 PUBLIC Foundation Objects
Important changes to LocalizedData – name, description and custom string fields in APIs

● Top, skip, orderby, and query without filter: After switching to the new Job Code Translation, the
LocalizedData Entity can be queried using simple filter (using eq or in). However, there is no support anymore
for query without filter or paging, and ordering or sorting. LocalizedData must be retrieved using the Job Code
query using expand and not queried directly.
● Shortcut access: Direct access to the LocalizedData without $filter such as odata/vs2/
LocalizedData(localizedDataCode=(‘TR:421:,localizedDataLocale=‘en_GB’) is not possible anymore. Use
odata/v2/LocalizedData?$filter=localizedDataCode+eq+’TR:421’+and+localizedDataLocale+eq+‘en_GB’)
instead or do a direct expand from FOJobCode entity.
● Changed business keys: LocalizedData will have a different code instead of TR:11. A number such as 34569811
originating from the new GOLocalizedData will be returned.
● Null-values for a translation: This happens if LocalizedData is not returned anymore by the OData API. This is
also true for expanded navigations in FOJobCode.

Additional Information

Set API User and Corporate Locale (in Provisioning)

 Remember

As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact your
implementation partner or Account Executive. For any non-implementation tasks, contact Product Support.

To minimize impact of change, make sure that you deal with setting the language as follows:

1. You have set the default language for your corporation in Provisioning.
2. You have set the user language under Options Change Langaguage . Make sure that the user language
and the default language are the same.
3. Activate the Provisioning settings.

Object Information

MDF Object:JobClassification
Business Keys: externalCode + startDate
Effective-date:true

Supported Operations

Query, Insert, Merge, Replace, Upsert, Delete

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 311
Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Property Description

localNavDEFLT Do not use this navigation property because it navigates to the

empty entity FOJobClassLocalDEFLT.

mdfSystemRecordId This property represents an MDF system field used as an iden­

tifier of an MDF record.

Use Case 1: Get the Job Code Information by External Code

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/FOJobCode?
$format=json&$filter=externalCode eq
'50000074'

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')",
"type": "SFOData.FOJobCode"
},
"externalCode": "50000074",
"startDate": "/Date(631152000000)/",
"supervisorLevel": "29901",
"name_ko_KR": "엔지니어링",
"createdDateTime": "/Date(1440393282000+0000)/",
"cust_string6_pt_PT": null,
"cust_string1_th_TH": null,
"name_pt_BR": "Engenharia",
"cust_string7_ja_JP": null,
"parentJobCode": null,
"workerCompCode": null,
"cust_string6_iw_IL": null,
"cust_string6_localized": "t",
"cust_string1_de_DE": null,
"cust_string7_ru_RU": null,
"cust_string1_ar_SA": null,
"cust_string2_fr_FR": null,
"grade": "GR-10",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

312 PUBLIC Foundation Objects
 "name_es_ES": "Ingeniería",
"cust_string7_de_DE": null,
"cust_string1_nl_NL": null,
"cust_string7_th_TH": null,
"isFulltimeEmployee": true,
"cust_string7_ar_SA": null,
"cust_string9_en_GB": "50070902",
"cust_string8_ru_RU": null,
"name_en_US": "Engineering",
"cust_string2_ja_JP": null,
"jobFunction": "50070902",
"cust_string6_th_TH": null,
"cust_string1_pt_PT": null,
"description_zh_TW": "工程設計",
"cust_string1_ru_RU": null,
"name_zh_CN": "工程设计",
"cust_string2_ru_RU": null,
"cust_string6_de_DE": null,
"description_en_GB": "Engineering",
"cust_string7_pt_PT": null,
"cust_string6_es_ES": null,
"name_en_GB": "Engineering",
"name_iw_IL": null,
"cust_string6_ar_SA": null,
"lastModifiedOn": "/Date(1495812945000)/",
"cust_string1_ja_JP": null,
"cust_string2_defaultValue": "Engineering",
"description_zh_CN": "工程设计",
"cust_string8_ja_JP": null,
"cust_string9_zh_TW": null,
"cust_string6_en_US": "t",
"cust_string6_zh_CN": null,
"description_ko_KR": "엔지니어링",
"lastModifiedDateTime": "/Date(1495827345000+0000)/",
"name_th_TH": null,
"cust_string9_defaultValue": "50070902",
"description_pt_BR": "Engenharia",
"cust_string8_en_GB": "Salary Grade 10 (GR-10)",
"cust_string6_ru_RU": null,
"cust_string9_en_US": null,
"cust_string7_iw_IL": null,
"cust_string9_zh_CN": null,
"cust_string2_pt_PT": null,
"cust_string8_nl_NL": null,
"regularTemporary": "R",
"name_nl_NL": null,
"cust_string9_ja_JP": null,
"name_ar_SA": null,
"name_de_DE": "Ingenieurwesen",
"name_zh_TW": "工程設計",
"cust_string7_ko_KR": null,
"name": "Engineering",
"cust_string9_localized": "50070902",
"description_ru_RU": "Машиностроение",
"name_ru_RU": "Машиностроение",
"cust_string6_en_GB": "t",
"name_pt_PT": null,
"cust_string5": "1",
"cust_string4": "R",
"cust_string3": "IC",
"cust_string7_nl_NL": null,
"description": "Engineering",
"description_de_DE": "Ingenieurwesen",
"cust_string8_en_US": "Salary Grade 10 (GR-10)",
"cust_string9_iw_IL": null,
"cust_string1_fr_FR": null,
"cust_string6_ko_KR": null,
"employeeClass": "4662",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 313
 "cust_string7_en_DEBUG": null,
"defaultSupervisorLevel": "1",
"cust_string8_iw_IL": null,
"defaultJobLevel": "IC",
"cust_string1_defaultValue": "50000074",
"cust_string7_zh_CN": null,
"cust_string1_pt_BR": null,
"cust_string2_de_DE": null,
"cust_string2_ar_SA": null,
"cust_string2_th_TH": null,
"cust_string6_nl_NL": null,
"createdBy": "admindlr",
"cust_string9_es_ES": null,
"cust_string7_en_GB": "Individual Contributor",
"cust_string6_zh_TW": null,
"description_pt_PT": null,
"description_th_TH": null,
"endDate": "/Date(253402214400000)/",
"description_ar_SA": null,
"cust_string2_es_ES": null,
"cust_string8_ko_KR": null,
"cust_string7_zh_TW": null,
"cust_string2_pt_BR": null,
"cust_string1_en_GB": "50000074",
"description_nl_NL": null,
"cust_string9_pt_PT": null,
"cust_string10": null,
"isRegular": "3612",
"cust_string8_es_ES": null,
"cust_string2_zh_CN": null,
"cust_string8_zh_CN": null,
"cust_string7_en_US": "Individual Contributor",
"cust_string1_zh_TW": null,
"status": "A",
"cust_string7_es_ES": null,
"cust_string8_pt_PT": null,
"description_fr_FR": "Ingénierie",
"name_fr_FR": "Ingénierie",
"name_en_DEBUG": null,
"createdOn": "/Date(1440378882000)/",
"cust_string8_en_DEBUG": null,
"cust_string8_zh_TW": null,
"description_iw_IL": null,
"cust_string2_zh_TW": null,
"cust_string9_ru_RU": null,
"name_defaultValue": "Engineering",
"cust_string1_en_DEBUG": null,
"cust_string9_ko_KR": null,
"jobLevel": "9838",
"cust_string2_ko_KR": null,
"cust_string6_defaultValue": "t",
"cust_string8_defaultValue": "Salary Grade 10 (GR-10)",
"cust_string6_en_DEBUG": null,
"defaultEmployeeClass": "1",
"cust_string9_nl_NL": null,
"cust_string2_nl_NL": null,
"name_localized": "Engineering",
"entityUUID": "26AE9D58CBDC6E05E0530B28080A8A5B",
"cust_string1_ko_KR": null,
"description_es_ES": "Ingeniería",
"cust_string8_localized": "Salary Grade 10 (GR-10)",
"cust_string8_th_TH": null,
"cust_string8_ar_SA": null,
"cust_string1_es_ES": null,
"cust_string6_fr_FR": null,
"standardHours": "40",
"cust_string6_pt_BR": null,
"cust_string9_pt_BR": null,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

314 PUBLIC Foundation Objects
 "description_defaultValue": "Engineering",
"cust_string9_fr_FR": null,
"cust_string2_en_GB": "Engineering",
"cust_string2_localized": "Engineering",
"cust_string9_en_DEBUG": null,
"cust_string6_ja_JP": null,
"description_en_US": "Engineering",
"description_en_DEBUG": null,
"description_ja_JP": "エンジニアリング",
"cust_string1_zh_CN": null,
"name_ja_JP": "エンジニアリング",
"cust_string7_localized": "Individual Contributor",
"cust_string8_de_DE": null,
"cust_string2_en_DEBUG": null,
"cust_string7_pt_BR": null,
"cust_string8_fr_FR": null,
"cust_string1_en_US": null,
"cust_string2_iw_IL": null,
"cust_string1_iw_IL": null,
"lastModifiedBy": "sfadmin",
"customString5": "4662",
"customString4": "3612",
"customString3": "9838",
"customString2": "Engineering",
"cust_string9_de_DE": null,
"customString9": "50070902",
"customString8": "Salary Grade 10 (GR-10)",
"customString7": "Individual Contributor",
"cust_string1_localized": "50000074",
"cust_string9_th_TH": null,
"customString6": "t",
"cust_string9_ar_SA": null,
"customString1": "50000074",
"cust_string7_defaultValue": "Individual Contributor",
"description_localized": "Engineering",
"cust_string2_en_US": "Engineering",
"cust_string8_pt_BR": null,
"cust_string7_fr_FR": null,
"nameTranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
nameTranslationTextNav"
}
},
"localNavCAN": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
localNavCAN"
}
},
"cust_string6TranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
cust_string6TranslationTextNav"
}
},
"jobFunctionNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
jobFunctionNav"
}
},
"cust_string7TranslationTextNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 315
 "uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
cust_string7TranslationTextNav"
}
},
"customString9TranslationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
customString9TranslationNav"
}
},
"descriptionTranslationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
descriptionTranslationNav"
}
},
"localNavUSA": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
localNavUSA"
}
},
"jobLevelNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
jobLevelNav"
}
},
"cust_string3Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
cust_string3Nav"
}
},
"regularTemporaryNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
regularTemporaryNav"
}
},
"gradeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/gradeNav"
}
},
"cust_string8TranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
cust_string8TranslationTextNav"
}
},
"defaultEmployeeClassNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
defaultEmployeeClassNav"
}
},
"cust_string1TranslationTextNav": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

316 PUBLIC Foundation Objects
 "__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
cust_string1TranslationTextNav"
}
},
"customString3Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
customString3Nav"
}
},
"defaultSupervisorLevelNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
defaultSupervisorLevelNav"
}
},
"localNavFRA": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
localNavFRA"
}
},
"localNavDEFLT": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
localNavDEFLT"
}
},
"localNavGBR": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
localNavGBR"
}
},
"customString2TranslationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
customString2TranslationNav"
}
},
"localNavAUS": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
localNavAUS"
}
},
"customString7TranslationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
customString7TranslationNav"
}
},
"parentJobCodeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
parentJobCodeNav"
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 317
 },
"customString4Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
customString4Nav"
}
},
"cust_string5Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
cust_string5Nav"
}
},
"descriptionTranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
descriptionTranslationTextNav"
}
},
"statusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
statusNav"
}
},
"toJobClassificationCountry": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
toJobClassificationCountry"
}
},
"localNavITA": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
localNavITA"
}
},
"customString8TranslationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
customString8TranslationNav"
}
},
"nameTranslationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
nameTranslationNav"
}
},
"isRegularNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
isRegularNav"
}
},
"customString5Nav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

318 PUBLIC Foundation Objects
 "uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
customString5Nav"
}
},
"defaultJobLevelNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
defaultJobLevelNav"
}
},
"cust_string9TranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
cust_string9TranslationTextNav"
}
},
"customString1TranslationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
customString1TranslationNav"
}
},
"customString6TranslationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
customString6TranslationNav"
}
},
"cust_string10Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
cust_string10Nav"
}
},
"cust_string2TranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
cust_string2TranslationTextNav"
}
},
"cust_string4Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
cust_string4Nav"
}
},
"employeeClassNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
employeeClassNav"
}
},
"localNavBRA": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
localNavBRA"
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 319
 "supervisorLevelNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOJobCode(externalCode='50000074',startDate=datetime'1990-01-01T00:00:00')/
supervisorLevelNav"
}
}
}
]
}
}

Use Case 2： Update the Status of Job Code

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert?
$format=json

Payload
{
"__metadata": {
"uri":
"FOJobCode(startDate=datetime'2014-09-11
T00:00:00',externalCode='20000')"
},
"status": "A"
}

Response

{
"d": [
{
"key": "FOJobCode/externalCode=20000,FOJobCode/
startDate=2014-09-11T00:00:00.000-05:00",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Error Codes

The table below lists different error codes generated when using this API.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

320 PUBLIC Foundation Objects
 AFFECTED_EXTERNAL_CODE_ERROR This record cannot be saved since one or more records of this
Code have reported errors.

END_DATE_EARLIER_THAN_START_DATE Start date cannot be greater than end date.

INVALID_LEGACY_PICKLIST_OPTION_ID This is an invalid picklist value in import file or database for

String.

Related Information

SAP API Business Hub: Foundation

9.14.16 FOPayGroup

The FOPayGroup entity represents the Generic Object Pay Group.

Object Information

MDF Object:PayGroup
Business Keys: externalCode + startDate
Effective-date:true

Supported Operations

Query, Insert, Merge, Replace, Upsert, Delete

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 321
Property Description

mdfSystemRecordId This property represents an MDF system field used as an iden­

tifier of an MDF record.

Use Case 1: Get the Pay Group Information for China

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/FOPayGroup?
$format=json&$filter=externalCode eq 'CN'

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
FOPayGroup(externalCode='CN',startDate=datetime'1900-01-01T00:00:00')",
"type": "SFOData.FOPayGroup"
},
"externalCode": "CN",
"startDate": "/Date(-2208988800000)/",
"primaryContactName": null,
"description_ko_KR": "중국 매월",
"lastModifiedDateTime": "/Date(1440391081000+0000)/",
"name_localized": "China Monthly",
"description_th_TH": null,
"endDate": "/Date(253402214400000)/",
"name_ko_KR": "중국 매월",
"createdDateTime": "/Date(1440391081000+0000)/",
"name_th_TH": null,
"dataDelimiter": null,
"description_ar_SA": null,
"paymentFrequency": "MT",
"description_pt_BR": "China mensal",
"lag": null,
"description_es_ES": "Mensual (China)",
"name_pt_BR": "China mensal",
"description_nl_NL": null,
"name_nl_NL": null,
"decimalPoint": null,
"secondaryContactName": null,
"description_defaultValue": "China Monthly",
"name_ar_SA": null,
"payrollVendorId": null,
"name_de_DE": "Monatlich (China)",
"name_zh_TW": null,
"name": "China Monthly",
"name_es_ES": "Mensual (China)",
"description_en_US": "China Monthly",
"description_en_DEBUG": null,
"description_ru_RU": "Китай, ежемесячно",
"status": "A",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

322 PUBLIC Foundation Objects
 "name_ru_RU": "Китай, ежемесячно",
"description_ja_JP": "毎月 (中国)",
"description_fr_FR": "Chine mensuel",
"name_pt_PT": null,
"secondaryContactID": null,
"payFrequency": "4619",
"description": "China Monthly",
"description_de_DE": "Monatlich (China)",
"name_fr_FR": "Chine mensuel",
"name_en_DEBUG": null,
"name_ja_JP": "毎月 (中国)",
"createdOn": "/Date(1440376681000)/",
"primaryContactID": null,
"name_en_US": "China Monthly",
"description_iw_IL": null,
"description_zh_TW": null,
"primaryContactEmail": null,
"name_zh_CN": "中国 - 每月",
"weeksInPayPeriod": null,
"name_defaultValue": "China Monthly",
"description_en_GB": null,
"lastModifiedBy": "admindlr",
"name_en_GB": null,
"name_iw_IL": null,
"lastModifiedOn": "/Date(1440376681000)/",
"earliestChangeDate": null,
"description_zh_CN": "中国 - 每月",
"createdBy": "admindlr",
"secondaryContactEmail": null,
"description_localized": "China Monthly",
"description_pt_PT": null,
"nameTranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOPayGroup(externalCode='CN',startDate=datetime'1900-01-01T00:00:00')/
nameTranslationTextNav"
}
},
"descriptionTranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOPayGroup(externalCode='CN',startDate=datetime'1900-01-01T00:00:00')/
descriptionTranslationTextNav"
}
},
"payFrequencyNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOPayGroup(externalCode='CN',startDate=datetime'1900-01-01T00:00:00')/
payFrequencyNav"
}
},
"statusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOPayGroup(externalCode='CN',startDate=datetime'1900-01-01T00:00:00')/statusNav"
}
},
"descriptionTranslationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOPayGroup(externalCode='CN',startDate=datetime'1900-01-01T00:00:00')/
descriptionTranslationNav"
}
},
"paymentFrequencyNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 323
 "uri": "https://<API-Server>/odata/v2/
FOPayGroup(externalCode='CN',startDate=datetime'1900-01-01T00:00:00')/
paymentFrequencyNav"
}
},
"nameTranslationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
FOPayGroup(externalCode='CN',

Use Case 2: Update the Status of Pay Group

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert?
$format=json

Payload
{
"__metadata":{

"uri":"FOPayGroup(startDate=datetime'201
4-09-11T00:00:00',externalCode='20000')"
},
"status":"A"
}

Response

{
"d": [
{
"key": "FOPayGroup/externalCode=20000,FOPayGroup/
startDate=2014-09-11T00:00:00.000-05:00",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Error Codes

The table below lists different error codes generated when using this API.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

324 PUBLIC Foundation Objects
 AFFECTED_EXTERNAL_CODE_ERROR This record cannot be saved since one or more records of this
Code have reported errors.

END_DATE_EARLIER_THAN_START_DATE Start date cannot be greater than end date.

INVALID_LEGACY_PICKLIST_OPTION_ID This is an invalid picklist value in import file or database for

String.

Related Information

SAP API Business Hub: Foundation

9.14.17 PayCalendar

This is a foundation object that describes a pay calendar for a particular pay group. This means it is the collection of
all pay periods referring to the same pay group.

Object information

MDF Object:PayCalendar
Business Keys: payGroup
Effective-date:false

Supported Operations

Query, Insert, Merge, Replace, Upsert, Delete

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 325
Use Case 1: Get the Pay Calendar for the APAC Pay Group

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/PayCalendar?
$format=json&$filter=payGroup eq
'APAC_GROUP'

Response

{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/PayCalendar('APAC_GROUP')",
"type": "SFOData.PayCalendar"
},
"payGroup": "APAC_GROUP",
"mdfSystemEffectiveEndDate": "\/Date(253402214400000)\/",
"mdfSystemObjectType": "PayCalendar",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "\/Date(1447049529000+0000)\/",
"mdfSystemTransactionSequence": "1",
"createdBy": "admin",
"mdfSystemRecordId": "B48CD96182B440348ECAE2439136091E",
"mdfSystemEntityId": "A2FF33F88E724BF386D5D225975D0F17",
"createdDateTime": "\/Date(1442990456000+0000)\/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"lastModifiedDate": "\/Date(1447078329000)\/",
"mdfSystemEffectiveStartDate": "\/Date(-2208988800000)\/",
"lastModifiedDateWithTZ": "\/Date(1447049529000+0000)\/",
"createdDate": "\/Date(1443019256000)\/",
"mdfSystemRecordStatus": "N",
"payGroupNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PayCalendar('APAC_GROUP')/
payGroupNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PayCalendar('APAC_GROUP')/
mdfSystemRecordStatusNav"
}
},
"toPayPeriod": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PayCalendar('APAC_GROUP')/
toPayPeriod"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PayCalendar('APAC_GROUP')/
mdfSystemStatusNav"
}
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

326 PUBLIC Foundation Objects
Use Case 2: Update the Pay Group of Pay Calendar

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert?
$format=json

Payload
{
"__metadata":{

"uri":"PayCalendar(externalCode='APAC_GR
OUP')"
},
payGroup": "APAC_GROUP
}

Response

{
"d": [
{
"key": "PayCalendar/externalCode='APAC_GROUP'",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Error Codes

The table below lists different error codes generated when using this API.

AFFECTED_EXTERNAL_CODE_ERROR This record cannot be saved since one or more records of this
Code have reported errors.

END_DATE_EARLIER_THAN_START_DATE Start date cannot be greater than end date.

INVALID_LEGACY_PICKLIST_OPTION_ID This is an invalid picklist value in import file or database for

String.

Related Information

SAP API Business Hub: Foundation

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 327
9.14.17.1 PayPeriod

Pay Period is the child object of GO Pay Calendar.

Object information

MDF Object:PayPeriod
Business Keys: PayCalendar_payGroup,externalCode
Effective-date:false

Supported Operations

Query, Insert, Merge, Replace, Upsert, Delete

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Case 1: Get the Pay Period for the APAC Pay Group

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/PayPeriod?
$format=json&$filter=PayCalendar_payGroup
eq 'APAC_GROUP'

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
PayPeriod(PayCalendar_payGroup='APAC_GROUP',externalCode=6636L)",
"type": "SFOData.PayPeriod"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

328 PUBLIC Foundation Objects
 },
"PayCalendar_payGroup": "APAC_GROUP",
"externalCode": "6636",
"payPeriodBeginDate": "\/Date(946684800000)\/",
"mdfSystemEffectiveEndDate": "\/Date(253402214400000)\/",
"mdfSystemObjectType": "PayPeriod",
"mdfSystemVersionId": null,
"runType": "INC",
"offcycle": false,
"lastModifiedDateTime": "\/Date(1447049529000+0000)\/",
"mdfSystemTransactionSequence": "1",
"cust_string1": "b",
"mdfSystemRecordId": "1ACED403FA1E4132B37D839DBDB87FB7",
"createdBy": "admin",
"mdfSystemEntityId": "818F9E53B6654906BFCDA0E1BAA5F607",
"processingRunId": "1",
"createdDateTime": "\/Date(1442990456000+0000)\/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"lastModifiedDate": "\/Date(1447078329000)\/",
"mdfSystemEffectiveStartDate": "\/Date(-2208988800000)\/",
"lastModifiedDateWithTZ": "\/Date(1447049529000+0000)\/",
"payPeriodEndDate": "\/Date(1609372800000)\/",
"payCheckIssueDate": null,
"createdDate": "\/Date(1443019256000)\/",
"mdfSystemRecordStatus": "N",
"runTypeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PayPeriod(PayCalendar_payGroup='APAC_GROUP',externalCode=6636L)/runTypeNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PayPeriod(PayCalendar_payGroup='APAC_GROUP',externalCode=6636L)/
mdfSystemRecordStatusNav"
}
},
"mdf{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
PayPeriod(PayCalendar_payGroup='APAC_GROUP',externalCode=6636L)",
"type": "SFOData.PayPeriod"
},
"PayCalendar_payGroup": "APAC_GROUP",
"externalCode": "6636",
"payPeriodBeginDate": "\/Date(946684800000)\/",
"mdfSystemEffectiveEndDate": "\/Date(253402214400000)\/",
"mdfSystemObjectType": "PayPeriod",
"mdfSystemVersionId": null,
"runType": "INC",
"offcycle": false,
"lastModifiedDateTime": "\/Date(1447049529000+0000)\/",
"mdfSystemTransactionSequence": "1",
"cust_string1": "b",
"mdfSystemRecordId": "1ACED403FA1E4132B37D839DBDB87FB7",
"createdBy": "admin",
"mdfSystemEntityId": "818F9E53B6654906BFCDA0E1BAA5F607",
"processingRunId": "1",
"createdDateTime": "\/Date(1442990456000+0000)\/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"lastModifiedDate": "\/Date(1447078329000)\/",
"mdfSystemEffectiveStartDate": "\/Date(-2208988800000)\/",
"lastModifiedDateWithTZ": "\/Date(1447049529000+0000)\/",
"payPeriodEndDate": "\/Date(1609372800000)\/",
"payCheckIssueDate": null,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 329
 "createdDate": "\/Date(1443019256000)\/",
"mdfSystemRecordStatus": "N",
"runTypeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PayPeriod(PayCalendar_payGroup='APAC_GROUP',externalCode=6636L)/runTypeNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PayPeriod(PayCalendar_payGroup='APAC_GROUP',externalCode=6636L)/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PayPeriod(PayCalendar_payGroup='APAC_GROUP',externalCode=6636L)/mdfSystemStatusNav"
}
}
}
"SystemStatusNav ": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PayPeriod(PayCalendar_payGroup='APAC_GROUP',externalCode=6636L)/mdfSystemStatusNav"
}
}

]
}
}

Use Case 2: Upsert a Record of Pay Period

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert?
$format=json

Payload
{
"__metadata": {
"uri": "https://
<API-Server>/odata/v2/
PayPeriod(PayCalendar_payGroup='UM',exte
rnalCode=474699L)",
"type":
"SFOData.PayPeriod"
},
"externalCode":
"474699",
"PayCalendar_payGroup":
"UM",
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

330 PUBLIC Foundation Objects
Response

{
"d": [
{
"key": "PayPeriod/PayCalendar_payGroup=UM,PayPeriod/
externalCode=474699",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Error Codes

The table below lists different error codes generated when using this API.

AFFECTED_EXTERNAL_CODE_ERROR This record cannot be saved since one or more records of this
Code have reported errors.

END_DATE_EARLIER_THAN_START_DATE Start date cannot be greater than end date.

INVALID_LEGACY_PICKLIST_OPTION_ID This is an invalid picklist value in import file or database for

String.

Related Information

SAP API Business Hub: Foundation

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Foundation Objects PUBLIC 331
10 Global Benefits Objects

Global Benefits offers a simplified, one-stop shop Benefits administration tool for organizations spread across the
globe.

10.1 Benefit

This entity is used to create and configure benefits. It is used for reimbursements and allowances, such as medical
bills, higher education, and a company car.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

benefitId Benefit ID. This is a business key.

effectiveStartDate The date and time the benefit is effective. This is a business
key.

Use Case: Query a Benefit Entry by Key

Request

Operation Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

332 PUBLIC Global Benefits Objects
 HTTP Method GET

URI https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate
=datetime'2015-01-01T00:00:00')

Response

{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')",
"type": "SFOData.Benefit"
},
"effectiveStartDate": "/Date(1420070400000)/",
"benefitId": "746",
"employerPayComponent": null,
"schemeType": null,
"createdDateTime": "/Date(1440664594000+0000)/",
"mdfSystemVersionId": null,
"savingsPlanCatchUpDetail": null,
"plan": null,
"qualifyingScheme": null,
"claimDetail": null,
"benefitSchedule": "1561",
"carryForwardEnrollment": false,
"mdfSystemRecordStatus": "N",
"dependentSpecificRule": false,
"empAnnualLimitPayComponent": null,
"benefitSpecific": null,
"bandingsConfiguration": null,
"deductionStartDate": null,
"claimScreenID": null,
"claimsLimitPerFrequencyPeriod": null,
"showRemaningNoOfDaysForClaim": null,
"status": "A",
"annualMaxPayComponent": null,
"benefitType": "ALLOWANCE",
"benefitEntityID": "27CB5565588140138DC80B75DCF62459",
"showRemaningNoOfDaysForEnrollment": "SHOW_NO_OF_DAYS",
"nomineeRelevant": null,
"claimDetailRequired": null,
"dummyField": null,
"savingsPlanSubType": null,
"beneficiaryRelevant": null,
"employeeClaimWorkflowId": null,
"currency": "AUD",
"exceptionWorkflowId": null,
"employeeEnrollmentEditAllowed": true,
"decimalPrecisionSettingForContributionAmount": null,
"emailNotificationForEnrollment": true,
"mdfSystemObjectType": "Benefit",
"optOutWorkflowId": null,
"createdDate": "/Date(1440650194000)/",
"pensionMinMaxContributionLimits": null,
"taxationMode": null,
"mdfSystemRecordId": "C9E5130358824D0980781019D4B0E675",
"country": null,
"creditPoints": null,
"lastModifiedDateTime": "/Date(1545161881000+0000)/",
"benefitShortDescription": "Transportation Allowance Australia",
"annualMinContributionAmount": null,
"ageOfRetirement": null,
"employeeEnrollmentWorkflowId": null,
"insuranceType": null,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 333
 "employerContributionHSA": null,
"frequency": "MON",
"enrollmentScreenID": null,
"employeeWithEmployerMatchContributions": null,
"multipleFundSelectionsAllowed": null,
"enrollmentRequired": true,
"claim": null,
"typeOfPension": null,
"annualMaxContributionAmount": null,
"sconNumber": null,
"employeeEnrollmentEditType": "ENROLLMENT_WINDOW",
"jobEnrollmentEditAllowed": null,
"benefitProgram": null,
"supressClientDateValidation": false,
"effectiveStatus": "A",
"enrolleeOptions": null,
"retroCalculationMode": null,
"enrollmentType": "MANUAL",
"effectiveEndDate": "/Date(253402214400000)/",
"exceedEntitlementAmount": null,
"conversionFactor": null,
"walletType": null,
"benefitSavingsPlanSubType": null,
"coverage": null,
"triggerDate": null,
"enrollmentOptOutAllowed": "NOT_ALLOWED",
"lastModifiedDate": "/Date(1545143881000)/",
"lastModifiedBy": "sfadmin",
"eligibilityRuleId": null,
"lastModifiedDateWithTZ": "/Date(1545161881000+0000)/",
"balanceCarryForward": null,
"pensionContributionOptions": null,
"enrollmentEffFromDateRule": null,
"enrollment": null,
"isEmployerContributionRequired": null,
"mdfSystemTransactionSequence": "1",
"pensionSchemeStartDate": null,
"noOfClaimTansactions": null,
"createdBy": "sfadmin",
"benefitName": "Transportation Allowance",
"bothBalanceCarryForwardParametersPresent": false,
"entitlementAmount": "2000",
"noOfDependentsToConsider": null,
"payrollIntegration": "PAY_COMPONENT_INTEGRATION",
"empAnnualLimitPayComponentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
empAnnualLimitPayComponentNav"
}
},
"employerContributionDetail": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
employerContributionDetail"
}
},
"pensionContributionOptionsNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
pensionContributionOptionsNav"
}
},
"benefitTypeNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

334 PUBLIC Global Benefits Objects
 "uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
benefitTypeNav"
}
},
"enrollmentTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
enrollmentTypeNav"
}
},
"deductionDetails": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
deductionDetails"
}
},
"employeeEnrollmentEditTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
employeeEnrollmentEditTypeNav"
}
},
"benefitProgramNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
benefitProgramNav"
}
},
"enrollmentOptOutAllowedNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
enrollmentOptOutAllowedNav"
}
},
"retroCalculationModeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
retroCalculationModeNav"
}
},
"savingsPlanSubTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
savingsPlanSubTypeNav"
}
},
"benefitCompanyHousing": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
benefitCompanyHousing"
}
},
"legalEntities": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
legalEntities"
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 335
 "deductionStartDateNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
deductionStartDateNav"
}
},
"eligibleBenefits": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
eligibleBenefits"
}
},
"employeeContributionDetail": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
employeeContributionDetail"
}
},
"annualMaxPayComponentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
annualMaxPayComponentNav"
}
},
"optOutWorkflowIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
optOutWorkflowIdNav"
}
},
"walletTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
walletTypeNav"
}
},
"insurancePlans": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
insurancePlans"
}
},
"statusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/statusNav"
}
},
"taxationModeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
taxationModeNav"
}
},
"benefitSavingsPlanTierConfig": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
benefitSavingsPlanTierConfig"
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

336 PUBLIC Global Benefits Objects
 },
"savingsPlanCatchUpDetailNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
savingsPlanCatchUpDetailNav"
}
},
"balanceCarryForwardOption": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
balanceCarryForwardOption"
}
},
"employerPayComponentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
employerPayComponentNav"
}
},
"benefitScheduleNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
benefitScheduleNav"
}
},
"benPaymentOptions": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
benPaymentOptions"
}
},
"pensionMinMaxContributionLimitsNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
pensionMinMaxContributionLimitsNav"
}
},
"triggerDateNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
triggerDateNav"
}
},
"employerContributionHSANav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
employerContributionHSANav"
}
},
"enrolleeOptionsNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
enrolleeOptionsNav"
}
},
"policyDocuments": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 337
 "uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
policyDocuments"
}
},
"coverageNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
coverageNav"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
createdByNav"
}
},
"benefitHyperlinkConfiguration": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
benefitHyperlinkConfiguration"
}
},
"typeOfPensionNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
typeOfPensionNav"
}
},
"pensionFunds": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
pensionFunds"
}
},
"currencyNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
currencyNav"
}
},
"showRemaningNoOfDaysForEnrollmentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
showRemaningNoOfDaysForEnrollmentNav"
}
},
"benefitSavingsPlanSubTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
benefitSavingsPlanSubTypeNav"
}
},
"planNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/planNav"
}
},
"effectiveStatusNav": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

338 PUBLIC Global Benefits Objects
 "__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
effectiveStatusNav"
}
},
"pensionAdditionalEmployeeContributionDetail": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
pensionAdditionalEmployeeContributionDetail"
}
},
"employeeClaimWorkflowIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
employeeClaimWorkflowIdNav"
}
},
"exceptionWorkflowIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
exceptionWorkflowIdNav"
}
},
"showRemaningNoOfDaysForClaimNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
showRemaningNoOfDaysForClaimNav"
}
},
"frequencyNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
frequencyNav"
}
},
"benCompanyCar": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
benCompanyCar"
}
},
"walletsAssociated": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
walletsAssociated"
}
},
"insuranceTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
insuranceTypeNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
lastModifiedByNav"
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 339
 },
"payrollIntegrationNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
payrollIntegrationNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
mdfSystemRecordStatusNav"
}
},
"usefulLinks": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
usefulLinks"
}
},
"schemeTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
schemeTypeNav"
}
},
"statutoryMinimumLookUp": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
statutoryMinimumLookUp"
}
},
"employeeWithEmployerMatchContributionsNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
employeeWithEmployerMatchContributionsNav"
}
},
"countryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
countryNav"
}
},
"multipleFundSelectionsAllowedNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
multipleFundSelectionsAllowedNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
wfRequestNav"
}
},
"employeeEnrollmentWorkflowIdNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

340 PUBLIC Global Benefits Objects
 "uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
employeeEnrollmentWorkflowIdNav"
}
},
"bandingsConfigurationNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
bandingsConfigurationNav"
}
},
"benefitContact": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/
benefitContact"
}
},
"forms": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
Benefit(benefitId='746',effectiveStartDate=datetime'2015-01-01T00:00:00')/forms"
}
}
}
}

Related Information

SAP API Business Hub: Global Benefits

10.2 BenefitAutomaticActionConfiguration

This entity contains ID, Benefit, Adjustment/Action, Effective From Rule and Deduction Change Effective From Rule.
This object is used to configure Benefit Automatic Action Configuration for Benefit Life Event Configuration.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 341
Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Navigation Property Related Entity Description

Benefits Benefit Navigation to the benefit

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitAutomaticActionConfiguration?$format=json

Response

"d": {
"results": [{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitAutomaticActionConfiguration",
"type": "SFOData.BenefitAutomaticActionConfiguration"
},
“id”: "benefitAutomaticActionConfiguration1",
“benefit”: "benefit1",
“actionFor”: "Delemit_Enrollment",
“effectiveDateRule”: "effectiveDateRule1",
“deductionEffectiveDateRule”: "deductionEffectiveDateRule1",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitAutomaticActionConfiguration/mdfSystemRecordStatusNav"
}
}
}]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

342 PUBLIC Global Benefits Objects
10.3 BenefitBalanceCarryForward

This entity is used to carry forward the unclaimed balances from the previous periods to the next period.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

balanceCarryForwardUptoNoOfSchedulePeriods Number of schedule periods up to which unclaimed balances

can be carried forwarded.

maximumBalanceCarryForwardAmount Amount that can be carry forwarded from the previous sched­
ule period to the next period.

upperLimitOnTotalBalanceCarryForwardAmount The maximum amount that can be carried forward to the end
of the highest schedule period.

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/BenefitBalanceCarryForward?
$format=json

Response

{
"d": {
"results": [
{

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 343
 "__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitBalanceCarryForward(Benefit_benefitId='BCF_2021',Benefit_effectiveStartDate=d
atetime'2020-01-01T00:00:00',externalCode=31844L",
"type": "SFOData.BenefitBalanceCarryForward"
},
"externalCode": "31844",
"Benefit_benefitId": "BCF_2021",
"Benefit_effectiveStartDate": "/Date(1577836800000)/",
"lastModifiedDateTime": "/Date(1635845564000+0000)/",
"lastModifiedBy": "ecadmin",
"maximumBalanceCarryForwardAmount": "100",
"createdDateTime": "/Date(1635845564000+0000)/",
"mdfSystemRecordStatus": "N",
"balanceCarryForwardUptoNoOfSchedulePeriods": null,
"createdBy": "ecadmin",
"upperLimitOnTotalBalanceCarryForwardAmount": null,
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitBalanceCarryForward(Benefit_benefitId='BCF_2021',Benefit_effectiveStartDate=d
atetime'2020-01-01T00:00:00',externalCode=31844L)/createdByNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitBalanceCarryForward(Benefit_benefitId='BCF_2021',Benefit_effectiveStartDate=d
atetime'2020-01-01T00:00:00',externalCode=31844L)/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitBalanceCarryForward(Benefit_benefitId='BCF_2021',Benefit_effectiveStartDate=d
atetime'2020-01-01T00:00:00',externalCode=31844L)/mdfSystemRecordStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Global Benefits

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

344 PUBLIC Global Benefits Objects
10.4 BenefitClaimAccumulation

This enitity enables the accumulation of benefit claims so they can be tracked within a defined cycle.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

claimWindowStart The start date for the claim.

claimWindowEnd The end date for the claim.

remainingAmount The amount remaining after claim is made.

accumulatedAmount The amount that has already been claimed.

balanceCarryForwardAmount The amount that is carried forward.

Navigation Properties

Navigation Property Related Entity Description

Benefit Claim Accumulation benefitBalanceCarryForwardDetail Gets the BalanceCarrryForwardDetails.

Benefit Claim Accumulation benefitClaims Gets the Benefit Employee Claim details.

Use Case: Get Vendor Information

A query operation on the VendorInfo entity returns all the information related to a given vendor.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 345
Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
BenefitClaimAccumulation(160705)?
$format=JSON

Response

{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitClaimAccumulation(160705L)",
"type": "SFOData.BenefitClaimAccumulation"
},
"externalCode": "160705",
"exception": null,
"mdfSystemLastModifiedDateWithTZ": "/Date(1486004759000+0000)/",
"lastModifiedDateTime": "/Date(1486004759000+0000)/",
"mdfSystemCreatedBy": "sfadmin",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"balanceCarryForwardAmount": "0",
"createdDateTime": "/Date(1486004759000+0000)/",
"mdfSystemVersionId": null,
"mdfSystemLastModifiedBy": "sfadmin",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"remainingAmount": "900",
"accumulatedAmount": "100",
"balanceCredits": null,
"mdfSystemStatus": "A",
"mdfSystemEntityId": "35E741DEF0384DBDA7ED530E663CF103",
"currency": "GBP",
"claimWindowEnd": "/Date(1514678400000)/",
"mdfSystemObjectType": "BenefitClaimAccumulation",
"workerId": "101037",
"mdfSystemLastModifiedDate": "/Date(1485986759000)/",
"lastModifiedBy": "sfadmin",
"mdfSystemRecordStatus": "N",
"benefit": "644",
"accumulatedCredits": null,
"mdfSystemTransactionSequence": "1",
"claimWindowStart": "/Date(1483228800000)/",
"createdBy": "sfadmin",
"mdfSystemCreatedDate": "/Date(1485986759000)/",
"mdfSystemRecordId": "D7A6D5DE033242F6BA5BEB60B4A582BE",
"schedulePeriod": "108381",
"benefitBalanceCarryForwardDetails": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitClaimAccumulation(160705L)/benefitBalanceCarryForwardDetails"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitClaimAccumulation(160705L)/mdfSystemStatusNav"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitClaimAccumulation(160705L)/createdByNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

346 PUBLIC Global Benefits Objects
 }
},
"benefitClaims": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitClaimAccumulation(160705L)/benefitClaims"
}
},
"exceptionNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitClaimAccumulation(160705L)/exceptionNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitClaimAccumulation(160705L)/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitClaimAccumulation(160705L)/mdfSystemRecordStatusNav"
}
},
"currencyNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitClaimAccumulation(160705L)/currencyNav"
}
},
"workerIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitClaimAccumulation(160705L)/workerIdNav"
}
},
"schedulePeriodNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitClaimAccumulation(160705L)/schedulePeriodNav"
}
},
"benefitNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitClaimAccumulation(160705L)/benefitNav"
}
},
"benefitEnrollments": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitClaimAccumulation(160705L)/benefitEnrollments"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitClaimAccumulation(160705L)/wfRequestNav"
}
}
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 347
Related Information

SAP API Business Hub: Global Benefits

10.5 BenefitCompanyCarAllowedModels

This entity is used to create values for different car models that are selected from the drop-down list in the
application.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

effectiveStartDate The effective start date of car model.

carModelName The name of the car model.

Navigation Properties

Navigation Property Related Entity Description

BenefitCompanyCarAllowedMod BenefitCompanyCar One-to-many association to Company­

els Car - to filter the CompanyCarAllowed­
Models.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

348 PUBLIC Global Benefits Objects
Use Case: Get details of company car allowed models

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitCompanyCarAllowedModels?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitCompanyCarAllowedModels(effectiveStartDate=datetime'2019-04-01T00:00:00',exte
rnalCode='13411')",
"type": "SFOData.BenefitCompanyCarAllowedModels"
},
"externalCode": "13411",
"effectiveStartDate": "/Date(1554076800000)/",
"effectiveEndDate": "/Date(253402214400000)/",
"lastModifiedDateTime": "/Date(1554187003000+0000)/",
"createdBy": "sriadmin",
"carModelName": "C11",
"lastModifiedBy": "sriadmin",
"createdDateTime": "/Date(1554187003000+0000)/",
"mdfSystemRecordStatus": "N",
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitCompanyCarAllowedModels(effectiveStartDate=datetime'2019-04-01T00:00:00',exte
rnalCode='13411')/wfRequestNav"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitCompanyCarAllowedModels(effectiveStartDate=datetime'2019-04-01T00:00:00',exte
rnalCode='13411')/createdByNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitCompanyCarAllowedModels(effectiveStartDate=datetime'2019-04-01T00:00:00',exte
rnalCode='13411')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitCompanyCarAllowedModels(effectiveStartDate=datetime'2019-04-01T00:00:00',exte
rnalCode='13411')/mdfSystemRecordStatusNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 349
Related Information

SAP API Business Hub: Global Benefits

10.6 BenefitCompanyCarLeaseServiceProvider

This entity is used to create values for car lease service providers.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Properties

Property Description

externalCode The company car code.

effectiveStartDate The effective start date of the car lease from the service provider.

serviceProviderName Name of the car lease service provider.

emiInterestRate The interest rate from the service provider for the equated monthly installments.

Navigation Properties

Navigation Property Related Entity Description

BenefitCompanyCarLeaseServi BenefitCompanyCar One-to-many association to Company­

Car - to filter the CompanyCarLeaseSer­
ceProvider
viceProvider.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

350 PUBLIC Global Benefits Objects
Use Case: Get details of company car lease service providers

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitCompanyCarLeaseServiceProvider?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitCompanyCarLeaseServiceProvider(effectiveStartDate=datetime'2019-04-02T00:00:0
0',externalCode='34235234')",
"type": "SFOData.BenefitCompanyCarLeaseServiceProvider"
},
"externalCode": "34235234",
"effectiveStartDate": "/Date(1554163200000)/",
"effectiveEndDate": "/Date(253402214400000)/",
"lastModifiedDateTime": "/Date(1554186900000+0000)/",
"lastModifiedBy": "sriadmin",
"createdDateTime": "/Date(1554186900000+0000)/",
"mdfSystemRecordStatus": "N",
"serviceProviderName": "SAP",
"createdBy": "sriadmin",
"emiInterestRate": "10",
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitCompanyCarLeaseServiceProvider(effectiveStartDate=datetime'2019-04-02T00:00:0
0',externalCode='34235234')/createdByNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitCompanyCarLeaseServiceProvider(effectiveStartDate=datetime'2019-04-02T00:00:0
0',externalCode='34235234')/wfRequestNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitCompanyCarLeaseServiceProvider(effectiveStartDate=datetime'2019-04-02T00:00:0
0',externalCode='34235234')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitCompanyCarLeaseServiceProvider(effectiveStartDate=datetime'2019-04-02T00:00:0
0',externalCode='34235234')/mdfSystemRecordStatusNav"
}
}
}
]
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 351
 }

Related Information

SAP API Business Hub: Global Benefits

10.7 BenefitsConfirmationStatementConfiguration

This entity is meant for mapping the template to various legal entity. Here Legal Entity is external code to address
the requirement of having only one template mapped per legal entity.

Supported Operations

Query

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitsConfirmationStatementConfiguration
?$format=json&$top=1

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitsConfirmationStatementConfiguration",
"type": "SFOData.BenefitsConfirmationStatementConfiguration"
},
"legalEntity": "ACE_USA",
"effectiveStartDate": "/Date(1496016000000)/",
" templateId ": "benefits",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1496123038000+0000)/",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

352 PUBLIC Global Benefits Objects
 "lastModifiedDateTime": "/Date(1496123038000+0000)/",
"mdfSystemRecordStatus": "N",
" legalEntityNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitsConfirmationStatementConfiguration/legalEntityNav"
},
"templateIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitsConfirmationStatementConfiguration/templateIdNav "
}
}
}
}
]
}
}

Related Information

SAP API Business Hub: Global Benefits

10.8 BenefitCompanyCarRecommendedVendors

This entity stores the details of recommended vendors for the company car benefit.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 353
Properties

Property Description

carVendorName The name of the car vendor.

Navigation Properties

Navigation Property Related Entity Description

BenefitCompanyCarRecommende BenefitCompanyCar Join-By-Column association to filter the

dVendors car vendors associated to a specific com­
pany car benefit.

Use Case: Get details of company car recommended vendors

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitCompanyCarRecommendedVendors

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitCompanyCarRecommendedVendors(effectiveStartDate=datetime'2019-04-01T00:00:00'
,externalCode='54545')",
"type": "SFOData.BenefitCompanyCarRecommendedVendors"
},
"externalCode": "54545",
"effectiveStartDate": "/Date(1554076800000)/",
"effectiveEndDate": "/Date(253402214400000)/",
"carVendorName": "Hundai",
"lastModifiedDateTime": "/Date(1554187073000+0000)/",
"createdBy": "sriadmin",
"lastModifiedBy": "sriadmin",
"createdDateTime": "/Date(1554187073000+0000)/",
"mdfSystemRecordStatus": "N",
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitCompanyCarRecommendedVendors(effectiveStartDate=datetime'2019-04-01T00:00:00'
,externalCode='54545')/wfRequestNav"
}
},
"createdByNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

354 PUBLIC Global Benefits Objects
 "uri": "https://<api-server>/odata/v2/
BenefitCompanyCarRecommendedVendors(effectiveStartDate=datetime'2019-04-01T00:00:00'
,externalCode='54545')/createdByNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitCompanyCarRecommendedVendors(effectiveStartDate=datetime'2019-04-01T00:00:00'
,externalCode='54545')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitCompanyCarRecommendedVendors(effectiveStartDate=datetime'2019-04-01T00:00:00'
,externalCode='54545')/mdfSystemRecordStatusNav"
}
}
}
]
}

Related Information

SAP API Business Hub: Global Benefits

10.9 BenefitContact

This entity stores the contact details of persons who are responsible for providing benefit-related information.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 355
Properties

Property Description

employeeName The name of the employee.

contactEmail The employee's email address.

contactPhone The employee's phone number.

Use Case: Get contact details of persons who are responsible for providing
benefit-related information

Request

Operation Query

HTTP Method GET

URI https://<api-sever>/odata/v2/BenefitContact

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitContact('JPATRICK')",
"type": "SFOData.BenefitContact"
},
"externalCode": "JPATRICK",
"employeeName": "James Patrick",
"lastModifiedDateTime": "/Date(1630644200000+0000)/",
"contactEmail": "[email protected]",
"lastModifiedBy": "ecadmin",
"createdDateTime": "/Date(1630644200000+0000)/",
"contactType": null,
"mdfSystemRecordStatus": "N",
"contactEmployeeId": "103073",
"createdBy": "ecadmin",
"contactPhone": "67809876",
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitContact('JPATRICK')/createdByNav"
}
},
"contactEmployeeIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitContact('JPATRICK')/contactEmployeeIdNav"
}
},
"contactTypeNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

356 PUBLIC Global Benefits Objects
 "uri": "https://<api-server>/odata/v2/
BenefitContact('JPATRICK')/contactTypeNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitContact('JPATRICK')/wfRequestNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitContact('JPATRICK')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitContact('JPATRICK')/mdfSystemRecordStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Global Benefits

10.10 BenefitDeductibleDetails

This object is used to capture the Benefit Deduction details during Benefit creation.

 Note

This API is read-only. To create or edit data, please use function import.

Supported Operations

Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 357
Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitDeductionDetails?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitDeductionDetails(Benefit_benefitId='SAVINGS_PALN',Benefit_effectiveStartDate=
datetime'2018-03-23T00:00:00',dedcutionDetailId=25291L)",
"type": "SFOData.BenefitDeductionDetails"
},
"Benefit_effectiveStartDate": "/Date(1521763200000)/",
"Benefit_benefitId": "SAVINGS_PALN",
"dedcutionDetailId": "25291",
"deductionPayComponent": "Savings plan paycomp",
"basePayComponent": "Savings plan paycomp",
"lastModifiedDateTime": "/Date(1521780910000+0000)/",
"createdBy": "admin",
"createdDateTime": "/Date(1521780910000+0000)/",
"lastModifiedBy": "admin",
"payFrequency": "MON",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitDeductionDetails(Benefit_benefitId='SAVINGS_PALN',Benefit_effectiveStartDate=
datetime'2018-03-23T00:00:00',dedcutionDetailId=25291L)/mdfSystemRecordStatusNav"
}
},
"deductionPayComponentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitDeductionDetails(Benefit_benefitId='SAVINGS_PALN',Benefit_effectiveStartDate=
datetime'2018-03-23T00:00:00',dedcutionDetailId=25291L)/deductionPayComponentNav"
}
},
"basePayComponentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitDeductionDetails(Benefit_benefitId='SAVINGS_PALN',Benefit_effectiveStartDate=
datetime'2018-03-23T00:00:00',dedcutionDetailId=25291L)/basePayComponentNav"
}
},
"payFrequencyNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitDeductionDetails(Benefit_benefitId='SAVINGS_PALN',Benefit_effectiveStartDate=
datetime'2018-03-23T00:00:00',dedcutionDetailId=25291L)/payFrequencyNav"
}
}
}
]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

358 PUBLIC Global Benefits Objects
 }
}

10.11 BenefitDocuments

This enity is used to store all kinds of documents related to the benefits, including policy documents, forms, and
relevant web links.

 Note

This API is read-only. To create or edit data, please use function import.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

effectiveStartDate The effective start date of the document.

shortName The short name of the document.

usefullLink A link to the document.

attachment Any attachment that refers to the document.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 359
Use Case: Get all benefit related documents

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/ BenefitDocuments

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitDocuments(effectiveStartDate=datetime'2021-01-01T00:00:00',id='DOC')",
"type": "SFOData.BenefitDocuments"
},
"effectiveStartDate": "/Date(1609459200000)/",
"id": "DOC",
"lastModifiedDateTime": "/Date(1630308427000+0000)/",
"lastModifiedBy": "bijo",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"createdDateTime": "/Date(1630308427000+0000)/",
"mdfSystemRecordStatus": "N",
"usefulLink": null,
"createdBy": "bijo",
"shortName": "DOC",
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitDocuments(effectiveStartDate=datetime'2021-01-01T00:00:00',id='DOC')/
createdByNav"
}
},
"attachmentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitDocuments(effectiveStartDate=datetime'2021-01-01T00:00:00',id='DOC')/
attachmentNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitDocuments(effectiveStartDate=datetime'2021-01-01T00:00:00',id='DOC')/
wfRequestNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitDocuments(effectiveStartDate=datetime'2021-01-01T00:00:00',id='DOC')/
lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitDocuments(effectiveStartDate=datetime'2021-01-01T00:00:00',id='DOC')/
mdfSystemRecordStatusNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

360 PUBLIC Global Benefits Objects
 }
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitDocuments(effectiveStartDate=datetime'2021-09-01T00:00:00',id='ID007')",
"type": "SFOData.BenefitDocuments"
},
"effectiveStartDate": "/Date(1630454400000)/",
"id": "ID007",
"lastModifiedDateTime": "/Date(1631650436000+0000)/",
"lastModifiedBy": "ecadmin",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"createdDateTime": "/Date(1631650436000+0000)/",
"mdfSystemRecordStatus": "N",
"usefulLink": null,
"createdBy": "ecadmin",
"shortName": "Bandings Pension UK",
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitDocuments(effectiveStartDate=datetime'2021-09-01T00:00:00',id='ID007')/
createdByNav"
}
},
"attachmentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitDocuments(effectiveStartDate=datetime'2021-09-01T00:00:00',id='ID007')/
attachmentNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitDocuments(effectiveStartDate=datetime'2021-09-01T00:00:00',id='ID007')/
wfRequestNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitDocuments(effectiveStartDate=datetime'2021-09-01T00:00:00',id='ID007')/
lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitDocuments(effectiveStartDate=datetime'2021-09-01T00:00:00',id='ID007')/
mdfSystemRecordStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Global Benefits

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 361
10.12 BenefitEmployeeClaim

This entity stores the details of the claim transactions made by the employees for the various benefits in the
company.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

claimDate The date the benefit is claimed.

entitlementAmount The amount the employee is eligible to claim.

totalAmount The amount that the employee is claiming for.

benefitDataSourceWithExternalCode The list of benefits that the employee is eligible to claim for.

Navigation Properties

Navigation Property Related Entity Description

BenefitEmployeeClaim BenefitEmployeeClaimDetail Contains additional detail fields required

during claim of a benefit.

BenefitEmployeeClaim BenefitFuelReimbursementClaimDetail Contains additional detail fields required

during claim of the fuel benefit.

BenefitEmployeeClaim BenefitDependentDetail Contains additional fields required to

capture the dependent information.

BenefitEmployeeClaim BenefitDocuments Stores information about policy docu­

ments, forms, useful links.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

362 PUBLIC Global Benefits Objects
 Navigation Property Related Entity Description

BenefitEmployeeClaim BenefitLeaveTravelReimbursementClaim Contains additional fields required to

capture the leave travel information.

BenefitEmployeeClaim BenefitFuelReimbursement Contains additional fields required to

capture the fuel reimbursement informa­
tion.

Use Case: Get details of the claim transactions made by the employees

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/BenefitEmployeeClaim

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeClaim('1DE4AEF51E784AD9A1B4DE255B350E7E')",
"type": "SFOData.BenefitEmployeeClaim"
},
"id": "1DE4AEF51E784AD9A1B4DE255B350E7E",
"exception": null,
"lastModifiedDateTime": "/Date(1629284526000+0000)/",
"benefitDataSourceWithExternalCode": "CLAIM_API",
"createdDateTime": "/Date(1629284526000+0000)/",
"byPassWorkflow": null,
"externalName": "80300_CLAIM_API_TEST_08182021_110206",
"currency": "USD",
"benefitProgram": null,
"workerId": "80300",
"benefitDataSource": null,
"nrpId": null,
"lastModifiedBy": "bijo",
"benefit": "CLAIM_API",
"benefitClaimEntityID": "50F16D4AD3BD4CD7A659CBF331CDF83C",
"totalAmount": "1000",
"recordStatus": "N",
"claimDate": "/Date(1629244800000)/",
"createdBy": "bijo",
"isTotalAmountReadOnly": null,
"entitlementAmount": null,
"remarks": null,
"status": null,
"policyDocuments": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeClaim('1DE4AEF51E784AD9A1B4DE255B350E7E')/policyDocuments"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 363
 }
},
"benFuelReimbursement": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeClaim('1DE4AEF51E784AD9A1B4DE255B350E7E')/benFuelReimbursement"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeClaim('1DE4AEF51E784AD9A1B4DE255B350E7E')/createdByNav"
}
},
"statusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeClaim('1DE4AEF51E784AD9A1B4DE255B350E7E')/statusNav"
}
},
"benTravelReimbursementClaim": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeClaim('1DE4AEF51E784AD9A1B4DE255B350E7E')/
benTravelReimbursementClaim"
}
},
"benefitFuelReimbursementClaimDetail": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeClaim('1DE4AEF51E784AD9A1B4DE255B350E7E')/
benefitFuelReimbursementClaimDetail"
}
},
"exceptionNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeClaim('1DE4AEF51E784AD9A1B4DE255B350E7E')/exceptionNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeClaim('1DE4AEF51E784AD9A1B4DE255B350E7E')/lastModifiedByNav"
}
},
"benefitContacts": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeClaim('1DE4AEF51E784AD9A1B4DE255B350E7E')/benefitContacts"
}
},
"benefitDependentDetail": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeClaim('1DE4AEF51E784AD9A1B4DE255B350E7E')/benefitDependentDetail"
}
},
"usefulLinks": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeClaim('1DE4AEF51E784AD9A1B4DE255B350E7E')/usefulLinks"
}
},
"currencyNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeClaim('1DE4AEF51E784AD9A1B4DE255B350E7E')/currencyNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

364 PUBLIC Global Benefits Objects
 }
},
"workerIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeClaim('1DE4AEF51E784AD9A1B4DE255B350E7E')/workerIdNav"
}
},
"benefitProgramNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeClaim('1DE4AEF51E784AD9A1B4DE255B350E7E')/benefitProgramNav"
}
},
"cust_attachment2Nav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeClaim('1DE4AEF51E784AD9A1B4DE255B350E7E')/cust_attachment2Nav"
}
},
"attachmentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeClaim('1DE4AEF51E784AD9A1B4DE255B350E7E')/attachmentNav"
}
},
"benefitEmployeeCarClaim": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeClaim('1DE4AEF51E784AD9A1B4DE255B350E7E')/benefitEmployeeCarClaim"
}
},
"benefitNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeClaim('1DE4AEF51E784AD9A1B4DE255B350E7E')/benefitNav"
}
},
"benefitEmployeeClaimDetail": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeClaim('1DE4AEF51E784AD9A1B4DE255B350E7E')/benefitEmployeeClaimDetail"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeClaim('1DE4AEF51E784AD9A1B4DE255B350E7E')/wfRequestNav"
}
},
"recordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeClaim('1DE4AEF51E784AD9A1B4DE255B350E7E')/recordStatusNav"
}
},
"forms": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeClaim('1DE4AEF51E784AD9A1B4DE255B350E7E')/forms"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 365
Related Information

SAP API Business Hub: Global Benefits

10.13 BenefitEnrollment

This entity contains a list of all the benefits for which an Employee is eligible.An employee uses this object to enroll
for eligible benefits.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

entitlementAmount The entitlement amount of the benefit.

benefitDataSourceWithExternalCode The data source field for benefits.

effectiveStartDate The start date of enrollment.

effectiveEndDate The end date of enrollment.

amount The total amount for which user has enrolled.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

366 PUBLIC Global Benefits Objects
Navigation Properties

Navigation Property Related Entity Description

BenefitEnrollment BenefitCompanyCarEnrollment This is additional field that contains com­

pany car enrollment details.

BenefitEnrollment BenefitPensionFundEnrollmentContribu- This field contains benefit pension fund

tionDetail related information.

BenefitEnrollment BenefitPensionDependentNominees This field contains the information about

the Dependent Nominees.

BenefitEnrollment BenefitPensionNonDependentNominees This field contains the information about

the Non Dependent Nominees.

BenefitEnrollment BenefitPensionEnrollmentContribution- This field contains the information re­

Detail lated to pension enrollment contribution.

BenefitEnrollment BenefitCompanyHousingEnrollment This field contains company housing re­

lated information.

Use Case: Get the list of all the enrolled benefits for the employee

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/BenefitEnrollment

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')",
"type": "SFOData.BenefitEnrollment"
},
"effectiveStartDate": "/Date(1640995200000)/",
"id": "DC37B856586146CDB49AC2C02873A3CB",
"eligibleWalletAmount": null,
"exception": null,
"isDedStartDateCalculated": null,
"jobRunDate": null,
"lastModifiedDateTime": "/Date(1629958406000+0000)/",
"enrollmentContext": null,
"enrollmentDate": "/Date(1629849600000)/",
"createdDateTime": "/Date(1629958406000+0000)/",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 367
 "eligibleWalletWithDataSource": null,
"externalName": "802987_INSURANCE_BEN_REC_INFO_08262021_061325",
"benefitPaymentOption": null,
"benefitProgram": null,
"workerId": "802987",
"retirementDate": null,
"benefitEnrollmentEntityID": "6563CC2467E447A49B4F07D8AC088C1F",
"benefit": "INSURANCE_BEN_REC_INFO",
"effectiveStatus": "I",
"deductionStartDate": "/Date(1629763200000)/",
"benefitEntitlementAmount": null,
"effectiveEndDate": "/Date(253402214400000)/",
"benefitDataSourceWithExternalCode": "INSURANCE_BEN_REC_INFO",
"amountFromWallet": null,
"isOptOutEvent": null,
"walletConsumedTill": null,
"currency": "USD",
"amount": null,
"benefitDataSource": null,
"creditPointsFromWallet": null,
"lastModifiedBy": "80300",
"compensationId": null,
"eligibleWalletCredits": null,
"benefitSavingsPlanEmployerContribution": null,
"recordStatus": "N",
"previousEnrollmentId": null,
"createdBy": "80300",
"isTriggeredEvent": null,
"compensationAdjustmentUntil": null,
"eligibleWallet": null,
"schedulePeriod": "2021",
"policyDocuments": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/policyDocuments"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/createdByNav"
}
},
"benefitDeductibleAllowanceEnrollment": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/benefitDeductibleAllowanceEnrollment"
}
},
"benefitSavingsPlanEnrollmentContributionDetail": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/benefitSavingsPlanEnrollmentContributionDetail"
}
},
"eligibleWalletNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/eligibleWalletNav"
}
},
"benefitSavingsPlanEnrollmentDetails": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

368 PUBLIC Global Benefits Objects
 "uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/benefitSavingsPlanEnrollmentDetails"
}
},
"enrollmentContextNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/enrollmentContextNav"
}
},
"benefitContacts": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/benefitContacts"
}
},
"benefitCompanyHousingEnrollment": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/benefitCompanyHousingEnrollment"
}
},
"currencyNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/currencyNav"
}
},
"benefitProgramNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/benefitProgramNav"
}
},
"schedulePeriodNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/schedulePeriodNav"
}
},
"attachmentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/attachmentNav"
}
},
"benefitNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/benefitNav"
}
},
"benefitInsurancePlanEnrollmentDetails": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/benefitInsurancePlanEnrollmentDetails"
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 369
 "effectiveStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/effectiveStatusNav"
}
},
"benefitPensionFundEnrollmentContributionDetail": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/benefitPensionFundEnrollmentContributionDetail"
}
},
"benefitSavingsPlanPrimaryBeneficiaries": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/benefitSavingsPlanPrimaryBeneficiaries"
}
},
"benefitPensionNonDependentNominees": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/benefitPensionNonDependentNominees"
}
},
"benefitPaymentOptionNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/benefitPaymentOptionNav"
}
},
"exceptionNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/exceptionNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/lastModifiedByNav"
}
},
"usefulLinks": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/usefulLinks"
}
},
"workerIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/workerIdNav"
}
},
"benefitPensionEnrollmentContributionDetail": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/benefitPensionEnrollmentContributionDetail"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

370 PUBLIC Global Benefits Objects
 }
},
"benefitPensionDependentNominees": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/benefitPensionDependentNominees"
}
},
"benefitCompanyCarEnrollment": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/benefitCompanyCarEnrollment"
}
},
"benefitSavingsPlanEmployerContributionNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/benefitSavingsPlanEmployerContributionNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/wfRequestNav"
}
},
"recordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/recordStatusNav"
}
},
"forms": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/forms"
}
},
"benefitSavingsPlanContingentBeneficiaries": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollment(effectiveStartDate=datetime'2022-01-01T00:00:00',id='DC37B85658614
6CDB49AC2C02873A3CB')/benefitSavingsPlanContingentBeneficiaries"
}
}
}
],
"__next": "https://<api-server>/odata/v2/BenefitEnrollment?$format=json&
$skiptoken=eyJzdGFydFJvdyI6MTAwMCwiZW5kUm93IjoyMDAwfQ=="
}
}

Related Information

SAP API Business Hub: Global Benefits

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 371
10.14 BenefitEnrollmentDependencyConfiguration

This Object is used to capture the Benefit Dependency containing Benefit Dependency Configuration Id, Comment
and Benefit Dependency Details. Benefit Dependency Details contains the Lead Benefit, Lead Insurance Plan,
Dependent Benefit, Dependent Insurance Plan and Enrollment Condition.

 Note

This API is read-only. To create or edit data, please use function import.

Supported Operations

Query

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitEnrollmentDependencyConfiguration(e
ffectiveStartDate=datetime'2017-10-02T00:0
0:00',id=694L)?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollmentDependencyConfiguration",
"type": "SFOData. BenefitEnrollmentDependencyConfiguration"
},
"benefitDependencyId": "DEPENDENCY CONFIGURATION ID",
"comment": "Benefit Dependency Configuration with details",
"benefitDependencyDetails": "benefitDependencydetailList",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1496123038000+0000)/",
"lastModifiedDateTime": "/Date(1496123038000+0000)/",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollmentDependencyConfiguration(/mdfSystemRecordStatusNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

372 PUBLIC Global Benefits Objects
 }
}
}
]
}
}

10.15 BenefitEnrollmentDependencyDetails

This Object is used to capture the Lead and Dependent Benefits with some Enrollment Condition.

Supported Operations

Query

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitEnrollmentDependencyDetails(effecti
veStartDate=datetime'2017-10-02T00:00:00',
id=694L)/$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/BenefitEnrollmentDependencyDetails",
"type": "SFOData. BenefitEnrollmentDependencyDetails"
},
"leadBenefit": "DummyBenefit1",
"leadInsurancePlan": "DummyPlan1",
"enrollmentCondition": "ENROLLED",
"dependentBenefit": "DummyBenefit2",
"dependentInsurancePlan": "DummyPlan2",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1496123038000+0000)/",
"lastModifiedDateTime": "/Date(1496123038000+0000)/",
"mdfSystemRecordStatus": "N",
"leadBenefitNav": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 373
 "__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollmentDependencyDetails/leadBenefitNav "
},
"leadInsurancePlanNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollmentDependencyDetails/leadInsurancePlanNav"
},
"enrollmentConditionNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollmentDependencyDetails/enrollmentConditionNav "
},
"dependentBenefitNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollmentDependencyDetails/dependentBenefitNav "
},
"dependentInsurancePlanNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollmentDependencyDetails/dependentInsurancePlanNav"
},
"parentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollmentDependencyDetails/parentNav "
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollmentDependencyDetails(/mdfSystemRecordStatusNav"
}
}
}
}
}
}
}
}
}
]
}
}

10.16 BenefitEnrollmentOptoutDetail

This entity contains BenefitEnrollment, BenefitEnrollmentId, BenefitEnrollmentId, BenefitSchedulePeriod,

OptoutRequestDate, EnrollmentChangeDate, ContributionChangeDate, and OptedoutBy. This entity is used to log
opted out details.

 Note

This API is read-only. To create or edit data, please use function import.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

374 PUBLIC Global Benefits Objects
Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Navigation Property Related Entity Description

Benefits Benefit Navigation to the Benefit

Use Case: Querying opted out BenefitEnrollment details

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitEnrollmentOptoutDetails?
$format=json

Response

"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollmentOptoutDetails",
"type": "SFOData. BenefitEnrollmentOptoutDetails"
},
"benefitEnrollment": "BenefitEnrollment1",
“benefitEnrollmentId”: “AHDGJ879709BDJ”,
“benefitSchedulePeriod”: “BenefitSchedulePeriod1”,
“optoutRequestDate”: "/Date(1521763200000)/",
“enrollmentChangeDate”: "/Date(1523163200000)/",
“contributionChangeDate”: "/Date(1526263200000)/",
“optedoutBy”: “admin1”,
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1496123038000+0000)/",
"lastModifiedDateTime": "/Date(1496123038000+0000)/",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 375
 "mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEnrollmentOptoutDetails/mdfSystemRecordStatusNav"
}
}
}
]
}
}

10.17 BenefitEmployeeOptoutRequests

This entity is used to get the worked ID and Enrollment Optout details of an employee. This entity is used to store
the enrollment optout details for an employee.

 Note

This API is read-only. To create or edit data, please use function import.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Navigation Property Related Entity Description

Benefits Benefit Navigation to the Benefit

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

376 PUBLIC Global Benefits Objects
Use Case: Queries opt out details of an employee

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitEmployeeOptoutRequests?$format=json

Response

"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeOptoutRequests",
"type": "SFOData. BenefitEmployeeOptoutRequests"
},
"workerId": "user1",
"benefitEnrollmentOptoutDetails": "benefitOptoutDetailsList",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1496123038000+0000)/",
"lastModifiedDateTime": "/Date(1496123038000+0000)/",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEmployeeOptoutRequests/mdfSystemRecordStatusNav"
}
}
}
]
}
}

10.18 BenefitEventDetermination

This entity contains System Event and Event Determination Rule Configuration. This entity is used to create Benefit
Event Determination object.

Supported Operations

Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 377
Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Navigation Property Related Entity Description

Benefits Benefit Navigation to the benefit

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/BenefitEventDetermination?
$format=json

Response

"d": {
"results": [{
"__metadata": {
"uri": "https://<api-server>/odata/v2/BenefitEventDetermination",
"type": "SFOData.BenefitEventDetermination"
},
“systemEvent”: "TERMINATION",
"eventDeterminationRuleConfiguration":
"eventDeterminationRuleConfiguration1",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/BenefitEventDetermination/
mdfSystemRecordStatusNav"
}
}
}]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

378 PUBLIC Global Benefits Objects
10.19 BenefitEventProcessingLog

This entity contains Processing Log Id, Worker Id, System Event, System Event Id, Comment, Event Rule Name,
Benefit Event, Benefit Life Event Configuration, Event Processing Status,Processing Result Detail,Event Published
By,Processed Date, Processed Time and Benefit Processing Log Details. This entity is used to log the details of
Processed BenefitEvent.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Navigation Property Related Entity Description

Benefits Benefit Navigation to the benefit

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/BenefitEventProcessingLog?
$format=json

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 379
Response

"d": {
"results": [{
"__metadata": {
"uri": "https://<api-server>/odata/v2/BenefitEventProcessingLog",
"type": "SFOData.BenefitEventProcessingLog"
},
"processingLogId": "ProcessingLog1",
"workerId": "admin",
"systemEvent": "TERMINATION",
"systemEventId": "Termination1",
"comment": "Terminated",
"eventRuleName": "TerminationRule",
"benefitEvent": "benefitEvent1",
"benefitLifeEventConfiguration": "benefitLifeEventConfiguration1",
"eventProcessingStatus": "SUCCESS",
"processingResultDetail": "Created",
"eventPublishedBy": "admin",
"processedDate": "/Date(1521763200000)/",
"processedTime": "/Date(1496123038000+0000)/",
"benefitProcessingLogDetails": "benefitProcessingLogDetails1",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/BenefitEventProcessingLog/
mdfSystemRecordStatusNav"
}
}
}]
}
}

10.20 BenefitOpenEnrollmentCycleConfiguration

This entity contains the details of the Open Enrollment cycle – the benefits that are part of it, the legal entity it is
valid, the schedule it is applicable for. This is used to configure the Open Enrollment Cycle, based on which the
employee would be able to enroll into the related benefits.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

380 PUBLIC Global Benefits Objects
Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitOpenEnrollmentCycleConfiguration?
$format=json&$top=1

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https:<api-server>/odata/v2/
BenefitOpenEnrollmentCycleConfiguration",
"type": "SFOData.BenefitOpenEnrollmentCycleConfiguration"
},
"openEnrollmentSchedule": "Schedule 1",
"legalEntity": "ACE_USA",
"instructionTextURL": "https://www.example.com",
"tncURL": "https://www.example.com",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1496123038000+0000)/",
"lastModifiedDateTime": "/Date(1496123038000+0000)/",
"mdfSystemRecordStatus": "N",
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitOpenEnrollmentCycleConfiguration/wfRequestNav"
},
"benefits": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/BenefitEnrollmentGroup/benefits"
}
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitOpenEnrollmentCycleConfiguration(/mdfSystemRecordStatusNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 381
Related Information

SAP API Business Hub: Global Benefits

10.21 BenefitsException

This entity contains information about all the exceptions that occur if the enrollment amount does not match the
eligiblility criteria or if the enrollment period has expired.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

exceptionStartDate The start date for benefits exception.

exceptionEndDate The end date for benefits exception.

Navigation Properties

Navigation Property Related Entity Description

BenefitException BenefitExceptionDetails This contains the information related to

different benefits and the schedule peri­
ods for which exception is granted.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

382 PUBLIC Global Benefits Objects
 Navigation Property Related Entity Description

BenefitException BenefitProgramExceptionDetails This contains the information related to

different benefit programs and the
schedule periods for which exception is
granted.

Use Case: Get Details of Benefit exceptions that occur when the enrollment
period has expired

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/BenefitsException

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitsException(28322L)",
"type": "SFOData.BenefitsException"
},
"exceptionId": "28322",
"lastModifiedDateTime": "/Date(1630604770000+0000)/",
"exceptionStartDate": "/Date(1630540800000)/",
"lifeEventConfiguration": null,
"createdDateTime": "/Date(1630604770000+0000)/",
"isAutomation": null,
"exceptionCreationDate": "/Date(1630540800000)/",
"legalEntity": "1700",
"newExceptionWindow": true,
"exceptionName": "103073_ENROLLMENT",
"workerId": "103073",
"lastModifiedBy": "ecadmin",
"mdfSystemRecordStatus": "N",
"createdBy": "ecadmin",
"exceptionFor": "ENROLLMENT",
"exceptionEndDate": "/Date(1631404800000)/",
"eventDate": "/Date(1630540800000)/",
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitsException(28322L)/createdByNav"
}
},
"exceptionForNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitsException(28322L)/exceptionForNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 383
 }
},
"benefitProgramExceptionDetails": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitsException(28322L)/benefitProgramExceptionDetails"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitsException(28322L)/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitsException(28322L)/mdfSystemRecordStatusNav"
}
},
"workerIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitsException(28322L)/workerIdNav"
}
},
"legalEntityNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitsException(28322L)/legalEntityNav"
}
},
"lifeEventConfigurationNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitsException(28322L)/lifeEventConfigurationNav"
}
},
"benefitExceptionDetails": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitsException(28322L)/benefitExceptionDetails"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitsException(28322L)/wfRequestNav"
}
}
},
]
}
}

Related Information

SAP API Business Hub: Global Benefits

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

384 PUBLIC Global Benefits Objects
10.22 BenefitHyperlinkConfiguration

This object is used to capture the URL and label for the URL to display with each benefit. The hyperlinks configured
in each benefit will be displayed with benefit on the employee screen.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitHyperlinkConfiguration/$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/BenefitHyperlinkConfiguration",
"type": "SFOData. BenefitHyperlinkConfiguration"
},
"url": "https://www.website.com",
"label": "Website",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1496123038000+0000)/",
"lastModifiedDateTime": "/Date(1496123038000+0000)/",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/BenefitHyperlinkConfiguration(/
mdfSystemRecordStatusNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 385
10.23 BenefitInsurancePlan

This entity fetches the employee insurance plan details such as plan name, insurance provider, pay component,
coverage option and so on. This entity is available under Create Benefit portlet.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

effectiveStartDate Effective Start Date

id Plan ID

frequency Frequency

planName_en_US Plan Name (en_US locale)

premiumType Premium Type

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitInsurancePlan?$format=json&$top=1

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

386 PUBLIC Global Benefits Objects
Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitInsurancePlan(effectiveStartDate=datetime'2015-03-05T00:00:00',id=2664L)",
"type": "SFOData.BenefitInsurancePlan"
},
"id": "2664",
"effectiveStartDate": "/Date(1425513600000)/",
"planName_pt_BR": null,
"mdfSystemLastModifiedDate": "/Date(1425527952000)/",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "BenefitInsurancePlan",
"planName_es_ES": null,
"mdfSystemVersionId": null,
"planName_ru_RU": null,
"mdfSystemLastModifiedDateWithTZ": "/Date(1425545952000+0000)/",
"lastModifiedDateTime": "/Date(1425545952000+0000)/",
"frequency": null,
"planName_en_US": "Medical Plan A",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "1A93F027A29145E9AAFCE32C7C451741",
"planName_defaultValue": "Medical Plan A",
"mdfSystemEntityId": "B5DCF12B37A1422DA825FBCBD51D0578",
"planName_fr_CA": null,
"mdfSystemStatus": "A",
"planName_ko_KR": null,
"mdfSystemLastModifiedBy": "admin",
"mdfSystemCreatedBy": "admin",
"mdfSystemRecordStatus": "N",
"planName_it_IT": null,
"eligibilityRuleForCoverage": null,
"provider": "2661",
"employeeContribution": "HEALTH",
"planName_en_GB": null,
"planName_fr_FR": null,
"mdfSystemCreatedDate": "/Date(1425525792000)/",
"planName_ja_JP": null,
"planName_zh_CN": null,
"employerContribution": "HEALTH",
"createdBy": "admin",
"planName_de_DE": null,
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1425543792000+0000)/",
"premiumType": "FIXEDPREMIUMAMOUNT",
"planName_nl_NL": null,
"planName_es_MX": null,
"frequencyNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsurancePlan(effectiveStartDate=datetime'2015-03-05T00:00:00',id=2664L)/
frequencyNav"
}
},
"employerContributionNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsurancePlan(effectiveStartDate=datetime'2015-03-05T00:00:00',id=2664L)/
employerContributionNav"
}
},
"premiumTypeNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 387
 "uri": "https://<api-server>/odata/v2/
BenefitInsurancePlan(effectiveStartDate=datetime'2015-03-05T00:00:00',id=2664L)/
premiumTypeNav"
}
},
"providerNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsurancePlan(effectiveStartDate=datetime'2015-03-05T00:00:00',id=2664L)/
providerNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsurancePlan(effectiveStartDate=datetime'2015-03-05T00:00:00',id=2664L)/
mdfSystemRecordStatusNav"
}
},
"employeeContributionNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsurancePlan(effectiveStartDate=datetime'2015-03-05T00:00:00',id=2664L)/
employeeContributionNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsurancePlan(effectiveStartDate=datetime'2015-03-05T00:00:00',id=2664L)/
mdfSystemStatusNav"
}
},
"coverageOptions": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsurancePlan(effectiveStartDate=datetime'2015-03-05T00:00:00',id=2664L)/
coverageOptions"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Global Benefits

10.24 BenefitInsurancePlanEnrollmentDetails

This entity fetches the employee insurance plan enrollment details.

 Note

This API is read-only. To create or edit data, please use imports function.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

388 PUBLIC Global Benefits Objects
Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

BenefitEnrollment_effectiveStartDate Benefit Enrollment Effective From

BenefitEnrollment_id Benefit Enrollment ID

externalCode externalCode

smoking Smoking

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitInsurancePlanEnrollmentDetails?
$format=json&$top=1

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitInsurancePlanEnrollmentDetails(BenefitEnrollment_effectiveStartDate=datetime'
2015-05-26T00:00:00',BenefitEnrollment_id=4413L,externalCode=4414L)",
"type": "SFOData.BenefitInsurancePlanEnrollmentDetails"
},
"BenefitEnrollment_id": "4413",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 389
 "BenefitEnrollment_effectiveStartDate": "/Date(1432598400000)/",
"externalCode": "4414",
"enrolleeOptions": "4346",
"mdfSystemLastModifiedDate": "/Date(1432611313000)/",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "BenefitInsurancePlanEnrollmentDetails",
"mdfSystemVersionId": null,
"mdfSystemLastModifiedDateWithTZ": "/Date(1432625713000+0000)/",
"lastModifiedDateTime": "/Date(1432625713000+0000)/",
"mdfSystemTransactionSequence": "1",
"benefitSalaryAmount": null,
"mdfSystemRecordId": "54E4E9506A884B61B630CDE5CD479F03",
"smoking": null,
"mdfSystemEntityId": "CE79BDBC8C9A4CB5B669C3E38B657C80",
"mdfSystemStatus": "A",
"roundedCoverageAmount": null,
"mdfSystemLastModifiedBy": "pchopra1",
"mdfSystemCreatedBy": "pchopra1",
"mdfSystemRecordStatus": "N",
"provider": "4345",
"employeeContribution": "10",
"mdfSystemCreatedDate": "/Date(1432611313000)/",
"employerContribution": "90",
"plan": "4348",
"createdBy": "pchopra1",
"coverage": "4347",
"lastModifiedBy": "pchopra1",
"createdDateTime": "/Date(1432625713000+0000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"planNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsurancePlanEnrollmentDetails(BenefitEnrollment_effectiveStartDate=datetime'
2015-05-26T00:00:00',BenefitEnrollment_id=4413L,externalCode=4414L)/planNav"
}
},
"enrolleeOptionsNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsurancePlanEnrollmentDetails(BenefitEnrollment_effectiveStartDate=datetime'
2015-05-26T00:00:00',BenefitEnrollment_id=4413L,externalCode=4414L)/
enrolleeOptionsNav"
}
},
"coverageNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsurancePlanEnrollmentDetails(BenefitEnrollment_effectiveStartDate=datetime'
2015-05-26T00:00:00',BenefitEnrollment_id=4413L,externalCode=4414L)/coverageNav"
}
},
"smokingNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsurancePlanEnrollmentDetails(BenefitEnrollment_effectiveStartDate=datetime'
2015-05-26T00:00:00',BenefitEnrollment_id=4413L,externalCode=4414L)/smokingNav"
}
},
"benefitInsuranceDependentDetails": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsurancePlanEnrollmentDetails(BenefitEnrollment_effectiveStartDate=datetime'
2015-05-26T00:00:00',BenefitEnrollment_id=4413L,externalCode=4414L)/
benefitInsuranceDependentDetails"
}
},
"providerNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

390 PUBLIC Global Benefits Objects
 "uri": "https://<api-server>/odata/v2/
BenefitInsurancePlanEnrollmentDetails(BenefitEnrollment_effectiveStartDate=datetime'
2015-05-26T00:00:00',BenefitEnrollment_id=4413L,externalCode=4414L)/providerNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsurancePlanEnrollmentDetails(BenefitEnrollment_effectiveStartDate=datetime'
2015-05-26T00:00:00',BenefitEnrollment_id=4413L,externalCode=4414L)/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsurancePlanEnrollmentDetails(BenefitEnrollment_effectiveStartDate=datetime'
2015-05-26T00:00:00',BenefitEnrollment_id=4413L,externalCode=4414L)/
mdfSystemStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Global Benefits

10.25 BenefitInsurancePlanUSA

This entity contains information about a benefit enrollment record when the insurance plans are subject to COBRA.
This entity is specific to the USA.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 391
Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitInsurancePlan(effectiveStartDate=da
tetime'2017-01-02T00:00:00',id=694L)/
insurancePlanUSA?$format=json

Response

{
"d":{
"results":[
{
"__metadata":{
"uri":"https://<api-server>/odata/v2/
BenefitInsurancePlanUSA(BenefitInsurancePlan_effectiveStartDate=datetime'2017-01-02T
00:00:00',BenefitInsurancePlan_id=694L,externalCode=695L)",
"type":"SFOData.BenefitInsurancePlanUSA"
},
"BenefitInsurancePlan_effectiveStartDate":"\/Date(1483315200000)\/",
"externalCode":"695",
"BenefitInsurancePlan_id":"694",
"enrolleeOptions":"692",
"createdBy":"admin",
"lastModifiedBy":"admin",
"createdDateTime":"\/Date(1490175536000+0000)\/",
"lastModifiedDateTime":"\/Date(1490175713000+0000)\/",
"mdfSystemRecordStatus":"N",
"cobraRelevant":{
"__deferred":{
"uri":"https://<api-server>/odata/v2/
BenefitInsurancePlanUSA(BenefitInsurancePlan_effectiveStartDate=datetime'2017-01-02T
00:00:00',BenefitInsurancePlan_id=694L,externalCode=695L)/cobraRelevant "
},
"mdfSystemRecordStatusNav":{
"__deferred":{
"uri":"https://<api-server>/odata/v2/
BenefitInsurancePlanUSA(BenefitInsurancePlan_effectiveStartDate=datetime'2017-01-02T
00:00:00',BenefitInsurancePlan_id=694L,externalCode=695L)/mdfSystemRecordStatusNav"
}
}
}
]
}
}

Additional Information

● To be able to query this entity, BenefitInsurancePlan entity as of 1705 API version and above is available; this
version contains the prerequisite country field and the nav insurancePlanUSA.
● BenefitInsurancePlanUSA is a composite entity and queried via BenefitInsurancePlan.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

392 PUBLIC Global Benefits Objects
 ● Entity is visible on the UI when USA is the country selected.
● BenefitInsurancePlanUSA has a Boolean field cobraRelevant to designate an insurance plan as COBRA-
relevant

Related Information

SAP API Business Hub: Global Benefits

10.26 BenefitInsuranceDependentDetail

This entity fetches the employee’s insurance dependent details such as dependent option and dependent type.
This entity is available under Insurance Plan portlet.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

BenefitEnrollment_effectiveStartDate Benefit Enrollment Effective From

BenefitEnrollment_id Benefit Enrollment ID

BenefitInsurancePlanEnrollmentDetails_exte Insurance Plan Enrollment Details externalCode

rnalCode

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 393
Property Description

dependentName Dependent Name

Use Case:

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitInsuranceDependentDetail?
$format=json&$top=1

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceDependentDetail(BenefitEnrollment_effectiveStartDate=datetime'2016-0
1-01T00:00:00',BenefitEnrollment_id=4441L,BenefitInsurancePlanEnrollmentDetails_exte
rnalCode=4442L,dependentName='4240')",
"type": "SFOData.BenefitInsuranceDependentDetail"
},
"dependentName": "4240",
"BenefitInsurancePlanEnrollmentDetails_externalCode": "4442",
"BenefitEnrollment_id": "4441",
"BenefitEnrollment_effectiveStartDate": "/Date(1451606400000)/",
"dateOfBirth": null,
"mdfSystemLastModifiedDate": "/Date(1447579447000)/",
"mdfSystemObjectType": "BenefitInsuranceDependentDetail",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"mdfSystemLastModifiedDateWithTZ": "/Date(1447597447000+0000)/",
"lastModifiedDateTime": "/Date(1447597447000+0000)/",
"mdfSystemCreatedDate": "/Date(1447579447000)/",
"mdfSystemTransactionSequence": "1",
"relationShipType": "2",
"mdfSystemRecordId": "0D5116710D4B4CFA8A19B8E714CE1EAA",
"createdBy": "v4admin",
"mdfSystemEntityId": "68C3D2FA452544D39BECF9786C95F740",
"createdDateTime": "/Date(1447597447000+0000)/",
"lastModifiedBy": "v4admin",
"mdfSystemStatus": "A",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"mdfSystemLastModifiedBy": "v4admin",
"mdfSystemRecordStatus": "N",
"mdfSystemCreatedBy": "v4admin",
"relationShipTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceDependentDetail(BenefitEnrollment_effectiveStartDate=datetime'2016-0
1-01T00:00:00',BenefitEnrollment_id=4441L,BenefitInsurancePlanEnrollmentDetails_exte
rnalCode=4442L,dependentName='4240')/relationShipTypeNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

394 PUBLIC Global Benefits Objects
 }
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceDependentDetail(BenefitEnrollment_effectiveStartDate=datetime'2016-0
1-01T00:00:00',BenefitEnrollment_id=4441L,BenefitInsurancePlanEnrollmentDetails_exte
rnalCode=4442L,dependentName='4240')/mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceDependentDetail(BenefitEnrollment_effectiveStartDate=datetime'2016-0
1-01T00:00:00',BenefitEnrollment_id=4441L,BenefitInsurancePlanEnrollmentDetails_exte
rnalCode=4442L,dependentName='4240')/mdfSystemStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Global Benefits

10.27 BenefitInsuranceCoverage

This entity fetches the employee insurance coverage such as coverage name and type. This entity is available under
Insurance Plan portlet.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 395
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

coverageid Coverage ID

amount Amount

coverageName_en_US Coverage Name (en_US locale)

coverageType Coverage Type

factor Factor

percentage Percentage

Use Case: Query the Benefit Insurance Coverage of an Employee

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitInsuranceCoverage(2663L)?
$format=json&$top=1

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceCoverage(2663L)",
"type": "SFOData.BenefitInsuranceCoverage"
},
"coverageId": "2663",
"mdfSystemLastModifiedDate": "/Date(1443075312000)/",
"mdfSystemObjectType": "BenefitInsuranceCoverage",
"mdfSystemLastModifiedDateWithTZ": "/Date(1443089712000+0000)/",
"lastModifiedDateTime": "/Date(1443089712000+0000)/",
"coverageLevel": "Wordlwide Cover incl. Winter",
"amount": "15000",
"coverageName_nl_NL": null,
"mdfSystemRecordId": "B239102F458F42BCAB96F2C0D3D6234B",
"mdfSystemEntityId": "1BEB3323C16E4D7E91D8EEA976E27913",
"mdfSystemStatus": "A",
"coverageName_defaultValue": "Annual",
"coverageName_ja_JP": null,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

396 PUBLIC Global Benefits Objects
 "mdfSystemLastModifiedBy": "admin",
"coverageName_es_ES": null,
"mdfSystemRecordStatus": "N",
"coverageName_fr_FR": null,
"benefitSalaryCalculationRule": null,
"minimumCoverageAmount": null,
"coverageName_en_GB": null,
"coverageName_ko_KR": null,
"mdfSystemCreatedDate": "/Date(1425525775000)/",
"createdBy": "admin",
"maximumCoverageAmount": null,
"createdDateTime": "/Date(1425543775000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"basePayComponentGroup": null,
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"coverageName_it_IT": null,
"coverageName_zh_CN": null,
"coverageName_en_US": "Health Advanced",
"mdfSystemTransactionSequence": "1",
"coverageName_de_DE": null,
"coverageName_pt_BR": null,
"benefitSalaryAmount": null,
"paycomponent": null,
"coverageName_fr_CA": null,
"coverageRoundingRule": null,
"roundedCoverageAmount": null,
"mdfSystemCreatedBy": "admin",
"coverageName_es_MX": null,
"coverageName_ru_RU": null,
"percentage": null,
"factor": null,
"coverageType": "AMOUNT",
"paycomponentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceCoverage(2663L)/paycomponentNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceCoverage(2663L)/mdfSystemStatusNav"
}
},
"basePayComponentGroupNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceCoverage(2663L)/basePayComponentGroupNav"
}
},
"coverageTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceCoverage(2663L)/coverageTypeNav"
}
},
"coverageLevelNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceCoverage(2663L)/coverageLevelNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceCoverage(2663L)/mdfSystemRecordStatusNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 397
 }
},
"toCoverageDetails": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceCoverage(2663L)/toCoverageDetails"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Global Benefits

10.28 BenefitInsuranceProvider

This entity fetches the e insurance provider details. This entity is available under Insurance Plan portlet

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

providerId Provider ID

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

398 PUBLIC Global Benefits Objects
 Property Description

providerName Provider Name

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitInsuranceProvider?$format=json&
$top=1

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceProvider(2661L)",
"type": "SFOData.BenefitInsuranceProvider"
},
"providerId": "2661",
"mdfSystemLastModifiedDate": "/Date(1425525515000)/",
"contactPhone": "+4487989000982",
"mdfSystemObjectType": "BenefitInsuranceProvider",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"contactEmail": "[email protected]",
"mdfSystemLastModifiedDateWithTZ": "/Date(1425543515000+0000)/",
"lastModifiedDateTime": "/Date(1425543515000+0000)/",
"mdfSystemCreatedDate": "/Date(1425525504000)/",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "43201A09918840F1B87D878FF128F94A",
"createdBy": "admin",
"providerName": "AIG",
"mdfSystemEntityId": "777611AD2B674B528C32082B9705AAA0",
"createdDateTime": "/Date(1425543504000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"mdfSystemLastModifiedBy": "admin",
"contactPerson": "Jaison",
"mdfSystemRecordStatus": "N",
"mdfSystemCreatedBy": "admin",
"usefulLinks": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceProvider(2661L)/usefulLinks"
}
},
"policyDocuments": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 399
 "uri": "https://<api-server>/odata/v2/
BenefitInsuranceProvider(2661L)/policyDocuments"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceProvider(2661L)/mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceProvider(2661L)/mdfSystemStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Global Benefits

10.29 BenefitInsuranceEnrolleeOptions

This entity fetches the employee enrollee options such as enrollee option name and dependent option. This entity
is available under Insurance Plan portlet.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

400 PUBLIC Global Benefits Objects
Properties

Property Description

id Enrollee Options ID

enrolleeOptionsName Enrollee Options Name

Use Case:

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitInsuranceEnrolleeOptions?
$format=json&$top=1

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceEnrolleeOptions(2662L)",
"type": "SFOData.BenefitInsuranceEnrolleeOptions"
},
"id": "2662",
"mdfSystemLastModifiedDate": "\/Date(1425525745000)\/",
"mdfSystemObjectType": "BenefitInsuranceEnrolleeOptions",
"mdfSystemEffectiveEndDate": "\/Date(253402214400000)\/",
"mdfSystemVersionId": null,
"enrolleeOptionsName": "Self+Family",
"mdfSystemLastModifiedDateWithTZ": "\/Date(1425543745000+0000)\/",
"lastModifiedDateTime": "\/Date(1425543745000+0000)\/",
"mdfSystemCreatedDate": "\/Date(1425525745000)\/",
"mdfSystemTransactionSequence": "1",
"dependentOption": "Self+Family",
"mdfSystemRecordId": "982370C227EC4F30857B4E75EE06E4C1",
"createdBy": "admin",
"mdfSystemEntityId": "C13F8D8D493D4207B714C69E6BB7F2DF",
"createdDateTime": "\/Date(1425543745000+0000)\/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"mdfSystemEffectiveStartDate": "\/Date(-2208988800000)\/",
"mdfSystemLastModifiedBy": "admin",
"mdfSystemRecordStatus": "N",
"mdfSystemCreatedBy": "admin",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceEnrolleeOptions(2662L)/mdfSystemRecordStatusNav"
}
},
"enrolleType": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 401
 "__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceEnrolleeOptions(2662L)/enrolleType"
}
},
"dependentOptionNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceEnrolleeOptions(2662L)/dependentOptionNav"
}
},
"toCoverageOptions": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceEnrolleeOptions(2662L)/toCoverageOptions"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceEnrolleeOptions(2662L)/mdfSystemStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Global Benefits

10.30 BenefitInsuranceRateChart

This entity fetches the rate chart details such as employee’s age, Insurance plan, factor, flat amount and per
dependent. This entity is available under Insurance Plan portlet.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

402 PUBLIC Global Benefits Objects
Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

effectiveStartDate Effective Start Date

rateChartId Rate Chart ID

factor Factor

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitInsuranceRateChart?$format=json&
$top=1

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceRateChart(effectiveStartDate=datetime'2015-04-28T00:00:00',rateChart
Id='C20')",
"type": "SFOData.BenefitInsuranceRateChart"
},
"effectiveStartDate": "\/Date(1430179200000)\/",
"rateChartId": "C20",
"insurancePlan": "3943",
"mdfSystemLastModifiedDate": "\/Date(1438848870000)\/",
"mdfSystemObjectType": "BenefitInsuranceRateChart",
"mdfSystemEffectiveEndDate": "\/Date(253402214400000)\/",
"mdfSystemVersionId": null,
"mdfSystemLastModifiedDateWithTZ": "\/Date(1438863270000+0000)\/",
"lastModifiedDateTime": "\/Date(1438863270000+0000)\/",
"mdfSystemTransactionSequence": "1",
"currency": "BRL",
"mdfSystemRecordId": "174CBED54BCF48818B758CD287B3589B",
"ageAsOfYear": null,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 403
 "mdfSystemEntityId": "85F93890789240C2B49E905AC99727C4",
"mdfSystemStatus": "A",
"mdfSystemLastModifiedBy": "admin",
"mdfSystemRecordStatus": "N",
"ageAsOfMonth": null,
"mdfSystemCreatedBy": "admin",
"provider": "3083",
"factor": "-1",
"mdfSystemCreatedDate": "\/Date(1430231715000)\/",
"createdBy": "admin",
"coverage": "5789",
"createdDateTime": "\/Date(1430246115000+0000)\/",
"ageAsOfDay": null,
"lastModifiedBy": "admin",
"coverageNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceRateChart(effectiveStartDate=datetime'2015-04-28T00:00:00',rateChart
Id='C20')/coverageNav"
}
},
"rateChartEnrollee": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceRateChart(effectiveStartDate=datetime'2015-04-28T00:00:00',rateChart
Id='C20')/rateChartEnrollee"
}
},
"ageAsOfMonthNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceRateChart(effectiveStartDate=datetime'2015-04-28T00:00:00',rateChart
Id='C20')/ageAsOfMonthNav"
}
},
"rateChartFixedAmount": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceRateChart(effectiveStartDate=datetime'2015-04-28T00:00:00',rateChart
Id='C20')/rateChartFixedAmount"
}
},
"currencyNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceRateChart(effectiveStartDate=datetime'2015-04-28T00:00:00',rateChart
Id='C20')/currencyNav"
}
},
"ageAsOfYearNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceRateChart(effectiveStartDate=datetime'2015-04-28T00:00:00',rateChart
Id='C20')/ageAsOfYearNav"
}
},
"ageAsOfDayNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceRateChart(effectiveStartDate=datetime'2015-04-28T00:00:00',rateChart
Id='C20')/ageAsOfDayNav"
}
},
"insurancePlanNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceRateChart(effectiveStartDate=datetime'2015-04-28T00:00:00',rateChart
Id='C20')/insurancePlanNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

404 PUBLIC Global Benefits Objects
 }
},
"providerNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceRateChart(effectiveStartDate=datetime'2015-04-28T00:00:00',rateChart
Id='C20')/providerNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceRateChart(effectiveStartDate=datetime'2015-04-28T00:00:00',rateChart
Id='C20')/mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceRateChart(effectiveStartDate=datetime'2015-04-28T00:00:00',rateChart
Id='C20')/mdfSystemStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Global Benefits

10.31 BenefitInsuranceRateChartEnrollee

This entity fetches the enrollee rate chart details. This entity is available under Insurance Rate Chart portlet.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 405
Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

BenefitInsuranceRateChart_effectiveStartDa Insurance Rate Chart_Effective Start Date

te

BenefitInsuranceRateChart_rateChartId Insurance Rate Chart_Rate Chart ID

externalCode externalCode

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitInsuranceRateChartEnrollee?
$format=json&$top=1

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceRateChartEnrollee(BenefitInsuranceRateChart_effectiveStartDate=datet
ime'2015-03-05T00:00:00',BenefitInsuranceRateChart_rateChartId='Medical Plan
A',externalCode=2668L)",
"type": "SFOData.BenefitInsuranceRateChartEnrollee"
},
"BenefitInsuranceRateChart_rateChartId": "Medical Plan A",
"BenefitInsuranceRateChart_effectiveStartDate": "\/
Date(1425513600000)\/",
"externalCode": "2668",
"ageTo": "60",
"mdfSystemLastModifiedDate": "\/Date(1425526156000)\/",
"mdfSystemEffectiveEndDate": "\/Date(253402214400000)\/",
"mdfSystemObjectType": "BenefitInsuranceRateChartEnrollee",
"mdfSystemVersionId": null,
"mdfSystemLastModifiedDateWithTZ": "\/Date(1425544156000+0000)\/",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

406 PUBLIC Global Benefits Objects
 "lastModifiedDateTime": "\/Date(1425544156000+0000)\/",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "D6076F81CBB5405794DC71B639ADB04F",
"mdfSystemEntityId": "F36C85DBD840482EA084AF17FE6DD8CF",
"mdfSystemStatus": "A",
"benefitInsuranceEnrolleeType": "2",
"mdfSystemLastModifiedBy": "admin",
"mdfSystemCreatedBy": "admin",
"mdfSystemRecordStatus": "N",
"employeeContribution": "100",
"mdfSystemCreatedDate": "\/Date(1425526156000)\/",
"employerContribution": "100",
"createdBy": "admin",
"ageFrom": "10",
"lastModifiedBy": "admin",
"createdDateTime": "\/Date(1425544156000+0000)\/",
"mdfSystemEffectiveStartDate": "\/Date(-2208988800000)\/",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceRateChartEnrollee(BenefitInsuranceRateChart_effectiveStartDate=datet
ime'2015-03-05T00:00:00',BenefitInsuranceRateChart_rateChartId='Medical Plan
A',externalCode=2668L)/mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceRateChartEnrollee(BenefitInsuranceRateChart_effectiveStartDate=datet
ime'2015-03-05T00:00:00',BenefitInsuranceRateChart_rateChartId='Medical Plan
A',externalCode=2668L)/mdfSystemStatusNav"
}
},
"benefitInsuranceEnrolleeTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceRateChartEnrollee(BenefitInsuranceRateChart_effectiveStartDate=datet
ime'2015-03-05T00:00:00',BenefitInsuranceRateChart_rateChartId='Medical Plan
A',externalCode=2668L)/benefitInsuranceEnrolleeTypeNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Global Benefits

10.32 BenefitInsuranceRateChartFixedAmount
This entity fetches the insurance rate chart with fixed amount.

 Note

This API is read-only. To create or edit data, please use imports function.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 407
Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

BenefitInsuranceRateChart_effectiveStartDa Insurance Rate Chart_Effective Start Date

te

BenefitInsuranceRateChart_rateChartId Insurance Rate Chart_Rate Chart ID

externalCode externalCode

rateChartType Rate Chart Type

smoking Smoking

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitInsuranceRateChartFixedAmount?
$format=json&$top=1

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceRateChartFixedAmount(BenefitInsuranceRateChart_effectiveStartDate=da
tetime'2015-03-05T00:00:00',BenefitInsuranceRateChart_rateChartId='Medical Plan
A',externalCode=2667L)",
"type": "SFOData.BenefitInsuranceRateChartFixedAmount"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

408 PUBLIC Global Benefits Objects
 },
"BenefitInsuranceRateChart_rateChartId": "Medical Plan A",
"BenefitInsuranceRateChart_effectiveStartDate": "\/
Date(1425513600000)\/",
"externalCode": "2667",
"ageTo": "60",
"mdfSystemLastModifiedDate": "\/Date(1425526156000)\/",
"mdfSystemEffectiveEndDate": "\/Date(253402214400000)\/",
"mdfSystemObjectType": "BenefitInsuranceRateChartFixedAmount",
"mdfSystemVersionId": null,
"location": null,
"mdfSystemLastModifiedDateWithTZ": "\/Date(1425544156000+0000)\/",
"lastModifiedDateTime": "\/Date(1425544156000+0000)\/",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "990EAA7F864E4EAC9D135CA3811A5990",
"smoking": "3471442",
"mdfSystemEntityId": "56375B21AC724204ABD2B5D253811032",
"mdfSystemStatus": "A",
"mdfSystemLastModifiedBy": "admin",
"enrolleeOption": "2662",
"mdfSystemCreatedBy": "admin",
"mdfSystemRecordStatus": "N",
"employeeContribution": "200",
"mdfSystemCreatedDate": "\/Date(1425526156000)\/",
"rateChartType": "REGULAR",
"employerContribution": "100",
"createdBy": "admin",
"ageFrom": "10",
"lastModifiedBy": "admin",
"createdDateTime": "\/Date(1425544156000+0000)\/",
"mdfSystemEffectiveStartDate": "\/Date(-2208988800000)\/",
"enrolleeOptionNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceRateChartFixedAmount(BenefitInsuranceRateChart_effectiveStartDate=da
tetime'2015-03-05T00:00:00',BenefitInsuranceRateChart_rateChartId='Medical Plan
A',externalCode=2667L)/enrolleeOptionNav"
}
},
"rateChartTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceRateChartFixedAmount(BenefitInsuranceRateChart_effectiveStartDate=da
tetime'2015-03-05T00:00:00',BenefitInsuranceRateChart_rateChartId='Medical Plan
A',externalCode=2667L)/rateChartTypeNav"
}
},
"smokingNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceRateChartFixedAmount(BenefitInsuranceRateChart_effectiveStartDate=da
tetime'2015-03-05T00:00:00',BenefitInsuranceRateChart_rateChartId='Medical Plan
A',externalCode=2667L)/smokingNav"
}
},
"locationNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceRateChartFixedAmount(BenefitInsuranceRateChart_effectiveStartDate=da
tetime'2015-03-05T00:00:00',BenefitInsuranceRateChart_rateChartId='Medical Plan
A',externalCode=2667L)/locationNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceRateChartFixedAmount(BenefitInsuranceRateChart_effectiveStartDate=da

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 409
 tetime'2015-03-05T00:00:00',BenefitInsuranceRateChart_rateChartId='Medical Plan
A',externalCode=2667L)/mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceRateChartFixedAmount(BenefitInsuranceRateChart_effectiveStartDate=da
tetime'2015-03-05T00:00:00',BenefitInsuranceRateChart_rateChartId='Medical Plan
A',externalCode=2667L)/mdfSystemStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Global Benefits

10.33 BenefitInsuranceCoverageOptions

This entity fetches the employee’s insurance coverage options such coverage details and enrollment for details.
Coverage Details consists of coverage and rate chart information. Enrollment For consists of enrollee option name,
dependent option and dependent type. This entity is available under Insurance Plan portlet.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

410 PUBLIC Global Benefits Objects
Properties

Property Description

BenefitInsurancePlan_effectiveStartDate Insurance Plan_mdfSystemEffectiveStartDate

BenefitInsurancePlan_id Insurance Plan_Plan ID

externalCode externalCode

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitInsuranceCoverageOptions?
$format=json&$top=1

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceCoverageOptions(BenefitInsurancePlan_effectiveStartDate=datetime'201
5-03-05T00:00:00',BenefitInsurancePlan_id=2664L,externalCode=2665L)",
"type": "SFOData.BenefitInsuranceCoverageOptions"
},
"BenefitInsurancePlan_effectiveStartDate": "\/
Date(1425513600000)\/",
"externalCode": "2665",
"BenefitInsurancePlan_id": "2664",
"mdfSystemLastModifiedDate": "\/Date(1425527952000)\/",
"enrolleeOptions": "2662",
"mdfSystemObjectType": "BenefitInsuranceCoverageOptions",
"mdfSystemEffectiveEndDate": "\/Date(253402214400000)\/",
"mdfSystemVersionId": null,
"mdfSystemLastModifiedDateWithTZ": "\/Date(1425545952000+0000)\/",
"lastModifiedDateTime": "\/Date(1425545952000+0000)\/",
"mdfSystemCreatedDate": "\/Date(1425525792000)\/",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "29309129560944A69F1786D1A6EA5270",
"createdBy": "admin",
"mdfSystemEntityId": "FD498B65E0C44131969392EF503E5D42",
"createdDateTime": "\/Date(1425543792000+0000)\/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"mdfSystemEffectiveStartDate": "\/Date(-2208988800000)\/",
"mdfSystemLastModifiedBy": "admin",
"mdfSystemRecordStatus": "N",
"mdfSystemCreatedBy": "admin",
"enrolleeOptionsNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 411
 "uri": "https://<api-server>/odata/v2/
BenefitInsuranceCoverageOptions(BenefitInsurancePlan_effectiveStartDate=datetime'201
5-03-05T00:00:00',BenefitInsurancePlan_id=2664L,externalCode=2665L)/
enrolleeOptionsNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceCoverageOptions(BenefitInsurancePlan_effectiveStartDate=datetime'201
5-03-05T00:00:00',BenefitInsurancePlan_id=2664L,externalCode=2665L)/
mdfSystemRecordStatusNav"
}
},
"coverageDetails": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceCoverageOptions(BenefitInsurancePlan_effectiveStartDate=datetime'201
5-03-05T00:00:00',BenefitInsurancePlan_id=2664L,externalCode=2665L)/coverageDetails"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceCoverageOptions(BenefitInsurancePlan_effectiveStartDate=datetime'201
5-03-05T00:00:00',BenefitInsurancePlan_id=2664L,externalCode=2665L)/
mdfSystemStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Global Benefits

10.34 BenefitInsuranceCoverageDetails

This entity fetches the employee insurance coverage details such as coverage and rate chart. This entity is available
under Insurance Plan portlet.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

412 PUBLIC Global Benefits Objects
Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

mdfSystemEffectiveStartDate Effective Start Date

BenefitInsuranceCoverageOptions_externalCo Insurance Coverage Options_externalCode

de

BenefitInsurancePlan_effectiveStartDate Insurance Plan_mdfSystemEffectiveStartDate

BenefitInsurancePlan_id Insurance Plan_Plan ID

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitInsuranceCoverageDetails?
$format=json&$top=1

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceCoverageDetails(BenefitInsuranceCoverageOptions_externalCode=2665L,B
enefitInsurancePlan_effectiveStartDate=datetime'2015-03-05T00:00:00',BenefitInsuranc
ePlan_id=2664L,externalCode=2666L)",
"type": "SFOData.BenefitInsuranceCoverageDetails"
},
"BenefitInsuranceCoverageOptions_externalCode": "2665",
"BenefitInsurancePlan_effectiveStartDate": "\/
Date(1425513600000)\/",
"externalCode": "2666",
"BenefitInsurancePlan_id": "2664",
"mdfSystemLastModifiedDate": "\/Date(1425527952000)\/",
"mdfSystemEffectiveEndDate": "\/Date(253402214400000)\/",
"mdfSystemObjectType": "BenefitInsuranceCoverageDetails",
"mdfSystemVersionId": null,
"mdfSystemLastModifiedDateWithTZ": "\/Date(1425545952000+0000)\/",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 413
 "lastModifiedDateTime": "\/Date(1425545952000+0000)\/",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "B4374BBE39924F35994FD5C11AE18518",
"mdfSystemEntityId": "9D28F1DE86324A898DF8690759032B9F",
"mdfSystemStatus": "A",
"mdfSystemLastModifiedBy": "admin",
"mdfSystemCreatedBy": "admin",
"mdfSystemRecordStatus": "N",
"mdfSystemCreatedDate": "\/Date(1425525792000)\/",
"createdBy": "admin",
"coverage": "2663",
"lastModifiedBy": "admin",
"createdDateTime": "\/Date(1425543792000+0000)\/",
"rateChart": "Medical Plan A",
"mdfSystemEffectiveStartDate": "\/Date(-2208988800000)\/",
"coverageNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceCoverageDetails(BenefitInsuranceCoverageOptions_externalCode=2665L,B
enefitInsurancePlan_effectiveStartDate=datetime'2015-03-05T00:00:00',BenefitInsuranc
ePlan_id=2664L,externalCode=2666L)/coverageNav"
}
},
"rateChartNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceCoverageDetails(BenefitInsuranceCoverageOptions_externalCode=2665L,B
enefitInsurancePlan_effectiveStartDate=datetime'2015-03-05T00:00:00',BenefitInsuranc
ePlan_id=2664L,externalCode=2666L)/rateChartNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceCoverageDetails(BenefitInsuranceCoverageOptions_externalCode=2665L,B
enefitInsurancePlan_effectiveStartDate=datetime'2015-03-05T00:00:00',BenefitInsuranc
ePlan_id=2664L,externalCode=2666L)/mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceCoverageDetails(BenefitInsuranceCoverageOptions_externalCode=2665L,B
enefitInsurancePlan_effectiveStartDate=datetime'2015-03-05T00:00:00',BenefitInsuranc
ePlan_id=2664L,externalCode=2666L)/mdfSystemStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Global Benefits

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

414 PUBLIC Global Benefits Objects
10.35 BenefitInsuranceEnrolleeType

This entity fetches the employee insurance enrollee type details such as self, self+family, self+spouse. This entity is
available under Insurance Plan portlet.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

mdfSystemEffectiveStartDate Effective Start Date

relationShipType Relationship Type

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitInsuranceEnrolleeType?$format=json&
$top=1

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 415
Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceEnrolleeType(mdfSystemEffectiveStartDate=datetime'1900-01-01T00:00:0
0',relationShipType='2')",
"type": "SFOData.BenefitInsuranceEnrolleeType"
},
"relationShipType": "2",
"mdfSystemEffectiveStartDate": "\/Date(-2208988800000)\/",
"mdfSystemLastModifiedDate": "\/Date(1425525722000)\/",
"mdfSystemEffectiveEndDate": "\/Date(253402214400000)\/",
"mdfSystemObjectType": "BenefitInsuranceEnrolleeType",
"mdfSystemVersionId": null,
"mdfSystemLastModifiedDateWithTZ": "\/Date(1425543722000+0000)\/",
"lastModifiedDateTime": "\/Date(1425543722000+0000)\/",
"mdfSystemCreatedDate": "\/Date(1425525722000)\/",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "8B742C5C791745FEAB0481E464E48CEB",
"createdBy": "admin",
"mdfSystemEntityId": "432103DBE8B64354A41EE26776B00996",
"createdDateTime": "\/Date(1425543722000+0000)\/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"mdfSystemLastModifiedBy": "admin",
"mdfSystemRecordStatus": "N",
"mdfSystemCreatedBy": "admin",
"relationShipTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceEnrolleeType(mdfSystemEffectiveStartDate=datetime'1900-01-01T00:00:0
0',relationShipType='2')/relationShipTypeNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceEnrolleeType(mdfSystemEffectiveStartDate=datetime'1900-01-01T00:00:0
0',relationShipType='2')/mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitInsuranceEnrolleeType(mdfSystemEffectiveStartDate=datetime'1900-01-01T00:00:0
0',relationShipType='2')/mdfSystemStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Global Benefits

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

416 PUBLIC Global Benefits Objects
10.36 BenefitOverviewHyperlinkConfiguration

This object is used to capture the Benefit Hyperlink Configuration to display hyperlinks on the Benefits Overview
page. It contains hyperlink configuration Id, hyperlink configuration name, and hyperlink configuration details.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitOverviewHyperlinkConfiguration?
$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitOverviewHyperlinkConfiguration",
"type": "SFOData. BenefitOverviewHyperlinkConfiguration "
},
"hyperlinkConfigurationId": "Benefits Hyperlink Configuration",
"hyperlinkConfigurationName": "Hyperlink Configuration",
"benefitOverviewHyperlinkDetails": "benefitHyperlinkDetailsList",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1496123038000+0000)/",
"lastModifiedDateTime": "/Date(1496123038000+0000)/",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitOverviewHyperlinkConfiguration(/mdfSystemRecordStatusNav"
}
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 417
 ]
}
}

10.37 BenefitOverviewHyperlinkDetails

This Object is used to capture the Label, URL and the Eligibility rule for the Hyperlinks. The hyperlinks configured
will be displayed on the Benefits Overview page

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitOverviewHyperlinkDetails/
$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/BenefitOverviewHyperlinkDetails",
"type": "SFOData.BenefitOverviewHyperlinkDetails"
},
"url": "https://www.website.com",
"label": "Website",
"eligibilityRule": "rule",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1496123038000+0000)/",
"lastModifiedDateTime": "/Date(1496123038000+0000)/",
"mdfSystemRecordStatus": "N",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

418 PUBLIC Global Benefits Objects
 "mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/BenefitOverviewHyperlinkDetails(/
mdfSystemRecordStatusNav"
}
}
}
]
}
}

10.38 BenefitProgramEnrollment

This entity contains the list of all of the benefit programs for which an employee is eligible.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

benefitProgramDataSourceWithExternalCode The list of all benefit programs for which employee is eligible.

effectiveStartDate The start date from which program enrollment is effective.

effectiveEndDate The end date after which program enrollment is no longer ac­
tive.

programAmount The total amount for program enrollment.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 419
Property Description

programEntitlementAmount The amount that employee is entitled to receive.

Navigation Properties

Navigation Property Related Entity Description

BenefitProgramEnrollment BenefitProgramEnrollmentDetail This field contains the information for

benefit program enrollment.

Use Case: Get the list of all the program enrollments for which the employee is
eligible

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/BenefitProgramEnrollment

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitProgramEnrollment(effectiveStartDate=datetime'2019-01-01T00:00:00',id=278687L
)",
"type": "SFOData.BenefitProgramEnrollment"
},
"effectiveStartDate": "/Date(1546300800000)/",
"id": "278687",
"effectiveEndDate": "/Date(253402214400000)/",
"exception": null,
"benefitProgramDataSourceWithExternalCode": "11",
"mdfSystemLastModifiedDateWithTZ": "/Date(1540188096000+0000)/",
"lastModifiedDateTime": "/Date(1540188096000+0000)/",
"mdfSystemCreatedBy": "sriadmin",
"enrollmentDate": "/Date(1540166400000)/",
"createdDateTime": "/Date(1540188096000+0000)/",
"mdfSystemVersionId": null,
"mdfSystemLastModifiedBy": "sriadmin",
"externalName": "SF_AUS_3_RR_1811_Benefit_Program_10222018_060136",
"mdfSystemEntityId": "8F782F4A31394AC08A62303C3B808CCD",
"benefitProgram": "11",
"mdfSystemObjectType": "BenefitProgramEnrollment",
"workerId": "SF_AUS_3",
"mdfSystemLastModifiedDate": "/Date(1540188096000)/",
"lastModifiedBy": "sriadmin",
"programEntitlementAmount": "100",
"programAmount": "1",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

420 PUBLIC Global Benefits Objects
 "effectiveStatus": "I",
"mdfSystemTransactionSequence": "1",
"recordStatus": "N",
"createdBy": "sriadmin",
"programCurrency": "INR",
"mdfSystemCreatedDate": "/Date(1540188096000)/",
"mdfSystemRecordId": "57787C29902D49A69D5DC964FF459A6C",
"benefitProgramDataSource": null,
"programCurrencyNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgramEnrollment(effectiveStartDate=datetime'2019-01-01T00:00:00',id=278687L
)/programCurrencyNav"
}
},
"policyDocuments": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgramEnrollment(effectiveStartDate=datetime'2019-01-01T00:00:00',id=278687L
)/policyDocuments"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgramEnrollment(effectiveStartDate=datetime'2019-01-01T00:00:00',id=278687L
)/createdByNav"
}
},
"exceptionNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgramEnrollment(effectiveStartDate=datetime'2019-01-01T00:00:00',id=278687L
)/exceptionNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgramEnrollment(effectiveStartDate=datetime'2019-01-01T00:00:00',id=278687L
)/lastModifiedByNav"
}
},
"usefulLinks": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgramEnrollment(effectiveStartDate=datetime'2019-01-01T00:00:00',id=278687L
)/usefulLinks"
}
},
"workerIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgramEnrollment(effectiveStartDate=datetime'2019-01-01T00:00:00',id=278687L
)/workerIdNav"
}
},
"benefitProgramNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgramEnrollment(effectiveStartDate=datetime'2019-01-01T00:00:00',id=278687L
)/benefitProgramNav"
}
},
"effectiveStatusNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 421
 "uri": "https://<api-server>/odata/v2/
BenefitProgramEnrollment(effectiveStartDate=datetime'2019-01-01T00:00:00',id=278687L
)/effectiveStatusNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgramEnrollment(effectiveStartDate=datetime'2019-01-01T00:00:00',id=278687L
)/wfRequestNav"
}
},
"benefitProgramEnrollmentDetail": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgramEnrollment(effectiveStartDate=datetime'2019-01-01T00:00:00',id=278687L
)/benefitProgramEnrollmentDetail"
}
},
"recordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgramEnrollment(effectiveStartDate=datetime'2019-01-01T00:00:00',id=278687L
)/recordStatusNav"
}
},
"forms": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgramEnrollment(effectiveStartDate=datetime'2019-01-01T00:00:00',id=278687L
)/forms"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Global Benefits

10.39 BenefitProgram

This entity is a bucket or pool that contains more than one benefit.

 Note

This API is read-only. To create or edit data, please use imports function.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

422 PUBLIC Global Benefits Objects
Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

programName The name of the program.

effectiveStartDate The program start date.

amount The cost of the program.

programEnrollmentWorkflowId The enrollment workflow ID for the program.

Navigation Properties

Navigation Property Related Entity Description

BenefitProgram benefits Benefits associated to the program.

BenefitProgram policyDocuments Policy documents for the program.

BenefitProgram forms Forms related to the program.

BenefitProgram usefulLinks Links associated to the program.

Use Case: get the list of all benefit programs in the system

Request

Operation Query

HTTP Method GET

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 423
URI https://<api-server>/odata/v2/BenefitProgram

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitProgram(effectiveStartDate=datetime'2021-01-01T00:00:00',programId='BP2111')"
,
"type": "SFOData.BenefitProgram"
},
"effectiveStartDate": "/Date(1609459200000)/",
"programId": "BP2111",
"lastModifiedDateTime": "/Date(1630392380000+0000)/",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"createdDateTime": "/Date(1630390725000+0000)/",
"programName": "BP2111",
"currency": "USD",
"exceptionWorkflowId": null,
"multipleSelectionAllowed": false,
"programSchedule": "9999",
"amount": null,
"lastModifiedBy": "sriadmin",
"eligibilityRuleId": null,
"mdfSystemRecordStatus": "N",
"supressClientDateValidation": false,
"programEnrollmentWorkflowId": null,
"createdBy": "sriadmin",
"status": null,
"benefits": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgram(effectiveStartDate=datetime'2021-01-01T00:00:00',programId='BP2111')/
benefits"
}
},
"programEnrollmentWorkflowIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgram(effectiveStartDate=datetime'2021-01-01T00:00:00',programId='BP2111')/
programEnrollmentWorkflowIdNav"
}
},
"policyDocuments": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgram(effectiveStartDate=datetime'2021-01-01T00:00:00',programId='BP2111')/
policyDocuments"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgram(effectiveStartDate=datetime'2021-01-01T00:00:00',programId='BP2111')/
createdByNav"
}
},
"statusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgram(effectiveStartDate=datetime'2021-01-01T00:00:00',programId='BP2111')/
statusNav"
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

424 PUBLIC Global Benefits Objects
 },
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgram(effectiveStartDate=datetime'2021-01-01T00:00:00',programId='BP2111')/
lastModifiedByNav"
}
},
"programScheduleNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgram(effectiveStartDate=datetime'2021-01-01T00:00:00',programId='BP2111')/
programScheduleNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgram(effectiveStartDate=datetime'2021-01-01T00:00:00',programId='BP2111')/
mdfSystemRecordStatusNav"
}
},
"usefulLinks": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgram(effectiveStartDate=datetime'2021-01-01T00:00:00',programId='BP2111')/
usefulLinks"
}
},
"currencyNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgram(effectiveStartDate=datetime'2021-01-01T00:00:00',programId='BP2111')/
currencyNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgram(effectiveStartDate=datetime'2021-01-01T00:00:00',programId='BP2111')/
wfRequestNav"
}
},
"exceptionWorkflowIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgram(effectiveStartDate=datetime'2021-01-01T00:00:00',programId='BP2111')/
exceptionWorkflowIdNav"
}
},
"forms": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitProgram(effectiveStartDate=datetime'2021-01-01T00:00:00',programId='BP2111')/
forms"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 425
Related Information

SAP API Business Hub: Global Benefits

10.40 BenefitSavingsPlanEnrollmentDetails

This object is used to capture the annual and per pay period contribution amounts of the employee for Savings
Plan benefit. It contains the annual and per pay period contribution amounts of the employee, the minimum and
maximum contribution amounts.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Use Case

Request

Operation Query

HTTP Method GET

URI http://<api-server>/odata/v2/
BenefitSavingsPlanEnrollmentDetails?
$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitSavingsPlanEnrollmentDetails(BenefitEnrollment_effectiveStartDate=datetime'20
18-03-23T00:00:00',BenefitEnrollment_id=25292L,id=25293L)",
"type": "SFOData.BenefitSavingsPlanEnrollmentDetails"
},
"id": "25293",
"BenefitEnrollment_id": "25292",
"BenefitEnrollment_effectiveStartDate": "/Date(1521763200000)/",
"annualMaxContributionAmount": "12",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

426 PUBLIC Global Benefits Objects
 "annualMinContributionAmount": "12",
"lastModifiedDateTime": "/Date(1521786370000+0000)/",
"perPayPeriodMaxContributionAmount": "12",
"perPayPeriodMinContributionAmount": "12",
"createdBy": "admin",
"annualContributionAmount": "12",
"empBenefitPayComponent": "Savings plan paycomp",
"createdDateTime": "/Date(1521786370000+0000)/",
"lastModifiedBy": "admin",
"payPeriodContributionAmount": "12",
"mdfSystemRecordStatus": "N",
"empBenefitPayComponentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitSavingsPlanEnrollmentDetails(BenefitEnrollment_effectiveStartDate=datetime'20
18-03-23T00:00:00',BenefitEnrollment_id=25292L,id=25293L)/empBenefitPayComponentNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitSavingsPlanEnrollmentDetails(BenefitEnrollment_effectiveStartDate=datetime'20
18-03-23T00:00:00',BenefitEnrollment_id=25292L,id=25293L)/mdfSystemRecordStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitSavingsPlanEnrollmentDetails(BenefitEnrollment_effectiveStartDate=datetime'20
19-01-01T00:00:00',BenefitEnrollment_id=25292L,id=25293L)",
"type": "SFOData.BenefitSavingsPlanEnrollmentDetails"
},
"id": "25293",
"BenefitEnrollment_id": "25292",
"BenefitEnrollment_effectiveStartDate": "/Date(1546300800000)/",
"annualMaxContributionAmount": "12",
"annualMinContributionAmount": "12",
"lastModifiedDateTime": "/Date(1521786370000+0000)/",
"perPayPeriodMaxContributionAmount": "12",
"perPayPeriodMinContributionAmount": "12",
"createdBy": "admin",
"annualContributionAmount": "12",
"empBenefitPayComponent": "Savings plan paycomp",
"createdDateTime": "/Date(1521786370000+0000)/",
"lastModifiedBy": "admin",
"payPeriodContributionAmount": "12",
"mdfSystemRecordStatus": "N",
"empBenefitPayComponentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitSavingsPlanEnrollmentDetails(BenefitEnrollment_effectiveStartDate=datetime'20
19-01-01T00:00:00',BenefitEnrollment_id=25292L,id=25293L)/empBenefitPayComponentNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitSavingsPlanEnrollmentDetails(BenefitEnrollment_effectiveStartDate=datetime'20
19-01-01T00:00:00',BenefitEnrollment_id=25292L,id=25293L)/mdfSystemRecordStatusNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 427
10.41 BenefitSavingsPlanCatchUpDetail

This object is used to capture the catchup contribution details for the Health Savings Account Savings Plan benefit.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitSavingsPlanCatchUpDetail(effectiveS
tartDate=datetime'2017-10-02T00:00:00',id=
694L)?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/BenefitSavingsPlanCatchUpDetail",
"type": "SFOData.BenefitSavingsPlanCatchUpDetail"
},
"id": "2L",
"payComponent": "BasicPay",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1496123038000+0000)/",
"lastModifiedDateTime": "/Date(1496123038000+0000)/",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/BenefitSavingsPlanCatchUpDetail/
mdfSystemRecordStatusNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

428 PUBLIC Global Benefits Objects
10.42 BenefitSavingsPlanContingentBeneficiary

This object is used to capture the Employee's Contingent Beneficiaries for the Savings Plan

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitSavingsPlanContingentBeneficiary(id
=694L)?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitSavingsPlanContingentBeneficiary",
"type": "SFOData.BenefitSavingsPlanContingentBeneficiary"
},
"id": "2L",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1496123038000+0000)/",
"lastModifiedDateTime": "/Date(1496123038000+0000)/",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitSavingsPlanContingentBeneficiary/mdfSystemRecordStatusNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 429
10.43 BenefitSavingsPlanERContributionConfigDetail

This object is used to capture the Employer Contribution details for the Health Savings Account Savings Plan
benefit.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitSavingsPlanERContributionConfigDeta
il(effectiveStartDate=datetime'2017-10-02T
00:00:00',id=694L)?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitSavingsPlanERContributionConfigDetail",
"type": "SFOData.BenefitSavingsPlanERContributionConfigDetail"
},
"id": "2L",
"payComponent": "BasicPay",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1496123038000+0000)/",
"lastModifiedDateTime": "/Date(1496123038000+0000)/",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitSavingsPlanERContributionConfigDetail(/mdfSystemRecordStatusNav"
}
}
}
]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

430 PUBLIC Global Benefits Objects
 }
}

10.44 BenefitSavingsPlanERContributionConfig

This object is used to capture the Employer Contribution details for the Health Savings Account Savings Plan
benefit.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitSavingsPlanERContributionConfig(eff
ectiveStartDate=datetime'2017-10-02T00:00:
00',id=694L)?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitSavingsPlanERContributionConfig",
"type": "SFOData.BenefitSavingsPlanERContributionConfig"
},
"id": "2L",
"payComponent": "BasicPay",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1496123038000+0000)/",
"lastModifiedDateTime": "/Date(1496123038000+0000)/",
"mdfSystemRecordStatusNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 431
 "uri": "https://<api-server>/odata/v2/
BenefitSavingsPlanERContributionConfig/mdfSystemRecordStatusNav"
}
}
}
]
}
}

10.45 BenefitSavingsPlanPrimaryBeneficiary

This object is used to capture the Employee's Primary Beneficiaries for the Savings Plan

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitSavingsPlanPrimaryBeneficiary(id=69
4L)?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitSavingsPlanPrimaryBeneficiary",
"type": "SFOData.BenefitSavingsPlanPrimaryBeneficiary"
},
"id": "2L",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1496123038000+0000)/",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

432 PUBLIC Global Benefits Objects
 "lastModifiedDateTime": "/Date(1496123038000+0000)/",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitSavingsPlanPrimaryBeneficiary/mdfSystemRecordStatusNav"
}
}
}
]
}
}

10.46 BenefitSavingsPlanTierConfiguration

This object is used to capture the Tier related contribution details for the Health Savings Account Savings Plan
benefit.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitSavingsPlanTierConfiguration(effect
iveStartDate=datetime'2017-10-02T00:00:00'
,id=694L)?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitSavingsPlanTierConfiguration",
"type": "SFOData.BenefitSavingsPlanTierConfiguration"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 433
 },
"id": "2L",
"payComponent": "BasicPay",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1496123038000+0000)/",
"lastModifiedDateTime": "/Date(1496123038000+0000)/",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitSavingsPlanTierConfiguration/mdfSystemRecordStatusNav"
}
}
}
]
}
}

10.47 BenefitSchedulePeriod

This is used for defining a period (set of dates) within which a particular benefit and claim is available for enrollment
and eligible for an employee.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

periodName The name of the period.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

434 PUBLIC Global Benefits Objects
 Property Description

enrollmentWindowStartDate The start date of the enrollment window.

enrollmentWindowEndDate The end date of the enrollment window.

enrollmentEffectiveFrom The day from which the enrollment is effective.

enrollmentValidityEndDate The last day on which the enrollment is effective.

claimWindowStartDate The start date of the claim.

claimwindowEndDate The end date of claim.

balanceCarryForwardUptoDate The balance of a claim that is allowed to carry forward to a spe­

cific date.

Use Case: Get details of the benefit schedule periods in the system

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitSchedulePeriod

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitSchedulePeriod('2019')",
"type": "SFOData.BenefitSchedulePeriod"
},
"id": "2019",
"balanceCarryForwardUptoDate": null,
"claimWindowEndDate": null,
"lastModifiedDateTime": "/Date(1635247779000+0000)/",
"enrollmentValidityEndDate": "/Date(1672444800000)/",
"lastModifiedBy": "ecadmin",
"claimWindowStartDate": null,
"createdDateTime": "/Date(1550471720000+0000)/",
"periodName": "2019_21",
"mdfSystemRecordStatus": "N",
"enrollmentWindowStartDate": "/Date(1546300800000)/",
"enrollmentWindowEndDate": "/Date(1640908800000)/",
"createdBy": "sriadmin",
"enrollmentEffectiveFrom": "/Date(1640995200000)/",
"createdByNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 435
 "uri": "https://<api-server>/odata/v2/
BenefitSchedulePeriod('2019')/createdByNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitSchedulePeriod('2019')/wfRequestNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitSchedulePeriod('2019')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitSchedulePeriod('2019')/mdfSystemRecordStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Global Benefits

10.48 BenefitSchedules

This entity is used for grouping two or more schedule periods. BenefitSchedules is required for allowances and
reimbursements. It defines the time period, by date, that an employee can enroll for and claim a benefit.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

436 PUBLIC Global Benefits Objects
Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

scheduleName The name of the schedule.

enrollmentWindowStartDate The start date for enrollment.

enrollmentWindowEndDate The end date for enrollment.

claimWindowStartDate The start date for the claim.

claimWindowEndDate The end date for the claim.

enrollmentWindowValidityEndDate The end date for the validity of an enrollment.

Use Case: Get details of benefit schedules in the system

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitSchedule

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitSchedules('2019_21')",
"type": "SFOData.BenefitSchedules"
},
"id": "2019_21",
"scheduleName": "2019_21",
"lastModifiedDateTime": "/Date(1627613647000+0000)/",
"lastModifiedBy": "adminb1",
"createdDateTime": "/Date(1550471730000+0000)/",
"mdfSystemRecordStatus": "N",
"createdBy": "sriadmin",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 437
 "createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitSchedules('2019_21')/createdByNav"
}
},
"periods": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitSchedules('2019_21')/periods"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitSchedules('2019_21')/wfRequestNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitSchedules('2019_21')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitSchedules('2019_21')/mdfSystemRecordStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Global Benefits

10.49 BenefitEffectiveDate

This entity contains the details of the benefit and the effective from rule for the respective benefit. This is used to
configure the benefit and the effective from date rule the benefit.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

438 PUBLIC Global Benefits Objects
Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitEffectiveDateConfiguration(effectiv
eStartDate=datetime'2017-10-02T00:00:00',i
d=694L)?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitEffectiveDateConfiguration",
"type": "SFOData. BenefitEffectiveDateConfiguration"
},
"benefit": "Benefit",
"rule": "Rule",
"parent": "BenefitLifeEventConfiguration",
"effectiveStartDate": "/Date(1496016000000)/",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1496123038000+0000)/",
"lastModifiedDateTime": "/Date(1496123038000+0000)/",
"mdfSystemRecordStatus": "N",
"benefitNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEffectiveDateConfiguration/benefitNav"
},
"ruleNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEffectiveDateConfiguration/ruleNav"
},
"parentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEffectiveDateConfiguration/parentNav"
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitEffectiveDateConfiguration(/mdfSystemRecordStatusNav"
}
}
}
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 439
10.50 BenefitEvent

This entity contains the details of Event like EventId and EventName for Benefit Event. This is used to configure a
benefit event.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitEvent(effectiveStartDate=datetime'2
017-10-02T00:00:00',id=694L)?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/BenefitEvent",
"type": "SFOData. BenefitEvent"
},
"eventCode": "Newhireevent",
"eventId": "NEW HIRE",
"effectiveStartDate": "/Date(1496016000000)/",
"eventName": "newHire",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1496123038000+0000)/",
"lastModifiedDateTime": "/Date(1496123038000+0000)/",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/BenefitEvent(/
mdfSystemRecordStatusNav"
}
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

440 PUBLIC Global Benefits Objects
 ]
}
}

Related Information

SAP API Business Hub: Global Benefits

10.51 BenefitLifeEvent

This entity contains the details of the Benefit Event, Legal Entity and Exception Window Rule for Life Event
Configuration. This is used to configure Life Event Configuration for particular legal Entity and will be used for
creating exception for particular user.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitLifeEventConfiguration(effectiveSta
rtDate=datetime'2017-10-02T00:00:00',id=69
4L)/$format=json

Response

{
"d": {
"results": [
{
"__metadata": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 441
 "uri": "https://<api-server>/odata/v2/
BenefitLifeEventConfiguration",
"type": "SFOData. BenefitLifeEventConfiguration"
},
"effectiveStartDate": "/Date(1496016000000)/",
" configurationId ": "LifeEvent",
"configurationName": "Life Event",
"benefitEvent": "newhire(new_hire)",
"legalEntity": "ACE_USA",
"exceptionWindowRule": "Rule",
"exceptionForPeriod": "OngoingPeriod",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1496123038000+0000)/",
"lastModifiedDateTime": "/Date(1496123038000+0000)/",
"mdfSystemRecordStatus": "N",
"legalEntityNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitLifeEventConfiguration/legalEntityNav"
},
"benefitEventNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitLifeEventConfiguration/benefitEventNav"
},
"ruleNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitLifeEventConfiguration/ruleNav"
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitLifeEventConfiguration (/mdfSystemRecordStatusNav"
}
}
}
}
}
}
]
}
}

10.52 BenefitDeductibleAllowanceEnrollment

This object is used to capture the employee and employer contribution details for Deductible Allowance
Enrollment. It contains the employee and employer contributions and respective pay components.

 Note

This API is read-only. To create or edit data, please use imports function.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

442 PUBLIC Global Benefits Objects
Supported Operations

Query

Use Case: Query by Key

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitDeductibleAllowanceEnrollment(effec
tiveStartDate=datetime'2017-10-02T00:00:00
',id=694L)?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitDeductibleAllowanceEnrollment",
"type": "SFOData. BenefitDeductibleAllowanceEnrollment"
},
"id": "2L",
"employeeContribution": "1000",
"employerContribution": "1500",
"employeeContributionPayComponent": "PayComponent",
"employerContributionPayComponent": "PayComponent",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1496123038000+0000)/",
"lastModifiedDateTime": "/Date(1496123038000+0000)/",
"mdfSystemRecordStatus": "N",
"employeeContributionPayComponentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitDeductibleAllowanceEnrollment/employeeContributionPayComponentNav "
},
"employerContributionPayComponentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitDeductibleAllowanceEnrollment/employerContributionPayComponentNav "
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitDeducibleAllowanceEnrollment(/mdfSystemRecordStatusNav"
}
}
}
}
}
]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 443
 }
}

10.53 BenefitsIntegrationRecurringInfo

This entity contains Benefit Recurring amounts that aren’t payments or deductions such as Employer contribution
and Fixed amount imputed income. This can be used to replicate or integrate the benefit recurring amounts to the
payroll system.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

externalCode The object is populated from code and hence external code is
filled with UUID.

benefit This holds the MDF reference to Benefit object.

payComponent This holds the FO reference to PayComponentEO object.

benefitEnrollment This holds the MDF reference to BenefitEnrollment object.

benefitSchedulePeriod This holds the MDF reference to BenefitSchedulePeriod object.

unitOfMeasure This holds the MDF reference to UnitOfMeasure object.

workerId This holds Employee’s Users Sys ID.

currency This holds the MDF reference to Currency object.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

444 PUBLIC Global Benefits Objects
 Property Description

frequency This holds the FO reference to FrequencyEO object.

Use Case 1: Get the recurring amounts for an <employee> ‘admin’

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/public/
BenefitsIntegrationRecurringInfo?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitsIntegrationRecurringInfo(id='26ADEA5250C94889B7F12A2CF3166DC7',payCompBeginD
ate=datetime'2019-09-16T00:00:00')",
"type": "SFOData.BenefitsIntegrationRecurringInfo"
},
"payCompBeginDate": "/Date(1568592000000)/",
"id": "26ADEA5250C94889B7F12A2CF3166DC7",
"lastModifiedDateTime": "/Date(1568484360000+0000)/",
"benefitSchedulePeriod": "25219",
"createdDateTime": "/Date(1568484360000+0000)/",
"frequency": "ANN",
"reference": null,
"externalName":
"admin_InsuranceTestmanual_INSURANCE_EMPLOYER_CONTRIBUTION",
"currency": "USD",
"value": "10000",
"payComponent": "HR-UK",
"workerId": "admin",
"unitOfMeasure": null,
"lastModifiedBy": "admin",
"benefit": "37776",
"benefitEnrollment": "E08DA731378B418299B0607A69C1FE37",
"payCompEndDate": "/Date(1568678400000)/",
"recordStatus": "N",
"createdBy": "admin",
"category": "INSURANCE_EMPLOYER_CONTRIBUTION",
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitsIntegrationRecurringInfo(id='26ADEA5250C94889B7F12A2CF3166DC7',payCompBeginD
ate=datetime'2019-09-16T00:00:00')/createdByNav"
}
},
"frequencyNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 445
 "uri": "https://<api-server>/odata/v2/
BenefitsIntegrationRecurringInfo(id='26ADEA5250C94889B7F12A2CF3166DC7',payCompBeginD
ate=datetime'2019-09-16T00:00:00')/frequencyNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitsIntegrationRecurringInfo(id='26ADEA5250C94889B7F12A2CF3166DC7',payCompBeginD
ate=datetime'2019-09-16T00:00:00')/lastModifiedByNav"
}
},
"currencyNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitsIntegrationRecurringInfo(id='26ADEA5250C94889B7F12A2CF3166DC7',payCompBeginD
ate=datetime'2019-09-16T00:00:00')/currencyNav"
}
},
"workerIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitsIntegrationRecurringInfo(id='26ADEA5250C94889B7F12A2CF3166DC7',payCompBeginD
ate=datetime'2019-09-16T00:00:00')/workerIdNav"
}
},
"benefitSchedulePeriodNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitsIntegrationRecurringInfo(id='26ADEA5250C94889B7F12A2CF3166DC7',payCompBeginD
ate=datetime'2019-09-16T00:00:00')/benefitSchedulePeriodNav"
}
},
"categoryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitsIntegrationRecurringInfo(id='26ADEA5250C94889B7F12A2CF3166DC7',payCompBeginD
ate=datetime'2019-09-16T00:00:00')/categoryNav"
}
},
"payComponentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitsIntegrationRecurringInfo(id='26ADEA5250C94889B7F12A2CF3166DC7',payCompBeginD
ate=datetime'2019-09-16T00:00:00')/payComponentNav"
}
},
"benefitNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitsIntegrationRecurringInfo(id='26ADEA5250C94889B7F12A2CF3166DC7',payCompBeginD
ate=datetime'2019-09-16T00:00:00')/benefitNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitsIntegrationRecurringInfo(id='26ADEA5250C94889B7F12A2CF3166DC7',payCompBeginD
ate=datetime'2019-09-16T00:00:00')/wfRequestNav"
}
},
"benefitEnrollmentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitsIntegrationRecurringInfo(id='26ADEA5250C94889B7F12A2CF3166DC7',payCompBeginD
ate=datetime'2019-09-16T00:00:00')/benefitEnrollmentNav"
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

446 PUBLIC Global Benefits Objects
 "recordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitsIntegrationRecurringInfo(id='26ADEA5250C94889B7F12A2CF3166DC7',payCompBeginD
ate=datetime'2019-09-16T00:00:00')/recordStatusNav"
}
}
}
]
}
}

10.54 ConfigurationProcessingLogDetails

This entity contains Processing Log Details Id, Benefit, Enrollment Id, Exception Id, Processed Status and
Processed Result Detail. This entity is used to log the details of processing Benefits under the details logs of
processed benefit event.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Navigation Property Related Entity Description

Benefits Benefit Navigation to the benefit

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 447
Use Case

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
ConfigurationProcessingLogDetails?$format=json

Response

"d": {
"results": [{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
ConfigurationProcessingLogDetails",
"type": "SFOData.ConfigurationProcessingLogDetails"
},
"processingLogDetailsId": "processingLogDetailsId1",
"benefit": "benefit1",
"enrollmentId": "enrollmentId1",
"exceptionId": "exceptionId1",
"processedStatus": "SUCCESS",
"processedResultDetail": "success",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
ConfigurationProcessingLogDetails(/mdfSystemRecordStatusNav"
}
}
}]
}
}

10.55 EventDeterminationRuleConfiguration

This entity contains Benefit Events Determination Rule, Apply Rule to All Legal Entities and Applicable Legal
Entities. This object is used to configure the rule for Benfits Event Dtetermination.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

448 PUBLIC Global Benefits Objects
Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Navigation Property Related Entity Description

Benefits Benefit Navigation to the benefit

Use Case

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
EventDeterminationRuleConfiguration?$format=json

Response

"d": {
"results": [{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
EventDeterminationRuleConfiguration ",
"type": "SFOData.EventDeterminationRuleConfiguration "
},
"benefitEventRule": "benefitEventRule1",
"eventRuleApplicableFor": "ALL_LEGAL_ENTITIES",
"legalEntityListForEventRule": "legalEntityListForEventRule1",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EventDeterminationRuleConfiguration(/mdfSystemRecordStatusNav"
}
}
}]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 449
10.56 EmployeeDismissalProtection

This entity provides ability for the user to create, modify, or delete EmployeeDismissalProtection entity. It also
provides the ability to link the EmployeeDismissalProtection to EmployeeDismissalProtectionDetail.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query, Insert, Upsert, Delete

Use Case: Query the EmployeeDismissalProtection for a single user

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/<Your Input>

Response

{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/restricted/
EmployeeDismissalProtection('SouzaB')",
"type": "SFOData.EmployeeDismissalProtection"
},
"workerId": "SouzaB",
"createdBy": "sriadmin",
"lastModifiedBy": "sriadmin",
"createdDateTime": "/Date(1539065659000+0000)/",
"lastModifiedDateTime": "/Date(1539065718000+0000)/",
"mdfSystemRecordStatus": "N",
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/restricted/
EmployeeDismissalProtection('SouzaB')/wfRequestNav"
}
},
"workerIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/restricted/
EmployeeDismissalProtection('SouzaB')/workerIdNav"
}
},
"empDismissalProtectionDetails": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

450 PUBLIC Global Benefits Objects
 "__deferred": {
"uri": "https://<api-server>/odata/v2/restricted/
EmployeeDismissalProtection('SouzaB')/empDismissalProtectionDetails"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/restricted/
EmployeeDismissalProtection('SouzaB')/mdfSystemRecordStatusNav"
}
}
}
}

Use Case: Upsert new EmployeeDismissalProtection record

Request

Operation Query

HTTP Method GET

URI http://<api-server>/odata/v2/upsert

Payload {
"__metadata": {
"uri": "https://<api-
server>/odata/v2/restricted/
EmployeeDismissalProtection('fdgg45')",
"type":
"SFOData.EmployeeDismissalProtection"
},
"workerId": "fdgg45"
}

Response

<?xml version="1.0" encoding="utf-8"?>

<feed
xmlns="http://www.w3.org/2005/Atom"
xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"
xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices">
<entry>
<content type="application/xml">
<m:properties>
<d:key m:null="true"></d:key>
<d:status>OK</d:status>
<d:editStatus>UPSERTED</d:editStatus>
<d:message m:null="true"></d:message>
<d:index m:type="Edm.Int32">0</d:index>
<d:httpCode m:type="Edm.Int32">200</d:httpCode>
<d:inlineResults m:type="Bag(SFOData.UpsertResult)"></
d:inlineResults>
</m:properties>
</content>
</entry>
</feed>

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 451
10.57 EmployeeDismissalProtectionDetail

This entity provides ability for the user to create, modify or delete EmployeeDismissalProtectionDetail entity.

 Note

This API is read-only. To create or edit data, please use imports function.

Supported Operations

Query, Insert, Upsert, Delete

Use Case: Query the EmployeeDismissalProtection for a single user

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
EmployeeDismissalProtectionDetail?
$filter=EmployeeDismissalProtection_worker
Id eq 'SouzaB'

Response

 Sample Code

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/restricted/
EmployeeDismissalProtectionDetail(EmployeeDismissalProtection_workerId='SouzaB',e
xternalCode='80A2D2A19694440CB1261E3D91629AEC')",
"type": "SFOData.EmployeeDismissalProtectionDetail"
},
"EmployeeDismissalProtection_workerId": "SouzaB",
"externalCode": "80A2D2A19694440CB1261E3D91629AEC",
"protectionStartDate": "/Date(1483228800000)/",
"createdBy": "sriadmin",
"lastModifiedBy": "sriadmin",
"createdDateTime": "/Date(1539065718000+0000)/",
"lastModifiedDateTime": "/Date(1539065718000+0000)/",
"dismissalProtectionType": "Military Service1",
"protectionEndDate": "/Date(1514678400000)/",
"mdfSystemRecordStatus": "N",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

452 PUBLIC Global Benefits Objects
 "mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/restricted/
EmployeeDismissalProtectionDetail(EmployeeDismissalProtection_workerId='SouzaB',e
xternalCode='80A2D2A19694440CB1261E3D91629AEC')/mdfSystemRecordStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/restricted/
EmployeeDismissalProtectionDetail(EmployeeDismissalProtection_workerId='SouzaB',e
xternalCode='6C173388CB3F45A4A10967B4C5D7162D')",
"type": "SFOData.EmployeeDismissalProtectionDetail"
},
"EmployeeDismissalProtection_workerId": "SouzaB",
"externalCode": "6C173388CB3F45A4A10967B4C5D7162D",
"protectionStartDate": "/Date(1535760000000)/",
"createdBy": "sriadmin",
"lastModifiedBy": "sriadmin",
"createdDateTime": "/Date(1539065659000+0000)/",
"lastModifiedDateTime": "/Date(1539065659000+0000)/",
"dismissalProtectionType": "paternity",
"protectionEndDate": "/Date(1546214400000)/",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/restricted/
EmployeeDismissalProtectionDetail(EmployeeDismissalProtection_workerId='SouzaB',e
xternalCode='6C173388CB3F45A4A10967B4C5D7162D')/mdfSystemRecordStatusNav"
}
}
}
]
}
}

Use Case: Upsert new EmployeeDismissalProtectionDetail record

Request

Operation Query

HTTP Method GET

URI http://<api-server>/odata/v2/upsert

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 453
Payload {
"__metadata": {
"uri": "https://
<api-server>/odata/v2//
EmployeeDismissalProtectionDetail",
"type":
"SFOData.EmployeeDismissalProtectionDeta
il"
},

"EmployeeDismissalProtection_workerId":
"SouzaB",
"protectionStartDate":
"/Date(1483228800000)/",

"dismissalProtectionType": "Military
Service1",
"protectionEndDate": "/
Date(1514677700000)/"
}

Response

<?xml version="1.0" encoding="utf-8"?>

<feed
xmlns="http://www.w3.org/2005/Atom"
xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"
xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices">
<entry>
<content type="application/xml">
<m:properties>
<d:key m:null="true"></d:key>
<d:status>OK</d:status>
<d:editStatus>UPSERTED</d:editStatus>
<d:message m:null="true"></d:message>
<d:index m:type="Edm.Int32">0</d:index>
<d:httpCode m:type="Edm.Int32">200</d:httpCode>
<d:inlineResults m:type="Bag(SFOData.UpsertResult)"></
d:inlineResults>
</m:properties>
</content>
</entry>
</feed>

10.58 EmployeeSeniority

This object is used to maintain the seniority details of the employee. Seniority details includes Seniority Type,
Seniority Years, Seniority Months and Seniority Days.

 Note

This API is read-only. To create or edit data, please use imports function.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

454 PUBLIC Global Benefits Objects
Supported Operations

Query

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
EmployeeSeniority(effectiveStartDate=datetime'2017-10-02T00
:00:00',id=694L)/$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/ EmployeeSeniority",
"type": "SFOData. EmployeeSeniority"
},
"user": "user",
"validOn": "/Date(1496016000000)/",
"seniorityType": "SeniorityType",
"seniorityYears": "5L",
"seniorityMonths": "2L",
"seniorityDays": "10L",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1496123038000+0000)/",
"lastModifiedDateTime": "/Date(1496123038000+0000)/",
"mdfSystemRecordStatus": "N",
"seniorityTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/EmployeeSeniority/
seniorityTypeNav "
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/EmployeeSeniority(/
mdfSystemRecordStatusNav"
}
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 455
10.59 EmployeeWithEmployerMatchContributions

This entity contains information about the matching employee and employer contribution percentages for pension
plan type Workplace.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

configurationId This field returns the external code or UUID.

configurationName This field returns the name of the configured object.

employeeWithEmployerMatchContributionEntri This field returns composite child association which holds the
es list of employee employer matching contribution percentage
entries.

Use Case: Get the EmployeeWithEmployerMatchContributions Objects Created

in the System

This example shows how to get all the EmployeeWithEmployerMatchContributions objects created in the system.

Request

Operation Query

HTTP Method GET

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

456 PUBLIC Global Benefits Objects
 URI https://<api-server>/odata/v2/
EmployeeWithEmployerMatchContributions?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
EmployeeWithEmployerMatchContributions(configurationId='EE_ER_MATCH1',effectiveStart
Date=datetime'2021-01-01T00:00:00')",
"type": "SFOData.EmployeeWithEmployerMatchContributions"
},
"effectiveStartDate": "/Date(1609459200000)/",
"configurationId": "EE_ER_MATCH1",
"effectiveEndDate": "/Date(253402214400000)/",
"lastModifiedDateTime": "/Date(1612385958000+0000)/",
"lastModifiedBy": "admin",
"configurationName": "EE_ER_MATCH1",
"createdDateTime": "/Date(1612385910000+0000)/",
"mdfSystemRecordStatus": "N",
"createdBy": "admin",
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeWithEmployerMatchContributions(configurationId='EE_ER_MATCH1',effectiveStart
Date=datetime'2021-01-01T00:00:00')/createdByNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeWithEmployerMatchContributions(configurationId='EE_ER_MATCH1',effectiveStart
Date=datetime'2021-01-01T00:00:00')/wfRequestNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeWithEmployerMatchContributions(configurationId='EE_ER_MATCH1',effectiveStart
Date=datetime'2021-01-01T00:00:00')/lastModifiedByNav"
}
},
"employeeWithEmployerMatchContributionEntries": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeWithEmployerMatchContributions(configurationId='EE_ER_MATCH1',effectiveStart
Date=datetime'2021-01-01T00:00:00')/employeeWithEmployerMatchContributionEntries"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeWithEmployerMatchContributions(configurationId='EE_ER_MATCH1',effectiveStart
Date=datetime'2021-01-01T00:00:00')/mdfSystemRecordStatusNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 457
10.60 EmployeeWithEmployerMatchContributionEntries

This entity contains a single set of contribution values that matches one employee contribution percentage with
the corresponding employer contribution percentage for pension plan type Workplace. An instance of this entity is
a single entry in the parent entity EmployeeWithEmployerMatchContributions.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

eeERMatchValuesID This is the external code and is populated automatically during

creation of the parent object.

eeContributionPercentage This is the contribution percentage from the employee.

erContributionPercentage This is the contribution percentage from the employer.

isDefault This represents whether an entry of this object shall be treated

as the default entry for its parent object. It can be true for only
one entry.

Use Case: Get the Employee and Employer Matching Contribution Entries

This example shows how to get all the employee and employer matching contribution entries.

Request

Operation Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

458 PUBLIC Global Benefits Objects
 HTTP Method GET

URI https://<api-server>/odata/v2/
EmployeeWithEmployerMatchContributionEntries?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
EmployeeWithEmployerMatchContributionEntries(EmployeeWithEmployerMatchContributions_
configurationId='EE_ER_MATCH1',EmployeeWithEmployerMatchContributions_effectiveStart
Date=datetime'2021-01-01T00:00:00',eeERMatchValuesID='9CCA5BF86F59405481D3D08F3D5198
D0')",
"type": "SFOData.EmployeeWithEmployerMatchContributionEntries"
},
"EmployeeWithEmployerMatchContributions_configurationId": "EE_ER_MATCH1",
"EmployeeWithEmployerMatchContributions_effectiveStartDate": "/
Date(1609459200000)/",
"eeERMatchValuesID": "9CCA5BF86F59405481D3D08F3D5198D0",
"eeContributionPercentage": "2.67",
"lastModifiedDateTime": "/Date(1612385958000+0000)/",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1612385910000+0000)/",
"mdfSystemRecordStatus": "N",
"isDefault": true,
"createdBy": "admin",
"erContributionPercentage": "4",
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeWithEmployerMatchContributionEntries(EmployeeWithEmployerMatchContributions_
configurationId='EE_ER_MATCH1',EmployeeWithEmployerMatchContributions_effectiveStart
Date=datetime'2021-01-01T00:00:00',eeERMatchValuesID='9CCA5BF86F59405481D3D08F3D5198
D0')/createdByNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeWithEmployerMatchContributionEntries(EmployeeWithEmployerMatchContributions_
configurationId='EE_ER_MATCH1',EmployeeWithEmployerMatchContributions_effectiveStart
Date=datetime'2021-01-01T00:00:00',eeERMatchValuesID='9CCA5BF86F59405481D3D08F3D5198
D0')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeWithEmployerMatchContributionEntries(EmployeeWithEmployerMatchContributions_
configurationId='EE_ER_MATCH1',EmployeeWithEmployerMatchContributions_effectiveStart
Date=datetime'2021-01-01T00:00:00',eeERMatchValuesID='9CCA5BF86F59405481D3D08F3D5198
D0')/mdfSystemRecordStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
EmployeeWithEmployerMatchContributionEntries(EmployeeWithEmployerMatchContributions_
configurationId='EE_ER_MATCH1',EmployeeWithEmployerMatchContributions_effectiveStart
Date=datetime'2021-01-01T00:00:00',eeERMatchValuesID='13324D486F93453EA77EFDF2842B18
50')",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 459
 "type": "SFOData.EmployeeWithEmployerMatchContributionEntries"
},
"EmployeeWithEmployerMatchContributions_configurationId": "EE_ER_MATCH1",
"EmployeeWithEmployerMatchContributions_effectiveStartDate": "/
Date(1609459200000)/",
"eeERMatchValuesID": "13324D486F93453EA77EFDF2842B1850",
"eeContributionPercentage": "2.6",
"lastModifiedDateTime": "/Date(1612385958000+0000)/",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1612385910000+0000)/",
"mdfSystemRecordStatus": "N",
"isDefault": false,
"createdBy": "admin",
"erContributionPercentage": "5",
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeWithEmployerMatchContributionEntries(EmployeeWithEmployerMatchContributions_
configurationId='EE_ER_MATCH1',EmployeeWithEmployerMatchContributions_effectiveStart
Date=datetime'2021-01-01T00:00:00',eeERMatchValuesID='13324D486F93453EA77EFDF2842B18
50')/createdByNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeWithEmployerMatchContributionEntries(EmployeeWithEmployerMatchContributions_
configurationId='EE_ER_MATCH1',EmployeeWithEmployerMatchContributions_effectiveStart
Date=datetime'2021-01-01T00:00:00',eeERMatchValuesID='13324D486F93453EA77EFDF2842B18
50')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeWithEmployerMatchContributionEntries(EmployeeWithEmployerMatchContributions_
configurationId='EE_ER_MATCH1',EmployeeWithEmployerMatchContributions_effectiveStart
Date=datetime'2021-01-01T00:00:00',eeERMatchValuesID='13324D486F93453EA77EFDF2842B18
50')/mdfSystemRecordStatusNav"
}
}
}
]
}
}

10.61 LegalEntityListForEventRule

This entity contains only Legal Entity. This entity is to configure all the Legal Entities associated to a Benefit Event in
Benfits Event Determination.

 Note

This API is read-only. To create or edit data, please use imports function.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

460 PUBLIC Global Benefits Objects
Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Navigation Property Related Entity Description

Benefits Benefit Navigation to the benefit.

Use Case

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/LegalEntityListForEventRule?
$format=json

Response

"d": {
"results": [{
"__metadata": {
"uri": "https://<api-server>/odata/v2/LegalEntityListForEventRule",
"type": "SFOData.LegalEntityListForEventRule"
},
"legalEntity": "legalEntity1",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/LegalEntityListForEventRule(/
mdfSystemRecordStatusNav"
}
}
}]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 461
10.62 BenefitPensionMinMaxContributionLimits

The BenefitPensionMinMaxContributionLimits contains the minimum and maximum limits of employee

and employer contribution values for pension type Workplace.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

configurationTableId This field returns the external code or UUID.

configurationTableName This field returns the name of the configured object.

currency This field returns the currency.

eeMinContributionPercentage This field returns the employee minimum contribution percent­

age.

eeMinContributionAmount This field returns the employee minimum contribution amount.

eeMaxContributionPercentage This field returns the employee maximum contribution per­

centage.

eeMaxContributionAmount This field returns the employee maximum contribution

amount.

erMinContributionPercentage This field returns the employer minimum contribution percent­

age.

erMinContributionAmount This field returns the employer minimum contribution amount.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

462 PUBLIC Global Benefits Objects
 Property Description

erMaxContributionPercentage This field returns the employer maximum contribution per­

centage.

erMaxContributionAmount This field returns the employer maximum contribution

amount.

eeDefaultPercentage This field returns the default employee contribution percent­

age.

eeDefaultAmount This field returns the default employee contribution amount.

erDefaultPercentage This field returns the default employer contribution percent­

age.

erDefaultAmount This field returns the default employer contribution amount.

Use Case: Get the BenefitPensionMinMaxContributionLimits Entries

This example shows how to get all the BenefitPensionMinMaxContributionLimits objects created in the system.

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitPensionMinMaxContributionLimits?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitPensionMinMaxContributionLimits(configurationTableId='MINMAX',effectiveStartD
ate=datetime'2021-01-01T00:00:00')",
"type": "SFOData.BenefitPensionMinMaxContributionLimits"
},
"effectiveStartDate": "/Date(1609459200000)/",
"configurationTableId": "MINMAX",
"effectiveEndDate": "/Date(253402214400000)/",
"lastModifiedDateTime": "/Date(1622009350000+0000)/",
"eeDefaultPercentage": null,
"configurationTableName": "MINMAXCONFIG",
"createdDateTime": "/Date(1622009350000+0000)/",
"eeMaxContributionAmount": null,
"erMaxContributionAmount": null,
"eeMinContributionPercentage": "10",
"eeMinContributionAmount": "150",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 463
 "eeDefaultAmount": null,
"currency": "USD",
"eeMaxContributionPercentage": null,
"lastModifiedBy": "sriadmin",
"erDefaultPercentage": null,
"mdfSystemRecordStatus": "N",
"erDefaultAmount": null,
"createdBy": "sriadmin",
"erMinContributionPercentage": "12",
"erMaxContributionPercentage": null,
"erMinContributionAmount": "200",
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitPensionMinMaxContributionLimits(configurationTableId='MINMAX',effectiveStartD
ate=datetime'2021-01-01T00:00:00')/createdByNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitPensionMinMaxContributionLimits(configurationTableId='MINMAX',effectiveStartD
ate=datetime'2021-01-01T00:00:00')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitPensionMinMaxContributionLimits(configurationTableId='MINMAX',effectiveStartD
ate=datetime'2021-01-01T00:00:00')/mdfSystemRecordStatusNav"
}
},
"currencyNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitPensionMinMaxContributionLimits(configurationTableId='MINMAX',effectiveStartD
ate=datetime'2021-01-01T00:00:00')/currencyNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitPensionMinMaxContributionLimits(configurationTableId='MINMAX',effectiveStartD
ate=datetime'2021-01-01T00:00:00')/wfRequestNav"
}
}
}
]
}
}

10.63 BenefitPensionAdditionalContributionLimits

This BenefitPensionAdditionalContributionLimits entity contains information about the minimum and

maximum limits of Additional Voluntary Contribution (AVC) from an employee. Additional Voluntary Contribution is
supported only for the pension/retirement plan type Workplace with contribution options as Employee with
Employer Match or Minimum and Maximum Limits.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

464 PUBLIC Global Benefits Objects
Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

contributionLimitId This field returns the external code or UUID.

contributionLimitName This field returns the name of the configured object.

effectiveStartDate This field returns the effective start date of the configured ob­
ject.

currency This field returns the currency maintained in the configured

object.

minAdditionalContributionAmount This field returns the minimum or lower limit of Additional Vol­
untary Contribution for the employee.

maxAdditionalContributionAmount This field returns the maximum or upper limit of Additional Vol­
untary Contribution for the employee.

Use Case: Get the BenefitPensionAdditionalContributionLimits Objects Created

in the System

This example show how to get all the BenefitPensionAdditionalContributionLimits objects created in the system.

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
BenefitPensionAdditionalContributionLimits?$format=json

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 465
Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
BenefitPensionAdditionalContributionLimits(contributionLimitId='AVC',effectiveStartD
ate=datetime'2021-01-01T00:00:00')",
"type": "SFOData.BenefitPensionAdditionalContributionLimits"
},
"contributionLimitId": "AVC",
"effectiveStartDate": "/Date(1609459200000)/",
"effectiveEndDate": "/Date(253402214400000)/",
"lastModifiedDateTime": "/Date(1624364816000+0000)/",
"contributionLimitName": "AVC",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1624364816000+0000)/",
"mdfSystemRecordStatus": "N",
"minAdditionalContributionAmount": "10",
"maxAdditionalContributionAmount": "10",
"createdBy": "admin",
"currency": "USD",
"currencyNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitPensionAdditionalContributionLimits(contributionLimitId='AVC',effectiveStartD
ate=datetime'2021-01-01T00:00:00')/currencyNav"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitPensionAdditionalContributionLimits(contributionLimitId='AVC',effectiveStartD
ate=datetime'2021-01-01T00:00:00')/createdByNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitPensionAdditionalContributionLimits(contributionLimitId='AVC',effectiveStartD
ate=datetime'2021-01-01T00:00:00')/wfRequestNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitPensionAdditionalContributionLimits(contributionLimitId='AVC',effectiveStartD
ate=datetime'2021-01-01T00:00:00')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
BenefitPensionAdditionalContributionLimits(contributionLimitId='AVC',effectiveStartD
ate=datetime'2021-01-01T00:00:00')/mdfSystemRecordStatusNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

466 PUBLIC Global Benefits Objects
10.64 PensionBandingConfiguration

The PensionBandingConfiguration parent entity contains the configuration details of the bands based on
payroll pensionable earnings. The entity is supported only for the pension/retirement plan type Workplace with
contribution options as Payroll Pensionable Earnings.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

bandingConfigurationId This field represents the unique ID of object.

bandingConfigurationName This field represents the object name.

effectiveStartDate This field returns the effective start date.

currency This field represents currency.

pensionBandingConfigurationDetails This field represents the entity that contains the contribution
guidelines based on the bands.

Use Case: Get the PensionBandingConfiguration Entries

This example shows how to get all the PensionBandingConfiguration entries from the system.

Request

Operation Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 467
HTTP Method GET

URI https://<api-server>/odata/v2/PensionBandingConfiguration?
$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PensionBandingConfiguration(bandingConfigurationId='123',effectiveStartDate=datetime
'2021-07-22T00:00:00')",
"type": "SFOData.PensionBandingConfiguration"
},
"effectiveStartDate": "/Date(1626912000000)/",
"bandingConfigurationId": "123",
"lastModifiedDateTime": "/Date(1626953796000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"createdDateTime": "/Date(1626953796000+0000)/",
"mdfSystemRecordStatus": "N",
"createdBy": "admin",
"bandingConfigurationName": "123",
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PensionBandingConfiguration(bandingConfigurationId='123',effectiveStartDate=datetime
'2021-07-22T00:00:00')/createdByNav"
}
},
"pensionBandingConfigurationDetails": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PensionBandingConfiguration(bandingConfigurationId='123',effectiveStartDate=datetime
'2021-07-22T00:00:00')/pensionBandingConfigurationDetails"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PensionBandingConfiguration(bandingConfigurationId='123',effectiveStartDate=datetime
'2021-07-22T00:00:00')/wfRequestNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PensionBandingConfiguration(bandingConfigurationId='123',effectiveStartDate=datetime
'2021-07-22T00:00:00')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PensionBandingConfiguration(bandingConfigurationId='123',effectiveStartDate=datetime
'2021-07-22T00:00:00')/mdfSystemRecordStatusNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

468 PUBLIC Global Benefits Objects
10.65 PensionBandingConfigurationDetails

The PensionBandingConfigurationDetails entity contains upper and lower band values and the respective
employee and employer contribution percentages for each entry.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

bandingDetailsId This field holds the unique ID of object.

lowerBandValue This field represents lower band value.

upperBandValue This field represents upper band value.

employeePercentage This field represents the employee percentage value for corre­
sponding band.

employerPercentage This field represents the employer percentage value for corre­
sponding band.

Use Case: Get the PensionBandingConfigurationDetails Entries

This example shows how to get all the PensionBandingConfigurationDetails entries from the system.

Request

Operation Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 469
HTTP Method GET

URI https://<api-server>/odata/v2/
PensionBandingConfigurationDetails?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PensionBandingConfigurationDetails(PensionBandingConfiguration_bandingConfigurationI
d='123',PensionBandingConfiguration_effectiveStartDate=datetime'2021-07-22T00:00:00'
,bandingDetailsId='601093505ADF48C7BCE7C612C6CAADFE')",
"type": "SFOData.PensionBandingConfigurationDetails"
},
"PensionBandingConfiguration_effectiveStartDate": "/Date(1626912000000)/",
"bandingDetailsId": "601093505ADF48C7BCE7C612C6CAADFE",
"PensionBandingConfiguration_bandingConfigurationId": "123",
"lastModifiedDateTime": "/Date(1626953796000+0000)/",
"employeePercentage": "100",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1626953796000+0000)/",
"mdfSystemRecordStatus": "N",
"lowerBandValue": "100",
"upperBandValue": "200",
"createdBy": "admin",
"employerPercentage": "100",
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PensionBandingConfigurationDetails(PensionBandingConfiguration_bandingConfigurationI
d='123',PensionBandingConfiguration_effectiveStartDate=datetime'2021-07-22T00:00:00'
,bandingDetailsId='601093505ADF48C7BCE7C612C6CAADFE')/createdByNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PensionBandingConfigurationDetails(PensionBandingConfiguration_bandingConfigurationI
d='123',PensionBandingConfiguration_effectiveStartDate=datetime'2021-07-22T00:00:00'
,bandingDetailsId='601093505ADF48C7BCE7C612C6CAADFE')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PensionBandingConfigurationDetails(PensionBandingConfiguration_bandingConfigurationI
d='123',PensionBandingConfiguration_effectiveStartDate=datetime'2021-07-22T00:00:00'
,bandingDetailsId='601093505ADF48C7BCE7C612C6CAADFE')/mdfSystemRecordStatusNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

470 PUBLIC Global Benefits Objects
10.66 IRSPremiumTable

The IRSPremiumTable entity contains the age bracket for imputed income calculation for excess coverage along
with exempt amount and factor. The IRS table is the basis for the imputed income calculation with monthly rates.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

configurationId This field returns the external code.

configurationName This field returns the external name.

effectiveStartDate This field returns the effective start date.

exemptedAmount This field represents exempted amount.

currency This field represents currency.

factor This field represents factor.

ageVerificationDate This field represents As of Day.

ageVerificationMonth This field represents As of Month.

ageVerificationYear This field represents As of Year.

imputedCostForAgeRanges This field represents the imputed cost for age ranges.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 471
Use Case: Get the IRS Premium Table Entries

This example shows how to get all the IRS Premium Table entries.

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/IRSPremiumTable?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
IRSPremiumTable(configurationId='123',effectiveStartDate=datetime'2021-07-19T00:00:0
0')",
"type": "SFOData.IRSPremiumTable"
},
"effectiveStartDate": "/Date(1626652800000)/",
"configurationId": "123",
"ageVerificationMonth": null,
"lastModifiedDateTime": "/Date(1626703443000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"configurationName": "123",
"createdDateTime": "/Date(1626703443000+0000)/",
"mdfSystemRecordStatus": "N",
"ageVerificationYear": null,
"createdBy": "admin",
"ageVerificationDate": null,
"currency": "USD",
"exemptedAmount": "250",
"factor": "1",
"currencyNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
IRSPremiumTable(configurationId='123',effectiveStartDate=datetime'2021-07-19T00:00:0
0')/currencyNav"
}
},
"ageVerificationMonthNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
IRSPremiumTable(configurationId='123',effectiveStartDate=datetime'2021-07-19T00:00:0
0')/ageVerificationMonthNav"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
IRSPremiumTable(configurationId='123',effectiveStartDate=datetime'2021-07-19T00:00:0
0')/createdByNav"
}
},
"imputedCostForAgeRanges": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

472 PUBLIC Global Benefits Objects
 "uri": "https://<api-server>/odata/v2/
IRSPremiumTable(configurationId='123',effectiveStartDate=datetime'2021-07-19T00:00:0
0')/imputedCostForAgeRanges"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
IRSPremiumTable(configurationId='123',effectiveStartDate=datetime'2021-07-19T00:00:0
0')/wfRequestNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
IRSPremiumTable(configurationId='123',effectiveStartDate=datetime'2021-07-19T00:00:0
0')/lastModifiedByNav"
}
},
"ageVerificationDateNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
IRSPremiumTable(configurationId='123',effectiveStartDate=datetime'2021-07-19T00:00:0
0')/ageVerificationDateNav"
}
},
"ageVerificationYearNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
IRSPremiumTable(configurationId='123',effectiveStartDate=datetime'2021-07-19T00:00:0
0')/ageVerificationYearNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
IRSPremiumTable(configurationId='123',effectiveStartDate=datetime'2021-07-19T00:00:0
0')/mdfSystemRecordStatusNav"
}
}
}
]
}
}

10.67 ImputedCostForAgeRanges

The ImputedCostForAgeRanges entity contains the age brackets for imputed income calculation for excess
coverage amount.

Supported Operations

Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 473
Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

ageFrom This field represents Age From.

ageTo This field represents Age To.

costPerAge This field represents Cost Per Age.

Use Case: Get the Age Range Entries for Imputed Income Calculation

This example shows how to get all the age range entries.

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/ImputedCostForAgeRanges?
$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
ImputedCostForAgeRanges(IRSPremiumTable_configurationId='123',IRSPremiumTable_effect
iveStartDate=datetime'2021-07-19T00:00:00',externalCode='9609958F64484EFDB0F4D878CE1
F45AF')",
"type": "SFOData.ImputedCostForAgeRanges"
},
"IRSPremiumTable_effectiveStartDate": "/Date(1626652800000)/",
"externalCode": "9609958F64484EFDB0F4D878CE1F45AF",
"IRSPremiumTable_configurationId": "123",
"lastModifiedDateTime": "/Date(1626703443000+0000)/",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1626703443000+0000)/",
"mdfSystemRecordStatus": "N",
"createdBy": "admin",
"ageFrom": "1",
"costPerAge": "100",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

474 PUBLIC Global Benefits Objects
 "ageTo": "50",
"createdByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
ImputedCostForAgeRanges(IRSPremiumTable_configurationId='123',IRSPremiumTable_effect
iveStartDate=datetime'2021-07-19T00:00:00',externalCode='9609958F64484EFDB0F4D878CE1
F45AF')/createdByNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
ImputedCostForAgeRanges(IRSPremiumTable_configurationId='123',IRSPremiumTable_effect
iveStartDate=datetime'2021-07-19T00:00:00',externalCode='9609958F64484EFDB0F4D878CE1
F45AF')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
ImputedCostForAgeRanges(IRSPremiumTable_configurationId='123',IRSPremiumTable_effect
iveStartDate=datetime'2021-07-19T00:00:00',externalCode='9609958F64484EFDB0F4D878CE1
F45AF')/mdfSystemRecordStatusNav"
}
}
}
]
}
}

10.68 Sample_API_Topic_with_Template

HRIS Element Information

Permissions

● <Permission Category> <Permission Name>

● <Permission Category> <Permission Name>

Supported Operations

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 475
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

Navigation Properties

Navigation Property Related Entity Description

Entity Relationship Diagram

Use Case: <Descriptive Title of Use Case>

Description of the use case.

Request

Operation <Your Input>

HTTP Method <Your Input>

URI https://<api-server>/odata/v2/<Your Input>

Headers

Payload

Response

Use Case: <Descriptive Title of Use Case>

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

476 PUBLIC Global Benefits Objects
Request

Operation <Your Input>

HTTP Method <Your Input>

URI https://<api-server>/odata/v2/<Your Input>

Headers

Payload

Response

Error Codes

Error Code Description

Additional Information

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Global Benefits Objects PUBLIC 477
11 Payment Information Objects

This section contains country or region-specific APIs for payment information.

The following entities are available:

Country/Region Entity Name Country/Region­specific Fields

Argentina PaymentInformationDetailV3ARG Account Type

Brazil PaymentInformationDetailV3BRA Bank Control Key

Chile PaymentInformationDetailV3CHL Bank Control Key

Colombia PaymentInformationDetailV3COL ● Account Type

● Proof of Identity

Ecuador PaymentInformationDetailV3ECU Account Type

France PaymentInformationDetailV3FRA Bank Control Key

Israel PaymentInformationDetailV3ISR ● Branch Code

● Branch Name

Italy PaymentInformationDetailV3ITA Bank Control Key

Japan PaymentInformationDetailV3JPN Account Type

Kenya PaymentInformationDetailV3KEN Account Type

Marcedonia PaymentInformationDetailV3MKD Account Type

Mexico PaymentInformationDetailV3MEX ● Bank Control Key

● CLABE Number

New Zealand PaymentInformationDetailV3NZL Reference Field

Nigeria PaymentInformationDetailV3NGA Account Type

Slovenia PaymentInformationDetailV3SVN Account Type

Spain PaymentInformationDetailV3ESP Bank Control Key

South Africa PaymentInformationDetailV3ZAF ● Account Type

● Account Holder Relationship

United Kingdom PaymentInformationDetailV3GBR Building Society Roll Number

United States PaymentInformationDetailV3USA Account Type

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

478 PUBLIC Payment Information Objects
 Country/Region Entity Name Country/Region­specific Fields

Venezuela PaymentInformationDetailV3VEN ● Account Type

● Payment Reference

Bank [page 479]

This entity contains bank-related information such as Bank Name, BIC, Bank Address, and so on.

PaymentInformationDetailV3GHA and PaymentInformationDetailV3SUR [page 482]

These entities store the country/region dependent fields for Payment Information Details for Ghana and
Suriname. You can use these entities to create, modify or delete the PaymentInformationDetailV3’s child
objects PaymentInformationDetailV3GHA entity and PaymentInformationDetailV3SUR entity.

PaymentInformationDetailV3ZAF [page 485]

You can use this entity to access the Payment Information Screen for South Africa (ZAF).

PaymentInformationDetailV3MOZ [page 496]

This entity stores the country-dependent fields of payment information details for Mozambique. You can
use this entity to create, modify or delete the PaymentInformationDetailV3’s child objects.

11.1 Bank

This entity contains bank-related information such as Bank Name, BIC, Bank Address, and so on.

Supported Operations

Query, Insert, Merge, Replace, Upsert, Delete

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Case: Querying Bank Details

The following example shows how to query bank details.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payment Information Objects PUBLIC 479
Request

Operation Query

HTTP Method GET

URI https://api-server/odata/v2/Bank?$format=json&$select=externalCode,bank­
Branch,city,postalCode,bankName,bankCountry,effectiveStatus,routingNum­
ber,street,businessIdentifierCode&$top=2

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://api-server/odata/v2/Bank('921')",
"type": "SFOData.Bank"
},
"externalCode": "921",
"routingNumber": "012-002",
"bankBranch": null,
"city": null,
"street": null,
"postalCode": null,
"businessIdentifierCode": null,
"bankName": "ANZ Martin Place and Pitt Street Martin Place",
"bankCountry": "AUS",
"effectiveStatus": "A"
},
{
"__metadata": {
"uri": "https://api-server/odata/v2/Bank('922')",
"type": "SFOData.Bank"
},
"externalCode": "922",
"routingNumber": "013-006",
"bankBranch": null,
"city": null,
"street": null,
"postalCode": null,
"businessIdentifierCode": null,
"bankName": "ANZ Melbourne (388 Collins)",
"bankCountry": "AUS",
"effectiveStatus": "A"
}
]
}
}

Use Case: Creating or Updating a Bank Object

The following example shows how to create or update bank details.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

480 PUBLIC Payment Information Objects
Request

Operation Upsert

HTTP Method POST

URI https://api-server/odata/v2/upsert?$format=json

Request Payload

 Sample Code

{
"__metadata": {
"uri": "https://api-server/
odata/v2/Bank('12345')",
"type": "SFOData.Bank"
},
"externalCode":"12345",
"bankBranch":null,
"city":null,
"street":null,
"postalCode":null,
"businessIdentifierCode": null,
"bankName":"Testing Bank of USA",
"bankCountry": "USA",
"effectiveStatus": "A"
}

Response

{
"d": [
{
"key": "Bank/externalCode=12345",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Additional Information

The property <bankCountry> stores the internal ID of the country MDF object.

Parent topic: Payment Information Objects [page 478]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payment Information Objects PUBLIC 481
Related Information

PaymentInformationDetailV3GHA and PaymentInformationDetailV3SUR [page 482]

PaymentInformationDetailV3ZAF [page 485]
PaymentInformationDetailV3MOZ [page 496]
SAP API Business Hub: Payment Information

11.2 PaymentInformationDetailV3GHA and

PaymentInformationDetailV3SUR

These entities store the country/region dependent fields for Payment Information Details for Ghana and Suriname.
You can use these entities to create, modify or delete the PaymentInformationDetailV3’s child objects
PaymentInformationDetailV3GHA entity and PaymentInformationDetailV3SUR entity.

Permissions

Payment Information V3 is enabled for your company instance.

Supported Operations

Query, Upsert, Insert, Delete.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties
PaymentInformationDetailV3GHA

Property Description

accountType -

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

482 PUBLIC Payment Information Objects
PaymentInformationDetailV3SUR
Property Description

accountType -

Navigation Properties
PaymentInformationDetailV3GHA

Navigation Property Related Entity Description

None - -

PaymentInformationDetailV3SUR
Navigation Property Related Entity Description

None - -

PaymentInformationDetailV3XXX

These entities store the country/region dependent fields for Payment Information Details for Ghana and Suriname.
You can use this entity to create, modify or delete the PaymentInformationDetailV3’s child objects
PaymentInformationDetailV3GHA entity and PaymentInformationDetailV3SUR entity.

Use Case: Querying the Country/Region-specific Payment Information Details

of a Single User

The following example for Suriname shows how to query the payment information detail of one country/region for
a single user.

Request

Operation Query

HTTP Method GET

URI /odata/v2/
PaymentInformationDetailV3SUR(PaymentInformationDetailV3_ex
ternalCode=22822L,PaymentInformationV3_effectiveStartDate=d
atetime'2019-09-04T00:00:00',PaymentInformationV3_worker='s
umeet',externalCode=23581L)?$format=json

Response

{
"d":{
"__metadata":{
"uri":"https://api-server/odata/v2/
PaymentInformationDetailV3SUR(PaymentInformationDetailV3_externalCode=22822L,Payment

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payment Information Objects PUBLIC 483
 InformationV3_effectiveStartDate=datetime'2019-09-04T00:00:00',PaymentInformationV3_
worker='sumeet',externalCode=23581L)",
"type":"SFOData.PaymentInformationDetailV3SUR"
},
"PaymentInformationV3_effectiveStartDate":"/Date(1567555200000)/",
"externalCode":"23581",
"PaymentInformationV3_worker":"sumeet",
"PaymentInformationDetailV3_externalCode":"22822",
"lastModifiedDateTime":"/Date(1597741580000+0000)/",
"createdBy":"admin",
"accountType":"CA",
"lastModifiedBy":"admin",
"createdDateTime":"/Date(1597741580000+0000)/",
"mdfSystemRecordStatus":"N",
"createdByNav":{
"__deferred":{
"uri":"https://api-server/odata/v2/
PaymentInformationDetailV3SUR(PaymentInformationDetailV3_externalCode=22822L,Payment
InformationV3_effectiveStartDate=datetime'2019-09-04T00:00:00',PaymentInformationV3_
worker='sumeet',externalCode=23581L)/createdByNav"
}
},
"lastModifiedByNav":{
"__deferred":{
"uri":"https://api-server/odata/v2/
PaymentInformationDetailV3SUR(PaymentInformationDetailV3_externalCode=22822L,Payment
InformationV3_effectiveStartDate=datetime'2019-09-04T00:00:00',PaymentInformationV3_
worker='sumeet',externalCode=23581L)/lastModifiedByNav"
}
},
"accountTypeNav":{
"__deferred":{
"uri":"https://api-server/odata/v2/
PaymentInformationDetailV3SUR(PaymentInformationDetailV3_externalCode=22822L,Payment
InformationV3_effectiveStartDate=datetime'2019-09-04T00:00:00',PaymentInformationV3_
worker='sumeet',externalCode=23581L)/accountTypeNav"
}
},
"mdfSystemRecordStatusNav":{
"__deferred":{
"uri":"https://api-server/odata/v2/
PaymentInformationDetailV3SUR(PaymentInformationDetailV3_externalCode=22822L,Payment
InformationV3_effectiveStartDate=datetime'2019-09-04T00:00:00',PaymentInformationV3_
worker='sumeet',externalCode=23581L)/mdfSystemRecordStatusNav"
}
}
}
}

Parent topic: Payment Information Objects [page 478]

Related Information

Bank [page 479]

PaymentInformationDetailV3ZAF [page 485]
PaymentInformationDetailV3MOZ [page 496]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

484 PUBLIC Payment Information Objects
11.3 PaymentInformationDetailV3ZAF

You can use this entity to access the Payment Information Screen for South Africa (ZAF).

Supported Operations

Query, Insert, Upsert, Delete

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Cases

Use Case: Get all PaymentInformationDetailV3ZAF instances.

Request Information

Operation Query

URI http://<api-server>/odata/v2/
PaymentInformationDetailV3ZAF?$format=json

Response

 Sample Code

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3ZAF(PaymentInformationDetailV3_externalCode=6853L,Payme
ntInformationV3_effectiveStartDate=datetime'2016-05-25T00:00:00',PaymentInformati
onV3_worker='ykumar',externalCode=6854L)",
"type": "SFOData.PaymentInformationDetailV3ZAF"
},
"PaymentInformationV3_effectiveStartDate": "/Date(1464134400000)/",
"PaymentInformationDetailV3_externalCode": "6853",
"PaymentInformationV3_worker": "ykumar",
"externalCode": "6854",
"accountHolderRelationship": "THIRDPARTY",
"accountType": "NOTPAIDEFT",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payment Information Objects PUBLIC 485
 "accountHolderRelationshipNav": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3ZAF(PaymentInformationDetailV3_externalCode=6853L,Payme
ntInformationV3_effectiveStartDate=datetime'2016-05-25T00:00:00',PaymentInformati
onV3_worker='ykumar',externalCode=6854L)/accountHolderRelationshipNav"
}
},
"accountTypeNav": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3ZAF(PaymentInformationDetailV3_externalCode=6853L,Payme
ntInformationV3_effectiveStartDate=datetime'2016-05-25T00:00:00',PaymentInformati
onV3_worker='ykumar',externalCode=6854L)/accountTypeNav"
}
}
},
{
"__metadata": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3ZAF(PaymentInformationDetailV3_externalCode=6851L,Payme
ntInformationV3_effectiveStartDate=datetime'2016-05-25T00:00:00',PaymentInformati
onV3_worker='ykumar',externalCode=6852L)",
"type": "SFOData.PaymentInformationDetailV3ZAF"
},
"PaymentInformationV3_effectiveStartDate": "/Date(1464134400000)/",
"PaymentInformationDetailV3_externalCode": "6851",
"PaymentInformationV3_worker": "ykumar",
"externalCode": "6852",
"accountHolderRelationship": "OWN",
"accountType": "CREDITCARD",
"accountHolderRelationshipNav": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3ZAF(PaymentInformationDetailV3_externalCode=6851L,Payme
ntInformationV3_effectiveStartDate=datetime'2016-05-25T00:00:00',PaymentInformati
onV3_worker='ykumar',externalCode=6852L)/accountHolderRelationshipNav"
}
},
"accountTypeNav": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3ZAF(PaymentInformationDetailV3_externalCode=6851L,Payme
ntInformationV3_effectiveStartDate=datetime'2016-05-25T00:00:00',PaymentInformati
onV3_worker='ykumar',externalCode=6852L)/accountTypeNav"
}
}
}
]
}
}

Use Case: Get all Payments including the South Africa specific fields.

Request Information

Operation Query

URI http://<Hostname>/odata/v2/
PaymentInformationDetailV3?$format=json&
$EXPAND=PaymentInformationDetailV3ZAFMETHO
D: GET

Response

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

486 PUBLIC Payment Information Objects
  Sample Code

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6853L)",
"type": "SFOData.PaymentInformationDetailV3"
},
"PaymentInformationV3_effectiveStartDate": "/Date(1464134400000)/",
"PaymentInformationV3_worker": "ykumar",
"externalCode": "6853",
"percent": null,
"amount": "23",
"accountNumber": "2332323",
"bank": null,
"paySequence": "1",
"payType": "PAYROLL",
"iban": null,
"purpose": null,
"currency": "ZAR",
"businessIdentifierCode": null,
"bankCountry": "ZAF",
"customPayType": null,
"accountOwner": "kumar",
"routingNumber": "123456",
"paymentMethod": "05",
"toPaymentInformationDetailV3JPN": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6853L)/
toPaymentInformationDetailV3JPN"
}
},
"toPaymentInformationDetailV3ISR": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6853L)/
toPaymentInformationDetailV3ISR"
}
},
"toPaymentInformationDetailV3COL": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6853L)/
toPaymentInformationDetailV3COL"
}
},
"toPaymentInformationDetailV3ZAF": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6853L)/
toPaymentInformationDetailV3ZAF"
}
},
"toPaymentInformationDetailV3GBR": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payment Information Objects PUBLIC 487
 05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6853L)/
toPaymentInformationDetailV3GBR"
}
},
"toPaymentInformationDetailV3NZL": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6853L)/
toPaymentInformationDetailV3NZL"
}
},
"toPaymentInformationDetailV3ITA": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6853L)/
toPaymentInformationDetailV3ITA"
}
},
"paymentMethodNav": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6853L)/
paymentMethodNav"
}
},
"toPaymentInformationDetailV3ECU": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6853L)/
toPaymentInformationDetailV3ECU"
}
},
"toPaymentInformationDetailV3USA": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6853L)/
toPaymentInformationDetailV3USA"
}
},
"toPaymentInformationDetailV3VEN": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6853L)/
toPaymentInformationDetailV3VEN"
}
},
"toPaymentInformationDetailV3CHL": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6853L)/
toPaymentInformationDetailV3CHL"
}
},
"currencyNav": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6853L)/
currencyNav"
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

488 PUBLIC Payment Information Objects
 "toPaymentInformationDetailV3FRA": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6853L)/
toPaymentInformationDetailV3FRA"
}
},
"toPaymentInformationDetailV3NGA": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6853L)/
toPaymentInformationDetailV3NGA"
}
},
"payTypeNav": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6853L)/
payTypeNav"
}
},
"bankCountryNav": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6853L)/
bankCountryNav"
}
},
"toPaymentInformationDetailV3ESP": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6853L)/
toPaymentInformationDetailV3ESP"
}
},
"toPaymentInformationDetailV3ARG": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6853L)/
toPaymentInformationDetailV3ARG"
}
},
"toPaymentInformationDetailV3MEX": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6853L)/
toPaymentInformationDetailV3MEX"
}
},
"toPaymentInformationDetailV3KEN": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6853L)/
toPaymentInformationDetailV3KEN"
}
},
"toPaymentInformationDetailV3BRA": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payment Information Objects PUBLIC 489
 05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6853L)/
toPaymentInformationDetailV3BRA"
}
}
},
{
"__metadata": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6851L)",
"type": "SFOData.PaymentInformationDetailV3"
},
"PaymentInformationV3_effectiveStartDate": "/Date(1464134400000)/",
"PaymentInformationV3_worker": "ykumar",
"externalCode": "6851",
"percent": null,
"amount": null,
"accountNumber": "777777777",
"bank": null,
"paySequence": "0",
"payType": "MAIN",
"iban": null,
"purpose": null,
"currency": null,
"businessIdentifierCode": null,
"bankCountry": "ZAF",
"customPayType": null,
"accountOwner": "yadav",
"routingNumber": "123456",
"paymentMethod": "05",
"toPaymentInformationDetailV3JPN": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6851L)/
toPaymentInformationDetailV3JPN"
}
},
"toPaymentInformationDetailV3ISR": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6851L)/
toPaymentInformationDetailV3ISR"
}
},
"toPaymentInformationDetailV3COL": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6851L)/
toPaymentInformationDetailV3COL"
}
},
"toPaymentInformationDetailV3ZAF": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6851L)/
toPaymentInformationDetailV3ZAF"
}
},
"toPaymentInformationDetailV3GBR": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6851L)/
toPaymentInformationDetailV3GBR"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

490 PUBLIC Payment Information Objects
 }
},
"toPaymentInformationDetailV3NZL": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6851L)/
toPaymentInformationDetailV3NZL"
}
},
"toPaymentInformationDetailV3ITA": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6851L)/
toPaymentInformationDetailV3ITA"
}
},
"paymentMethodNav": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6851L)/
paymentMethodNav"
}
},
"toPaymentInformationDetailV3ECU": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6851L)/
toPaymentInformationDetailV3ECU"
}
},
"toPaymentInformationDetailV3USA": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6851L)/
toPaymentInformationDetailV3USA"
}
},
"toPaymentInformationDetailV3VEN": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6851L)/
toPaymentInformationDetailV3VEN"
}
},
"toPaymentInformationDetailV3CHL": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6851L)/
toPaymentInformationDetailV3CHL"
}
},
"currencyNav": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6851L)/
currencyNav"
}
},
"toPaymentInformationDetailV3FRA": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payment Information Objects PUBLIC 491
 "uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6851L)/
toPaymentInformationDetailV3FRA"
}
},
"toPaymentInformationDetailV3NGA": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6851L)/
toPaymentInformationDetailV3NGA"
}
},
"payTypeNav": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6851L)/
payTypeNav"
}
},
"bankCountryNav": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6851L)/
bankCountryNav"
}
},
"toPaymentInformationDetailV3ESP": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6851L)/
toPaymentInformationDetailV3ESP"
}
},
"toPaymentInformationDetailV3ARG": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6851L)/
toPaymentInformationDetailV3ARG"
}
},
"toPaymentInformationDetailV3MEX": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6851L)/
toPaymentInformationDetailV3MEX"
}
},
"toPaymentInformationDetailV3KEN": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6851L)/
toPaymentInformationDetailV3KEN"
}
},
"toPaymentInformationDetailV3BRA": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6851L)/
toPaymentInformationDetailV3BRA"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

492 PUBLIC Payment Information Objects
 }
}
},
{
"__metadata": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6855L)",
"type": "SFOData.PaymentInformationDetailV3"
},
"PaymentInformationV3_effectiveStartDate": "/Date(1464134400000)/",
"PaymentInformationV3_worker": "ykumar",
"externalCode": "6855",
"percent": "23",
"amount": null,
"accountNumber": "346456456456",
"bank": null,
"paySequence": "2",
"payType": "BONUS",
"iban": null,
"purpose": null,
"currency": "ZAR",
"businessIdentifierCode": null,
"bankCountry": "ZAF",
"customPayType": null,
"accountOwner": "arora",
"routingNumber": "987654",
"paymentMethod": "05",
"toPaymentInformationDetailV3JPN": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6855L)/
toPaymentInformationDetailV3JPN"
}
},
"toPaymentInformationDetailV3ISR": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6855L)/
toPaymentInformationDetailV3ISR"
}
},
"toPaymentInformationDetailV3COL": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6855L)/
toPaymentInformationDetailV3COL"
}
},
"toPaymentInformationDetailV3ZAF": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6855L)/
toPaymentInformationDetailV3ZAF"
}
},
"toPaymentInformationDetailV3GBR": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6855L)/
toPaymentInformationDetailV3GBR"
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payment Information Objects PUBLIC 493
 "toPaymentInformationDetailV3NZL": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6855L)/
toPaymentInformationDetailV3NZL"
}
},
"toPaymentInformationDetailV3ITA": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6855L)/
toPaymentInformationDetailV3ITA"
}
},
"paymentMethodNav": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6855L)/
paymentMethodNav"
}
},
"toPaymentInformationDetailV3ECU": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6855L)/
toPaymentInformationDetailV3ECU"
}
},
"toPaymentInformationDetailV3USA": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6855L)/
toPaymentInformationDetailV3USA"
}
},
"toPaymentInformationDetailV3VEN": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6855L)/
toPaymentInformationDetailV3VEN"
}
},
"toPaymentInformationDetailV3CHL": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6855L)/
toPaymentInformationDetailV3CHL"
}
},
"currencyNav": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6855L)/
currencyNav"
}
},
"toPaymentInformationDetailV3FRA": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

494 PUBLIC Payment Information Objects
 05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6855L)/
toPaymentInformationDetailV3FRA"
}
},
"toPaymentInformationDetailV3NGA": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6855L)/
toPaymentInformationDetailV3NGA"
}
},
"payTypeNav": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6855L)/
payTypeNav"
}
},
"bankCountryNav": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6855L)/
bankCountryNav"
}
},
"toPaymentInformationDetailV3ESP": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6855L)/
toPaymentInformationDetailV3ESP"
}
},
"toPaymentInformationDetailV3ARG": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6855L)/
toPaymentInformationDetailV3ARG"
}
},
"toPaymentInformationDetailV3MEX": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6855L)/
toPaymentInformationDetailV3MEX"
}
},
"toPaymentInformationDetailV3KEN": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6855L)/
toPaymentInformationDetailV3KEN"
}
},
"toPaymentInformationDetailV3BRA": {
"__deferred": {
"uri": "https://api-server/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate=datetime'2016-
05-25T00:00:00',PaymentInformationV3_worker='ykumar',externalCode=6855L)/
toPaymentInformationDetailV3BRA"
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payment Information Objects PUBLIC 495
 }
]
}
}

Parent topic: Payment Information Objects [page 478]

Related Information

Bank [page 479]

PaymentInformationDetailV3GHA and PaymentInformationDetailV3SUR [page 482]
PaymentInformationDetailV3MOZ [page 496]

11.4 PaymentInformationDetailV3MOZ

This entity stores the country-dependent fields of payment information details for Mozambique. You can use this
entity to create, modify or delete the PaymentInformationDetailV3’s child objects.

Supported Operations

Operation Description

Query Yes

Insert Yes

Upsert Yes

Delete Yes

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

496 PUBLIC Payment Information Objects
Properties

Property Description

accountType

Entity Relationship Diagram

Use Case 1: <Query the XXX for a single user>

The following example uses Mozambique as an example shows how to query the payment information details of
one country for a single user.

Request

Operation Query

HTTP Method GET

URI https://<hostname>/odata/v2/
PaymentInformationDetailV3(PaymentInformationV3_effectiveSt
artDate=datetime'2019-09-04T00:00:00',PaymentInformationV3_
worker='155',externalCode=22890L)/
toPaymentInformationDetailV3MOZ?$format=json

Response

{
"d": {
"__metadata": {
"uri": "https://localhost:443/odata/v2/
PaymentInformationDetailV3MOZ(PaymentInformationDetailV3_externalCode=22890L,Payment
InformationV3_effectiveStartDate=datetime'2019-09-04T00:00:00',PaymentInformationV3_
worker='155',externalCode=22916L)",
"type": "SFOData.PaymentInformationDetailV3MOZ"
},
"PaymentInformationV3_effectiveStartDate": "/Date(1567555200000)/",
"externalCode": "22916",
"PaymentInformationV3_worker": "155",
"PaymentInformationDetailV3_externalCode": "22890",
"lastModifiedDateTime": "/Date(1567583742000+0000)/",
"accountType": "CURRENT",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1567583742000+0000)/",
"mdfSystemRecordStatus": "N",
"createdBy": "admin",
"createdByNav": {
"__deferred": {
"uri": "https://localhost:443/odata/v2/
PaymentInformationDetailV3MOZ(PaymentInformationDetailV3_externalCode=22890L,Payment
InformationV3_effectiveStartDate=datetime'2019-09-04T00:00:00',PaymentInformationV3_
worker='155',externalCode=22916L)/createdByNav"
}
},
"accountTypeNav": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payment Information Objects PUBLIC 497
 "__deferred": {
"uri": "https://localhost:443/odata/v2/
PaymentInformationDetailV3MOZ(PaymentInformationDetailV3_externalCode=22890L,Payment
InformationV3_effectiveStartDate=datetime'2019-09-04T00:00:00',PaymentInformationV3_
worker='155',externalCode=22916L)/accountTypeNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://localhost:443/odata/v2/
PaymentInformationDetailV3MOZ(PaymentInformationDetailV3_externalCode=22890L,Payment
InformationV3_effectiveStartDate=datetime'2019-09-04T00:00:00',PaymentInformationV3_
worker='155',externalCode=22916L)/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://localhost:443/odata/v2/
PaymentInformationDetailV3MOZ(PaymentInformationDetailV3_externalCode=22890L,Payment
InformationV3_effectiveStartDate=datetime'2019-09-04T00:00:00',PaymentInformationV3_
worker='155',externalCode=22916L)/mdfSystemRecordStatusNav"
}
}
}
}

Use Case 2: Upsert the XXX for a single user

The following example uses Macedonia as an example and shows how to upsert the payment information of one
country for a single user.

Request

Operation Upsert

HTTP Method POST

URI https://<hostname>/odata/v2/upsert

Payload {
"__metadata": {
"uri":
"PaymentInformationDetailV3MOZ(PaymentInformationDetailV
3_externalCode=22890L,PaymentInformationV3_effectiveStar
tDate=datetime'2019-09-04T00:00:00',PaymentInformationV3
_worker='155',externalCode=22916)"
},
"accountType": "SAVINGS"
}

Response

<?xml version="1.0" encoding="utf-8"?>

<feed xmlns="http://www.w3.org/2005/Atom" xmlns:m="http://schemas.microsoft.com/ado/
2007/08/dataservices/metadata" xmlns:d="http://schemas.microsoft.com/ado/2007/08/
dataservices">
<entry>
<content type="application/xml">

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

498 PUBLIC Payment Information Objects
 <m:properties>
<d:key>PaymentInformationDetailV3MOZ/
PaymentInformationDetailV3_externalCode=22890,PaymentInformationDetailV3MOZ/
PaymentInformationV3_effectiveStartDate=2019-09-04T00:00:00.000+08:00,PaymentInforma
tionDetailV3MOZ/PaymentInformationV3_worker=155,PaymentInformationDetailV3MOZ/
externalCode=22916</d:key>
<d:status>OK</d:status>
<d:editStatus>UPSERTED</d:editStatus>
<d:message m:null="true"></d:message>
<d:index m:type="Edm.Int32">0</d:index>
<d:httpCode m:type="Edm.Int32">200</d:httpCode>
<d:inlineResults m:type="Bag(SFOData.UpsertResult)"></
d:inlineResults>
</m:properties>
</content>
</entry>
</feed>

Use Case 3: Delete the XXX for a single user

The following example uses Macedonia as an example and shows how to delete the payment information of one
country for a single user.

Request

Operation Delete

HTTP Method DELETE

URI http://<hostname>/odata/v2/
PaymentInformationDetailV3MOZ(PaymentInformationDetailV3_ex
ternalCode=22890L,PaymentInformationV3_effectiveStartDate=d
atetime'2019-09-04T00:00:00',PaymentInformationV3_worker='1
55',externalCode=22916L)

Parent topic: Payment Information Objects [page 478]

Related Information

Bank [page 479]

PaymentInformationDetailV3GHA and PaymentInformationDetailV3SUR [page 482]
PaymentInformationDetailV3ZAF [page 485]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payment Information Objects PUBLIC 499
12 Payroll

12.1 DataReplicationProxy

You use this entity to store references to Employee Central Time data that are relevant for replication to your
selected system/landscape, like Employee Central Payroll or SAP ERP HCM, and to identify all delta changes of
your replicated time data. It only contains a limited number of references to available Employee Central Time
objects.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Case: Retrieving Data Replication Proxies

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
DataReplicationProxy?$format=json

Response

{
"d": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

500 PUBLIC Payroll
 "results": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/
DataReplicationProxy('75846be1b99b413f8d0f8872e89d3acf')",
"type": "SFOData.DataReplicationProxy"
},
"externalCode": "75846be1b99b413f8d0f8872e89d3acf",
"replicationTargetSystem": "XXXCLNT100",
"useCostCenterExternalObjectId": false,
"sourceGenericObjectInternalId": "123456789",
"userId": "111",
"replicationContentType": "EMPLOYEE_TIME_DATA",
"allowReplicationInCorrectionPhase": false,
"sourceGenericObjectExternalCode": "75846be1b99b413f8d0f8872e89d3acf",
"legalEntity": "AE01",
"employeeTime": "75846be1b99b413f8d0f8872e89d3acf",
"dataReplicationProxyStatus": "OUT_OF_SYNC",
"earliestReplicationDateTime": "/Date(1454510575000+0000)/",
"employeeTimeNav": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/
EmployeeTime('75846be1b99b413f8d0f8872e89d3acf')",
"type": "SFOData.EmployeeTime"
},
"externalCode": "75846be1b99b413f8d0f8872e89d3acf",
"quantityInDays": "1",
"endDate": "/Date(1424217600000)/",
"timeType": "OOO",
"approvalStatus": "APPROVED",
"comment": null,
"startDate": "/Date(1424217600000)/",
"quantityInHours": "8",
}
}
}
}

12.2 EmployeePayrollRunResults

You use this entity to retain information about the employees payroll run results for a particular period of time.

Permissions

● User Permissions Miscellaneous Permissions

Supported Operations

Query, Insert, Upsert, Merge, Delete

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payroll PUBLIC 501
Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Cases

This is the query operation for EmployeePayrollRunResults entity which is further associated with
EmployeePayrollRunResultsItems with 1:N relationship. This query is requesting the data for an employee called
‘maryusa1’ and in response, the required data will be retrieved.

Request

Operation QUERY

URI https://<api-server>/odata/v2/
EmployeePayrollRunResults?$format=json&
$filter=userId eq 'maryusa1'&
$expand=employeePayrollRunResults

Headers Authorization: Basic <Base 64 encoded (“user@com­

pany:password”)>

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

502 PUBLIC Payroll
 Payload {
"__metadata": {
"uri": "https://<api-server>/
odata/v2/
EmployeePayrollRunResults(externalCode='
SAP_EC_PAYROLL_US01_0101201501312015_399
1_4031',mdfSystemEffectiveStartDate=date
time'2015-01-31T00:00:00')",
"type":
"SFOData.EmployeePayrollRunResults"
},
"mdfSystemEffectiveStartDate": "/
Date(1422662400000)/",
"externalCode":
"SAP_EC_PAYROLL_US01_0101201501312015_39
91_4031",
"payrollRunType": "EC_PRT_001",
"mdfSystemEffectiveEndDate": "/
Date(253402214400000)/",
"mdfSystemObjectType":
"EmployeePayrollRunResults",
"payrollId": null,
"mdfSystemVersionId": null,
"employmentId": "4031",
"lastModifiedDateTime": "/
Date(1436522255000+0000)/",
"sequenceNumber": "15",
"mdfSystemTransactionSequence": "1",
"currency": "USD",
"payrollProviderPayrollRunType":
"R",
"payrollProviderId":
"SAP_EC_PAYROLL",
"isVoid": false,
"mdfSystemRecordId":
"376D2FFE74E64F23BFF86DC13FEF3F6B",
"mdfSystemEntityId":
"5921769D435546AA9C5F650789047230",
"userId": "maryusa1",
"personId": "3991",
"mdfSystemStatus": "A",
"payDate": "/Date(1422662400000)/",
"systemId": "QK8",
"lastModifiedDateWithTZ": "/
Date(1436522255000+0000)/",
"createdDate": "/
Date(1427788173000)/",
"mdfSystemRecordStatus": "N",
"startDateWhenPaid": "/
Date(1420070400000)/",
"externalName": null,
"endDateWhenPaid": "/
Date(1422662400000)/",
"clientId": "507",
"createdBy": "hajek",
"createdDateTime": "/
Date(1427788173000+0000)/",
"lastModifiedBy": "admin",
"lastModifiedDate": "/
Date(1436522255000)/",
"companyId": "US01",
"payrollRunTypeNav": {
"__deferred": {
"uri": "https://<api-
server>/odata/v2/

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payroll PUBLIC 503
 EmployeePayrollRunResults(externalCode='
SAP_EC_PAYROLL_US01_0101201501312015_399
1_4031',mdfSystemEffectiveStartDate=date
time'2015-01-31T00:00:00')/
payrollRunTypeNav"
}
}

Response

{
"d": {
"results": [{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
EmployeePayrollRunResults(externalCode='SAP_EC_PAYROLL_US01_0101201501312015_3991_40
31',mdfSystemEffectiveStartDate=datetime'2015-01-31T00:00:00')",
"type": "SFOData.EmployeePayrollRunResults"
},
"mdfSystemEffectiveStartDate": "/Date(1422662400000)/",
"externalCode":
"SAP_EC_PAYROLL_US01_0101201501312015_3991_4031",
"payrollRunType": "EC_PRT_001",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "EmployeePayrollRunResults",
"payrollId": null,
"mdfSystemVersionId": null,
"employmentId": "4031",
"lastModifiedDateTime": "/Date(1436522255000+0000)/",
"sequenceNumber": "15",
"mdfSystemTransactionSequence": "1",
"currency": "USD",
"payrollProviderPayrollRunType": "R",
"payrollProviderId": "SAP_EC_PAYROLL",
"isVoid": false,
"mdfSystemRecordId": "376D2FFE74E64F23BFF86DC13FEF3F6B",
"mdfSystemEntityId": "5921769D435546AA9C5F650789047230",
"userId": "maryusa1",
"personId": "3991",
"mdfSystemStatus": "A",
"payDate": "/Date(1422662400000)/",
"systemId": "QK8",
"lastModifiedDateWithTZ": "/Date(1436522255000+0000)/",
"createdDate": "/Date(1427788173000)/",
"mdfSystemRecordStatus": "N",
"startDateWhenPaid": "/Date(1420070400000)/",
"externalName": null,
"endDateWhenPaid": "/Date(1422662400000)/",
"clientId": "507",
"createdBy": "hajek",
"createdDateTime": "/Date(1427788173000+0000)/",
"lastModifiedBy": "admin",
"lastModifiedDate": "/Date(1436522255000)/",
"companyId": "US01",
"payrollRunTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeePayrollRunResults(externalCode='SAP_EC_PAYROLL_US01_0101201501312015_3991_40
31',mdfSystemEffectiveStartDate=datetime'2015-01-31T00:00:00')/payrollRunTypeNav"
}
},
"employeePayrollRunResultsItems": {
"results": [{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
EmployeePayrollRunResultsItems(EmployeePayrollRunResults_externalCode='SAP_EC_PAYROL

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

504 PUBLIC Payroll
 L_US01_0101201501312015_3991_4031',EmployeePayrollRunResults_mdfSystemEffectiveStart
Date=datetime'2015-01-31T00:00:00',externalCode='3991_/101_0101201501312015')",
"type": "SFOData.EmployeePayrollRunResultsItems"
},

"EmployeePayrollRunResults_mdfSystemEffectiveStartDate": "/Date(1422662400000)/",
"EmployeePayrollRunResults_externalCode":
"SAP_EC_PAYROLL_US01_0101201501312015_3991_4031",
"externalCode": "3991_/101_0101201501312015",
"payrollProviderWageType": "/101",
"payrollProviderGroupingValue": null,
"mdfSystemEffectiveEndDate": "/
Date(253402214400000)/",
"mdfSystemObjectType":
"EmployeePayrollRunResultsItems",
"mdfSystemVersionId": null,
"payrollProviderUnitOfMeasurement": null,
"lastModifiedDateTime": "/
Date(1436522255000+0000)/",
"mdfSystemTransactionSequence": "1",
"amount": "85.27",
"mdfSystemRecordId":
"A863859AFD61418A95EABD522652F7D9",
"mdfSystemEntityId":
"DBB2408595F64423AB0CCCB17466E59E",
"mdfSystemStatus": "A",
"quantity": "0",
"lastModifiedDateWithTZ": "/
Date(1436522255000+0000)/",
"createdDate": "/Date(1429517937000)/",
"mdfSystemRecordStatus": "N",
"wageType": "EC_MOB_US_GROSS",
"unitOfMeasurement": null,
"externalName": null,
"payrollProviderGroupingReason": null,
"createdBy": "hajek",
"groupingReason": null,
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1429517937000+0000)/",
"startDateWhenEarned": "/Date(1420070400000)/",
"lastModifiedDate": "/Date(1436522255000)/",
"mdfSystemEffectiveStartDate": "/
Date(-2208988800000)/",
"endDateWhenEarned": "/Date(1422662400000)/",
"groupingReasonNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeePayrollRunResultsItems(EmployeePayrollRunResults_externalCode='SAP_EC_PAYROL
L_US01_0101201501312015_3991_4031',EmployeePayrollRunResults_mdfSystemEffectiveStart
Date=datetime'2015-01-31T00:00:00',externalCode='3991_/101_0101201501312015')/
groupingReasonNav"
}
},
"wageTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeePayrollRunResultsItems(EmployeePayrollRunResults_externalCode='SAP_EC_PAYROL
L_US01_0101201501312015_3991_4031',EmployeePayrollRunResults_mdfSystemEffectiveStart
Date=datetime'2015-01-31T00:00:00',externalCode='3991_/101_0101201501312015')/
wageTypeNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeePayrollRunResultsItems(EmployeePayrollRunResults_externalCode='SAP_EC_PAYROL
L_US01_0101201501312015_3991_4031',EmployeePayrollRunResults_mdfSystemEffectiveStart

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payroll PUBLIC 505
 Date=datetime'2015-01-31T00:00:00',externalCode='3991_/101_0101201501312015')/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeePayrollRunResultsItems(EmployeePayrollRunResults_externalCode='SAP_EC_PAYROL
L_US01_0101201501312015_3991_4031',EmployeePayrollRunResults_mdfSystemEffectiveStart
Date=datetime'2015-01-31T00:00:00',externalCode='3991_/101_0101201501312015')/
mdfSystemStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
EmployeePayrollRunResultsItems(EmployeePayrollRunResults_externalCode='SAP_EC_PAYROL
L_US01_0101201501312015_3991_4031',EmployeePayrollRunResults_mdfSystemEffectiveStart
Date=datetime'2015-01-31T00:00:00',externalCode='3991_/845_0101201501312015')",
"type": "SFOData.EmployeePayrollRunResultsItems"
},

"EmployeePayrollRunResults_mdfSystemEffectiveStartDate": "/Date(1422662400000)/",
"EmployeePayrollRunResults_externalCode":
"SAP_EC_PAYROLL_US01_0101201501312015_3991_4031",
"externalCode": "3991_/845_0101201501312015",
"payrollProviderWageType": "/845",
"payrollProviderGroupingValue": null,
"mdfSystemEffectiveEndDate": "/
Date(253402214400000)/",
"mdfSystemObjectType":
"EmployeePayrollRunResultsItems",
"mdfSystemVersionId": null,
"payrollProviderUnitOfMeasurement": null,
"lastModifiedDateTime": "/
Date(1435563657000+0000)/",
"mdfSystemTransactionSequence": "1",
"amount": "120.9",
"mdfSystemRecordId":
"44748190EB8C4986B57A96C5E70FA540",
"mdfSystemEntityId":
"CD3CD50DFE9D40C6BE9802B835D8ABF3",
"mdfSystemStatus": "A",
"quantity": "37.5",
"lastModifiedDateWithTZ": "/
Date(1435563657000+0000)/",
"createdDate": "/Date(1429517937000)/",
"mdfSystemRecordStatus": "N",
"wageType": "EC_WT_845",
"unitOfMeasurement": null,
"externalName": null,
"payrollProviderGroupingReason": null,
"createdBy": "hajek",
"groupingReason": null,
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1429517937000+0000)/",
"startDateWhenEarned": "/Date(1420070400000)/",
"lastModifiedDate": "/Date(1435563657000)/",
"mdfSystemEffectiveStartDate": "/
Date(-2208988800000)/",
"endDateWhenEarned": "/Date(1422662400000)/",
"groupingReasonNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeePayrollRunResultsItems(EmployeePayrollRunResults_externalCode='SAP_EC_PAYROL
L_US01_0101201501312015_3991_4031',EmployeePayrollRunResults_mdfSystemEffectiveStart

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

506 PUBLIC Payroll
 Date=datetime'2015-01-31T00:00:00',externalCode='3991_/845_0101201501312015')/
groupingReasonNav"
}
},
"wageTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeePayrollRunResultsItems(EmployeePayrollRunResults_externalCode='SAP_EC_PAYROL
L_US01_0101201501312015_3991_4031',EmployeePayrollRunResults_mdfSystemEffectiveStart
Date=datetime'2015-01-31T00:00:00',externalCode='3991_/845_0101201501312015')/
wageTypeNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeePayrollRunResultsItems(EmployeePayrollRunResults_externalCode='SAP_EC_PAYROL
L_US01_0101201501312015_3991_4031',EmployeePayrollRunResults_mdfSystemEffectiveStart
Date=datetime'2015-01-31T00:00:00',externalCode='3991_/845_0101201501312015')/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeePayrollRunResultsItems(EmployeePayrollRunResults_externalCode='SAP_EC_PAYROL
L_US01_0101201501312015_3991_4031',EmployeePayrollRunResults_mdfSystemEffectiveStart
Date=datetime'2015-01-31T00:00:00',externalCode='3991_/845_0101201501312015')/
mdfSystemStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
EmployeePayrollRunResultsItems(EmployeePayrollRunResults_externalCode='SAP_EC_PAYROL
L_US01_0101201501312015_3991_4031',EmployeePayrollRunResults_mdfSystemEffectiveStart
Date=datetime'2015-01-31T00:00:00',externalCode='3991_/846_0101201501312015')",
"type": "SFOData.EmployeePayrollRunResultsItems"
}
}
]
}
}

Related Information

SAP API Business Hub: Employee Central Payroll

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payroll PUBLIC 507
12.2.1 EmployeePayrollRunResultsItems

You can upsert EmployeePayrollRunResultsItems with EmployeePayrollRunResults, only. This means that all
required operations are carried out through the parent object.

Permissions

● User Permissions Miscellaneous Permissions

Supported Operations

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Case: <Descriptive Title of Use Case>

Description of the use case.

Request

Operation <Your Input>

HTTP Method <Your Input>

URI https://<api-server>/odata/v2/<Your Input>

Headers

Payload

Response

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

508 PUBLIC Payroll
Related Information

SAP API Business Hub: Employee Central Payroll

12.3 PayrollDataMaintenanceTask

The Employee Central Payroll system uses this entity to upsert a JSON-Array of PayrollDataMaintenanceTask
objects. These objects are used to monitor the status of additional end-user tasks, for example payroll-relevant
employee data that has to be entered for a new hire.

Supported Operations

Query, Upsert, Insert

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Cases

Request

Operation Upsert

HTTP Method POST

URI http://<api-server>/odata/v2/upsert?
$format=json

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payroll PUBLIC 509
Payload {
"__metadata":{

"uri":"PayrollDataMaintenanceTask(extern
alCode='40F2E963-0B8A-1EE7-82C7-63DDD7D2
A169')"
},
"userIdNav":{
"__metadata":{
"uri":"User(userId='111')"
}
},
"taskType":"NEW_HIRE",
"legalEntity":"AE01",
"employeeDataEffectiveFromDate":"/
Date(1489190400000)/"
},
{
"__metadata":{

"uri":"PayrollDataMaintenanceTask(extern
alCode='40F2E963-0B8A-1EE7-82C7-63DDD7D2
E169')"
},
"userIdNav":{
"__metadata":{
"uri":"User(userId='111')"
}
},
"taskType":"NEW_HIRE",
"legalEntity":"AE01",
"employeeDataEffectiveFromDate":"/
Date(1489449600000)/"
},
{
"__metadata":{

"uri":"PayrollDataMaintenanceTask(extern
alCode='40F2E963-0B8A-1EE7-82C7-63DDD7D2
C169')"
},
"userIdNav":{
"__metadata":{
"uri":"User(userId='111')"
}
},
"taskType":"NEW_HIRE",
"legalEntity":"AE01",
"employeeDataEffectiveFromDate":"/
Date(1489363200000)/"
}

Response

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

510 PUBLIC Payroll
12.4 PayrollDataMaintenanceTaskConfiguration

Employee Central Payroll uses this entity to upsert a JSON-Array of PayrollEvent configuration objects. Use
these objects for payroll configuration.

Supported Operations

Query, Insert, Upsert, Merge, Delete

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Case

Request

Operation Upsert

URI https://<api-server>/odata/v2/upsert?
$format=json

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payroll PUBLIC 511
Payload „{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollDataMaintenanceTaskConfiguration(
'05ce0ba5c4d34818ac0ecc5694c8f2df')",
"type":
"SFOData.PayrollDataMaintenanceTaskConfi
guration"
},
"status": "A",
"country": "AUS",
"taskTypes": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollDataMaintenanceTaskTypeConfigurat
ion(PayrollDataMaintenanceTaskConfigurat
ion_externalCode='05ce0ba5c4d34818ac0ecc
5694c8f2df',externalCode='c74874772d1c49
7f9d0f231fa51d9eea')",
"type":
"SFOData.PayrollDataMaintenanceTaskTypeC
onfiguration"
},
"externalCode":
"c74874772d1c497f9d0f231fa51d9eea",
"taskType": "NEW_HIRE",
"links": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollDataMaintenanceTaskTypeLinkConfig
uration(PayrollDataMaintenanceTaskConfig
uration_externalCode='05ce0ba5c4d34818ac
0ecc5694c8f2df',PayrollDataMaintenanceTa
skTypeConfiguration_externalCode='c74874
772d1c497f9d0f231fa51d9eea',externalCode
='1be43d5e0e9046ffb15610409fa989ea')",
"type":
"SFOData.PayrollDataMaintenanceTaskTypeL
inkConfiguration"
},
"infotypeName": "227"
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollDataMaintenanceTaskTypeLinkConfig
uration(PayrollDataMaintenanceTaskConfig
uration_externalCode='05ce0ba5c4d34818ac
0ecc5694c8f2df',PayrollDataMaintenanceTa
skTypeConfiguration_externalCode='c74874
772d1c497f9d0f231fa51d9eea',externalCode
='339e500eb4264e81b02cc4c2f3007df7')",
"type":
"SFOData.PayrollDataMaintenanceTaskTypeL
inkConfiguration"
},
"infotypeName": "509"
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

512 PUBLIC Payroll
 {
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollDataMaintenanceTaskTypeLinkConfig
uration(PayrollDataMaintenanceTaskConfig
uration_externalCode='05ce0ba5c4d34818ac
0ecc5694c8f2df',PayrollDataMaintenanceTa
skTypeConfiguration_externalCode='c74874
772d1c497f9d0f231fa51d9eea',externalCode
='186c11387f914e8486b4b96ab73f9c63')",
"type":
"SFOData.PayrollDataMaintenanceTaskTypeL
inkConfiguration"
},
"infotypeName": "33"
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollDataMaintenanceTaskTypeLinkConfig
uration(PayrollDataMaintenanceTaskConfig
uration_externalCode='05ce0ba5c4d34818ac
0ecc5694c8f2df',PayrollDataMaintenanceTa
skTypeConfiguration_externalCode='c74874
772d1c497f9d0f231fa51d9eea',externalCode
='0a922b6405e141f1a894b7a4051d7ff3')",
"type":
"SFOData.PayrollDataMaintenanceTaskTypeL
inkConfiguration"
},
"infotypeName": "188"
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollDataMaintenanceTaskTypeLinkConfig
uration(PayrollDataMaintenanceTaskConfig
uration_externalCode='05ce0ba5c4d34818ac
0ecc5694c8f2df',PayrollDataMaintenanceTa
skTypeConfiguration_externalCode='c74874
772d1c497f9d0f231fa51d9eea',externalCode
='11ad4bd6a07a42799a620b2b8cdccb7e')",
"type":
"SFOData.PayrollDataMaintenanceTaskTypeL
inkConfiguration"
},
"infotypeName": "45"
}
]
}
}
]
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollDataMaintenanceTaskConfiguration(
'cfd105f9340c439a87106de2cf495781')",
"type":
"SFOData.PayrollDataMaintenanceTaskConfi
guration"
},
"status": "A",
"country": "FRA",
"taskTypes": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payroll PUBLIC 513
 "results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollDataMaintenanceTaskTypeConfigurat
ion(PayrollDataMaintenanceTaskConfigurat
ion_externalCode='cfd105f9340c439a87106d
e2cf495781',externalCode='59861119539747
a5939e8b72563d14a5')",
"type":
"SFOData.PayrollDataMaintenanceTaskTypeC
onfiguration"
},
"externalCode":
"59861119539747a5939e8b72563d14a5",
"taskType": "NEW_HIRE",
"links": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollDataMaintenanceTaskTypeLinkConfig
uration(PayrollDataMaintenanceTaskConfig
uration_externalCode='cfd105f9340c439a87
106de2cf495781',PayrollDataMaintenanceTa
skTypeConfiguration_externalCode='598611
19539747a5939e8b72563d14a5',externalCode
='85fc1d2269e245948894865d10fcad39')",
"type":
"SFOData.PayrollDataMaintenanceTaskTypeL
inkConfiguration"
},
"infotypeName": "217"
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollDataMaintenanceTaskTypeLinkConfig
uration(PayrollDataMaintenanceTaskConfig
uration_externalCode='cfd105f9340c439a87
106de2cf495781',PayrollDataMaintenanceTa
skTypeConfiguration_externalCode='598611
19539747a5939e8b72563d14a5',externalCode
='fe12d94682bb4cf7ac031fadd2b5fdc3')",
"type":
"SFOData.PayrollDataMaintenanceTaskTypeL
inkConfiguration"
},
"infotypeName": "272"
}
]
}
}
]
}
}
]
}
}

Response

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

514 PUBLIC Payroll
Additional Information

The PayrollDataMaintenanceTaskConfiguration entity is an external API for the Employee Central Payroll solution. It
is used by the Employee Central Payroll system to upsert a JSON-Array of PayrollDataMaintnanceTaskConfiguration
objects that are used for country-specific payroll configuration. It includes additional payroll-relevant tasks for the
admin. For example, after a hire, there is additional payroll-relevant employee data that needs to be entered. It gives
the admin a list of infotypes that need to be maintained to complete the payroll aspect of the new hire.

Additional information:

● Child MDF: PayrollDataMaintenanceTaskTypeConfiguration. It contains the enum of the task type (for example
new_hire) and the list of infotypes that are required for the configuration of events.
● Grandchild MDF: PayrollDataMaintenanceTaskTypeLinkConfiguration. It contains the infotype details that are
required for the configuration of events.

12.5 PayrollSystemConfiguration

You use this entity to fetch and display payroll system configuration objects in the Payroll Configuration UI like
payroll system configuration data, payroll data maintenance task configuration data and payroll portlets data.

Supported Operations

Query, Insert, Upsert

Use Case: Creating and Updating Payroll System Configuration objects

Request

Operation Upsert

HTTP Method POST

URI https://<api-server>/odata/v2/upsert?
$format=json

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payroll PUBLIC 515
Payload {
"d": {
"results": [{
"__metadata": {
"uri": "
PayrollSystemConfiguration(81L)",
"type":
"SFOData.PayrollSystemConfiguration"
},
"enablePayStatement": true,
"status": "I",
"thirdPartyIdpUrl": null,
"enableBsi": false,
"payrollSystemClientId":
"801",
"payrollSystemUrl":
"https://my010010.payroll.ondemand.com",

"enablePayrollUiIntegration": true,

"enableEnhancedValidationsForProduction"
: true,
"country": "AUS",
"categories": {
"results": [{
"__metadata": {
"uri": "
PayrollConfigurationCategory(PayrollSyst
emConfiguration_externalCode=81L,externa
lCode=82L)",
"type":
"SFOData.PayrollConfigurationCategory"
},

"externalCategoryName_defaultValue":
"Earnings and Deductions",
"links": {
"results": [{

"__metadata": {
"uri":
PayrollConfigurationCategoryLink(Payroll
ConfigurationCategory_externalCode=82L,

PayrollSystemConfiguration_externalCode=
81L,

externalCode=85L)",
"type":
"SFOData.PayrollConfigurationCategoryLin
k"
}

"selfService": false,

"adminService": true,
"service":
null,
"url": null,

"infotypeNumber": "11"
},
{

"__metadata": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

516 PUBLIC Payroll
 "uri":
"PayrollConfigurationCategoryLink(Payrol
lConfigurationCategory_externalCode=82L,

PayrollSystemConfiguration_externalCode=
81L,

externalCode=84L)",
"type":
"SFOData.PayrollConfigurationCategoryLin
k"
},

"selfService": false,

"adminService": true,
"service":
null,
"url": null,

"infotypeNumber": "850"
},
{

"__metadata": {
"uri":
"PayrollConfigurationCategoryLink(Payrol
lConfigurationCategory_externalCode=82L,

PayrollSystemConfiguration_externalCode=
81L,

externalCode=83L)",
"type":
"SFOData.PayrollConfigurationCategoryLin
k"
},

"selfService": false,

"adminService": true,
"service":
null,
"url": null,

"infotypeNumber": "849"
}]
}
}]
}
}]
}
}

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollSystemConfiguration('77c90c013d2c42b89fd5ec53b7edee8b')",
"type": "SFOData.PayrollSystemConfiguration"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payroll PUBLIC 517
 },
"externalCode": "77c90c013d2c42b89fd5ec53b7edee8b",
"externalName": "ARG",
"status": "I",
"enablePayStatement": false,
"payrollSystemUrl": null,
"payrollSystemClientId": null,
"enablePayrollUiIntegration": false,
"lastModifiedDateTime": "/Date(1547633032000+0000)/",
"country": "ARG",
"sapSystemConfiguration": null,
"thirdPartyIdpUrl": null,
"enableBsi": false,
"enablePaystatementDownloadFunctionality": false,
"lastModifiedBy": "admin",
"enableEnhancedValidationsForProduction": true,
"statusNav": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFEnumValue(key='com.successfactors.genericobject.api.StatusEnum',value='I')",
"type": "SFOData.MDFEnumValue"
},
"value": "I",
"key": "com.successfactors.genericobject.api.StatusEnum",
"en_US": "InActive",
"localized": "InActive"
},
"countryNav": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
Country(code='ARG',effectiveStartDate=datetime'1900-01-01T00:00:00')",
"type": "SFOData.Country"
},
"code": "ARG",
"externalName_localized": "Argentina"
}
]
},
"sapSystemConfigurationNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollSystemConfiguration('77c90c013d2c42b89fd5ec53b7edee8b')/
sapSystemConfigurationNav"
}
},
"categories": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategory(PayrollSystemConfiguration_externalCode='77c90c013d2c42
b89fd5ec53b7edee8b',externalCode='0b8ff64d63b1466ebfa6b3f8aeb87861')",
"type": "SFOData.PayrollConfigurationCategory"
},
"PayrollSystemConfiguration_externalCode":
"77c90c013d2c42b89fd5ec53b7edee8b",
"externalCode": "0b8ff64d63b1466ebfa6b3f8aeb87861",
"externalCategoryName_en_US": "Earnings and Deductions",
"lastModifiedDateTime": "/Date(1547633032000+0000)/",
"createdBy": "admin",
"createdDateTime": "/Date(1547633032000+0000)/",
"lastModifiedBy": "admin",
"externalCategoryName_localized": "Earnings and Deductions",
"externalCategoryName_defaultValue": "Earnings and Deductions",
"mdfSystemRecordStatus": "N",
"externalCategoryNameTranslationTextNav": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

518 PUBLIC Payroll
 "results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('en_US')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "en_US",
"value": "Earnings and Deductions"
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('defaultValue')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "defaultValue",
"value": "Earnings and Deductions"
}
]
},
"links": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='0b8ff64d
63b1466ebfa6b3f8aeb87861',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='6b15e331328249a6a4fcebac76e52da5')",
"type": "SFOData.PayrollConfigurationCategoryLink"
},
"PayrollSystemConfiguration_externalCode":
"77c90c013d2c42b89fd5ec53b7edee8b",
"PayrollConfigurationCategory_externalCode":
"0b8ff64d63b1466ebfa6b3f8aeb87861",
"externalCode": "6b15e331328249a6a4fcebac76e52da5",
"selfService": true,
"externalLinkName_localized": "Pay Statement",
"externalLinkName_defaultValue": "Pay Statement",
"lastModifiedDateTime": "/Date(1547633032000+0000)/",
"typeOfUrl": null,
"url": null,
"infotypeNumber": null,
"createdBy": "admin",
"adminService": true,
"service": "1",
"createdDateTime": "/Date(1547633032000+0000)/",
"lastModifiedBy": "admin",
"externalLinkName_en_US": "Pay Statement",
"mdfSystemRecordStatus": "N",
"typeOfUrlNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='0b8ff64d
63b1466ebfa6b3f8aeb87861',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='6b15e331328249a6a4fcebac76e52da5')/typeOfUrlNav"
}
},
"externalLinkNameTranslationTextNav": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('en_US')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "en_US",
"value": "Pay Statement"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payroll PUBLIC 519
 },
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('defaultValue')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "defaultValue",
"value": "Pay Statement"
}
]
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='0b8ff64d
63b1466ebfa6b3f8aeb87861',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='6b15e331328249a6a4fcebac76e52da5')/
mdfSystemRecordStatusNav"
}
},
"serviceNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='0b8ff64d
63b1466ebfa6b3f8aeb87861',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='6b15e331328249a6a4fcebac76e52da5')/serviceNav"
}
}
}
]
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategory(PayrollSystemConfiguration_externalCode='77c90c013d2c42
b89fd5ec53b7edee8b',externalCode='0b8ff64d63b1466ebfa6b3f8aeb87861')/
mdfSystemRecordStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategory(PayrollSystemConfiguration_externalCode='77c90c013d2c42
b89fd5ec53b7edee8b',externalCode='d4673fca6cdd46788387f605009a97e6')",
"type": "SFOData.PayrollConfigurationCategory"
},
"PayrollSystemConfiguration_externalCode":
"77c90c013d2c42b89fd5ec53b7edee8b",
"externalCode": "d4673fca6cdd46788387f605009a97e6",
"externalCategoryName_en_US": "Tax",
"lastModifiedDateTime": "/Date(1547633032000+0000)/",
"createdBy": "admin",
"createdDateTime": "/Date(1547633032000+0000)/",
"lastModifiedBy": "admin",
"externalCategoryName_localized": "Tax",
"externalCategoryName_defaultValue": "Tax",
"mdfSystemRecordStatus": "N",
"externalCategoryNameTranslationTextNav": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('en_US')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "en_US",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

520 PUBLIC Payroll
 "value": "Tax"
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('defaultValue')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "defaultValue",
"value": "Tax"
}
]
},
"links": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='d4673fca
6cdd46788387f605009a97e6',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='ed7b0d5ee7c141d998b3acf6f6650849')",
"type": "SFOData.PayrollConfigurationCategoryLink"
},
"PayrollSystemConfiguration_externalCode":
"77c90c013d2c42b89fd5ec53b7edee8b",
"PayrollConfigurationCategory_externalCode":
"d4673fca6cdd46788387f605009a97e6",
"externalCode": "ed7b0d5ee7c141d998b3acf6f6650849",
"selfService": false,
"externalLinkName_localized": "Income Tax",
"externalLinkName_defaultValue": "Income Tax",
"lastModifiedDateTime": "/Date(1547633032000+0000)/",
"typeOfUrl": null,
"url": null,
"infotypeNumber": "389",
"createdBy": "admin",
"adminService": true,
"service": null,
"createdDateTime": "/Date(1547633032000+0000)/",
"lastModifiedBy": "admin",
"externalLinkName_en_US": "Income Tax",
"mdfSystemRecordStatus": "N",
"typeOfUrlNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='d4673fca
6cdd46788387f605009a97e6',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='ed7b0d5ee7c141d998b3acf6f6650849')/typeOfUrlNav"
}
},
"externalLinkNameTranslationTextNav": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('en_US')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "en_US",
"value": "Income Tax"
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('defaultValue')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "defaultValue",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payroll PUBLIC 521
 "value": "Income Tax"
}
]
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='d4673fca
6cdd46788387f605009a97e6',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='ed7b0d5ee7c141d998b3acf6f6650849')/
mdfSystemRecordStatusNav"
}
},
"serviceNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='d4673fca
6cdd46788387f605009a97e6',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='ed7b0d5ee7c141d998b3acf6f6650849')/serviceNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='d4673fca
6cdd46788387f605009a97e6',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='00dc560f676d4fffba14a5c2df6b2e5e')",
"type": "SFOData.PayrollConfigurationCategoryLink"
},
"PayrollSystemConfiguration_externalCode":
"77c90c013d2c42b89fd5ec53b7edee8b",
"PayrollConfigurationCategory_externalCode":
"d4673fca6cdd46788387f605009a97e6",
"externalCode": "00dc560f676d4fffba14a5c2df6b2e5e",
"selfService": false,
"externalLinkName_localized": "Income Tax: Deductions",
"externalLinkName_defaultValue": "Income Tax: Deductions",
"lastModifiedDateTime": "/Date(1547633032000+0000)/",
"typeOfUrl": null,
"url": null,
"infotypeNumber": "390",
"createdBy": "admin",
"adminService": true,
"service": null,
"createdDateTime": "/Date(1547633032000+0000)/",
"lastModifiedBy": "admin",
"externalLinkName_en_US": "Income Tax: Deductions",
"mdfSystemRecordStatus": "N",
"typeOfUrlNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='d4673fca
6cdd46788387f605009a97e6',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='00dc560f676d4fffba14a5c2df6b2e5e')/typeOfUrlNav"
}
},
"externalLinkNameTranslationTextNav": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('en_US')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "en_US",
"value": "Income Tax: Deductions"
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

522 PUBLIC Payroll
 {
"__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('defaultValue')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "defaultValue",
"value": "Income Tax: Deductions"
}
]
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='d4673fca
6cdd46788387f605009a97e6',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='00dc560f676d4fffba14a5c2df6b2e5e')/
mdfSystemRecordStatusNav"
}
},
"serviceNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='d4673fca
6cdd46788387f605009a97e6',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='00dc560f676d4fffba14a5c2df6b2e5e')/serviceNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='d4673fca
6cdd46788387f605009a97e6',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='b4a5b390e22a46eb8141878bb103bbdf')",
"type": "SFOData.PayrollConfigurationCategoryLink"
},
"PayrollSystemConfiguration_externalCode":
"77c90c013d2c42b89fd5ec53b7edee8b",
"PayrollConfigurationCategory_externalCode":
"d4673fca6cdd46788387f605009a97e6",
"externalCode": "b4a5b390e22a46eb8141878bb103bbdf",
"selfService": false,
"externalLinkName_localized": "Income Tax-Another Employer",
"externalLinkName_defaultValue": "Income Tax-Another Employer",
"lastModifiedDateTime": "/Date(1547633032000+0000)/",
"typeOfUrl": null,
"url": null,
"infotypeNumber": "391",
"createdBy": "admin",
"adminService": true,
"service": null,
"createdDateTime": "/Date(1547633032000+0000)/",
"lastModifiedBy": "admin",
"externalLinkName_en_US": "Income Tax-Another Employer",
"mdfSystemRecordStatus": "N",
"typeOfUrlNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='d4673fca
6cdd46788387f605009a97e6',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='b4a5b390e22a46eb8141878bb103bbdf')/typeOfUrlNav"
}
},
"externalLinkNameTranslationTextNav": {
"results": [
{
"__metadata": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payroll PUBLIC 523
 "uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('en_US')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "en_US",
"value": "Income Tax-Another Employer"
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('defaultValue')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "defaultValue",
"value": "Income Tax-Another Employer"
}
]
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='d4673fca
6cdd46788387f605009a97e6',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='b4a5b390e22a46eb8141878bb103bbdf')/
mdfSystemRecordStatusNav"
}
},
"serviceNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='d4673fca
6cdd46788387f605009a97e6',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='b4a5b390e22a46eb8141878bb103bbdf')/serviceNav"
}
}
}
]
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategory(PayrollSystemConfiguration_externalCode='77c90c013d2c42
b89fd5ec53b7edee8b',externalCode='d4673fca6cdd46788387f605009a97e6')/
mdfSystemRecordStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategory(PayrollSystemConfiguration_externalCode='77c90c013d2c42
b89fd5ec53b7edee8b',externalCode='bfd46f8607af4419a11c14d2592d44b8')",
"type": "SFOData.PayrollConfigurationCategory"
},
"PayrollSystemConfiguration_externalCode":
"77c90c013d2c42b89fd5ec53b7edee8b",
"externalCode": "bfd46f8607af4419a11c14d2592d44b8",
"externalCategoryName_en_US": "Others",
"lastModifiedDateTime": "/Date(1547633032000+0000)/",
"createdBy": "admin",
"createdDateTime": "/Date(1547633032000+0000)/",
"lastModifiedBy": "admin",
"externalCategoryName_localized": "Others",
"externalCategoryName_defaultValue": "Others",
"mdfSystemRecordStatus": "N",
"externalCategoryNameTranslationTextNav": {
"results": [
{

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

524 PUBLIC Payroll
 "__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('en_US')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "en_US",
"value": "Others"
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('defaultValue')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "defaultValue",
"value": "Others"
}
]
},
"links": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='bfd46f86
07af4419a11c14d2592d44b8',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='c0a4bfa4fa9a4aa3ac2431962744bc46')",
"type": "SFOData.PayrollConfigurationCategoryLink"
},
"PayrollSystemConfiguration_externalCode":
"77c90c013d2c42b89fd5ec53b7edee8b",
"PayrollConfigurationCategory_externalCode":
"bfd46f8607af4419a11c14d2592d44b8",
"externalCode": "c0a4bfa4fa9a4aa3ac2431962744bc46",
"selfService": false,
"externalLinkName_localized": "Contract Elements",
"externalLinkName_defaultValue": "Contract Elements",
"lastModifiedDateTime": "/Date(1547633032000+0000)/",
"typeOfUrl": null,
"url": null,
"infotypeNumber": "16",
"createdBy": "admin",
"adminService": true,
"service": null,
"createdDateTime": "/Date(1547633032000+0000)/",
"lastModifiedBy": "admin",
"externalLinkName_en_US": "Contract Elements",
"mdfSystemRecordStatus": "N",
"typeOfUrlNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='bfd46f86
07af4419a11c14d2592d44b8',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='c0a4bfa4fa9a4aa3ac2431962744bc46')/typeOfUrlNav"
}
},
"externalLinkNameTranslationTextNav": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('en_US')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "en_US",
"value": "Contract Elements"
},
{

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payroll PUBLIC 525
 "__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('defaultValue')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "defaultValue",
"value": "Contract Elements"
}
]
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='bfd46f86
07af4419a11c14d2592d44b8',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='c0a4bfa4fa9a4aa3ac2431962744bc46')/
mdfSystemRecordStatusNav"
}
},
"serviceNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='bfd46f86
07af4419a11c14d2592d44b8',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='c0a4bfa4fa9a4aa3ac2431962744bc46')/serviceNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='bfd46f86
07af4419a11c14d2592d44b8',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='c0502723bcfc45b28ebf768f763b7c69')",
"type": "SFOData.PayrollConfigurationCategoryLink"
},
"PayrollSystemConfiguration_externalCode":
"77c90c013d2c42b89fd5ec53b7edee8b",
"PayrollConfigurationCategory_externalCode":
"bfd46f8607af4419a11c14d2592d44b8",
"externalCode": "c0502723bcfc45b28ebf768f763b7c69",
"selfService": false,
"externalLinkName_localized": "Personal IDs",
"externalLinkName_defaultValue": "Personal IDs",
"lastModifiedDateTime": "/Date(1547633032000+0000)/",
"typeOfUrl": null,
"url": null,
"infotypeNumber": "185",
"createdBy": "admin",
"adminService": true,
"service": null,
"createdDateTime": "/Date(1547633032000+0000)/",
"lastModifiedBy": "admin",
"externalLinkName_en_US": "Personal IDs",
"mdfSystemRecordStatus": "N",
"typeOfUrlNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='bfd46f86
07af4419a11c14d2592d44b8',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='c0502723bcfc45b28ebf768f763b7c69')/typeOfUrlNav"
}
},
"externalLinkNameTranslationTextNav": {
"results": [
{
"__metadata": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

526 PUBLIC Payroll
 "uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('en_US')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "en_US",
"value": "Personal IDs"
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('defaultValue')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "defaultValue",
"value": "Personal IDs"
}
]
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='bfd46f86
07af4419a11c14d2592d44b8',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='c0502723bcfc45b28ebf768f763b7c69')/
mdfSystemRecordStatusNav"
}
},
"serviceNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='bfd46f86
07af4419a11c14d2592d44b8',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='c0502723bcfc45b28ebf768f763b7c69')/serviceNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='bfd46f86
07af4419a11c14d2592d44b8',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='81110be53f664dd996ecf0f285b60fe0')",
"type": "SFOData.PayrollConfigurationCategoryLink"
},
"PayrollSystemConfiguration_externalCode":
"77c90c013d2c42b89fd5ec53b7edee8b",
"PayrollConfigurationCategory_externalCode":
"bfd46f8607af4419a11c14d2592d44b8",
"externalCode": "81110be53f664dd996ecf0f285b60fe0",
"selfService": false,
"externalLinkName_localized": "Termination: General Data",
"externalLinkName_defaultValue": "Termination: General Data",
"lastModifiedDateTime": "/Date(1547633032000+0000)/",
"typeOfUrl": null,
"url": null,
"infotypeNumber": "551",
"createdBy": "admin",
"adminService": true,
"service": null,
"createdDateTime": "/Date(1547633032000+0000)/",
"lastModifiedBy": "admin",
"externalLinkName_en_US": "Termination: General Data",
"mdfSystemRecordStatus": "N",
"typeOfUrlNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='bfd46f86

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payroll PUBLIC 527
 07af4419a11c14d2592d44b8',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='81110be53f664dd996ecf0f285b60fe0')/typeOfUrlNav"
}
},
"externalLinkNameTranslationTextNav": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('en_US')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "en_US",
"value": "Termination: General Data"
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('defaultValue')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "defaultValue",
"value": "Termination: General Data"
}
]
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='bfd46f86
07af4419a11c14d2592d44b8',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='81110be53f664dd996ecf0f285b60fe0')/
mdfSystemRecordStatusNav"
}
},
"serviceNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='bfd46f86
07af4419a11c14d2592d44b8',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='81110be53f664dd996ecf0f285b60fe0')/serviceNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='bfd46f86
07af4419a11c14d2592d44b8',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='606e7519bd6f4be19280e8eccc64a736')",
"type": "SFOData.PayrollConfigurationCategoryLink"
},
"PayrollSystemConfiguration_externalCode":
"77c90c013d2c42b89fd5ec53b7edee8b",
"PayrollConfigurationCategory_externalCode":
"bfd46f8607af4419a11c14d2592d44b8",
"externalCode": "606e7519bd6f4be19280e8eccc64a736",
"selfService": false,
"externalLinkName_localized": "Events: My Simplification",
"externalLinkName_defaultValue": "Events: My Simplification",
"lastModifiedDateTime": "/Date(1547633032000+0000)/",
"typeOfUrl": null,
"url": null,
"infotypeNumber": "875",
"createdBy": "admin",
"adminService": true,
"service": null,
"createdDateTime": "/Date(1547633032000+0000)/",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

528 PUBLIC Payroll
 "lastModifiedBy": "admin",
"externalLinkName_en_US": "Events: My Simplification",
"mdfSystemRecordStatus": "N",
"typeOfUrlNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='bfd46f86
07af4419a11c14d2592d44b8',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='606e7519bd6f4be19280e8eccc64a736')/typeOfUrlNav"
}
},
"externalLinkNameTranslationTextNav": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('en_US')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "en_US",
"value": "Events: My Simplification"
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('defaultValue')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "defaultValue",
"value": "Events: My Simplification"
}
]
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='bfd46f86
07af4419a11c14d2592d44b8',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='606e7519bd6f4be19280e8eccc64a736')/
mdfSystemRecordStatusNav"
}
},
"serviceNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='bfd46f86
07af4419a11c14d2592d44b8',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='606e7519bd6f4be19280e8eccc64a736')/serviceNav"
}
}
}
]
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategory(PayrollSystemConfiguration_externalCode='77c90c013d2c42
b89fd5ec53b7edee8b',externalCode='bfd46f8607af4419a11c14d2592d44b8')/
mdfSystemRecordStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategory(PayrollSystemConfiguration_externalCode='77c90c013d2c42
b89fd5ec53b7edee8b',externalCode='3dd87df3595e49ebbb344de42e324a62')",
"type": "SFOData.PayrollConfigurationCategory"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payroll PUBLIC 529
 },
"PayrollSystemConfiguration_externalCode":
"77c90c013d2c42b89fd5ec53b7edee8b",
"externalCode": "3dd87df3595e49ebbb344de42e324a62",
"externalCategoryName_en_US": "Social Insurance ",
"lastModifiedDateTime": "/Date(1547633032000+0000)/",
"createdBy": "admin",
"createdDateTime": "/Date(1547633032000+0000)/",
"lastModifiedBy": "admin",
"externalCategoryName_localized": "Social Insurance ",
"externalCategoryName_defaultValue": "Social Insurance ",
"mdfSystemRecordStatus": "N",
"externalCategoryNameTranslationTextNav": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('en_US')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "en_US",
"value": "Social Insurance "
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('defaultValue')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "defaultValue",
"value": "Social Insurance "
}
]
},
"links": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='3dd87df3
595e49ebbb344de42e324a62',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='73ea170a89a4410797dda638acc86447')",
"type": "SFOData.PayrollConfigurationCategoryLink"
},
"PayrollSystemConfiguration_externalCode":
"77c90c013d2c42b89fd5ec53b7edee8b",
"PayrollConfigurationCategory_externalCode":
"3dd87df3595e49ebbb344de42e324a62",
"externalCode": "73ea170a89a4410797dda638acc86447",
"selfService": false,
"externalLinkName_localized": "User Administration",
"externalLinkName_defaultValue": "User Administration",
"lastModifiedDateTime": "/Date(1547633032000+0000)/",
"typeOfUrl": null,
"url": null,
"infotypeNumber": "392",
"createdBy": "admin",
"adminService": true,
"service": null,
"createdDateTime": "/Date(1547633032000+0000)/",
"lastModifiedBy": "admin",
"externalLinkName_en_US": "User Administration",
"mdfSystemRecordStatus": "N",
"typeOfUrlNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='3dd87df3

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

530 PUBLIC Payroll
 595e49ebbb344de42e324a62',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='73ea170a89a4410797dda638acc86447')/typeOfUrlNav"
}
},
"externalLinkNameTranslationTextNav": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('en_US')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "en_US",
"value": "User Administration"
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
MDFLocalizedValue('defaultValue')",
"type": "SFOData.MDFLocalizedValue"
},
"locale": "defaultValue",
"value": "User Administration"
}
]
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='3dd87df3
595e49ebbb344de42e324a62',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='73ea170a89a4410797dda638acc86447')/
mdfSystemRecordStatusNav"
}
},
"serviceNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategoryLink(PayrollConfigurationCategory_externalCode='3dd87df3
595e49ebbb344de42e324a62',PayrollSystemConfiguration_externalCode='77c90c013d2c42b89
fd5ec53b7edee8b',externalCode='73ea170a89a4410797dda638acc86447')/serviceNav"
}
}
}
]
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
PayrollConfigurationCategory(PayrollSystemConfiguration_externalCode='77c90c013d2c42
b89fd5ec53b7edee8b',externalCode='3dd87df3595e49ebbb344de42e324a62')/
mdfSystemRecordStatusNav"
}
}
}
]
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payroll PUBLIC 531
12.6 SAPSystemConfiguration

The SAPSystemConfiguration entity is an external API for the Employee Central Payroll solution. It’s used by the
Employee Central Payroll system to fetch and display SAPSystemConfiguration objects. It’s used to maintain data
required to connect to payroll systems.

Permissions

 Note

To be able to use this API, you must have Employee Central Payroll or Payroll Integration enabled in your
instance. Contact Product Support to enable these features.

Supported Operations

Query, Insert, Upsert

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Case: Creating and Updating SAPSystemConfiguration Objects

Request

Operation Upsert

HTTP Method POST

URI https://<api-server>/odata/v2/upsert

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

532 PUBLIC Payroll
 Payload [
{
"__metadata":{

"uri":"SAPSystemConfiguration(externalCo
de='ABC/123')"
},
"payrollSystemUrl":"https://<api-
server>",
"payrollSystemClientId":"123"
},
{
"__metadata":{

"uri":"SAPSystemConfiguration(externalCo
de='DEF/456')"
},
"payrollSystemUrl":"https://<api-
server>",
"payrollSystemClientId":"456"
}
]

Response

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Payroll PUBLIC 533
13 Person Objects

13.1 PerAddressDEFLT

The PerAddressDEFLT contains information about a person's addresses.

HRIS Element Information

HRIS Element ID:homeAddress

Business Key: personIdExternal + effectiveStartDate + addressType
Permission Mode: HRIS element permission control
Effective-date:true
Foundation Type:false
Person Entity Element:true
Supports Incremental Load:true.
Supports NO_OVERWRITE: yes.

Supported Operations

Query, Upsert

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

operation To delete a record, use the upsert operation and set this prop­
erty to DELIMIT.

Use Case 1: Query the Persons with a Specific Address

This example shows how to query all persons whose state in the business address is California.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

534 PUBLIC Person Objects
Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
PerAddressDEFLT?$filter=state eq 'CA' and
addressType eq 'business'&
$select=state,address1,address2,personIdEx
ternal&$top=1&$format=JSON

Response

 Sample Code

{
"d": {
"results": [
{
"__metadata": {
uri: "https://<API-Server>/odata/v2/public/
PerAddressDEFLT(addressType='business',personIdExternal='jtong1',startDate=dateti
me'1993-02-15T00:00:00') "
type: " SFOData.PerAddressDEFLT "},
personIdExternal: "jtong1"
state: "CA"
address1: "1500 Fashion Island Blvd."
address2: "Ste. 300"
}
}
}

Use Case 2: Update the Home Addresses of an Employee

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Person Objects PUBLIC 535
Payload
{
"__metadata": {
"uri": "PerAddressDEFLT",
"type": "SFOData.PerAddressDEFLT"
},
"addressType": "home",
"personIdExternal": "454",
"startDate": "/Date(1532572453000)/",
"endDate": "/Date(3173567653000)/",
"county": "5498",
"province": "5506",
"state": "3661",
"address1Alt1": "add1alt1",
"city": "Shanghai",
"customString20": "TTT",
"customDouble1": "5.6",
"zipCodeAlt1": "123",
"customString10": "5502",
"stateAlt2": "abc",
"customLong1Alt1": null,
"stateAlt1": "aa",
"country": "CHN",
"zipCode": "201203",
"notes": "test upsert",
"cityAlt2": "city2",
"customLong12": "2197",
"customLong13": "S1",
"cityAlt1": "city1",
"address5": "tyierueht",
"countryAlt1": null,
"countryAlt2": null,
"customLong9": "5494",
"customLong7": "A3",
"countyAlt1": "wjjew",
"customLong6": "CAN",
"countyAlt2": "dd",
"customDate1": "/
Date(1532918053000)/",
"address3": "502, no.66, lane 888,
Somewhere district",
"customDate1Alt1": "/
Date(1532918053000)/",
"customDate1Alt2": "/
Date(1532918053000)/",
"address1": "15-71 NCI Tower, No. 12
A Test Ave",
"customString5": "BWK",
"customString4": "D1",
"customString3": "dr1sfmgr1",
"customString2": "4185",
"customString9": "5503",
"customString8": "S1",
"customString7": "A1",
"customString6": "AUS",
"customString1": "5122"
}

Response

{
"d": [
{
"key": "PerAddressDEFLT/addressType=home,PerAddressDEFLT/
personIdExternal=454,PerAddressDEFLT/startDate=2018-07-26T02:34:13.000Z",
"status": "OK",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

536 PUBLIC Person Objects
 "editStatus": UPSERTED,
"message": "",
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Country/Region-Specific Logic

You can define the attributes of the PerAddressDEFLT fields differently for countries and regions in the
Succession Data Model and the Country/region-Specific Data Model. As it is not possible to have multiple entities
per country or region, this OData API exposes a single entity PerAddressDEFLT, and offers a single field for all
countries and regions.

See PerAddressDEFLT [page 30] for more information.

Related Information

SAP API Business Hub: Personal Information

Permission Settings [page 15]
Filtering out external user data [page 832]

13.2 PerEmail

This PerEmail API enables you to read, update, create, or delete an employee's email address.

HRIS Element Information

HRIS Element ID:emailInfo

Business Keys: personIdExternal + emailType
Effective-date:false
Foundation Type:false
Person Entity Element:true
Supports Incremental Load: true
Supports NO_OVERWRITE: true

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Person Objects PUBLIC 537
Supported Operations

Query, Upsert

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

operation To delete a record, use the upsert operation and set this prop­
erty to DELIMIT.

Use Case 1: Get Email Addresses by Specific Criteria

The example shows how to get the Private and Primary email addresses.

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/PerEmail?
$filter=emailType eq '8448' and isPrimary
eq 'true'&$select=emailAddress&
$format=JSON

Response

 Sample Code

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
PerEmail(emailType='8448',personIdExternal='109031')",
"type": "SFOData.PerEmail"
},
"emailAddress": "[email protected]"
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

538 PUBLIC Person Objects
Use Case 2: Update an Email Address

This example shows how to update a user's business Email address.

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/Upsert

Payload
 Sample Code

{
"__metadata": {
"uri":
"PerEmail(emailType='8448',personIdEx
ternal='109031')",
"type": "SFOData.PerEmail"
},
"emailAddress":
"[email protected]"
}

Response

 Sample Code

{
"d": [
{
"key": "PerEmail/emailType=8448,PerEmail/personIdExternal=109031",
"status": "OK",
"editStatus": UPSERTED,
"message": "",
"index": 0,
"httpCode": 200,
"inlineResults": Null
}
]
}

Related Information

SAP API Business Hub: Personal Information

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Person Objects PUBLIC 539
13.3 PersonEmpTerminationInfo

You can use the PersonEmpTerminationInfo API to expose the latest termination date of an employee.

Supported Operations

Operation Description

Query You query an employee's active employment counts, Person ID,

and latest termination date via $expand from the PerPerson
entity, but not directly query the PersonEmpTerminationInfo
entity.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Case: Retrieve the Latest Termination Date of a Specific Employee

This example shows how to retrieve the latest termination date of an employee with $expand from PerPerson. The
latest termination date is represented by the <latestTerminationDate> field.

Request

Operation Query

HTTP Method GET

URI http://<API-Server>/odata/v2/PerPerson?
$format=json&
$expand=personEmpTerminationInfoNav &
$select= personEmpTerminationInfoNav&
$filter=personEmpTerminationInfoNav/
personIdExternal+eq+'admin'

Response

{
"d": {
"results": [
{

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

540 PUBLIC Person Objects
 "__metadata": {
"uri": "https://<API-Server>/odata/v2/PerPerson('admin')",
"type": "SFOData.PerPerson"
},
"personEmpTerminationInfoNav": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
PersonEmpTerminationInfo('admin')",
"type": "SFOData.PersonEmpTerminationInfo"
},
"personIdExternal": "admin",
"activeEmploymentsCount": 1,
"latestTerminationDate": null
}
}
]
}
}

Related Information

SAP API Business Hub: Employment Information

13.4 PerEmergencyContacts

This entity contains emergency contact information of an employee.

HRIS Element Information

HRIS Element ID:emergencyContactPrimary

Business Keys: personIdExternal + name + relationship
Effective-date:false
Foundation Type:false
Person Entity Element:true
Supports Incremental Load:true
Supports NO_OVERWRITE: true

Supported Operations

Query, Upsert

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Person Objects PUBLIC 541
Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

operation To delete a record, use the upsert operation and set this prop­
erty to DELIMIT.

Use Case 1: Get Primary Emergency Contact

This example shows how to query the Person ID and Relationship about employees' primary emergency contact.

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
PerEmergencyContacts?$filter=primaryFlag
ne 'Y'&
$select=personIdExternal,relationship&
$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/public/
PerEmergencyContacts(name='Chad
Hoff',personIdExternal='mhoff1',relationship='Brother')",
"type": "SFOData.PerEmergencyContacts"
},
"relationship": "Brother",
"personIdExternal": "mhoff1"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/public/
PerEmergencyContacts(name='Francesca
Borriello',personIdExternal='165',relationship='Spouse')",
"type": "SFOData.PerEmergencyContacts"
},
"relationship": "Spouse",
"personIdExternal": "165"
},
{
"__metadata": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

542 PUBLIC Person Objects
 "uri": "https://<API-Server>/odata/v2/public/
PerEmergencyContacts(name='Test',personIdExternal='greinhard3',relationship='1766')"
,
"type": "SFOData.PerEmergencyContacts"
},
"relationship": "1766",
"personIdExternal": "greinhard3"
}
]
}
}

Use Case 2: Update the Country/Region of an Emergency Contact

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/Upsert

Headers Content-Type: application/json

Payload
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
PerEmergencyContacts(name='Karen
Grant',personIdExternal='cgrant1',relati
onship='1767')",
"type": "SFOData.PerEmergencyContacts"
},
"addressCountry": "DEU"
}

Response

{
"d": [
{
"key": "PerEmergencyContacts/name=Karen Grant,PerEmergencyContacts/
personIdExternal=cgrant1,PerEmergencyContacts/relationship=1767",
"status": "OK",
"editStatus": UPSERTED,
"message": "",
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Related Information

SAP API Business Hub: Personal Information

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Person Objects PUBLIC 543
13.5 PerGlobalInfo<Country/Region>

This entity contains the global information for an employee.

HRIS Element Information

HRIS Element ID:globalInfo

Business Keys: personIdExternal + startDate + country
Effective-date:true
Foundation Type:false
Person Entity Element:true
Supports Incremental Load:true
Supports NO_OVERWRITE: true
Supports MCPD: false

Supported Operations

Query, Upsert

Properties and Navigation Properties

Properties
This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

personIdExternal The employee ID

country The country or region where the employee works

createdOn The date that the global information was added

createdBy The ID of the person who created the global information entry

lastModifiedOn The date that the global information was modified

lastModifiedBy The ID of the person who made the last update to the global information entry

customString(1,20) An optional field for a string with 1-20 characters

customDate(1,10) An optional field for a date with 1-20 characters.

customLong(1,20) An optional field for numbers with 1-20 characters

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

544 PUBLIC Person Objects
 Property Description

customDouble(1,20) An optional field for a double precision decimal

endDate The date the global information is set to inactive

operation To delete a record, use the upsert operation and set this property to DELIMIT.

Navigation Properties

Navigation Property Related Entity Description

countryNav Territory Navigation to the Territory entity de­

scribing the country or region for PerGlo­
balInfo

personNav PerPerson Navigation to the PerPerson entity

that contains biographical information
for the corresponding person

Use Case 1: Get the Global Information of an Employee

This example shows how to get the global information of an employee based in USA.

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExt
ernal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')&$format=JSON

Response

{
"d": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')",
"type": "SFOData.PerGlobalInfoUSA"
},
"country": "USA",
"personIdExternal": "dr1sfmgr11",
"startDate": "/Date(978652800000)/",
"lastModifiedDateTime": "/Date(1333434025000+0000)/",
"endDate": "/Date(253402214400000)/",
"createdDateTime": "/Date(1333434025000+0000)/",
"genericString1": "2603",
"customLong16": null,
"customLong14": null,
"customLong15": null,
"genericNumber12": null,
"customLong9": "3245251",
"customLong8": "3441",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Person Objects PUBLIC 545
 "customLong7": null,
"customLong6": null,
"customLong5": null,
"customLong4": null,
"customLong3": null,
"customLong1": null,
"createdOn": "/Date(1333434025000)/",
"customDate1": null,
"genericDate5": null,
"genericNumber1": "0",
"lastModifiedBy": "ajp",
"customString5": null,
"customString10": null,
"customString4": "BU9",
"customString3": null,
"customString9": "cstr9usa-17",
"customString14": null,
"customString8": "39761",
"customString15": null,
"customString7": null,
"customString16": null,
"customString6": null,
"lastModifiedOn": "/Date(1333434025000)/",
"customString1": "5122",
"createdBy": "ajp",
"customString16Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/customString16Nav"
}
},
"customString1Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/customString1Nav"
}
},
"customLong15Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/customLong15Nav"
}
},
"customString5Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/customString5Nav"
}
},
"customLong1Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/customLong1Nav"
}
},
"customLong5Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/customLong5Nav"
}
},
"customLong9Nav": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

546 PUBLIC Person Objects
 "__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/customLong9Nav"
}
},
"customString9Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/customString9Nav"
}
},
"customLong16Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/customLong16Nav"
}
},
"customString15Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/customString15Nav"
}
},
"genericNumber12Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/genericNumber12Nav"
}
},
"customString4Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/customString4Nav"
}
},
"customLong6Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/customLong6Nav"
}
},
"customLong7Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/customLong7Nav"
}
},
"customString14Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/customString14Nav"
}
},
"customString3Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/customString3Nav"
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Person Objects PUBLIC 547
 },
"customLong3Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/customLong3Nav"
}
},
"personNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/personNav"
}
},
"customString7Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/customString7Nav"
}
},
"customLong14Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/customLong14Nav"
}
},
"customLong4Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/customLong4Nav"
}
},
"countryNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/countryNav"
}
},
"customString6Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/customString6Nav"
}
},
"customString10Nav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerGlobalInfoUSA(country='USA',personIdExternal='dr1sfmgr11',startDate=datetime'2001
-01-05T00:00:00')/customString10Nav"
}
}
}
}

Use Case 2: Update the Global Information of an Employee

This example shows how to update the global information of an employee.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

548 PUBLIC Person Objects
Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert

Payload
{
"__metadata": {
"uri": "PerGlobalInfoUSA",
"type": "SFOData.PerGlobalInfoUSA"
},
"country": "USA",
"personIdExternal": "454",
"startDate": "/
Date(1532563200000)/",
"endDate": "/
Date(253402214400000)/",
"genericString1": "abc",
"customLong5": "S3",
"customLong4": "BU24",
"customLong3": "ADBE-BLR_TEST2",
"customLong1": "5122",
"customDate1": "/
Date(1496275200000)/",
"genericDate5": "/
Date(1494288000000)/",
"genericNumber1": "0",
"customString1": "5123",
"genericDate1": "/
Date(1493596800000)/"
}

Response

{
"d": [
{
"key": "PerGlobalInfoUSA/country=USA,PerGlobalInfoUSA/
personIdExternal=454,PerGlobalInfoUSA/startDate=2018-07-26T00:00:00.000Z",
"status": "OK",
"editStatus": UPSERTED,
"message": "",
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Additional Information

When you make a last modified query, look at how this entity behaves with $filter and lastModifiedOn:
lastModifiedDateTime and $filter [page 42].

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Person Objects PUBLIC 549
Related Information

Permission Settings [page 15]

13.6 PerNationalId

This entity contains national identification card information for an employee.

HRIS Element Information

HRIS Element ID:nationalIdCard

Business Keys: personIdExternal + country + cardType
Effective-date:false
Foundation Type:false
Person Entity Element:true
Supports Incremental Load:true
Supports NO_OVERWRITE: true

Supported Operations

Query, Upsert

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

operation To delete a record, use the upsert operation and set this prop­
erty to DELIMIT.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

550 PUBLIC Person Objects
Use Case 1: Retrieve All Persons Whose National Id Isn’t Primary in the Country
or Region They Live

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
PerNationalId?$filter=isPrimary eq
'false'&
$select=personIdExternal,nationalId,countr
y&$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/public/
PerNationalId(cardType='itin',country='USA',personIdExternal='vstokes1')",
"type": "SFOData.PerNationalId"
},
"personIdExternal": "vstokes1",
"country": "USA",
"nationalId": "48-98493057"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/public/
PerNationalId(cardType='itin',country='USA',personIdExternal='wsown1')",
"type": "SFOData.PerNationalId"
},
"personIdExternal": "wsown1",
"country": "USA",
"nationalId": "47-49409408"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/public/
PerNationalId(cardType='itin',country='USA',personIdExternal='smormony1')",
"type": "SFOData.PerNationalId"
},
"personIdExternal": "smormony1",
"country": "USA",
"nationalId": "45-34593835"
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Person Objects PUBLIC 551
Use Case 2: Update the National ID Information of an Employee

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert

Payload
{
"__metadata": {
"uri": "PerNationalId",
"type": "SFOData.PerNationalId"
},
"country": "USA",
"personIdExternal": "454",
"cardType": "ssn",
"notes": "test upsert",
"deuevCode": "abc",
"cpamId": "123456",
"customLong1": "5123",
"customDouble1": "3456",
"isPrimary": true,
"customDate1": "/
Date(1557014400000)/",
"customString2": "4184",
"customString1": "5122",
"nationalId": "456-85-9999"
}

Response

{
"d": [
{
"key": "PerNationalId/cardType=ssn,PerNationalId/
country=USA,PerNationalId/personIdExternal=454",
"status": "OK",
"editStatus": UPSERTED,
"message": "",
"index": 0,
"httpCode": 200,
"inlineResults": Null
}
]
}

Related Information

SAP API Business Hub: Personal Information

Permission Settings [page 15]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

552 PUBLIC Person Objects
13.7 PerPerson

You can use this OData API to display non-effective-dated biological information about an employee such as date
and place of birth, and date of death.

HRIS Element Information

HRIS Element ID:personInfo

Business Keys: personIdExternal
Effective-date:false
Foundation Type:false
Person Entity Element:true
Supports Incremental Load:true
Supports NO_OVERWRITE: true

Supported Operations

Operation Description

Query

Upsert Upsert is supported with an incremental purge

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

personIdExternal Business key.

custom-string1, custom-string2, custom-string3 These three custom string fields are filterable, so you can
query PerPerson with filters on these fields rather than
fetch all the records. In some cases they are used to store ex­
ternal system IDs.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Person Objects PUBLIC 553
Navigation Properties

Navigation Property Related Entity Description

SecondaryAssignmentNav SecondaryAssignments Navigation to the

SecondaryAssignments to know
which employment contract is the pri­
mary one for replication scenarios

personEmpTerminationInfoNav PersonEmpTerminationInfo Navigation to the

personEmpTerminationInfo to
get the latest employment date for an
employee.

personTypeUsageNav PersonTypeUsage Navigation to PersonTypeUsage.

The PersonTypeUsage entity is used

by the PerPerson entity to query per­
son records, and can be filtered by per­
son type.

Use Case 1: Get the First PerPerson Record

This example shows how to get the first record of an employee's information.

Request

Operation Query

HTTP Method GET

URI http://<API-Server>/odata/v2/PerPerson?
$top=1&$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/PerPerson('aaaa')",
"type": "SFOData.PerPerson"
},
"personIdExternal": "aaaa",
"dateOfBirth": null,
"lastModifiedOn": "/Date(1303743709000)/",
"lastModifiedDateTime": "/Date(1303758109000+0000)/",
"dateOfDeath": null,
"createdOn": "/Date(1303743708000)/",
"countryOfBirth": null,
"createdBy": "v4admin",
"createdDateTime": "/Date(1303758108000+0000)/",
"lastModifiedBy": "v4admin",
"personId": "4",
"personRerlationshipNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('aaaa')/
personRerlationshipNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

554 PUBLIC Person Objects
 }
},
"emergencyContactNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('aaaa')/
emergencyContactNav"
}
},
"phoneNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('aaaa')/phoneNav"
}
},
"personalInfoNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('aaaa')/personalInfoNav"
}
},
"homeAddressNavDEFLT": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('aaaa')/
homeAddressNavDEFLT"
}
},
"secondaryAssignmentsNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('aaaa')/
secondaryAssignmentsNav"
}
},
"nationalIdNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('aaaa')/nationalIdNav"
}
},
"countryOfBirthNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('aaaa')/
countryOfBirthNav"
}
},
"emailNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('aaaa')/emailNav"
}
},
"socialAccountNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('aaaa')/
socialAccountNav"
}
},
"employmentNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('aaaa')/employmentNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Person Objects PUBLIC 555
Use Case 2: Add a New Employee

Look at PerPerson Upsert [page 827] for information on how you can use this entity to add a new employee.

Additional Information

Although the PerPerson entity is created when the user entity is upserted, it remains hidden. It only becomes
visible when:

● It is explicitly upserted
● EmpEmployment has been upserted. For more information, see EmpEmployment Upsert [page 828]
● Filters for including or excluding internal and external users are available. For more information, see Filtering
out external user data [page 832]

Related Information

SAP API Business Hub: Personal Information

Permission Settings [page 15]
Adding a New Employee [page 825]
PerPerson Upsert [page 827]
PersonEmpTerminationInfo [page 540]
Differentiating primary from secondary employment during concurrent employment replication [page 844]

13.7.1 generateNextPersonID

You use this API to generate the next person ID assigned for a new hire, incrementing it as required.

The generated IDs are used in the User entity (fields: username and userID), PerPerson entity (field:
personIdExternal, userID), Employment entity (fields: personIdExternal and userID), Person Objects
(field: personIdExternal), Employment Objects (field: userID).

 Note

If you configure business rules for generating next person IDs, the rules are skipped in this API, which is
different from the behaviors on the Add New Employee page.

Supported Operations

HTTP Method: POST

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

556 PUBLIC Person Objects
Return Type: GenerateNextPersonIDResponse

Support Payload (sap:support-payload): false

Use Case 1: Creating a Single ID

Use the Insert operation to create a single ID for a new hire.

Request

Operation Insert

HTTP Method POST

URI https://<API-Server>/odata/v2/generateNextPersonID?$format=json

Response

{
"d" : {
"GenerateNextPersonIDResponse" : {
"personID" : "214"
}
}
}

Use Case 2: Creating Multiple IDs

Use the Insert operation to create multiple IDs for new hires.

 Note

When you generate more than one ID, use a $BATCH statement to avoid too many roundtrips. Make sure that
users use the generated IDs in a unique way. Any unused numbers will create gaps since the API generates the
numbers in an incremental fashion.

Request

HTTP Method POST

URI https://<API-Server>/odata/v2/$batch

Payload
--batch_36522ad7-fc75-4b56-8c71-56071383e77b
Content-Type: multipart/mixed; boundary=changeset_1

--changeset_1
Content-Transfer-Encoding: binary
Content-Type: application/http

POST generateNextPersonID HTTP/1.1

Content-Type: application/xml;charset=utf-8

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Person Objects PUBLIC 557
 --changeset_1
Content-Transfer-Encoding: binary
Content-Type: application/http

POST generateNextPersonID HTTP/1.1

Content-Type: application/xml;charset=utf-8

--changeset_1
Content-Transfer-Encoding: binary
Content-Type: application/http

POST generateNextPersonID HTTP/1.1

Content-Type: application/xml;charset=utf-8

--changeset_1--

--batch_36522ad7-fc75-4b56-8c71-56071383e77b--

Response

--batch_840c9610-df87-42ce-bd42-948f9e3f8e04
Content-Type: multipart/mixed; boundary=changeset_75c877a0-4c68-4b0e-af47-
b8bdb19c117b

--changeset_75c877a0-4c68-4b0e-af47-b8bdb19c117b
Content-Type: application/http
Content-Transfer-Encoding: binary

HTTP/1.1 200 OK
Content-Type: application/xml; charset=utf-8
DataServiceVersion: 1.0
Content-Length: 314

<?xml version='1.0' encoding='utf-8'?><d:GenerateNextPersonIDResponse

m:type="SFOData.GenerateNextPersonIDResponse" xmlns:d="http://
schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://
schemas.microsoft.com/ado/2007/08/dataservices/metadata"><d:personID>232</
d:personID></d:GenerateNextPersonIDResponse>

--changeset_75c877a0-4c68-4b0e-af47-b8bdb19c117b
Content-Type: application/http
Content-Transfer-Encoding: binary

HTTP/1.1 200 OK
Content-Type: application/xml; charset=utf-8
DataServiceVersion: 1.0
Content-Length: 314

<?xml version='1.0' encoding='utf-8'?><d:GenerateNextPersonIDResponse

m:type="SFOData.GenerateNextPersonIDResponse" xmlns:d="http://
schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://
schemas.microsoft.com/ado/2007/08/dataservices/metadata"><d:personID>233</
d:personID></d:GenerateNextPersonIDResponse>

--changeset_75c877a0-4c68-4b0e-af47-b8bdb19c117b
Content-Type: application/http
Content-Transfer-Encoding: binary

HTTP/1.1 200 OK
Content-Type: application/xml; charset=utf-8
DataServiceVersion: 1.0
Content-Length: 314

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

558 PUBLIC Person Objects
 <?xml version='1.0' encoding='utf-8'?><d:GenerateNextPersonIDResponse
m:type="SFOData.GenerateNextPersonIDResponse" xmlns:d="http://
schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://
schemas.microsoft.com/ado/2007/08/dataservices/metadata"><d:personID>234</
d:personID></d:GenerateNextPersonIDResponse>

--changeset_75c877a0-4c68-4b0e-af47-b8bdb19c117b--

--batch_840c9610-df87-42ce-bd42-948f9e3f8e04--

Related Information

SAP API Business Hub: Personal Information

Permission Settings [page 15]

13.8 PerPersonal

This entity contains an employee's personal information such as name, gender, and marital status.

HRIS Element Information

HRIS Element ID:personalInfo

Business Keys: personIdExternal + startDate
Effective-date:true
Foundation Type:false
Person Entity Element:true
Supports Incremental Load:true
Supports NO_OVERWRITE: true
Supports MCPD: false

Supported Operations

Operation Description

Query You can also choose whether to include or exclude internal and
external user data from these queries. You can do this by using
the filter described in Filtering out external user data [page
832].

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Person Objects PUBLIC 559
Operation Description

Upsert The Upsert operation requires two steps: first, upsert non-
country/region-specific fields; then do upsert operation for the
country or region.

 Note
Person_id_external and start_date are required in the Up­
sert request.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

operation To delete a record, use the upsert operation and set this prop­
erty to DELETE.

Use Case 1: Query Personal Information of Specific Persons

Use the Query operation to get the First and Last name of all persons whose first or last name starts with "Ca".

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/PerPersonal?
$filter=firstName like 'Ca%' or lastName
like 'Ca%'&$select=firstName,lastName&
$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/public/
PerPersonal(personIdExternal='wcarver1',startDate=datetime'1990-01-01T00:00:00')",
"type": "SFOData.PerPersonal"
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

560 PUBLIC Person Objects
 "lastName": "Carver",
"firstName": "William"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/public/
PerPersonal(personIdExternal='mclements1',startDate=datetime'1990-01-01T00:00:00')",
"type": "SFOData.PerPersonal"
},
"lastName": "Carvalho",
"firstName": "Marcelo"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/public/
PerPersonal(personIdExternal='ecarpenter1',startDate=datetime'1990-01-01T00:00:00')"
,
"type": "SFOData.PerPersonal"
},
"lastName": "Carpenter",
"firstName": "Elizabeth"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/public/
PerPersonal(personIdExternal='cclark1',startDate=datetime'1990-01-01T00:00:00')",
"type": "SFOData.PerPersonal"
},
"lastName": "Clark",
"firstName": "Caroline"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/public/
PerPersonal(personIdExternal='charper1',startDate=datetime'1990-01-01T00:00:00')",
"type": "SFOData.PerPersonal"
},
"lastName": "Harper",
"firstName": "Catherine"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/public/
PerPersonal(personIdExternal='clewis1',startDate=datetime'1990-01-01T00:00:00')",
"type": "SFOData.PerPersonal"
},
"lastName": "Lewis",
"firstName": "Carl"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/public/
PerPersonal(personIdExternal='cccc',startDate=datetime'1990-01-01T00:00:00')",
"type": "SFOData.PerPersonal"
},
"lastName": "Weimer",
"firstName": "Casey"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/public/
PerPersonal(personIdExternal='chenderson1',startDate=datetime'1990-01-01T00:00:00')"
,
"type": "SFOData.PerPersonal"
},
"lastName": "Henderson",
"firstName": "Carrie"
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Person Objects PUBLIC 561
 {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/public/
PerPersonal(personIdExternal='chill1',startDate=datetime'1990-01-01T00:00:00')",
"type": "SFOData.PerPersonal"
},
"lastName": "Hill",
"firstName": "Carrie"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/public/
PerPersonal(personIdExternal='cbliss1',startDate=datetime'1990-01-01T00:00:00')",
"type": "SFOData.PerPersonal"
},
"lastName": "Bliss",
"firstName": "Carolyn"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/public/
PerPersonal(personIdExternal='cgrant1',startDate=datetime'2014-07-29T00:00:00')",
"type": "SFOData.PerPersonal"
},
"lastName": "Grant",
"firstName": "Carla"
}
]
}
}

Use Case 2: Update the Personal Information of an Employee

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

562 PUBLIC Person Objects
 Payload
{
"__metadata": {
"uri": "PerPersonal",
"type": "SFOData.PerPersonal"
},
"personIdExternal": "iiii",
"startDate": "/Date(1532563200000)/",
"formalNameAlt2": "test",
"formalNameAlt1": "test",
"endDate": "/Date(253402214400000)/",
"aboriginalPerson": false,
"lastName": "zhang",
"gender": "F",
"dateOfDeath": "/
Date(2858466853000)/",
"displayName": "cici",
"certificateStartDate": "/
Date(1522886400000)/",
"customDouble1": "2.2",
"healthcareProvince": "aabca",
"religion": "5507",
"medalVeteran": false,
"secondTitle": "5499",
"dateOfFirstEntryInFrance": "/
Date(1524700800000)/",
"nativePreferredLang": "2105",
"ethnicGroup": "adbcd",
"nameFormat": "test",
"firstName": "cici",
"customLong9": "5497",
"customLong8": "School 6301",
"veteran": false,
"salutation": "2587",
"maritalStatus": "2609",
"since": "/Date(1523232000000)/",
"formalName": "cici zhang",
"certificateEndDate": "/
Date(1806969600000)/",
"birthNameAlt1": "test",
"title": "dev",
"expectedRetirementDate": "/
Date(1524873600000)/",
"isOverridden": false,
"separatedVeteran": false,
"customDate1": "/Date(978825600000)/",
"middleNameAlt1": "test",
"visibleMinority": false,
}

Response

{
"d": [
{
"key": "PerPersonal/personIdExternal=iiii,PerPersonal/
startDate=2018-07-26T00:00:00.000Z",
"status": "OK",
"editStatus": UPSERTED,
"message": "",
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Person Objects PUBLIC 563
 }

Additional Information

When you make a last modified query, take a look at how this entity behaves with $filter and lastModifiedDateTime:
lastModifiedDateTime and $filter [page 42]

Related Information

SAP API Business Hub: Personal Information

13.9 PerPersonRelationship

The entity contains information about an employee's dependents.

HRIS Element Information

HRIS Element ID: personRelationshipInfo

Business Keys: personIdExternal + relatedPersonIdExternal + startDate
Effective-date:true
Foundation Type:false
Person Entity Element:true
Supports Incremental Load:false for now
Supports NO_OVERWRITE: false for now

Supported Operations

Query, Upsert

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

564 PUBLIC Person Objects
Properties

Property Description

isAddressSameAsPerson This field shows if the dependent has the same address as the
employee.

operation To delete a record, use the upsert operation and set this prop­
erty to DELIMIT.

Navigation Properties

Navigation Property Related Entity Description

personNav PerPerson Navigation to PerPerson entity for all

biographical information for correspond­
ing person

relPersonNav PerPerson Navigation to PerPerson for all bio­

graphical information of a related person

relPersonalNav PerPersonal Navigation to PerPersonal entity for

all personal information of related per­
sons

relNationalIdNav PerNationalId Navigation to PerNationalId entity

for all national identification card infor­
mation of related persons

Use Case 1: Query the First Record of Personal Information

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
PerPersonRelationship?$top=1&$format=JSON

Response

 Sample Code

"d":
{
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
PerPersonRelationship(personIdExternal='gcharles1',relatedPersonIdExternal='197_d
637',startDate=datetime'2013-02-20T00:00:00')",
"type": "SFOData.PerPersonRelationship"
},
"startDate": "/Date(1361318400000)/",
"relatedPersonIdExternal": "197_d637",
"personIdExternal": "gcharles1",
"lastName": "Zamora-Smith",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Person Objects PUBLIC 565
 "customString2": null,
"isBeneficiary": null,
"endDate": "/Date(253402300799000)/",
"lastModifiedDateTime": "/Date(1361363017000+0000)/",
"lastModifiedOn": "/Date(1361345017000)/",
"createdOn": "/Date(1361345017000)/",
"relationshipType": "6117",
"createdBy": "admin",
"createdDateTime": "/Date(1361363017000+0000)/",
"lastModifiedBy": "admin",
"customString1": null,
"firstName": "Debby",
"isAccompanyingDependent": null,
"relNationalIdNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerPersonRelationship(personIdExternal='gcharles1',relatedPersonIdExternal='197_d
637',startDate=datetime'2013-02-20T00:00:00')/relNationalIdNav"
}
},
"personNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerPersonRelationship(personIdExternal='gcharles1',relatedPersonIdExternal='197_d
637',startDate=datetime'2013-02-20T00:00:00')/personNav"
}
},
"relationshipTypeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerPersonRelationship(personIdExternal='gcharles1',relatedPersonIdExternal='197_d
637',startDate=datetime'2013-02-20T00:00:00')/relationshipTypeNav"
}
},
"relPersonNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerPersonRelationship(personIdExternal='gcharles1',relatedPersonIdExternal='197_d
637',startDate=datetime'2013-02-20T00:00:00')/relPersonNav"
}
},
"relPersonalNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PerPersonRelationship(personIdExternal='gcharles1',relatedPersonIdExternal='197_d
637',startDate=datetime'2013-02-20T00:00:00')/relPersonalNav"
}
}
}
]
}
}

Use Case 2: Upsert

Request

Operation Upsert

HTTP Method POST

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

566 PUBLIC Person Objects
 URI http://<API-Server>/odata/v2/upsert

Payload
 Sample Code

{
"__metadata": {
"uri": "https://<API-Server>/
odata/v2/
PerPersonRelationship(personIdExterna
l='hmueller1',relatedPersonIdExternal
='1397_d1417',startDate=datetime'2014
-01-01T00:00:00')",
"type":
"SFOData.PerPersonRelationship"
},
"customString2": "test"
}

Response

{
"d": [
{
"key": "PerPersonRelationship/name=Full Name,PerPersonRelationship/
personIdExternal=hmueller1,PerPersonRelationship/relationship=1767",
"status": "OK",
"editStatus": UPSERTED,
"message": "",
"index": 0,
"httpCode": 400,
"inlineResults": null
}
]
}

Additional Information

When you make a last modified query, look at how this entity behaves with $filter and lastModifiedOn:
lastModifiedDateTime and $filter [page 42].

Related Information

SAP API Business Hub: Personal Information

Permission Settings [page 15]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Person Objects PUBLIC 567
13.10 PerPhone

This entity contains an employee's phone numbers.

HRIS Element Information

HRIS Element ID: phoneInfo

Business Keys: personIdExternal + phoneType
Effective-date:false
Foundation Type:false
Person Entity Element:true
Supports Incremental Load:true
Supports NO_OVERWRITE: true
Supports MCPD:false

Supported Operations

Query, Upsert

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

operation To delete a record, use the upsert operation and set this prop­
erty to DELIMIT.

Use Case 1: Get the Person with a Specific Phone Number

This example shows how to get the person with the phone number '123'.

Request

Operation Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

568 PUBLIC Person Objects
 HTTP Method GET

URI https://<API-Server>/odata/v2/PerPhone?
$filter=phoneNumber eq '123'&
$expand=personNav/personalInfoNav&
$select=phoneNumber,personNav/
personalInfoNav/firstName,personNav/
personalInfoNav/lastName&$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
PerPhone(personIdExternal='cgrant1',phoneType='5847')",
"type": "SFOData.PerPhone"
},
"phoneNumber": "123",
"personNav": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/PerPerson('cgrant1')",
"type": "SFOData.PerPerson"
},
"personalInfoNav": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
PerPersonal(personIdExternal='cgrant1',startDate=datetime'2014-10-30T00:00:00')",
"type": "SFOData.PerPersonal"
},
"lastName": "Grant-Miller3",
"firstName": "Carla"
}
]
}
}
}
]
}
}

Use Case 2: Add the Phone Information of an Employee

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert?
purgeType=full

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Person Objects PUBLIC 569
Payload
{
"__metadata": {
"uri": "PerPhone",
"type": "SFOData.PerPhone"
},
"phoneType": "4828",
"personIdExternal": "cgrant",
"customLong13": "99999999999",
"customLong10": "TTT",
"customLong11": "onlyBasicSchool-2",
"customLong14": "D2",
"areaCode": "11111",
"customLong9": "787777",
"phoneNumber": "123456890",
"customLong8": "S3",
"customLong7": "A2",
"customLong6": "ALB",
"customLong5": "DLY",
"customLong4": "D3",
"customLong2": "4187",
"customLong1": "5123",
"extension": "uuuu",
"customDouble3": "666666",
"customDouble1": "55555",
"countryCode": "00000",
"isPrimary": true,
"customDate1": "/
Date(1517529600000)/",
"customDate3": "/
Date(1538697600000)/",
}

Response

{
"d": [
{
"key": "PerPhone/personIdExternal=cgrant,PerPhone/phoneType=4828",
"status": "OK",
"editStatus": UPSERTED,
"message": "",
"index": 0,
"httpCode": 200,
"inlineResults": Null
}
]
}

Related Information

SAP API Business Hub: Personal Information

Permission Settings [page 15]
Filtering out external user data [page 832]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

570 PUBLIC Person Objects
13.11 PerSocialAccount

This entity contains the employee's social account information.

HRIS Element Information

HRIS Element ID: imInfo

Business Keys: personIdExternal + domain
Effective-date:false
Foundation Type:false
Person Entity Element:true
Supports Incremental Load:true
Supports NO_OVERWRITE: true

Supported Operations

Upsert, Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

operation To delete a record, use the upsert operation and set this prop­
erty to DELETE.

Use Case 1: Get All Social Accounts Which Do Not Equal the Domain 1764 and
1765

Request

Operation Query

HTTP Method GET

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Person Objects PUBLIC 571
URI https://<API-Server>/odata/v2/
PerSocialAccount?$filter=domain ne '1764'
and domain ne '1765'&
$select=domain,personIdExternal,imId&
$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
PerSocialAccount(domain='1762',personIdExternal='cgrant1')",
"type": "SFOData.PerSocialAccount"
},
"personIdExternal": "cgrant1",
"domain": "1762",
"imId": "carla123"
}
]
}
}

Related Information

SAP API Business Hub: Personal Information

Permission Settings [page 15]

13.12 PersonKey

You can use this entity to expose the person UUID for integration and import scenarios.

Supported Operations

Operation Description

Query You query PersonKey via $expand from the User entity. You
can’t query PersonKey directly.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

572 PUBLIC Person Objects
Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Navigation Property Related Entity Description Permission

UserAccountNav UserAccount Navigate to account informa­ To run a query for account in­
tion, for example, the user formation, you also need the
name and status of the ac­ User Account OData entity
count. You query the account permission. You can find it un­
information through $expand der Administrator
from the User entity: $ex­
Permissions Manage
pand= PersonKeyNav/User­
AccountNav. User .

Use Case: Retrieve the perPersonUuid

In integration and import scenarios, you can use PersonKey to retrieve the person UUID represented by the
<perPersonUuid> field. This field is automatically populated by the system when a user is created. The value is
immutable meaning that you can’t change it.

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
User('admin')?$format=json&
$expand=personKeyNav&$filter=personKeyNav/
pePersonUuid eq
"3A085DB0D9184B49B0E3E70D6F07EB1A"

Response

{
"d": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/User('admin')",
"type": "SFOData.User"
},
....
},
"personKeyNav": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/PersonKey('admin')",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Person Objects PUBLIC 573
 "type": "SFOData.PersonKey"
},
"personIdExternal": "admin",
"personId": "2",
"perPersonUuid": "3A085DB0D9184B49B0E3E70D6F07EB1A"
}

Related Information

SAP API Business Hub: Personal Information

Provisioning Settings [page 15]
Permission Settings [page 15]

13.13 PersonType

PersonType is an entity that indicates the type of person. Examples are like Onboardee for Onboarded users,
Student for LMS users, Dependent, and so on.

Permissions

PersonType is an MDF object. Please get permissions for MDF before you use this entity.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

574 PUBLIC Person Objects
Use Case: Get the Person Type Information of Users

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/PersonType?
$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/PersonType('Onboardee')",
"type": "SFOData.PersonType"
},
"externalCode": "Onboardee",
"personTypeName_ru_RU": null,
"personTypeName_fr_FR": null,
"personTypeName_defaultValue": "Onboardee",
"personTypeName_en_DEBUG": null,
"personTypeName_localized": "Onboardee",
"lastModifiedDateTime": "/Date(1512384851000+0000)/",
"createdBy": "v4admin",
"personTypeName_de_DE": null,
"createdDateTime": "/Date(1512384851000+0000)/",
"lastModifiedBy": "v4admin",
"personTypeName_es_ES": null,
"personType": "ONBOARDEE",
"personTypeName_en_US": "Onboardee",
"mdfSystemRecordStatus": "N",
"personTypeNameTranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PersonType('Onboardee')/personTypeNameTranslationTextNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PersonType('Onboardee')/mdfSystemRecordStatusNav"
}
},
"personTypeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PersonType('Onboardee')/personTypeNav"
}
}
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/PersonType('Student')",
"type": "SFOData.PersonType"
},
"externalCode": "Student",
"personTypeName_ru_RU": null,
"personTypeName_fr_FR": null,
"personTypeName_defaultValue": "external LMS user",
"personTypeName_en_DEBUG": null,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Person Objects PUBLIC 575
 "personTypeName_localized": "ExternalLMSUser",
"lastModifiedDateTime": "/Date(1520999393000+0000)/",
"createdBy": "admin",
"personTypeName_de_DE": null,
"createdDateTime": "/Date(1520999246000+0000)/",
"lastModifiedBy": "admin",
"personTypeName_es_ES": null,
"personType": "STUDENT",
"personTypeName_en_US": "ExternalLMSUser",
"mdfSystemRecordStatus": "N",
"personTypeNameTranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PersonType('Student')/
personTypeNameTranslationTextNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PersonType('Student')/
mdfSystemRecordStatusNav"
}
},
"personTypeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PersonType('Student')/
personTypeNav"
}
}
}
]
}
}

13.14 PersonTypeUsage

PersonTypeUsage is a composite object that links Person to PersonType.

Permissions

PersonTypeUsage is an MDF object. Please get permissions for MDF before you use this entity.

Supported Operations

Operation Description

Query Query all the PersonTypeUsage records.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

576 PUBLIC Person Objects
Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Navigation Property Related Entity Description

personTypeNav PersonType Navigation to PersonType.

 Note

The PersonTypeUsage entity is used by the PerPerson entity to query person records, and can be filtered by
person type.

Use Case 1: Get All the PersonTypeUsage Records

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
PersonTypeUsage?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/PersonTypeUsage(5961L)",
"type": "SFOData.PersonTypeUsage"
},
"externalCode": "5961",
"startDate": "/Date(-2208988800000)/",
"person": "ONB001",
"endDate": "/Date(253402214400000)/",
"lastModifiedDateTime": "/Date(1512400831000+0000)/",
"createdBy": "admin",
"createdDateTime": "/Date(1512400831000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"personType": "Onboardee",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PersonTypeUsage(5961L)/mdfSystemRecordStatusNav"
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Person Objects PUBLIC 577
 },
"personTypeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PersonTypeUsage(5961L)/personTypeNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PersonTypeUsage(5961L)/mdfSystemStatusNav"
}
}
}
]
}
}

Use Case 2: Get the PerPerson Records of a Specific Person Type

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/PerPerson?
$format=json&$filter=personTypeUsageNav/
personTypeNav/personType eq 'ONBORDEE'

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/PerPerson('SUPTtest')",
"type": "SFOData.PerPerson"
},
"personIdExternal": "SUPTtest",
"dateOfBirth": null,
"perPersonUuid": "04FE29A7092D4142A3C3D99717E4D1ED",
"lastModifiedOn": "/Date(1524725000000)/",
"customString11": null,
"lastModifiedDateTime": "/Date(1524725000000+0000)/",
"createdOn": "/Date(1524725000000)/",
"createdBy": "admin",
"createdDateTime": "/Date(1524725000000+0000)/",
"lastModifiedBy": "admin",
"personId": "2767",
"customString1": null,
"personRerlationshipNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('SUPTtest')/
personRerlationshipNav"
}
},
"emergencyContactNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('SUPTtest')/
emergencyContactNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

578 PUBLIC Person Objects
 }
},
"phoneNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('SUPTtest')/
phoneNav"
}
},
"personalInfoNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('SUPTtest')/
personalInfoNav"
}
},
"homeAddressNavDEFLT": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('SUPTtest')/
homeAddressNavDEFLT"
}
},
"secondaryAssignmentsNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('SUPTtest')/
secondaryAssignmentsNav"
}
},
"personTypeUsageNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('SUPTtest')/
personTypeUsageNav"
}
},
"userAccountNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('SUPTtest')/
userAccountNav"
}
},
"nationalIdNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('SUPTtest')/
nationalIdNav"
}
},
"personEmpTerminationInfoNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('SUPTtest')/
personEmpTerminationInfoNav"
}
},
"emailNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('SUPTtest')/
emailNav"
}
},
"socialAccountNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('SUPTtest')/
socialAccountNav"
}
},
"employmentNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PerPerson('SUPTtest')/
employmentNav"
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Person Objects PUBLIC 579
 }
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

580 PUBLIC Person Objects
14 Position Management

Contains a list of entities in Position Management.

Entity Relationship Diagram

The following diagram shows the relationships between position entities:

PositionRightToReturn [page 582]

PositionRightToReturn indicates whether an employee is allowed to return to their original position after a
Leave of Absence or Global Assignment.

Position [page 583]

Use the Position entity to query position details, create, and edit positions.

PositionCompetencyMappingEntity [page 591]

This entity contains the mapping relationship between a position and its required competencies.

PositionEntity [page 596]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Position Management PUBLIC 581
 PositionEntity is an extension of Position that contains skills and competency information related to
the position. The skills and competencies are expressed through navigation properties that points to
PositionSkillMappingEntity and PositionCompetencyMappingEntity.

14.1 PositionRightToReturn

PositionRightToReturn indicates whether an employee is allowed to return to their original position after a Leave of
Absence or Global Assignment.

Permissions

Permission System Required Setting

Configure Object Definitions MDF Foundation Objects (related to the security in Object Defi-
nition) View Current, View History, Create, Insert, Correct, De­
lete, Import/Export

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Case 1: Get Details of Right to Return to a Position

You want to get information on whether an employee is entitled to return to the position he or she occupied before,
for example, going on global assignment.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

582 PUBLIC Position Management
Request

Operation Query

HTTP Method GET

URI https:/hostname/odata/v2/PositionRightToReturn

Payload {"externalCode": "9855"}

Parent topic: Position Management [page 581]

Related Information

Position [page 583]

PositionCompetencyMappingEntity [page 591]
PositionEntity [page 596]

14.2 Position

Use the Position entity to query position details, create, and edit positions.

Supported Operations

Query, Insert, Merge, Replace, Upsert, Delete

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Position Management PUBLIC 583
Properties

Property Description

code Business key

effectiveStartDate Business key

businessUnit The Business Unit in which this Job Posting belongs.

effectiveStatus Effective status of the position. Possible values:

● A: Active
● I: Inactive

This field is required.

employeeClass Employee class values can be found in MDF picklist

EmployeeClass.

externalName_<locale> A list of properties representing the external name of the posi­

tion in different languages as indicated by the locale code.

externalName_defaultValue Default external name of the position.

location The code of the location in which this Job Posting is located.

positionTitle Position title. This field is required.

standardHours The standard number of hours per week for this position.

Navigation Properties

Navigation Property Related Entity Description

incumbentNav User Information about the user stored in the

incumbent field of the position.

 Caution
This entry doesn't reflect whether
the employee is assigned to the posi­
tion. That information is stored in the
employee's Job Information. The
incumbentNav field is used by only
Succession Management. Don't use
it in Position Management.

parentPosition Position Parent position.

positionMatrixRelationship PositionMatrixRelationship Matrix relationship of the position

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

584 PUBLIC Position Management
 Navigation Property Related Entity Description

rightToReturn RightToReturn Indicates whether an employee on global

assignment or leave of absence can re­
turn to their original position.

successorNav Successor Successor of the position.

Use Case 1: Querying Position Details by Keys

This examples show show to query the details of a position by its business keys.

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-0
1-01T00:00:00')

Response

{
"d": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')",
"type": "SFOData.Position"
},
"code": "50014362",
"effectiveStartDate": "/Date(631152000000)/",
"businessUnit": "PRODS",
"lastModifiedDateTime": "/Date(1515681234000+0000)/",
"jobTitle": "Custodian",
"criticality": null,
"createdDateTime": "/Date(1443726167000+0000)/",
"jobCode": "50071001",
"mdfSystemVersionId": null,
"type": "RP",
"incumbent": null,
"division": "MANU",
"externalName_zh_TW": "保管員",
"externalName_ja_JP": "管理人",
"mdfSystemEntityId": "10AE9CC0A80C718BE0530B28080AD5E1",
"payRange": null,
"regularTemporary": "R",
"externalName_pt_PT": null,
"costCenter": "US10_RDGEN",
"standardHours": null,
"legacyPositionId": null,
"externalName_zh_CN": "保管员",
"externalName_localized": "Custodian",
"mdfSystemRecordStatus": "N",
"vacant": true,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Position Management PUBLIC 585
 "effectiveStatus": "A",
"externalName_fr_FR": "Consignataire",
"technicalParameters": null,
"externalName_en_GB": "Custodian",
"effectiveEndDate": "/Date(253402214400000)/",
"positionCriticality": "0",
"externalName_nl_NL": null,
"positionTitle": "Custodian",
"description": null,
"externalName_defaultValue": "Custodian",
"externalName_es_ES": "Conservador",
"positionControlled": null,
"externalName_pt_BR": "Depositário",
"payGrade": "H-04",
"company": "1710",
"department": "50150012",
"employeeClass": "1",
"mdfSystemObjectType": "Position",
"creationSource": null,
"changeReason": null,
"targetFTE": "4",
"lastModifiedDate": "/Date(1515663234000)/",
"externalName_ru_RU": "Хранитель",
"lastModifiedBy": "sfadmin",
"lastModifiedDateWithTZ": "/Date(1515681234000+0000)/",
"jobLevel": "IC",
"transactionSequence": "1",
"externalName_de_DE": "Verwalter",
"externalName_ko_KR": "관리인",
"createdDate": "/Date(1443711767000)/",
"createdBy": "sfadmin",
"mdfSystemOptimisticLockUUID": "86F1757F76554601999F4DD3769083F0",
"mdfSystemRecordId": "4616BFE3B2E04D00AF037BB9AA0009D6",
"comment": null,
"location": "1710-2009",
"multipleIncumbentsAllowed": true,
"externalName_en_US": "Custodian",
"externalName_en_DEBUG": null,
"creationSourceNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
creationSourceNav"
}
},
"regularTemporaryNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
regularTemporaryNav"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
createdByNav"
}
},
"externalNameTranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
externalNameTranslationTextNav"
}
},
"incumbentNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

586 PUBLIC Position Management
 "uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
incumbentNav"
}
},
"positionCriticalityNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
positionCriticalityNav"
}
},
"changeReasonNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
changeReasonNav"
}
},
"companyNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
companyNav"
}
},
"successorNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
successorNav"
}
},
"effectiveStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
effectiveStatusNav"
}
},
"departmentNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
departmentNav"
}
},
"rightToReturn": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
rightToReturn"
}
},
"businessUnitNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
businessUnitNav"
}
},
"positionMatrixRelationship": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
positionMatrixRelationship"
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Position Management PUBLIC 587
 "locationNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
locationNav"
}
},
"payRangeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
payRangeNav"
}
},
"jobLevelNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
jobLevelNav"
}
},
"costCenterNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
costCenterNav"
}
},
"employeeClassNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
employeeClassNav"
}
},
"jobCodeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
jobCodeNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
mdfSystemRecordStatusNav"
}
},
"divisionNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
divisionNav"
}
},
"parentPosition": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
parentPosition"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

588 PUBLIC Position Management
 }
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
wfRequestNav"
}
},
"payGradeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
Position(code='50014362',effectiveStartDate=datetime'1990-01-01T00:00:00')/
payGradeNav"
}
}
}
}

Use Case 2: Creating a Position with Insert

This example shows how to to create a position entry using insert.

Request

Operation Insert

HTTP Method POST

URI https://<API-Server>/odata/v2/Position

Headers Accept: application/json

Content-Type: application/json

Payload {
"__metadata": {
"uri": "Position"
},
"code": "11223344",
"effectiveStartDate": "/Date(1574245948000)/",
"positionTitle":"HR Administrator",
"effectiveStatus":"A"
}

Response

{
"d": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
Position(code='11223344',effectiveStartDate=datetime'2019-11-20T00:00:00')",
"type": "SFOData.Position"
},
"positionTitle": "HR Administrator",
"effectiveStatus": "A",
"effectiveStartDate": "/Date(1574208000000)/",
"code": "11223344"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Position Management PUBLIC 589
 }
}

Use Case 3: Modifying a Position

You can modify a position by merging fields or by replacing existing fields. The example below shows how to do this
using merge.

Request

Operation Merge

HTTP Method POST

URI https://<API-Server>/odata/v2/
Position(code='11223344',effectiveStartDate=datetime'2019-1
1-20T00:00:00')

Headers x-http-method: MERGE

Content-Type: application/json

Payload {
"comment": "Updating position location",
"location": "1710-2009"
}

Response

{
"d": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
Position(code='11223344',effectiveStartDate=datetime'2019-11-20T00:00:00'),
"type": "SFOData.Position"
},
"positionTitle": "HR Administrator",
"effectiveStatus": "A",
"effectiveStartDate": "/Date(1574208000000)/",
"code": "11223344"
}
}

Parent topic: Position Management [page 581]

Related Information

PositionRightToReturn [page 582]

PositionCompetencyMappingEntity [page 591]
PositionEntity [page 596]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

590 PUBLIC Position Management
SAP API Business Hub: Position Management

14.3 PositionCompetencyMappingEntity

This entity contains the mapping relationship between a position and its required competencies.

Supported Operations

Query, Insert, Merge, Replace, Upsert, Delete

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

PositionEntity_externalCode External code of the related PositionEntity entry. This is

a business key.

externalCode External code of the mapping entry. This is a business key.

status Status of the position. Possible statuses are:

● A: Active
● I: Inactive

rating_<locale> A list of properties representing rating values in different lo­

cales.

rating_defaultValue Default rating value.

weight_<locale> A list of properties representing the weight values in different

locales.

weight_defaultValue Default weight value.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Position Management PUBLIC 591
Navigation Properties

Navigation Property Related Entity Description

competencyNav CompetencyEntity Competency information of the position.

This navigation property is required.

Use Case 1: Query a Competency Mapping by Key

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
PositionCompetencyMappingEntity(PositionEntity_externalCode
='1000580',externalCode='1007147')

Response

{
"d": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
PositionCompetencyMappingEntity(PositionEntity_externalCode='1000580',externalCode='
1007147')",
"type": "SFOData.PositionCompetencyMappingEntity"
},
"PositionEntity_externalCode": "1000580",
"externalCode": "1007147",
"rating_pt_PT": null,
"weight_defaultValue": null,
"lastModifiedDateTime": "/Date(1446760225000+0000)/",
"rating_ru_RU": null,
"weight_en_GB": null,
"createdDateTime": "/Date(1446760225000+0000)/",
"mdfSystemVersionId": null,
"rating_en_US": null,
"weight_en_DEBUG": null,
"rating_en_DEBUG": null,
"rating_de_DE": null,
"rating_zh_TW": null,
"rating_fr_FR": null,
"mdfSystemEntityId": "91D8ADC0520F44C9BA03258D9834919F",
"effectiveStartDate": "/Date(-2208988800000)/",
"weight_ja_JP": null,
"weight_pt_BR": null,
"weight_fr_FR": null,
"mdfSystemRecordStatus": "N",
"rating_ja_JP": null,
"rating_ko_KR": null,
"rating_pt_BR": null,
"subModule": null,
"weight_localized": null,
"status": "A",
"effectiveEndDate": "/Date(253402214400000)/",
"competency": "1000076",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

592 PUBLIC Position Management
 "weight_en_US": null,
"rating_en_GB": null,
"weight_zh_CN": null,
"weight_pt_PT": null,
"rating_es_ES": null,
"rating_defaultValue": null,
"mdfSystemObjectType": "PositionCompetencyMappingEntity",
"rating_nl_NL": null,
"lastModifiedDate": "/Date(1446742225000)/",
"weight_ru_RU": null,
"lastModifiedBy": "sfadmin",
"weight_de_DE": null,
"weight_zh_TW": null,
"lastModifiedDateWithTZ": "/Date(1446760225000+0000)/",
"weight_ko_KR": null,
"transactionSequence": "1",
"createdDate": "/Date(1446742225000)/",
"createdBy": "sfadmin",
"weight_nl_NL": null,
"mdfSystemRecordId": "ECDA07D861B3490D9E421EE4AB2DD7DD",
"rating_zh_CN": null,
"rating_localized": null,
"weight_es_ES": null,
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PositionCompetencyMappingEntity(PositionEntity_externalCode='1000580',externalCode='
1007147')/createdByNav"
}
},
"weightTranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PositionCompetencyMappingEntity(PositionEntity_externalCode='1000580',externalCode='
1007147')/weightTranslationTextNav"
}
},
"statusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PositionCompetencyMappingEntity(PositionEntity_externalCode='1000580',externalCode='
1007147')/statusNav"
}
},
"ratingTranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PositionCompetencyMappingEntity(PositionEntity_externalCode='1000580',externalCode='
1007147')/ratingTranslationTextNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PositionCompetencyMappingEntity(PositionEntity_externalCode='1000580',externalCode='
1007147')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
PositionCompetencyMappingEntity(PositionEntity_externalCode='1000580',externalCode='
1007147')/mdfSystemRecordStatusNav"
}
},
"competencyNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Position Management PUBLIC 593
 "uri": "https://<API-Server>/odata/v2/
PositionCompetencyMappingEntity(PositionEntity_externalCode='1000580',externalCode='
1007147')/competencyNav"
}
}
}
}

Use Case 2: Query the Competency Mappings of a PositionEntity

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
PositionCompetencyMappingEntity(PositionEntity_externalCode
='1000580',externalCode='1007147')

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
PositionCompetencyMappingEntity(PositionEntity_externalCode='1000580',externalCode='
1007147')",
"type": "SFOData.PositionCompetencyMappingEntity"
},
"PositionEntity_externalCode": "1000580",
"externalCode": "1007147"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
PositionCompetencyMappingEntity(PositionEntity_externalCode='1000580',externalCode='
1007146')",
"type": "SFOData.PositionCompetencyMappingEntity"
},
"PositionEntity_externalCode": "1000580",
"externalCode": "1007146"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
PositionCompetencyMappingEntity(PositionEntity_externalCode='1000580',externalCode='
1007148')",
"type": "SFOData.PositionCompetencyMappingEntity"
},
"PositionEntity_externalCode": "1000580",
"externalCode": "1007148"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
PositionCompetencyMappingEntity(PositionEntity_externalCode='1000580',externalCode='
1007149')",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

594 PUBLIC Position Management
 "type": "SFOData.PositionCompetencyMappingEntity"
},
"PositionEntity_externalCode": "1000580",
"externalCode": "1007149"
}
]
}
}

Use Case 3: Map a PositionEntity Record to a Competency

Request

Operation Insert

HTTP Method POST

URI https://<API-Server>/odata/v2/
PositionCompetencyMappingEntity

Headers

Payload

Response

Parent topic: Position Management [page 581]

Related Information

PositionRightToReturn [page 582]

Position [page 583]
PositionEntity [page 596]
SAP API Business Hub: Position Management

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Position Management PUBLIC 595
14.4 PositionEntity

PositionEntity is an extension of Position that contains skills and competency information related to the
position. The skills and competencies are expressed through navigation properties that points to
PositionSkillMappingEntity and PositionCompetencyMappingEntity.

Supported Operations

Query, Insert, Merge, Replace, Upsert, Delete

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

externalCode Business key.

status This is a required field. Possible statuses are:

● A: Active
● I: Inactive

position External code of the related position.

Navigation Properties

Navigation Property Related Entity Description

positionCompetencyMappings PositionCompetencyMappingEntity Competencies required for the position.

positionSkillMappings PositionSkillMappingEntity Skills required for the position.

positionNav Position Related position information. This is a re­

quired navigation property when you cre­
ate or edit a PositionEntity entry.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

596 PUBLIC Position Management
Use Case 1: Query a PositionEntity's Skill Information

In this example, we try to query a PositionEntity and its related skills and competency information.

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/PositionEntity('1000580')?
$expand=positionSkillMappings&
$select=position,positionSkillMappings/skill

Response
In this example, a list of skills are related to this position. You can further expand toSkillEntity for details.

{
"d": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/PositionEntity('1000580')",
"type": "SFOData.PositionEntity"
},
"position": "50014345",
"positionSkillMappings": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
PositionSkillMappingEntity(PositionEntity_externalCode='1000580',externalCode='10071
39')",
"type": "SFOData.PositionSkillMappingEntity"
},
"skill": "1000516"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
PositionSkillMappingEntity(PositionEntity_externalCode='1000580',externalCode='10071
40')",
"type": "SFOData.PositionSkillMappingEntity"
},
"skill": "1000524"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
PositionSkillMappingEntity(PositionEntity_externalCode='1000580',externalCode='10071
41')",
"type": "SFOData.PositionSkillMappingEntity"
},
"skill": "1000530"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
PositionSkillMappingEntity(PositionEntity_externalCode='1000580',externalCode='10071
42')",
"type": "SFOData.PositionSkillMappingEntity"
},
"skill": "1000529"
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Position Management PUBLIC 597
 {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
PositionSkillMappingEntity(PositionEntity_externalCode='1000580',externalCode='10071
43')",
"type": "SFOData.PositionSkillMappingEntity"
},
"skill": "1000542"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
PositionSkillMappingEntity(PositionEntity_externalCode='1000580',externalCode='10071
44')",
"type": "SFOData.PositionSkillMappingEntity"
},
"skill": "1000528"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
PositionSkillMappingEntity(PositionEntity_externalCode='1000580',externalCode='10071
45')",
"type": "SFOData.PositionSkillMappingEntity"
},
"skill": "1000503"
}
]
}
}
}

Use Case 2: Creating a PositionEntity Record

This example shows how to create a PositionEntity record for an existing position using insert.

Request

Operation Insert

HTTP Method POST

URI https://<API-Server>/odata/v2/PositionEntity

Payload {
"__metadata": {
"uri": "PositionEntity"
},
"status": "A",
"positionNav": {
"__metadata": {
"uri":
"Position(code='11223344',effectiveStartDate=datetime'20
19-11-20T00:00:00')"
}
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

598 PUBLIC Position Management
Response

{
"d": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/PositionEntity('1020939')",
"type": "SFOData.PositionEntity"
},
"status": "A",
"externalCode": "1020939",
"positionNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/PositionEntity('1020939')/
positionNav"
}
}
}
}

Parent topic: Position Management [page 581]

Related Information

PositionRightToReturn [page 582]

Position [page 583]
PositionCompetencyMappingEntity [page 591]
SAP API Business Hub: Position Management

14.5 Function Imports

14.5.1 getPositionObjectData

You can use this function import to get the data of a position object.

Supported Operations

HTTP Method: GET

Return Type: RuleFieldMappingBeanList

Support Payload: false

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Position Management PUBLIC 599
Parameters

Parameter Type Description Required

positionId Long ID of the position object. Yes

userId String ID of the user who occupies Yes

the position.

Use Case: Retrieve the Position Ojbect Data of a User by Position ID

This example API call creates and returns a list of mapping of fields between SAP Fieldglass field names and
position field values for the given position ID in user’s locale by executing the rule defined in the Position
Management Settings.

Request

HTTP Method GET

URI https://<api-server>/odata/v2/
getPositionObjectData?
positionId=11545533L&userId=clewis1

Response

<d:RuleFieldMappingBeanList xmlns:d="http://schemas.microsoft.com/ado/2007/08/
dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/
metadata" m:type="SFOData.RuleFieldMappingBeanList">
<d:ruleFieldMappings m:type="Bag(SFOData.RuleFieldMappingBean)">
<d:element>
<d:fieldName>fg_location</d:fieldName>
<d:fieldValue>NL_AMS</d:fieldValue>
</d:element>
<d:element>
<d:fieldName>fg_jobTitle</d:fieldName>
<d:fieldValue>Developer 1</d:fieldValue>
</d:element>
<d:element>
<d:fieldName>OWNER</d:fieldName>
<d:fieldValue>clewis1</d:fieldValue>
</d:element>
<d:element>
<d:fieldName>TITLE</d:fieldName>
<d:fieldValue>SF Analyst_DE</d:fieldValue>
</d:element>
</d:ruleFieldMappings>
</d:RuleFieldMappingBeanList>

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

600 PUBLIC Position Management
15 Service Center

15.1 ServiceCenterConfiguration

You can use this entity to configure labels for the Landing page and Create Ticket page of the Ask HR application.

Permissions

User Permissions Miscellaneous Permissions Service Center Configuration

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Navigation Property Related Entity Description

LandingPageConfiguration LandingPageConfiguration Landing page configuration of Service

Center

CreateTicketPageConfiguration CreateTicketPageConfiguration Create Ticket page configuration of Serv­

ice Center

Use Case 1: Query Service Center Configuration

This example shows how to query the Service Center configuration.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Service Center PUBLIC 601
Request

Operation Query

HTTP Method GET

URI https://<API-Server>/v2/ServiceCenterConfiguration?
$expand=landingPageConfiguration,createTicketPageConfiguration&
$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-server>/odata/v2/ServiceCenterConfiguration(32343L)",
"type": "SFOData.ServiceCenterConfiguration"
},
"externalCode": "32343",
"configurationName": "configuration name",
"landingPageConfiguration": {
"__metadata": {
"uri": "https://<API-server>/odata/v2/
LandingPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externalCode
=32344L)",
"type": "SFOData.LandingPageConfiguration"
},
"externalCode": "32344",
"ServiceCenterConfiguration_externalCode": "32343",
"ticketsOverviewTileHeader_pt_BR": null,
"searchKBTileSubHeader_en_RTL": null,
"createTicketTileHeader_nl_NL": null,
"searchKBTileSubHeader_fr_CA": null,
"contactHRTileHeader_fr_CA": null,
"createTicketTileSubHeader_fr_CA": null,
"contactHRTileSubHeader_zh_CN": null,
"searchKBTileHeader_en_RTL": null,
"createTicketTileHeader_en_RTL": null,
"contactHRTileSubHeader_de_DE": null,
"ticketsOverviewTileHeader_es_MX": null,
"createTicketTileHeader_ar_SA": null,
"ticketsOverviewTileSubHeader_en_DEBUG_APOS_RTL": null,
"contactHRTileSubHeader_fr_FR": null,
"ticketsOverviewTileSubHeader_en_US": "manage issues",
"searchKBTileHeader_es_MX": null,
"ticketsOverviewTileHeader_es_ES": null,
"contactHRTileSubHeader_en_US": "country wise support",
"searchKBTileHeader_es_ES": null,
"createTicketTileHeader_en_DEBUG": null,
"ticketsOverviewTileSubHeader_zh_CN": null,
"contactHRTileHeader_defaultValue": "Support",
"createTicketTileHeader_it_IT": null,
"contactHRTileSubHeader_localized": "country wise support",
"ticketsOverviewTileHeader_localized": "View",
"ticketsOverviewTileSubHeader_de_DE": null,
"contactHRTileSubHeader_pt_BR": null,
"searchKBTileSubHeader_es_MX": null,
"contactHRTileSubHeader_en_RTL": null,
"ticketsOverviewTileSubHeader_en_DEBUG": null,
"ticketsOverviewTileSubHeader_es_MX": null,
"createTicketTileSubHeader_it_IT": null,
"ticketsOverviewTileHeader_en_US": "View",
"ticketsOverviewTileSubHeader_es_ES": null,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

602 PUBLIC Service Center
 "searchKBTileHeader_pt_BR": null,
"ticketsOverviewTileHeader_fr_FR": null,
"ticketsOverviewTileSubHeader_localized": "manage issues",
"ticketsOverviewTileSubHeader_fr_CA": null,
"createTicketTileSubHeader_nl_NL": null,
"searchKBTileSubHeader_nl_NL": null,
"contactHRTileHeader_es_ES": null,
"contactHRTileSubHeader_en_DEBUG_APOS_RTL": null,
"contactHRTileHeader_es_MX": null,
"ticketsOverviewTileHeader_en_DEBUG_APOS_RTL": null,
"createTicketTileSubHeader_pt_BR": null,
"createTicketTileSubHeader_localized": "view issues",
"contactHRTileHeader_ar_SA": null,
"contactHRTileSubHeader_en_GB": null,
"searchKBTileHeader_fr_FR": null,
"contactHRTileHeader_en_US": "Support",
"contactHRTileSubHeader_en_DEBUG": null,
"createTicketTileHeader_en_GB": null,
"createTicketTileHeader_fr_FR": null,
"contactHRTileSubHeader_nl_NL": null,
"ticketsOverviewTileHeader_en_GB": null,
"searchKBTileHeader_nl_NL": null,
"contactHRTileHeader_en_DEBUG_APOS_RTL": null,
"ticketsOverviewTileHeader_defaultValue": "View",
"contactHRTileHeader_it_IT": null,
"createTicketTileSubHeader_zh_CN": null,
"searchKBTileHeader_localized": "KB",
"createTicketTileHeader_zh_CN": null,
"createTicketTileSubHeader_fr_FR": null,
"searchKBTileHeader_zh_CN": null,
"ticketsOverviewTileHeader_zh_CN": null,
"contactHRTileHeader_pt_BR": null,
"createTicketTileSubHeader_en_GB": null,
"createTicketTileSubHeader_en_DEBUG": null,
"searchKBTileSubHeader_en_DEBUG_APOS_RTL": null,
"ticketsOverviewTileHeader_ar_SA": null,
"createTicketTileHeader_es_ES": null,
"createTicketTileHeader_es_MX": null,
"searchKBTileHeader_ar_SA": null,
"searchKBTileHeader_en_GB": null,
"createTicketTileHeader_en_US": "Report",
"createTicketTileHeader_defaultValue": "Report",
"contactHRTileHeader_fr_FR": null,
"searchKBTileSubHeader_de_DE": null,
"searchKBTileSubHeader_en_GB": null,
"contactHRTileHeader_en_GB": null,
"contactHRTileSubHeader_it_IT": null,
"searchKBTileSubHeader_fr_FR": null,
"ticketsOverviewTileHeader_nl_NL": null,
"contactHRTileHeader_de_DE": null,
"ticketsOverviewTileSubHeader_it_IT": null,
"createTicketTileSubHeader_defaultValue": "view issues",
"createTicketTileHeader_pt_BR": null,
"searchKBTileSubHeader_ar_SA": null,
"contactHRTileHeader_en_RTL": null,
"searchKBTileHeader_defaultValue": "KB",
"contactHRTileHeader_zh_CN": null,
"ticketsOverviewTileSubHeader_ar_SA": null,
"searchKBTileHeader_en_DEBUG_APOS_RTL": null,
"contactHRTileHeader_en_DEBUG": null,
"createTicketTileSubHeader_de_DE": null,
"createTicketTileSubHeader_en_US": "view issues",
"ticketsOverviewTileHeader_it_IT": null,
"ticketsOverviewTileSubHeader_nl_NL": null,
"createTicketTileSubHeader_es_ES": null,
"createTicketTileSubHeader_es_MX": null,
"searchKBTileHeader_it_IT": null,
"ticketsOverviewTileSubHeader_en_RTL": null,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Service Center PUBLIC 603
 "createTicketTileHeader_fr_CA": null,
"createTicketTileSubHeader_ar_SA": null,
"ticketsOverviewTileHeader_en_RTL": null,
"searchKBTileSubHeader_zh_CN": null,
"ticketsOverviewTileHeader_de_DE": null,
"ticketsOverviewTileSubHeader_defaultValue": "manage issues",
"contactHRTileHeader_nl_NL": null,
"searchKBTileSubHeader_es_ES": null,
"createTicketTileHeader_en_DEBUG_APOS_RTL": null,
"createTicketTileSubHeader_en_DEBUG_APOS_RTL": null,
"searchKBTileHeader_en_US": "KB",
"searchKBTileSubHeader_defaultValue": "Search for help",
"ticketsOverviewTileSubHeader_en_GB": null,
"searchKBTileHeader_de_DE": null,
"createTicketTileHeader_de_DE": null,
"createTicketTileSubHeader_en_RTL": null,
"searchKBTileSubHeader_en_DEBUG": null,
"searchKBTileSubHeader_en_US": "Search for help",
"searchKBTileHeader_fr_CA": null,
"contactHRTileSubHeader_es_ES": null,
"contactHRTileSubHeader_es_MX": null,
"contactHRTileSubHeader_fr_CA": null,
"searchKBTileSubHeader_pt_BR": null,
"searchKBTileSubHeader_it_IT": null,
"ticketsOverviewTileSubHeader_pt_BR": null,
"ticketsOverviewTileSubHeader_fr_FR": null,
"contactHRTileSubHeader_ar_SA": null,
"contactHRTileHeader_localized": "Support",
"createTicketTileHeader_localized": "Report",
"ticketsOverviewTileHeader_en_DEBUG": null,
"ticketsOverviewTileHeader_fr_CA": null,
"searchKBTileHeader_en_DEBUG": null,
"contactHRTileSubHeader_defaultValue": "country wise support",
"searchKBTileSubHeader_localized": "Search for help",
"ticketsOverviewTileHeaderTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
LandingPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externalCode
=32344L)/ticketsOverviewTileHeaderTranslationTextNav"
}
},
"createTicketTileHeaderTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
LandingPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externalCode
=32344L)/createTicketTileHeaderTranslationTextNav"
}
},
"createTicketTileSubHeaderTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
LandingPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externalCode
=32344L)/createTicketTileSubHeaderTranslationTextNav"
}
},
"contactHRTileHeaderTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
LandingPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externalCode
=32344L)/contactHRTileHeaderTranslationTextNav"
}
},
"ticketsOverviewTileSubHeaderTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
LandingPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externalCode
=32344L)/ticketsOverviewTileSubHeaderTranslationTextNav"
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

604 PUBLIC Service Center
 },
"searchKBTileHeaderTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
LandingPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externalCode
=32344L)/searchKBTileHeaderTranslationTextNav"
}
},
"contactHRTileSubHeaderTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
LandingPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externalCode
=32344L)/contactHRTileSubHeaderTranslationTextNav"
}
},
"searchKBTileSubHeaderTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
LandingPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externalCode
=32344L)/searchKBTileSubHeaderTranslationTextNav"
}
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
ServiceCenterConfiguration(32343L)/wfRequestNav"
}
},
"createTicketPageConfiguration": {
"__metadata": {
"uri": "https://<API-server>/odata/v2/
CreateTicketPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externa
lCode=32345L)",
"type": "SFOData.CreateTicketPageConfiguration"
},
"externalCode": "32345",
"ServiceCenterConfiguration_externalCode": "32343",
"serviceCategoryLabel_es_ES": null,
"priorityLabel_defaultValue": "Importance",
"affectedUserLabel_pt_BR": null,
"subjectDescLabel_fr_FR": null,
"subjectDescLabel_de_DE": null,
"serviceCategoryLabel_en_RTL": null,
"serviceCategoryLabel_pt_BR": null,
"serviceCategoryLabel_localized": "Service",
"serviceCategoryLabel_zh_CN": null,
"affectedUserLabel_es_MX": null,
"affectedUserLabel_es_ES": null,
"incidentCategoryLabel_de_DE": null,
"incidentCategoryLabel_en_GB": null,
"priorityLabel_it_IT": null,
"incidentCategoryLabel_en_RTL": null,
"incidentCategoryLabel_fr_FR": null,
"subjectDescLabel_en_US": "Ticket Content",
"priorityLabel_en_DEBUG_APOS_RTL": null,
"priorityLabel_fr_CA": null,
"priorityLabel_en_RTL": null,
"affectedUserLabel_fr_CA": null,
"incidentCategoryLabel_zh_CN": null,
"serviceCategoryLabel_en_DEBUG_APOS_RTL": null,
"priorityLabel_ar_SA": null,
"affectedUserLabel_zh_CN": null,
"priorityLabel_nl_NL": null,
"serviceCategoryLabel_en_DEBUG": null,
"subjectDescLabel_ar_SA": null,
"subjectDescLabel_en_DEBUG_APOS_RTL": null,
"affectedUserLabel_en_DEBUG": null,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Service Center PUBLIC 605
 "incidentCategoryLabel_en_DEBUG_APOS_RTL": null,
"incidentCategoryLabel_nl_NL": null,
"serviceCategoryLabel_fr_FR": null,
"affectedUserLabel_en_RTL": null,
"subjectDescLabel_es_ES": null,
"subjectDescLabel_es_MX": null,
"incidentCategoryLabel_localized": "Incident",
"affectedUserLabel_localized": "Employee ID",
"subjectDescLabel_en_RTL": null,
"subjectDescLabel_fr_CA": null,
"serviceCategoryLabel_nl_NL": null,
"affectedUserLabel_ar_SA": null,
"affectedUserLabel_en_DEBUG_APOS_RTL": null,
"priorityLabel_localized": "Importance",
"incidentCategoryLabel_fr_CA": null,
"affectedUserLabel_nl_NL": null,
"priorityLabel_fr_FR": null,
"priorityLabel_en_US": "Importance",
"affectedUserLabel_defaultValue": "Employee ID",
"priorityLabel_zh_CN": null,
"affectedUserLabel_en_GB": null,
"incidentCategoryLabel_defaultValue": "Incident",
"subjectDescLabel_en_DEBUG": null,
"priorityLabel_es_ES": null,
"subjectDescLabel_localized": "Ticket Content",
"incidentCategoryLabel_en_DEBUG": null,
"serviceCategoryLabel_en_GB": null,
"priorityLabel_de_DE": null,
"priorityLabel_es_MX": null,
"serviceCategoryLabel_defaultValue": "Service",
"subjectDescLabel_it_IT": null,
"affectedUserLabel_de_DE": null,
"affectedUserLabel_fr_FR": null,
"subjectDescLabel_pt_BR": null,
"incidentCategoryLabel_es_ES": null,
"serviceCategoryLabel_de_DE": null,
"incidentCategoryLabel_es_MX": null,
"priorityLabel_en_GB": null,
"incidentCategoryLabel_en_US": "Incident",
"priorityLabel_pt_BR": null,
"incidentCategoryLabel_ar_SA": null,
"serviceCategoryLabel_it_IT": null,
"subjectDescLabel_defaultValue": "Ticket Content",
"serviceCategoryLabel_fr_CA": null,
"subjectDescLabel_nl_NL": null,
"incidentCategoryLabel_it_IT": null,
"subjectDescLabel_en_GB": null,
"priorityLabel_en_DEBUG": null,
"subjectDescLabel_zh_CN": null,
"serviceCategoryLabel_en_US": "Service",
"affectedUserLabel_en_US": "Employee ID",
"serviceCategoryLabel_ar_SA": null,
"affectedUserLabel_it_IT": null,
"incidentCategoryLabel_pt_BR": null,
"serviceCategoryLabel_es_MX": null,
"affectedUserLabelTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
CreateTicketPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externa
lCode=32345L)/affectedUserLabelTranslationTextNav"
}
},
"priorityLabelTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
CreateTicketPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externa
lCode=32345L)/priorityLabelTranslationTextNav"
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

606 PUBLIC Service Center
 },
"serviceCategoryLabelTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
CreateTicketPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externa
lCode=32345L)/serviceCategoryLabelTranslationTextNav"
}
},
"incidentCategoryLabelTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
CreateTicketPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externa
lCode=32345L)/incidentCategoryLabelTranslationTextNav"
}
},
"subjectDescLabelTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
CreateTicketPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externa
lCode=32345L)/subjectDescLabelTranslationTextNav"
}
}
}
}
]
}
}

15.2 LandingPageConfiguration

This entity is used to store the configuration details for the Landing page of the Ask HR application.

Permissions

User Permissions Miscellaneous Permissions Service Center Configuration

Supported Operations

Query

Use Case 1: Query AskHR Landing Page Configuration

This example shows how to query the Landing page configuration.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Service Center PUBLIC 607
Request

Operation Query

HTTP Method GET

URI https://<API-Server>/v2/LandingPageConfiguration?
$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-server>/odata/v2/
LandingPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externalCode
=32344L)",
"type": "SFOData.LandingPageConfiguration"
},
"externalCode": "32344",
"ServiceCenterConfiguration_externalCode": "32343",
"ticketsOverviewTileHeader_pt_BR": null,
"searchKBTileSubHeader_en_RTL": null,
"createTicketTileHeader_nl_NL": null,
"searchKBTileSubHeader_fr_CA": null,
"contactHRTileHeader_fr_CA": null,
"createTicketTileSubHeader_fr_CA": null,
"contactHRTileSubHeader_zh_CN": null,
"searchKBTileHeader_en_RTL": null,
"createTicketTileHeader_en_RTL": null,
"contactHRTileSubHeader_de_DE": null,
"ticketsOverviewTileHeader_es_MX": null,
"createTicketTileHeader_ar_SA": null,
"ticketsOverviewTileSubHeader_en_DEBUG_APOS_RTL": null,
"contactHRTileSubHeader_fr_FR": null,
"ticketsOverviewTileSubHeader_en_US": "manage issues",
"searchKBTileHeader_es_MX": null,
"ticketsOverviewTileHeader_es_ES": null,
"contactHRTileSubHeader_en_US": "country wise support",
"searchKBTileHeader_es_ES": null,
"createTicketTileHeader_en_DEBUG": null,
"ticketsOverviewTileSubHeader_zh_CN": null,
"contactHRTileHeader_defaultValue": "Support",
"createTicketTileHeader_it_IT": null,
"contactHRTileSubHeader_localized": "country wise support",
"ticketsOverviewTileHeader_localized": "View",
"ticketsOverviewTileSubHeader_de_DE": null,
"contactHRTileSubHeader_pt_BR": null,
"searchKBTileSubHeader_es_MX": null,
"contactHRTileSubHeader_en_RTL": null,
"ticketsOverviewTileSubHeader_en_DEBUG": null,
"ticketsOverviewTileSubHeader_es_MX": null,
"createTicketTileSubHeader_it_IT": null,
"ticketsOverviewTileHeader_en_US": "View",
"ticketsOverviewTileSubHeader_es_ES": null,
"searchKBTileHeader_pt_BR": null,
"ticketsOverviewTileHeader_fr_FR": null,
"ticketsOverviewTileSubHeader_localized": "manage issues",
"ticketsOverviewTileSubHeader_fr_CA": null,
"createTicketTileSubHeader_nl_NL": null,
"searchKBTileSubHeader_nl_NL": null,
"contactHRTileHeader_es_ES": null,
"contactHRTileSubHeader_en_DEBUG_APOS_RTL": null,
"contactHRTileHeader_es_MX": null,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

608 PUBLIC Service Center
 "ticketsOverviewTileHeader_en_DEBUG_APOS_RTL": null,
"createTicketTileSubHeader_pt_BR": null,
"createTicketTileSubHeader_localized": "view issues",
"contactHRTileHeader_ar_SA": null,
"contactHRTileSubHeader_en_GB": null,
"searchKBTileHeader_fr_FR": null,
"contactHRTileHeader_en_US": "Support",
"contactHRTileSubHeader_en_DEBUG": null,
"createTicketTileHeader_en_GB": null,
"createTicketTileHeader_fr_FR": null,
"contactHRTileSubHeader_nl_NL": null,
"ticketsOverviewTileHeader_en_GB": null,
"searchKBTileHeader_nl_NL": null,
"contactHRTileHeader_en_DEBUG_APOS_RTL": null,
"ticketsOverviewTileHeader_defaultValue": "View",
"contactHRTileHeader_it_IT": null,
"createTicketTileSubHeader_zh_CN": null,
"searchKBTileHeader_localized": "KB",
"createTicketTileHeader_zh_CN": null,
"createTicketTileSubHeader_fr_FR": null,
"searchKBTileHeader_zh_CN": null,
"ticketsOverviewTileHeader_zh_CN": null,
"contactHRTileHeader_pt_BR": null,
"createTicketTileSubHeader_en_GB": null,
"createTicketTileSubHeader_en_DEBUG": null,
"searchKBTileSubHeader_en_DEBUG_APOS_RTL": null,
"ticketsOverviewTileHeader_ar_SA": null,
"createTicketTileHeader_es_ES": null,
"createTicketTileHeader_es_MX": null,
"searchKBTileHeader_ar_SA": null,
"searchKBTileHeader_en_GB": null,
"createTicketTileHeader_en_US": "Report",
"createTicketTileHeader_defaultValue": "Report",
"contactHRTileHeader_fr_FR": null,
"searchKBTileSubHeader_de_DE": null,
"searchKBTileSubHeader_en_GB": null,
"contactHRTileHeader_en_GB": null,
"contactHRTileSubHeader_it_IT": null,
"searchKBTileSubHeader_fr_FR": null,
"ticketsOverviewTileHeader_nl_NL": null,
"contactHRTileHeader_de_DE": null,
"ticketsOverviewTileSubHeader_it_IT": null,
"createTicketTileSubHeader_defaultValue": "view issues",
"createTicketTileHeader_pt_BR": null,
"searchKBTileSubHeader_ar_SA": null,
"contactHRTileHeader_en_RTL": null,
"searchKBTileHeader_defaultValue": "KB",
"contactHRTileHeader_zh_CN": null,
"ticketsOverviewTileSubHeader_ar_SA": null,
"searchKBTileHeader_en_DEBUG_APOS_RTL": null,
"contactHRTileHeader_en_DEBUG": null,
"createTicketTileSubHeader_de_DE": null,
"createTicketTileSubHeader_en_US": "view issues",
"ticketsOverviewTileHeader_it_IT": null,
"ticketsOverviewTileSubHeader_nl_NL": null,
"createTicketTileSubHeader_es_ES": null,
"createTicketTileSubHeader_es_MX": null,
"searchKBTileHeader_it_IT": null,
"ticketsOverviewTileSubHeader_en_RTL": null,
"createTicketTileHeader_fr_CA": null,
"createTicketTileSubHeader_ar_SA": null,
"ticketsOverviewTileHeader_en_RTL": null,
"searchKBTileSubHeader_zh_CN": null,
"ticketsOverviewTileHeader_de_DE": null,
"ticketsOverviewTileSubHeader_defaultValue": "manage issues",
"contactHRTileHeader_nl_NL": null,
"searchKBTileSubHeader_es_ES": null,
"createTicketTileHeader_en_DEBUG_APOS_RTL": null,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Service Center PUBLIC 609
 "createTicketTileSubHeader_en_DEBUG_APOS_RTL": null,
"searchKBTileHeader_en_US": "KB",
"searchKBTileSubHeader_defaultValue": "Search for help",
"ticketsOverviewTileSubHeader_en_GB": null,
"searchKBTileHeader_de_DE": null,
"createTicketTileHeader_de_DE": null,
"createTicketTileSubHeader_en_RTL": null,
"searchKBTileSubHeader_en_DEBUG": null,
"searchKBTileSubHeader_en_US": "Search for help",
"searchKBTileHeader_fr_CA": null,
"contactHRTileSubHeader_es_ES": null,
"contactHRTileSubHeader_es_MX": null,
"contactHRTileSubHeader_fr_CA": null,
"searchKBTileSubHeader_pt_BR": null,
"searchKBTileSubHeader_it_IT": null,
"ticketsOverviewTileSubHeader_pt_BR": null,
"ticketsOverviewTileSubHeader_fr_FR": null,
"contactHRTileSubHeader_ar_SA": null,
"contactHRTileHeader_localized": "Support",
"createTicketTileHeader_localized": "Report",
"ticketsOverviewTileHeader_en_DEBUG": null,
"ticketsOverviewTileHeader_fr_CA": null,
"searchKBTileHeader_en_DEBUG": null,
"contactHRTileSubHeader_defaultValue": "country wise support",
"searchKBTileSubHeader_localized": "Search for help",
"ticketsOverviewTileHeaderTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
LandingPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externalCode
=32344L)/ticketsOverviewTileHeaderTranslationTextNav"
}
},
"createTicketTileHeaderTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
LandingPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externalCode
=32344L)/createTicketTileHeaderTranslationTextNav"
}
},
"createTicketTileSubHeaderTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
LandingPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externalCode
=32344L)/createTicketTileSubHeaderTranslationTextNav"
}
},
"contactHRTileHeaderTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
LandingPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externalCode
=32344L)/contactHRTileHeaderTranslationTextNav"
}
},
"ticketsOverviewTileSubHeaderTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
LandingPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externalCode
=32344L)/ticketsOverviewTileSubHeaderTranslationTextNav"
}
},
"searchKBTileHeaderTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
LandingPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externalCode
=32344L)/searchKBTileHeaderTranslationTextNav"
}
},
"contactHRTileSubHeaderTranslationTextNav": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

610 PUBLIC Service Center
 "__deferred": {
"uri": "https://<API-server>/odata/v2/
LandingPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externalCode
=32344L)/contactHRTileSubHeaderTranslationTextNav"
}
},
"searchKBTileSubHeaderTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
LandingPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externalCode
=32344L)/searchKBTileSubHeaderTranslationTextNav"
}
}
}
]
}
}

15.3 CreateTicketPageConfiguration

This entity is used to store the configuration details for the Create Ticket page of the Ask HR application.

Permissions

User Permissions Miscellaneous Permissions Service Center Configuration

Supported Operations

Query

Use Case 1: Query Create Ticket Configuration

This example shows how to query the Create Ticket page configuration.

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/v2/CreateTicketPageConfiguration?
$format=json

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Service Center PUBLIC 611
Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-server>/odata/v2/
CreateTicketPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externa
lCode=32345L)",
"type": "SFOData.CreateTicketPageConfiguration"
},
"externalCode": "32345",
"ServiceCenterConfiguration_externalCode": "32343",
"serviceCategoryLabel_es_ES": null,
"priorityLabel_defaultValue": "Importance",
"affectedUserLabel_pt_BR": null,
"subjectDescLabel_fr_FR": null,
"subjectDescLabel_de_DE": null,
"serviceCategoryLabel_en_RTL": null,
"serviceCategoryLabel_pt_BR": null,
"serviceCategoryLabel_localized": "Service",
"serviceCategoryLabel_zh_CN": null,
"affectedUserLabel_es_MX": null,
"affectedUserLabel_es_ES": null,
"incidentCategoryLabel_de_DE": null,
"incidentCategoryLabel_en_GB": null,
"priorityLabel_it_IT": null,
"incidentCategoryLabel_en_RTL": null,
"incidentCategoryLabel_fr_FR": null,
"subjectDescLabel_en_US": "Ticket Content",
"priorityLabel_en_DEBUG_APOS_RTL": null,
"priorityLabel_fr_CA": null,
"priorityLabel_en_RTL": null,
"affectedUserLabel_fr_CA": null,
"incidentCategoryLabel_zh_CN": null,
"serviceCategoryLabel_en_DEBUG_APOS_RTL": null,
"priorityLabel_ar_SA": null,
"affectedUserLabel_zh_CN": null,
"priorityLabel_nl_NL": null,
"serviceCategoryLabel_en_DEBUG": null,
"subjectDescLabel_ar_SA": null,
"subjectDescLabel_en_DEBUG_APOS_RTL": null,
"affectedUserLabel_en_DEBUG": null,
"incidentCategoryLabel_en_DEBUG_APOS_RTL": null,
"incidentCategoryLabel_nl_NL": null,
"serviceCategoryLabel_fr_FR": null,
"affectedUserLabel_en_RTL": null,
"subjectDescLabel_es_ES": null,
"subjectDescLabel_es_MX": null,
"incidentCategoryLabel_localized": "Incident",
"affectedUserLabel_localized": "Employee ID",
"subjectDescLabel_en_RTL": null,
"subjectDescLabel_fr_CA": null,
"serviceCategoryLabel_nl_NL": null,
"affectedUserLabel_ar_SA": null,
"affectedUserLabel_en_DEBUG_APOS_RTL": null,
"priorityLabel_localized": "Importance",
"incidentCategoryLabel_fr_CA": null,
"affectedUserLabel_nl_NL": null,
"priorityLabel_fr_FR": null,
"priorityLabel_en_US": "Importance",
"affectedUserLabel_defaultValue": "Employee ID",
"priorityLabel_zh_CN": null,
"affectedUserLabel_en_GB": null,
"incidentCategoryLabel_defaultValue": "Incident",
"subjectDescLabel_en_DEBUG": null,
"priorityLabel_es_ES": null,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

612 PUBLIC Service Center
 "subjectDescLabel_localized": "Ticket Content",
"incidentCategoryLabel_en_DEBUG": null,
"serviceCategoryLabel_en_GB": null,
"priorityLabel_de_DE": null,
"priorityLabel_es_MX": null,
"serviceCategoryLabel_defaultValue": "Service",
"subjectDescLabel_it_IT": null,
"affectedUserLabel_de_DE": null,
"affectedUserLabel_fr_FR": null,
"subjectDescLabel_pt_BR": null,
"incidentCategoryLabel_es_ES": null,
"serviceCategoryLabel_de_DE": null,
"incidentCategoryLabel_es_MX": null,
"priorityLabel_en_GB": null,
"incidentCategoryLabel_en_US": "Incident",
"priorityLabel_pt_BR": null,
"incidentCategoryLabel_ar_SA": null,
"serviceCategoryLabel_it_IT": null,
"subjectDescLabel_defaultValue": "Ticket Content",
"serviceCategoryLabel_fr_CA": null,
"subjectDescLabel_nl_NL": null,
"incidentCategoryLabel_it_IT": null,
"subjectDescLabel_en_GB": null,
"priorityLabel_en_DEBUG": null,
"subjectDescLabel_zh_CN": null,
"serviceCategoryLabel_en_US": "Service",
"affectedUserLabel_en_US": "Employee ID",
"serviceCategoryLabel_ar_SA": null,
"affectedUserLabel_it_IT": null,
"incidentCategoryLabel_pt_BR": null,
"serviceCategoryLabel_es_MX": null,
"affectedUserLabelTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
CreateTicketPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externa
lCode=32345L)/affectedUserLabelTranslationTextNav"
}
},
"priorityLabelTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
CreateTicketPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externa
lCode=32345L)/priorityLabelTranslationTextNav"
}
},
"serviceCategoryLabelTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
CreateTicketPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externa
lCode=32345L)/serviceCategoryLabelTranslationTextNav"
}
},
"incidentCategoryLabelTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
CreateTicketPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externa
lCode=32345L)/incidentCategoryLabelTranslationTextNav"
}
},
"subjectDescLabelTranslationTextNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
CreateTicketPageConfiguration(ServiceCenterConfiguration_externalCode=32343L,externa
lCode=32345L)/subjectDescLabelTranslationTextNav"
}
}
}
]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Service Center PUBLIC 613
 }
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

614 PUBLIC Service Center
16 Time & Attendance Management

16.1 Time Off Objects

In this section, you'll find the APIs available for Time Off. You can use Time Off to manage absences such as
vacation, sick leave, and paid time off.

Before using any of the Time Off entities described here, you need to switch on Time Off in the Admin Center. For
details of how to do this, take a look at the Activating Time Management documentation in the Implementing Time
Management in SAP SuccessFactors guide.

In addition, you need to have permission to use the individual objects in question. For information on these
permissions, take a look at the Permissions in Time Off documentation in the Implementing Time Management in
SAP SuccessFactors guide.

 Note

The following fields are set to Visible and Read Only by default: CreatedDate, CreatedBy, LastModifiedDate, and
LastModifiedBy. The fields are set to Read Only for the EmployeeTime, TimeAccountPayout, and
TimeAccountPurchase objects. It's possible that the fields are visible on the Manage Data user interface. If
you'd like to hide them, follow the steps to hide the fields lined out in each object definition.

16.1.1 AbsenceCountingMethod

You can enter an absence counting method in a time type, to determine which days are included in calculating an
absence taken of that time type. You can also determine the basis on which the calculation takes place and the
weekdays to which the calculation base should apply.

Operations Allowed

Query

Properties

Here you can see the required fields and business keys for this entity. Check the OData API dictionary in your
instance to see the complete list of properties, and check your metadata for navigations, and associations.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 615
Property Business Key Required Field Description

externalCode Yes Yes External Code

externalName No Yes External Name for all relevant

languages

country No No Absence counting methods

can be country-specific. If this
one is, the relevant country
appears here.

base No Yes Option that is used for the ab­

sence calculation. Work
Schedule / Calendar Days

monday No Yes Yes/No whether the day is

covered by this method.

tuesday No Yes Yes/No whether the day is

covered by this method.

wednesday No Yes Yes/No whether the day is

covered by this method.

thursday No Yes Yes/No whether the day is

covered by this method.

friday No Yes Yes/No whether the day is

covered by this method.

saturday No Yes Yes/No whether the day is

covered by this method.

sunday No Yes Yes/No whether the day is

covered by this method.

considerHolidays No Yes Choose Yes here if you want to

take account of holidays when
calculating an absence.

Code Examples
URI: http://<hostname>/odata/v2/AbsenceCountingMethod('ACM_EXAMPLE')$format=JSON

{
"d": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/AbsenceCountingMethod('ACM_EXAMPLE')",
"type": "SFOData.AbsenceCountingMethod"
},
"externalCode": "ACM_EXAMPLE",
"externalName_ko_KR": null,
"mdfSystemObjectType": "AbsenceCountingMethod",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"monday": true,
"externalName_de_DE": null,
"externalName_localized": "ACM_EXAMPLE",
"externalName_defaultValue": "ACM_EXAMPLE",
"externalName_es_MX": null,
"lastModifiedDateTime": "/Date(1464005812000+0000)/",
"externalName_da_DK": null,
"mdfSystemTransactionSequence": "1",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

616 PUBLIC Time & Attendance Management
 "externalName_fi_FI": null,
"mdfSystemRecordId": "B1482C05967B45E3A5C09D23EE79AD9F",
"mdfSystemEntityId": "DC85B619655F4ECCA7F5984DDA64F049",
"mdfSystemStatus": "A",
"saturday": false,
"lastModifiedDateWithTZ": "/Date(1464005812000+0000)/",
"externalName_zh_TW": null,
"externalName_en_US": "ACM_EXAMPLE",
"tuesday": true,
"friday": false,
"externalName_en_SAP_SLS": null,
"createdDate": "/Date(1464013012000)/",
"externalName_ja_JP": null,
"mdfSystemRecordStatus": "N",
"thursday": true,
"externalName_pl_PL": null,
"country": null,
"wednesday": true,
"createdBy": "admin",
"externalName_it_IT": null,
"sunday": false,
"externalName_en_RTL": null,
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1464005812000+0000)/",
"base": "WORKSCHEDULE",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDate": "/Date(1464013012000)/",
"externalName_en_GB": null,
"externalName_es_ES": null,
"considerHolidays": true,
"externalName_nl_NL": null,
"externalName_zh_CN": null,
"externalName_en_DEBUG": null,
"externalName_fr_FR": null,
"externalNameTranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/AbsenceCountingMethod('ACM_EXAMPLE')/
externalNameTranslationTextNav"
}
}
}
}

Related Information

SAP API Business Hub: Time Off

16.1.2 AccrualCalculationBase

The entity is used to store reported times (per user and date). The records need to be provided to this storage from
a data source outside Time Off, such as by import or integration using OData. The entity represents the raw data.

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 617
Code Examples

Example 1: Create a new entry

URI: http://<api-server>/odata/v2/upsert

Payload

{
"__metadata" : {
"uri" : "http://localhost:8080/odata/v2/
AccrualCalculationBase(externalCode='country_2015-12-28')",
"type" : "SFOData.AccrualCalculationBase"
},
"externalCode" : "country_2015-12-28",
"userId" : "country",
"actualQuantity" : 6,
"date" : "\/Date(1451260800000)\/"
}
Response:
{
"d" : [
{
"key" : null,
"status" : "OK",
"editStatus" : "UPSERTED",
"message" : null,
"index" : 0,
"httpCode" : 200,
"inlineResults" : null
}
]
}

Example 2: Retrieve data

URI: http://<api-server>/odata/v2/AccrualCalculationBase?$format=json

Operation: GET

Response:

{
"d" : {
"results" : [
{
"__metadata" : {
"uri" : "https://localhost:443/odata/v2/
AccrualCalculationBase('country_2015-12-28')", "type" :
"SFOData.AccrualCalculationBase"
},
"externalCode" : "country_2015-12-28",
"mdfSystemEffectiveEndDate" : "\/Date(253402214400000)\/", "mdfSystemObjectType" :
"AccrualCalculationBase",
"mdfSystemVersionId" : null,
"lastModifiedDateTime" : "\/Date(1451465919000+0000)\/",
"date" : "\/Date(1451260800000)\/",
"mdfSystemTransactionSequence" : "1",
"mdfSystemRecordId" : "02114EA3DE97476A910F425807E9C03E",
"mdfSystemEntityId" : "A38105E8A5354C81A7AF20895B66924F",
"userId" : "country",
"mdfSystemStatus" : "A",
"lastModifiedDateWithTZ" : "\/Date(1451465919000+0000)\/",
"createdDate" : "\/Date(1451469519000)\/",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

618 PUBLIC Time & Attendance Management
 "mdfSystemRecordStatus" : "N",
"quantity3" : null,
"quantity4" : null,
"quantity5" : null,
"quantity1" : null,
"quantity2" : null,
"createdBy" : "daily",
"lastModifiedBy" : "daily",
"createdDateTime" : "\/Date(1451465919000+0000)\/",
"mdfSystemEffectiveStartDate" : "\/Date(-2208988800000)\/",
"lastModifiedDate" : "\/Date(1451469519000)\/",
"actualQuantity" : "6", "mdfSystemRecordStatusNav" : {
"__deferred" : {
"uri" : "https://localhost:443/odata/v2/
AccrualCalculationBase('country_2015-12-28')/mdfSystemRecordStatusNav"
}
}, "userIdNav" : {
"__deferred" : {
"uri" : "https://localhost:443/odata/v2/
AccrualCalculationBase('country_2015-12-28')/userIdNav"
}
}, "mdfSystemStatusNav" : {
"__deferred" : {
"uri" : "https://localhost:443/odata/v2/
AccrualCalculationBase('country_2015-12-28')/mdfSystemStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Time Off

16.1.3 AvailableTimeType

Contains information about the available time type, which is one of the time types that an employee is allowed to
take.

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 619
Use Case

API Call Description

https://<api-server>/odata/v2/ Retrieves first Available Time Type record

AvailableTimeType?$top=1&$format=JSON

Code Examples

"d": {
"results": [
{
"__metadata": {
"uri": "https://<host.sap.com>/odata/v2/
AvailableTimeType(TimeTypeProfile_externalCode='TP_normal',externalCode='13')",
"type": "SFOData.AvailableTimeType"
},
"TimeTypeProfile_externalCode": "TP_normal",
"externalCode": "13",
"mdfSystemObjectType": "AvailableTimeType",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"favoriteTimeType": false,
"lastModifiedDateTime": "/Date(1457380136000+0000)/",
"hideAccountBalance": null,
"timeType": "TRAVEL",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "0E9AC4A2D7574B5B91D6AA865E529E76",
"createdBy": "sfadmin",
"mdfSystemEntityId": "5F277D467E2D42628AA4082BCA12A785",
"createdDateTime": "/Date(1440598493000+0000)/",
"enabledInEssScenario": true,
"lastModifiedBy": "sfadmin",
"mdfSystemStatus": "A",
"lastModifiedDate": "/Date(1457362136000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDateWithTZ": "/Date(1457380136000+0000)/",
"createdDate": "/Date(1440584093000)/",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<host.sap.com>/odata/v2/
AvailableTimeType(TimeTypeProfile_externalCode='TP_normal',externalCode='13')/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<host.sap.com>/odata/v2/
AvailableTimeType(TimeTypeProfile_externalCode='TP_normal',externalCode='13')/
mdfSystemStatusNav"
}
},
"timeTypeNav": {
"__deferred": {
"uri": "https://<host.sap.com>/odata/v2/
AvailableTimeType(TimeTypeProfile_externalCode='TP_normal',externalCode='13')/
timeTypeNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

620 PUBLIC Time & Attendance Management
 }
}
}
]
}
}

Related Information

SAP API Business Hub: Time Off

16.1.4 EmployeeTime

You can use this API to manage employee absences such as vacation, sick leave, and other paid time off.

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Cases

API Call Description

https://<api-server>/odata/v2/ Get employee time for the user defined in the call.
EmployeeTime?&$format=json&$filter=userId
%20eq%20'sampleemployee'

Code Examples

{
d: {
results: [104]
0: {
__metadata: {
uri: "https://<api-server>/odata/v2/
EmployeeTime('50f007dd864e448691e8f2cf0ae5f0fe')"
type: "SFOData.EmployeeTime"
}-
externalCode: "50f007dd864e448691e8f2cf0ae5f0fe"
quantityInDays: null
mdfSystemObjectType: "EmployeeTime"
cancellationWorkflowRequestId: null
endDate: "/Date(1420416000000)/"
lastModifiedDateTime: "/Date(1429101050000+0000)/"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 621
 endTime: null
timeType: "HGB_WORK"
startTime: null
cust_Division: null
mdfSystemRecordId: "93B1732C8E5545219D995A5E0C068E64"
mdfSystemEntityId: "7A3FCE07910B4CDEB28584A3F373526E"
userId: "raji1505emp"
fractionQuantity: null
approvalStatus: "APPROVED"
mdfSystemStatus: "A"
cust_company: null
createdDate: "/Date(1429101050000)/"
mdfSystemRecordStatus: "N"
cust_Department: null
editable: null
createdBy: "raji1505emp"
lastModifiedBy: "raji1505emp"
createdDateTime: "/Date(1429101050000+0000)/"
loaExpectedReturnDate: null
mdfSystemEffectiveStartDate: "/Date(-2208988800000)/"
comment: null
loaStartJobInfoId: null
startDate: "/Date(1420416000000)/"
mdfSystemEffectiveEndDate: "/Date(253402214400000)/"
mdfSystemVersionId: null
mdfSystemTransactionSequence: "1"
timeRecordOrigin: null
workflowRequestId: null
loaActualReturnDate: null
lastModifiedDateWithTZ: "/Date(1429101050000+0000)/"
quantityInHours: "10"
flexibleRequesting: null
deductionQuantity: "10"
loaEndJobInfoId: null
cust_BU: null
lastModifiedDate: "/Date(1429101050000)/"
cust_companyNav: {
__deferred: {
uri: "https://<api-server>/odata/v2/
EmployeeTime('50f007dd864e448691e8f2cf0ae5f0fe')/cust_companyNav"
}-
}-
timeCalendar: {
__deferred: {
uri: "https://<api-server>/odata/v2/
EmployeeTime('50f007dd864e448691e8f2cf0ae5f0fe')/timeCalendar"
}-
}-
timeTypeNav: {
__deferred: {
uri: "https://<api-server>/odata/v2/
EmployeeTime('50f007dd864e448691e8f2cf0ae5f0fe')/timeTypeNav"
}-
}-
countryExtensionESP: {
__deferred: {
uri: "https://<api-server>/odata/v2/
EmployeeTime('50f007dd864e448691e8f2cf0ae5f0fe')/countryExtensionESP"
}-
}-
approvalStatusNav: {
__deferred: {
uri: "https://<api-server>/odata/v2/
EmployeeTime('50f007dd864e448691e8f2cf0ae5f0fe')/approvalStatusNav"
}-
}-
countryExtensionDEU: {
__deferred: {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

622 PUBLIC Time & Attendance Management
 uri: "https://<api-server>/odata/v2/
EmployeeTime('50f007dd864e448691e8f2cf0ae5f0fe')/countryExtensionDEU"
}-
}-
mdfSystemStatusNav: {
__deferred: {
uri: "https://<api-server>/odata/v2/
EmployeeTime('50f007dd864e448691e8f2cf0ae5f0fe')/mdfSystemStatusNav"
}-
}-
cust_DepartmentNav: {
__deferred: {
uri: "https://<api-server>/odata/v2/
EmployeeTime('50f007dd864e448691e8f2cf0ae5f0fe')/cust_DepartmentNav"
}-
}-
timeRecordOriginNav: {
__deferred: {
uri: "https://<api-server>/odata/v2/
EmployeeTime('50f007dd864e448691e8f2cf0ae5f0fe')/timeRecordOriginNav"
}-
}-
cust_BUNav: {
__deferred: {
uri: "https://<api-server>/odata/v2/
EmployeeTime('50f007dd864e448691e8f2cf0ae5f0fe')/cust_BUNav"
}-
}-
cust_DivisionNav: {
__deferred: {
uri: "https://<api-server>/odata/v2/
EmployeeTime('50f007dd864e448691e8f2cf0ae5f0fe')/cust_DivisionNav"
}-
}-
mdfSystemRecordStatusNav: {
__deferred: {
uri: "https://<api-server>/odata/v2/
EmployeeTime('50f007dd864e448691e8f2cf0ae5f0fe')/mdfSystemRecordStatusNav"
}-
}-
userIdNav: {
__deferred: {
uri: "https://<api-server>/odata/v2/
EmployeeTime('50f007dd864e448691e8f2cf0ae5f0fe')/userIdNav"
}-
}-
}

Related Information

SAP API Business Hub: Time Off

16.1.5 EmployeeTime<Country/Region>
Country/region-specific entities for EmployeeTime are available. Take a look at the sub-sections to see which
countries are supported with country/region-specific fields. These entities are child entities of EmployeeTime.

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 623
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Australia: EmployeeTimeAUS

This entity contains Australia specific absence fields, which is used for requesting advance leave payment.

Canada: EmployeeTimeCAN

This entity contains three date fields specific to Canada, which is used for short term disability in Time.

Colombia: EmployeeTimeCOL

Admin can use this object to store Colombia-specific details of an EmployeeTime created for sick leave. It is used
only when Colombia is the country in the time type and contains only the GO reference to the EmployeeTimeGroup
used for linking of absences. This MDF is effective dated from parent.

Germany: EmployeeTimeDEU

This entity contains information about employee time created for sick leave. It is specific to Germany and is a child
of the entity EmployeeTime.

Spain: EmployeeTimeESP

This entity contains information about employee time created for sick leave. It is specific to Spain and is a child of
the entity EmployeeTime.

Mexico: EmployeeTimeMEX

This entity contains information about employee time created for sick leave. It is specific to Mexico and contains
the field Reference Number which is only required for maintaining employee time in Mexico. Apart from this
country/region-specific field, this object also holds the GO reference to the group Identical Sicknesses which is
used for the linking of absences.
Sample Query for creating EmployeeTimeMex http://<api-server>/odata/v2/
EmployeeTime(‘<external-code of Employee Time>’)/countryExtensionMEX

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

624 PUBLIC Time & Attendance Management
Netherlands: EmployeeTimeNLD

This entity contains a Netherlands specific field to record the available working capacity of an employee when
recovering from illness in Time Off

Poland: EmployeeTimePOL

This entity contains ZLA Code, ZLA Document Number, ZLA Issue Date and ZLA Delivery Date. This object is used
to store the employee specific Time fields information for a Polish Employee.

USA: EmployeeTimeUSA

This entity contains three date fields specific to USA, which is used for short term disability in Time.

EmployeeTimeAUS [page 626]

This entity contains Australia-specific absence fields, which are used for requesting advance leave
payment.

EmployeeTimeCAN [page 627]

This entity contains three date fields specific to Canada, which are used for short-term disability in Time
Management.

EmployeeTimeCOL [page 629]

This entity contains absence-related information for Colombia.

EmployeeTimeDEU [page 632]

This entity contains information about absences for employees in Germany.

EmployeeTimeESP [page 635]

This entity contains specific information for Spain related to absence.

EmployeeTimeMEX [page 636]

This entity contains absence-related information for Mexico.

EmployeeTimeNLD [page 638]

This entity contains a field specific to the Netherlands that is used to record the work capacity of an
employee when recovering from illness in Time Management.

EmployeeTimePOL [page 640]

This entity contains ZLA Code, ZLA Document Number, ZLA Issue Date and ZLA Delivery Date. This object
is used to store the employee-specific Time Management fields information for an employee based in
Poland.

EmployeeTimeUSA [page 642]

This entity contains date fields specific to USA, which are used for short-term disability in Time
Management.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 625
16.1.5.1 EmployeeTimeAUS

This entity contains Australia-specific absence fields, which are used for requesting advance leave payment.

Supported Operations

Query

Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

requestLeaveAdvancePayment The option to request the advance leave payment.

splitPaymentAcrossFinancialYear The option to request the split of the payment across the financial year.

Use Case: Querying the advance leave payment information for an employee in
Australia

Request

Operation Query

HTTP Method GET

URI https://<API-server>/odata/v2/EmployeeTimeAUS?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": " https://<API-server>/odata/v2/
EmployeeTimeAUS(EmployeeTime_externalCode='6e42e96016f34499a6e6671ef975ef33',externa
lCode=10444L)",
"type": "SFOData.EmployeeTimeAUS"
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

626 PUBLIC Time & Attendance Management
 "EmployeeTime_externalCode": "6e42e96016f34499a6e6671ef975ef33",
"externalCode": "10444",
"lastModifiedDateTime": "/Date(1579250016000+0000)/",
"lastModifiedBy": "rgopal",
"createdDateTime": "/Date(1579250016000+0000)/",
"mdfSystemRecordStatus": "N",
"requestAdvanceLeavePayment": true,
"createdBy": "rgopal",
"splitPaymentAcrossFinancialYear": null,
"createdByNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
EmployeeTimeAUS(EmployeeTime_externalCode='6e42e96016f34499a6e6671ef975ef33',externa
lCode=10444L)/createdByNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
EmployeeTimeAUS(EmployeeTime_externalCode='6e42e96016f34499a6e6671ef975ef33',externa
lCode=10444L)/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
EmployeeTimeAUS(EmployeeTime_externalCode='6e42e96016f34499a6e6671ef975ef33',externa
lCode=10444L)/mdfSystemRecordStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Time Off

16.1.5.2 EmployeeTimeCAN

This entity contains three date fields specific to Canada, which are used for short-term disability in Time
Management.

Supported Operations

Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 627
Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

disabilityPeriodOneEndDate This field is used to record the end date of the first short-term
disability absence.

disabilityPeriodTwoEndDate This field is used to record the end date of the second short-
term disability absence.

disabilityPeriodThreeEndDate This field is used to record the end date of the third short-term
disability absence.

refDisabilityPeriodOneEndDate This field is used to record the reference end date of the first
short-term disability period.

refDisabilityPeriodTwoEndDate This field is used to record the reference end date of the sec­
ond short-term disability period.

refDisabilityPeriodThreeEndDate This field is used to record the reference end date of the third
short-term disability period.

policyDeviation This field is used to record a deviation from the policy for short-
term disability absences.

Use Case: Querying the short-term disbaility absence information for an

employee in Canada

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/EmployeeTimeCAN?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

628 PUBLIC Time & Attendance Management
 "uri": "https://<API-Server>/odata/v2/
EmployeeTimeCAN(EmployeeTime_externalCode='288f90ed195d4ad2970399fe5d58b27e',externa
lCode=11034L)",
"type": "SFOData.EmployeeTimeCAN"
},
"EmployeeTime_externalCode": "288f90ed195d4ad2970399fe5d58b27e",
"externalCode": "11034",
"lastModifiedDateTime": "/Date(1591025331000+0000)/",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1591025331000+0000)/",
"mdfSystemRecordStatus": "N",
"disabilityPeriodThreeEndDate": null,
"disabilityPeriodTwoEndDate": "/Date(1595462400000)/",
"disabilityPeriodOneEndDate": "/Date(1594684800000)/",
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmployeeTimeCAN(EmployeeTime_externalCode='288f90ed195d4ad2970399fe5d58b27e',externa
lCode=11034L)/createdByNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmployeeTimeCAN(EmployeeTime_externalCode='288f90ed195d4ad2970399fe5d58b27e',externa
lCode=11034L)/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmployeeTimeCAN(EmployeeTime_externalCode='288f90ed195d4ad2970399fe5d58b27e',externa
lCode=11034L)/mdfSystemRecordStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Time Off

16.1.5.3 EmployeeTimeCOL

This entity contains absence-related information for Colombia.

Supported Operations

Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 629
Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

identicalSicknessGroup The option to group an employee's sickness as identical.

Use Case: Querying information about an identical sickness group for

employees in Colombia

Request

Operation Query

HTTP Method GET

URI https://<API-server>/odata/v2/EmployeeTimeCOL?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<hostname>/odata/v2/
EmployeeTimeDEU(EmployeeTime_externalCode='592af6d3d06f410db56ab71aaecea896',externa
lCode=13714L)",
"type": "SFOData.EmployeeTimeDEU"
},
"externalCode": "13714",
"EmployeeTime_externalCode": "592af6d3d06f410db56ab71aaecea896",
"continuedPayEndDate": null,
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "EmployeeTimeDEU",
"mdfSystemVersionId": null,
"identicalSicknessGroup": "2022ffa1320141fd93c070b9be459865",
"sicknessCertificateStartDate": null,
"lastModifiedDateTime": "/Date(1492598128000+0000)/",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "8F47FCE6A1DE4DE18287FACFEABD0E40",
"mdfSystemEntityId": "3C92D5967437427DB416737306F7239A",
"overlappingSicknessGroup": null,
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/Date(1492598128000+0000)/",
"createdDate": "/Date(1492598092000)/",
"mdfSystemRecordStatus": "N",
"paySupplementStartDate": null,
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1492598092000+0000)/",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

630 PUBLIC Time & Attendance Management
 "lastModifiedDate": "/Date(1492598128000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"continuedPayCreditedDays": null,
"paySupplementEndDate": null,
"overlappingSicknessGroupNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
EmployeeTimeDEU(EmployeeTime_externalCode='592af6d3d06f410db56ab71aaecea896',externa
lCode=13714L)/overlappingSicknessGroupNav"
}
},
"identicalSicknessGroupNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
EmployeeTimeDEU(EmployeeTime_externalCode='592af6d3d06f410db56ab71aaecea896',externa
lCode=13714L)/identicalSicknessGroupNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
EmployeeTimeDEU(EmployeeTime_externalCode='592af6d3d06f410db56ab71aaecea896',externa
lCode=13714L)/mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
EmployeeTimeDEU(EmployeeTime_externalCode='592af6d3d06f410db56ab71aaecea896',externa
lCode=13714L)/mdfSystemStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<hostname>/odata/v2/
EmployeeTimeDEU(EmployeeTime_externalCode='51a3d66425704772aa55b99be6c6a8ea',externa
lCode=13718L)",
"type": "SFOData.EmployeeTimeDEU"
},
"externalCode": "13718",
"EmployeeTime_externalCode": "51a3d66425704772aa55b99be6c6a8ea",
"continuedPayEndDate": null,
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "EmployeeTimeDEU",
"mdfSystemVersionId": null,
"identicalSicknessGroup": "2022ffa1320141fd93c070b9be459865",
"sicknessCertificateStartDate": null,
"lastModifiedDateTime": "/Date(1492598128000+0000)/",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "0EB9391118494F7BA518FCF367FDD503",
"mdfSystemEntityId": "158C47611E7D4AD599812DEB9D407D3A",
"overlappingSicknessGroup": null,
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/Date(1492598128000+0000)/",
"createdDate": "/Date(1492598128000)/",
"mdfSystemRecordStatus": "N",
"paySupplementStartDate": null,
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1492598128000+0000)/",
"lastModifiedDate": "/Date(1492598128000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"continuedPayCreditedDays": null,
"paySupplementEndDate": null,
"overlappingSicknessGroupNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 631
 "uri": "https://<hostname>/odata/v2/
EmployeeTimeDEU(EmployeeTime_externalCode='51a3d66425704772aa55b99be6c6a8ea',externa
lCode=13718L)/overlappingSicknessGroupNav"
}
},
"identicalSicknessGroupNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
EmployeeTimeDEU(EmployeeTime_externalCode='51a3d66425704772aa55b99be6c6a8ea',externa
lCode=13718L)/identicalSicknessGroupNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
EmployeeTimeDEU(EmployeeTime_externalCode='51a3d66425704772aa55b99be6c6a8ea',externa
lCode=13718L)/mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
EmployeeTimeDEU(EmployeeTime_externalCode='51a3d66425704772aa55b99be6c6a8ea',externa
lCode=13718L)/mdfSystemStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Time Off

16.1.5.4 EmployeeTimeDEU

This entity contains information about absences for employees in Germany.

Supported Operations

Query

Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

632 PUBLIC Time & Attendance Management
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

continuedPayCreditedDays This field is used to record the days credited for continued pay.

identicalSicknessGroup This field is used to record an identical sickness group.

overlappingSicknessGroup This field is used to record an overlapping sickness group.

continuedPayEndDate This field is used to record the end date of continued pay.

paySupplementStartDate This field is used to record the start date of the sick pay supplement.

paySupplementEndDate This field is used to record the end date of the sick pay supplement.

sicknessCertificateStartDate This field is used to record the certified start date of the sickess.

refContinuedPayEndDate This field is used to record the reference end date of continued pay.

refPaySupplementStartDate This field is used to record the reference start date of the sick pay supplement.

refPaySupplementEndDate This field is used to record the reference end date of the sick pay supplement.

deviationFromSickPayPeriods This field is used to record a deviation from sick pay periods.

Use Case: Querying the continued sick pay information for an employee in
Germany

Request

Operation Query

HTTP Method GET

URI https://<API-server>/odata/v2/EmployeeTimeAUS?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<hostname>/odata/v2/
EmployeeTimeDEU(EmployeeTime_externalCode='592af6d3d06f410db56ab71aaecea896',externa
lCode=13714L)",
"type": "SFOData.EmployeeTimeDEU"
},
"externalCode": "13714",
"EmployeeTime_externalCode": "592af6d3d06f410db56ab71aaecea896",
"continuedPayEndDate": null,
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "EmployeeTimeDEU",
"mdfSystemVersionId": null,
"identicalSicknessGroup": "2022ffa1320141fd93c070b9be459865",
"sicknessCertificateStartDate": null,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 633
 "lastModifiedDateTime": "/Date(1492598128000+0000)/",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "8F47FCE6A1DE4DE18287FACFEABD0E40",
"mdfSystemEntityId": "3C92D5967437427DB416737306F7239A",
"overlappingSicknessGroup": null,
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/Date(1492598128000+0000)/",
"createdDate": "/Date(1492598092000)/",
"mdfSystemRecordStatus": "N",
"paySupplementStartDate": null,
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1492598092000+0000)/",
"lastModifiedDate": "/Date(1492598128000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"continuedPayCreditedDays": null,
"paySupplementEndDate": null,
"overlappingSicknessGroupNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
EmployeeTimeDEU(EmployeeTime_externalCode='592af6d3d06f410db56ab71aaecea896',externa
lCode=13714L)/overlappingSicknessGroupNav"
}
},
"identicalSicknessGroupNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
EmployeeTimeDEU(EmployeeTime_externalCode='592af6d3d06f410db56ab71aaecea896',externa
lCode=13714L)/identicalSicknessGroupNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
EmployeeTimeDEU(EmployeeTime_externalCode='592af6d3d06f410db56ab71aaecea896',externa
lCode=13714L)/mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
EmployeeTimeDEU(EmployeeTime_externalCode='592af6d3d06f410db56ab71aaecea896',externa
lCode=13714L)/mdfSystemStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<hostname>/odata/v2/
EmployeeTimeDEU(EmployeeTime_externalCode='51a3d66425704772aa55b99be6c6a8ea',externa
lCode=13718L)",
"type": "SFOData.EmployeeTimeDEU"
},
"externalCode": "13718",
"EmployeeTime_externalCode": "51a3d66425704772aa55b99be6c6a8ea",
"continuedPayEndDate": null,
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "EmployeeTimeDEU",
"mdfSystemVersionId": null,
"identicalSicknessGroup": "2022ffa1320141fd93c070b9be459865",
"sicknessCertificateStartDate": null,
"lastModifiedDateTime": "/Date(1492598128000+0000)/",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "0EB9391118494F7BA518FCF367FDD503",
"mdfSystemEntityId": "158C47611E7D4AD599812DEB9D407D3A",
"overlappingSicknessGroup": null,
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/Date(1492598128000+0000)/",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

634 PUBLIC Time & Attendance Management
 "createdDate": "/Date(1492598128000)/",
"mdfSystemRecordStatus": "N",
"paySupplementStartDate": null,
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1492598128000+0000)/",
"lastModifiedDate": "/Date(1492598128000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"continuedPayCreditedDays": null,
"paySupplementEndDate": null,
"overlappingSicknessGroupNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
EmployeeTimeDEU(EmployeeTime_externalCode='51a3d66425704772aa55b99be6c6a8ea',externa
lCode=13718L)/overlappingSicknessGroupNav"
}
},
"identicalSicknessGroupNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
EmployeeTimeDEU(EmployeeTime_externalCode='51a3d66425704772aa55b99be6c6a8ea',externa
lCode=13718L)/identicalSicknessGroupNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
EmployeeTimeDEU(EmployeeTime_externalCode='51a3d66425704772aa55b99be6c6a8ea',externa
lCode=13718L)/mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
EmployeeTimeDEU(EmployeeTime_externalCode='51a3d66425704772aa55b99be6c6a8ea',externa
lCode=13718L)/mdfSystemStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Time Off

16.1.5.5 EmployeeTimeESP

This entity contains specific information for Spain related to absence.

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 635
Code Examples

Example: Retrieve data of the EmployeeTimeESP objects in JSON. (In this case there are no such objects)

URI: http://<api-server>/odata/v2/EmployeeTimeESP?$format=json

Method: GET

Response:

 Sample Code

{
"d": {
"results": []
}
}

Related Information

SAP API Business Hub: Time Off

16.1.5.6 EmployeeTimeMEX

This entity contains absence-related information for Mexico.

Supported Operations

Query

Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

636 PUBLIC Time & Attendance Management
Properties

Property Description

referenceNumber This field is used to record the first disability period end date
for the short-term disability absence.

identicalSicknessGroup This field is used to record the second disability period end
date for the short-term disability absence.

daysAlreadyCumulatedForSameSickness This field is used to record the third disability period end date
for the short-term disability absence.

Use Case: Querying the "prima vacacional" (annual entitlement) information for
an employee based in Mexico

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/EmployeeTimeMEX?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmployeeTimeUSA(EmployeeTime_externalCode='ae22341a4c5042bb9d49799624a9d125',externa
lCode=11172L)",
"type": "SFOData.EmployeeTimeUSA"
},
"EmployeeTime_externalCode": "ae22341a4c5042bb9d49799624a9d125",
"externalCode": "11172",
"lastModifiedDateTime": "/Date(1594113847000+0000)/",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1594113847000+0000)/",
"mdfSystemRecordStatus": "N",
"createdBy": "admin",
"disabilityPeriodThreeEndDate": null,
"disabilityPeriodTwoEndDate": "/Date(1595462400000)/",
"disabilityPeriodOneEndDate": "/Date(1594684800000)/",
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmployeeTimeUSA(EmployeeTime_externalCode='ae22341a4c5042bb9d49799624a9d125',externa
lCode=11172L)/createdByNav"
}
},
"lastModifiedByNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 637
 "uri": "https://<API-Server>/odata/v2/
EmployeeTimeUSA(EmployeeTime_externalCode='ae22341a4c5042bb9d49799624a9d125',externa
lCode=11172L)/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmployeeTimeUSA(EmployeeTime_externalCode='ae22341a4c5042bb9d49799624a9d125',externa
lCode=11172L)/mdfSystemRecordStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Time Off

16.1.5.7 EmployeeTimeNLD

This entity contains a field specific to the Netherlands that is used to record the work capacity of an employee
when recovering from illness in Time Management.

Supported Operations

Query

Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

638 PUBLIC Time & Attendance Management
Properties

Property Description

workCapacityPercentageDuringIllness This field is used to store the percentage of an employee's (re­

duced) work capacity due to illness until they are able to return
to their regular work schedule.

Use Case: Querying the available work capacity information for an employee in
the Netherlands

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/EmployeeTimeNLD?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmployeeTimeNLD(EmployeeTime_externalCode='9d1b35ee251042c3a087999bbfed1f26',externa
lCode=15467L)",
"type": "SFOData.EmployeeTimeNLD"
},
"EmployeeTime_externalCode": "9d1b35ee251042c3a087999bbfed1f26",
"externalCode": "15467",
"lastModifiedDateTime": "/Date(1628575479000+0000)/",
"createdBy": "admin",
"entityUUID": "1DDCAF49072646368866170A944713E9",
"lastModifiedBy": "admin",
"workCapacityPercentageDuringIllness": "30",
"createdDateTime": "/Date(1628575479000+0000)/",
"mdfSystemRecordStatus": "N",
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmployeeTimeNLD(EmployeeTime_externalCode='9d1b35ee251042c3a087999bbfed1f26',externa
lCode=15467L)/createdByNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmployeeTimeNLD(EmployeeTime_externalCode='9d1b35ee251042c3a087999bbfed1f26',externa
lCode=15467L)/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 639
 "uri": "https://<API-Server>/odata/v2/
EmployeeTimeNLD(EmployeeTime_externalCode='9d1b35ee251042c3a087999bbfed1f26',externa
lCode=15467L)/mdfSystemRecordStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Time Off

16.1.5.8 EmployeeTimePOL

This entity contains ZLA Code, ZLA Document Number, ZLA Issue Date and ZLA Delivery Date. This object is used
to store the employee-specific Time Management fields information for an employee based in Poland.

Supported Operations

Query

Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

absenceCode The reference code related to the absence.

zlaDocumentNumber The document number from the ZLA sickness certificate.

zlaIssueDate The date on which the illness was reported to the ZLA authority

zlaDeliveryDate The date on which the ZLA certificate was delivered by the employee to the em­
ployer.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

640 PUBLIC Time & Attendance Management
Use Case: Querying the ZLA information for an employee based in Poland

Request

Operation Query

HTTP Method GET

URI https://<API-server>/odata/v2/EmployeeTimePOL?format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-server>/odata/v2/
EmployeeTimePOL(EmployeeTime_externalCode='833834f528a04ea6af1d502e57003543',externa
lCode=60529L)",
"type": "SFOData.EmployeeTimePOL"
},
"EmployeeTime_externalCode": "833834f528a04ea6af1d502e57003543",
"externalCode": "60529",
"zlaDeliveryDate": "/Date(1568246400000)/",
"lastModifiedDateTime": "/Date(1569214037000+0000)/",
"lastModifiedBy": "akumar",
"createdDateTime": "/Date(1569213976000+0000)/",
"mdfSystemRecordStatus": "N",
"absenceCode": "11",
"createdBy": "akumar",
"zlaDocumentNumber": "1111",
"zlaIssueDate": "/Date(1568246400000)/",
"createdByNav": {
"__deferred": {
"uri": "https<API-server>/odata/v2/
EmployeeTimePOL(EmployeeTime_externalCode='833834f528a04ea6af1d502e57003543',externa
lCode=60529L)/createdByNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
EmployeeTimePOL(EmployeeTime_externalCode='833834f528a04ea6af1d502e57003543',externa
lCode=60529L)/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
EmployeeTimePOL(EmployeeTime_externalCode='833834f528a04ea6af1d502e57003543',externa
lCode=60529L)/mdfSystemRecordStatusNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 641
Related Information

SAP API Business Hub: Time Off

16.1.5.9 EmployeeTimeUSA

This entity contains date fields specific to USA, which are used for short-term disability in Time Management.

Supported Operations

Query

Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

disabilityPeriodOneEndDate This field is used to record the first disability period end date
for the short-term disability absence.

disabilityPeriodTwoEndDate This field is used to record the second disability period end
date for the short-term disability absence.

disabilityPeriodThreeEndDate This field is used to record the third disability period end date
for the short-term disability absence.

refDisabilityPeriodOneEndDate This field is used to record the reference end date of the first
short-term disability period.

refDisabilityPeriodTwoEndDate This field is used to record the reference end date of the sec­
ond short-term disability period.

refDisabilityPeriodThreeEndDate This field is used to record the reference end date of the third
short-term disability period.

policyDeviation This field is used to record a deviation from the policy for short-
term disability absences.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

642 PUBLIC Time & Attendance Management
Use Case: Querying short-term disbability absence information for an employee
in the USA

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/EmployeeTimeUSA?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
EmployeeTimeUSA(EmployeeTime_externalCode='ae22341a4c5042bb9d49799624a9d125',externa
lCode=11172L)",
"type": "SFOData.EmployeeTimeUSA"
},
"EmployeeTime_externalCode": "ae22341a4c5042bb9d49799624a9d125",
"externalCode": "11172",
"lastModifiedDateTime": "/Date(1594113847000+0000)/",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1594113847000+0000)/",
"mdfSystemRecordStatus": "N",
"createdBy": "admin",
"disabilityPeriodThreeEndDate": null,
"disabilityPeriodTwoEndDate": "/Date(1595462400000)/",
"disabilityPeriodOneEndDate": "/Date(1594684800000)/",
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmployeeTimeUSA(EmployeeTime_externalCode='ae22341a4c5042bb9d49799624a9d125',externa
lCode=11172L)/createdByNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmployeeTimeUSA(EmployeeTime_externalCode='ae22341a4c5042bb9d49799624a9d125',externa
lCode=11172L)/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
EmployeeTimeUSA(EmployeeTime_externalCode='ae22341a4c5042bb9d49799624a9d125',externa
lCode=11172L)/mdfSystemRecordStatusNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 643
Related Information

SAP API Business Hub: Time Off

16.1.6 EmployeeTimeCalendar

Contains absence information on a daily basis. There is one entry for every working day with the relevant number of
days and number of hours. For example, if there is a half day absence on an eight-hour working day, the resulting
calendar entry has 0.5 days and 4 hours

OData Examples

Example – Retrieve data of the employee time calendar which belongs to the employee time with specific external
code

URI http://<hostname>/odata/v2/
EmployeeTimeCalendar(EmployeeTime_externalCode=57d8c995114f421eb97ebcce2a9c3324',externalCode='57d
8c995114f421eb97ebcce2a9c3324'')?$format=json

 Sample Code

{
"d": {
"__metadata": {
"uri": "https://<hostname>/odata/v2/
EmployeeTimeCalendar(EmployeeTime_externalCode='9d59e47c10434d91afeb3fd664c01093'
,externalCode='57d8c995114f421eb97ebcce2a9c3324')",
"type": "SFOData.EmployeeTimeCalendar"
},
"externalCode": "57d8c995114f421eb97ebcce2a9c3324",
"EmployeeTime_externalCode": "9d59e47c10434d91afeb3fd664c01093",
"quantityInDays": "1",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "EmployeeTimeCalendar",
"workScheduleInternalId": "50257",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1486480298000+0000)/",
"endTime": null,
"date": "/Date(1486425600000)/",
"mdfSystemTransactionSequence": "1",
"startTime": null,
"mdfSystemRecordId": "C663DFE9A67E43289A3183B51B614CF0",
"mdfSystemEntityId": "C1ADC4497A9E44C9878F1FEC00753817",
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/Date(1486480298000+0000)/",
"createdDate": "/Date(1486462298000)/",
"quantityInHours": "8",
"mdfSystemRecordStatus": "N",
"deductionQuantity": "1",
"createdBy": "sfadmin",
"lastModifiedBy": "sfadmin",
"createdDateTime": "/Date(1486480298000+0000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDate": "/Date(1486462298000)/",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

644 PUBLIC Time & Attendance Management
 "mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
EmployeeTimeCalendar(EmployeeTime_externalCode='9d59e47c10434d91afeb3fd664c01093'
,externalCode='57d8c995114f421eb97ebcce2a9c3324')/mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
EmployeeTimeCalendar(EmployeeTime_externalCode='9d59e47c10434d91afeb3fd664c01093'
,externalCode='57d8c995114f421eb97ebcce2a9c3324')/mdfSystemStatusNav"
}
}
}
}

Related Information

SAP API Business Hub: Time Off

16.1.7 EmployeeTimeGroup

The entity is used to group EmployeeTime objects for special use cases. Currently it is used for recurring absences
and linking of absences.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

externalCode External Code. This is a business key and is required.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 645
Property Description

userId External Name for all relevant languages. This field is required.

itemsCategory This indicates what items this employee time group contains.
Values: LINKED_ABSENCES or RECURRING_ABSENCES. This
field is required.

Navigation Properties

Navigation Propertz Related Entity Description

items EmployeeTimeGroupItem Navigation to EmployeeTimeGroupItem

userIdNav User Navigation to User

Code Examples

URI: http://<api-server>/odata/v2/EmployeeTimeGroup('76931234932b4666820c4be07a0a7c2a')?
$expand=items&$format=JSON

 Sample Code

{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/
EmployeeTimeGroup('76931234932b4666820c4be07a0a7c2a')",
"type": "SFOData.EmployeeTimeGroup"
},
"externalCode": "76931234932b4666820c4be07a0a7c2a",
"mdfSystemObjectType": "EmployeeTimeGroup",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1461325378000+0000)/",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "7EC32545B28C4888AF677383389ED2AF",
"createdBy": "admin",
"mdfSystemEntityId": "42D3F5A0CF3F47BA8ED3D9B42A029444",
"userId": "mhoff",
"createdDateTime": "/Date(1461325377000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"lastModifiedDate": "/Date(1461332578000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"itemsCategory": "LINKED_ABSENCES",
"lastModifiedDateWithTZ": "/Date(1461325378000+0000)/",
"createdDate": "/Date(1461332577000)/",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTimeGroup('76931234932b4666820c4be07a0a7c2a')/mdfSystemRecordStatusNav"
}
},
"itemsCategoryNav": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

646 PUBLIC Time & Attendance Management
 "__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTimeGroup('76931234932b4666820c4be07a0a7c2a')/itemsCategoryNav"
}
},
"userIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTimeGroup('76931234932b4666820c4be07a0a7c2a')/userIdNav"
}
},
"items": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
EmployeeTimeGroupItem(EmployeeTimeGroup_externalCode='76931234932b4666820c4be07a0
a7c2a',mdfSystemExternalCode='462e517c09dc49248f6d25b704ede3ac')",
"type": "SFOData.EmployeeTimeGroupItem"
},
"EmployeeTimeGroup_externalCode": "76931234932b4666820c4be07a0a7c2a",
"mdfSystemExternalCode": "462e517c09dc49248f6d25b704ede3ac",
"mdfSystemObjectType": "EmployeeTimeGroupItem",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"employeeTime": "ad2946e1c07d4f97a61535c0b7f796aa",
"lastModifiedDateTime": "/Date(1461325378000+0000)/",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "AD58F8FFFCD741F7974C3ADDF0C96DE6",
"createdBy": "admin",
"mdfSystemEntityId": "197DDFB6AF8E4D61AFBE5FF516C0F8DD",
"createdDateTime": "/Date(1461325378000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"lastModifiedDate": "/Date(1461332578000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDateWithTZ": "/Date(1461325378000+0000)/",
"comment": null,
"createdDate": "/Date(1461332578000)/",
"mdfSystemRecordStatus": "N",
"employeeTimeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTimeGroupItem(EmployeeTimeGroup_externalCode='76931234932b4666820c4be07a0
a7c2a',mdfSystemExternalCode='462e517c09dc49248f6d25b704ede3ac')/employeeTimeNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTimeGroupItem(EmployeeTimeGroup_externalCode='76931234932b4666820c4be07a0
a7c2a',mdfSystemExternalCode='462e517c09dc49248f6d25b704ede3ac')/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTimeGroupItem(EmployeeTimeGroup_externalCode='76931234932b4666820c4be07a0
a7c2a',mdfSystemExternalCode='462e517c09dc49248f6d25b704ede3ac')/
mdfSystemStatusNav"
}
}
},
{
"__metadata": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 647
 "uri": "https://<api-server>/odata/v2/
EmployeeTimeGroupItem(EmployeeTimeGroup_externalCode='76931234932b4666820c4be07a0
a7c2a',mdfSystemExternalCode='2eec85bedcb54f4bac432c743a61d394')",
"type": "SFOData.EmployeeTimeGroupItem"
},
"EmployeeTimeGroup_externalCode": "76931234932b4666820c4be07a0a7c2a",
"mdfSystemExternalCode": "2eec85bedcb54f4bac432c743a61d394",
"mdfSystemObjectType": "EmployeeTimeGroupItem",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"employeeTime": "2bbf683e5d504e7e8ec955c2698ddc56",
"lastModifiedDateTime": "/Date(1461325378000+0000)/",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "B410E96B4B87460586A89D7C93BFDCE1",
"createdBy": "admin",
"mdfSystemEntityId": "7C2A5E6D782645F4A99553BD6CBA9A06",
"createdDateTime": "/Date(1461325378000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"lastModifiedDate": "/Date(1461332578000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDateWithTZ": "/Date(1461325378000+0000)/",
"comment": null,
"createdDate": "/Date(1461332578000)/",
"mdfSystemRecordStatus": "N",
"employeeTimeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTimeGroupItem(EmployeeTimeGroup_externalCode='76931234932b4666820c4be07a0
a7c2a',mdfSystemExternalCode='2eec85bedcb54f4bac432c743a61d394')/employeeTimeNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTimeGroupItem(EmployeeTimeGroup_externalCode='76931234932b4666820c4be07a0
a7c2a',mdfSystemExternalCode='2eec85bedcb54f4bac432c743a61d394')/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTimeGroupItem(EmployeeTimeGroup_externalCode='76931234932b4666820c4be07a0
a7c2a',mdfSystemExternalCode='2eec85bedcb54f4bac432c743a61d394')/
mdfSystemStatusNav"
}
}
}
]
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTimeGroup('76931234932b4666820c4be07a0a7c2a')/mdfSystemStatusNav"
}
}
}
}

Related Information

SAP API Business Hub: Time Off

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

648 PUBLIC Time & Attendance Management
16.1.8 EmployeeTimeGroupItem

This entity is an item of an EmployeeTimeGroup. It stores a reference to an EmployeeTime.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Business Key Required Field Description

externalCode Yes Yes External Code

comment No Yes Optional comment

Navigation Properties

Navigation Propertz Related Entity Description

employeeTimeNav User Navigation to EmployeeTime

Code Examples

URI: http://<api-server>/odata/v2/EmployeeTimeGroup('76931234932b4666820c4be07a0a7c2a')?
$select=items&$expand=items,items/employeeTimeNav&$format=JSON

 Sample Code

{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/
EmployeeTimeGroup('76931234932b4666820c4be07a0a7c2a')",
"type": "SFOData.EmployeeTimeGroup"
},
"items": {
"results": [
{
"__metadata": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 649
 "uri": "https://<api-server>/odata/v2/
EmployeeTimeGroupItem(EmployeeTimeGroup_externalCode='76931234932b4666820c4be07a0
a7c2a',mdfSystemExternalCode='462e517c09dc49248f6d25b704ede3ac')",
"type": "SFOData.EmployeeTimeGroupItem"
},
"EmployeeTimeGroup_externalCode": "76931234932b4666820c4be07a0a7c2a",
"mdfSystemExternalCode": "462e517c09dc49248f6d25b704ede3ac",
"mdfSystemObjectType": "EmployeeTimeGroupItem",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"employeeTime": "ad2946e1c07d4f97a61535c0b7f796aa",
"lastModifiedDateTime": "/Date(1461325378000+0000)/",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "AD58F8FFFCD741F7974C3ADDF0C96DE6",
"createdBy": "admin",
"mdfSystemEntityId": "197DDFB6AF8E4D61AFBE5FF516C0F8DD",
"createdDateTime": "/Date(1461325378000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"lastModifiedDate": "/Date(1461332578000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDateWithTZ": "/Date(1461325378000+0000)/",
"comment": null,
"createdDate": "/Date(1461332578000)/",
"mdfSystemRecordStatus": "N",
"employeeTimeNav": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/
EmployeeTime('ad2946e1c07d4f97a61535c0b7f796aa')",
"type": "SFOData.EmployeeTime"
},
"externalCode": "ad2946e1c07d4f97a61535c0b7f796aa",
"quantityInDays": "1",
"mdfSystemObjectType": "EmployeeTime",
"cancellationWorkflowRequestId": null,
"endDate": "/Date(1461024000000)/",
"lastModifiedDateTime": "/Date(1461325378000+0000)/",
"endTime": null,
"timeType": "SICK_LEAVE_ESP",
"startTime": null,
"mdfSystemRecordId": "B286283D196A41E682D1496F25092A11",
"mdfSystemEntityId": "2EFE4056015046FCBB092E541FEE3E64",
"userId": "vdelbosque",
"fractionQuantity": "1",
"approvalStatus": "APPROVED",
"mdfSystemStatus": "A",
"createdDate": "/Date(1461330833000)/",
"mdfSystemRecordStatus": "N",
"undeterminedEndDate": false,
"editable": true,
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1461323633000+0000)/",
"loaExpectedReturnDate": null,
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"comment": null,
"loaStartJobInfoId": null,
"startDate": "/Date(1461024000000)/",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"recurrenceGroup": null,
"mdfSystemTransactionSequence": "1",
"timeRecordOrigin": null,
"workflowRequestId": null,
"loaActualReturnDate": null,
"lastModifiedDateWithTZ": "/Date(1461325378000+0000)/",
"quantityInHours": "8",
"flexibleRequesting": false,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

650 PUBLIC Time & Attendance Management
 "deductionQuantity": "1",
"loaEndJobInfoId": null,
"originalQuantityInDays": "1",
"lastModifiedDate": "/Date(1461332578000)/",
"recurrenceGroupNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTime('ad2946e1c07d4f97a61535c0b7f796aa')/recurrenceGroupNav"
}
},
"timeCalendar": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTime('ad2946e1c07d4f97a61535c0b7f796aa')/timeCalendar"
}
},
"countryExtensionESP": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTime('ad2946e1c07d4f97a61535c0b7f796aa')/countryExtensionESP"
}
},
"timeTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTime('ad2946e1c07d4f97a61535c0b7f796aa')/timeTypeNav"
}
},
"approvalStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTime('ad2946e1c07d4f97a61535c0b7f796aa')/approvalStatusNav"
}
},
"countryExtensionDEU": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTime('ad2946e1c07d4f97a61535c0b7f796aa')/countryExtensionDEU"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTime('ad2946e1c07d4f97a61535c0b7f796aa')/mdfSystemStatusNav"
}
},
"timeRecordOriginNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTime('ad2946e1c07d4f97a61535c0b7f796aa')/timeRecordOriginNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTime('ad2946e1c07d4f97a61535c0b7f796aa')/mdfSystemRecordStatusNav"
}
},
"userIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTime('ad2946e1c07d4f97a61535c0b7f796aa')/userIdNav"
}
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 651
 "uri": "https://<api-server>/odata/v2/
EmployeeTimeGroupItem(EmployeeTimeGroup_externalCode='76931234932b4666820c4be07a0
a7c2a',mdfSystemExternalCode='462e517c09dc49248f6d25b704ede3ac')/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTimeGroupItem(EmployeeTimeGroup_externalCode='76931234932b4666820c4be07a0
a7c2a',mdfSystemExternalCode='462e517c09dc49248f6d25b704ede3ac')/
mdfSystemStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
EmployeeTimeGroupItem(EmployeeTimeGroup_externalCode='76931234932b4666820c4be07a0
a7c2a',mdfSystemExternalCode='2eec85bedcb54f4bac432c743a61d394')",
"type": "SFOData.EmployeeTimeGroupItem"
},
"EmployeeTimeGroup_externalCode": "76931234932b4666820c4be07a0a7c2a",
"mdfSystemExternalCode": "2eec85bedcb54f4bac432c743a61d394",
"mdfSystemObjectType": "EmployeeTimeGroupItem",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"employeeTime": "2bbf683e5d504e7e8ec955c2698ddc56",
"lastModifiedDateTime": "/Date(1461325378000+0000)/",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "B410E96B4B87460586A89D7C93BFDCE1",
"createdBy": "admin",
"mdfSystemEntityId": "7C2A5E6D782645F4A99553BD6CBA9A06",
"createdDateTime": "/Date(1461325378000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"lastModifiedDate": "/Date(1461332578000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDateWithTZ": "/Date(1461325378000+0000)/",
"comment": null,
"createdDate": "/Date(1461332578000)/",
"mdfSystemRecordStatus": "N",
"employeeTimeNav": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/
EmployeeTime('2bbf683e5d504e7e8ec955c2698ddc56')",
"type": "SFOData.EmployeeTime"
},
"externalCode": "2bbf683e5d504e7e8ec955c2698ddc56",
"quantityInDays": "1",
"mdfSystemObjectType": "EmployeeTime",
"cancellationWorkflowRequestId": null,
"endDate": "/Date(1460937600000)/",
"lastModifiedDateTime": "/Date(1461325378000+0000)/",
"endTime": null,
"timeType": "SICK_LEAVE_ESP",
"startTime": null,
"mdfSystemRecordId": "871E929757174F8E97DB9DD788AD1CEC",
"mdfSystemEntityId": "A31ADC02E0964AD4BC80FE8E1EC2695C",
"userId": "vdelbosque",
"fractionQuantity": "1",
"approvalStatus": "APPROVED",
"mdfSystemStatus": "A",
"createdDate": "/Date(1461330424000)/",
"mdfSystemRecordStatus": "N",
"undeterminedEndDate": false,
"editable": true,
"createdBy": "admin",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

652 PUBLIC Time & Attendance Management
 "lastModifiedBy": "admin",
"createdDateTime": "/Date(1461323224000+0000)/",
"loaExpectedReturnDate": null,
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"comment": null,
"loaStartJobInfoId": null,
"startDate": "/Date(1460937600000)/",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"recurrenceGroup": null,
"mdfSystemTransactionSequence": "1",
"timeRecordOrigin": null,
"workflowRequestId": null,
"loaActualReturnDate": null,
"lastModifiedDateWithTZ": "/Date(1461325378000+0000)/",
"quantityInHours": "8",
"flexibleRequesting": false,
"deductionQuantity": "1",
"loaEndJobInfoId": null,
"originalQuantityInDays": "1",
"lastModifiedDate": "/Date(1461332578000)/",
"recurrenceGroupNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTime('2bbf683e5d504e7e8ec955c2698ddc56')/recurrenceGroupNav"
}
},
"timeCalendar": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTime('2bbf683e5d504e7e8ec955c2698ddc56')/timeCalendar"
}
},
"countryExtensionESP": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTime('2bbf683e5d504e7e8ec955c2698ddc56')/countryExtensionESP"
}
},
"timeTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTime('2bbf683e5d504e7e8ec955c2698ddc56')/timeTypeNav"
}
},
"approvalStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTime('2bbf683e5d504e7e8ec955c2698ddc56')/approvalStatusNav"
}
},
"countryExtensionDEU": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTime('2bbf683e5d504e7e8ec955c2698ddc56')/countryExtensionDEU"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTime('2bbf683e5d504e7e8ec955c2698ddc56')/mdfSystemStatusNav"
}
},
"timeRecordOriginNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTime('2bbf683e5d504e7e8ec955c2698ddc56')/timeRecordOriginNav"
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 653
 },
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTime('2bbf683e5d504e7e8ec955c2698ddc56')/mdfSystemRecordStatusNav"
}
},
"userIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTime('2bbf683e5d504e7e8ec955c2698ddc56')/userIdNav"
}
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTimeGroupItem(EmployeeTimeGroup_externalCode='76931234932b4666820c4be07a0
a7c2a',mdfSystemExternalCode='2eec85bedcb54f4bac432c743a61d394')/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
EmployeeTimeGroupItem(EmployeeTimeGroup_externalCode='76931234932b4666820c4be07a0
a7c2a',mdfSystemExternalCode='2eec85bedcb54f4bac432c743a61d394')/
mdfSystemStatusNav"
}
}
}
]
}
}
}

Related Information

SAP API Business Hub: Time Off

16.1.9 Holiday

You use the Holiday object to create holidays for inclusion in a holiday calendar.

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

654 PUBLIC Time & Attendance Management
Use Case: Get Specified Holiday

Request Information

URI http://<api-server>/odata/v2/Holiday?
$format=json&$filter=holidayCode%20eq
%20'FR-Victory Day

Headers Authorization: Basic <Base 64 encoded (“user@com­

pany:password”)>

Response

 Sample Code

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/Holiday('FR-Victory
Day')",
"type": "SFOData.Holiday"
},
"holidayCode": "FR-Victory Day",
"name_ko_KR": "유럽 전승 기념일",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "Holiday",
"mdfSystemVersionId": null,
"name_ru_RU": "День Победы в Европе (Франция)",
"lastModifiedDateTime": "/Date(1461163954000+0000)/",
"name_ja_JP": "ヨーロッパ戦勝記念日",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "E49E3AB6C7D14896A6C1FFD4E839A315",
"mdfSystemEntityId": "139D108B9314467783E6AB93FE05FC98",
"name_localized": "Victory in Europe Day",
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/Date(1461163954000+0000)/",
"name_es_ES": "Día de la Victoria en Europa",
"createdDate": "/Date(1443711833000)/",
"name_defaultValue": "Victory in Europe Day",
"name_fr_FR": "Jour de la Victoire en Europe",
"mdfSystemRecordStatus": "N",
"name_en_US": "Victory in Europe Day",
"name_pt_BR": "Dia da Vitória da Forças Aliadas na Europa",
"oldName": null,
"name_zh_CN": "欧洲胜利日（法国）",
"country": "FRA",
"createdBy": "sfadmin",
"name_de_DE": "Tag des Sieges",
"lastModifiedBy": "sfadmin",
"createdDateTime": "/Date(1443726233000+0000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDate": "/Date(1461149554000)/",
"name_en_GB": "Victory in Europe Day",
"countryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/Holiday('FR-
Victory Day')/countryNav"
}
},
"nameTranslationTextNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/Holiday('FR-
Victory Day')/nameTranslationTextNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 655
 }
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/Holiday('FR-
Victory Day')/wfRequestNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/Holiday('FR-
Victory Day')/mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/Holiday('FR-
Victory Day')/mdfSystemStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Time Off

16.1.10 HolidayAssignment

The entity contains more information about a holiday. Information such as the date of the holiday, it's class (full day
or half day) is stored in this entity.

Operations Allowed

Operation Description

GET Query a record

Properties

This table shows the required fields and business keys for this entity. Check the OData API dictionary in your
instance to see the complete list of properties, and check your metadata for navigations and associations.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

656 PUBLIC Time & Attendance Management
 Property Business Key Required Field Description

externalCode Yes Yes External Code

data Yes Yes Date of the holiday

holidayClass No No Defines whether the holiday is

a non-working day, half work­
ing day or a normal workday.
Can be either FULL, HALF, or
NONE

holiday No No Reference to a holiday object

Navigation Properties

Navigation Propertz Related Entity Description

holidayNav Holiday Navigation to the holiday

holidayClassNav HolidayClass Navigation to the holiday class

Code Examples

Request for getting all holidays which are assigned for calendar 'HolidayCalendar_odata':

Query:

https://<hostname>/odata/v2/HolidayAssignment?$filter=HolidayCalendar_externalCode eq 'HOLIDAY_US'&
$format=json
Response

 Sample Code

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<hostname>/odata/v2/
HolidayAssignment(HolidayCalendar_externalCode='HolidayCalendar_odata',date=datet
ime'2020-01-01T00:00:00')",
"type": "SFOData.HolidayAssignment"
},
"date": "/Date(1325376000000)/",
"HolidayCalendar_externalCode": "HolidayCalendar_odata",
"lastModifiedDateTime": "/Date(1581583334000+0000)/",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"createdDateTime": "/Date(1351136090000+0000)/",
"mdfSystemVersionId": null,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 657
 "holiday": "NEW_YEAR",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"mdfSystemStatus": "A",
"mdfSystemEntityId": "0D15EB00F59D6032E0537A54740A259C",
"mdfSystemObjectType": "HolidayAssignment",
"lastModifiedDate": "/Date(1581583334000)/",
"lastModifiedBy": "admin",
"lastModifiedDateWithTZ": "/Date(1581583334000+0000)/",
"mdfSystemRecordStatus": "N",
"mdfSystemTransactionSequence": "1",
"holidayClass": "FULL",
"createdDate": "/Date(1351136090000)/",
"createdBy": "admin",
"mdfSystemRecordId": "0D15EB0091236032E0537A54740A259C",
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
HolidayAssignment(HolidayCalendar_externalCode='HolidayCalendar_odata',date=datet
ime'2020-01-01T00:00:00')/mdfSystemStatusNav"
}
},
"holidayNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
HolidayAssignment(HolidayCalendar_externalCode='HolidayCalendar_odata',date=datet
ime'2020-01-01T00:00:00')/holidayNav"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
HolidayAssignment(HolidayCalendar_externalCode='HolidayCalendar_odata',date=datet
ime'2020-01-01T00:00:00')/createdByNav"
}
},
"holidayClassNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
HolidayAssignment(HolidayCalendar_externalCode='HolidayCalendar_odata',date=datet
ime'2020-01-01T00:00:00')/holidayClassNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
HolidayAssignment(HolidayCalendar_externalCode='HolidayCalendar_odata',date=datet
ime'2020-01-01T00:00:00')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
HolidayAssignment(HolidayCalendar_externalCode='HolidayCalendar_odata',date=datet
ime'2020-01-01T00:00:00')/mdfSystemRecordStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<hostname>/odata/v2/
HolidayAssignment(HolidayCalendar_externalCode='HolidayCalendar_odata',date=datet
ime'2020-12-31T00:00:00')",
"type": "SFOData.HolidayAssignment"
},
"date": "/Date(1419984000000)/",
"HolidayCalendar_externalCode": "HolidayCalendar_odata",
"lastModifiedDateTime": "/Date(1581583334000+0000)/",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

658 PUBLIC Time & Attendance Management
 "createdDateTime": "/Date(1418740450000+0000)/",
"mdfSystemVersionId": null,
"holiday": "New_Year_Eve",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"mdfSystemStatus": "A",
"mdfSystemEntityId": "0D15EB016F3A6032E0537A54740A259C",
"mdfSystemObjectType": "HolidayAssignment",
"lastModifiedDate": "/Date(1581583334000)/",
"lastModifiedBy": "admin",
"lastModifiedDateWithTZ": "/Date(1581583334000+0000)/",
"mdfSystemRecordStatus": "N",
"mdfSystemTransactionSequence": "1",
"holidayClass": "HALF",
"createdDate": "/Date(1418740450000)/",
"createdBy": "admin",
"mdfSystemRecordId": "0D15EB0091516032E0537A54740A259C",
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
HolidayAssignment(HolidayCalendar_externalCode='HolidayCalendar_odata',date=datet
ime'2020-12-31T00:00:00')/mdfSystemStatusNav"
}
},
"holidayNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
HolidayAssignment(HolidayCalendar_externalCode='HolidayCalendar_odata',date=datet
ime'2020-12-31T00:00:00')/holidayNav"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
HolidayAssignment(HolidayCalendar_externalCode='HolidayCalendar_odata',date=datet
ime'2020-12-31T00:00:00')/createdByNav"
}
},
"holidayClassNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
HolidayAssignment(HolidayCalendar_externalCode='HolidayCalendar_odata',date=datet
ime'2020-12-31T00:00:00')/holidayClassNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
HolidayAssignment(HolidayCalendar_externalCode='HolidayCalendar_odata',date=datet
ime'2020-12-31T00:00:00')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
HolidayAssignment(HolidayCalendar_externalCode='HolidayCalendar_odata',date=datet
ime'2020-12-31T00:00:00')/mdfSystemRecordStatusNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 659
16.1.11 HolidayCalendar

A holiday calendar defines all relevant public holidays for an employee.

Use Case: Filter holiday calendar by country/region

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
HolidayCalendar?$format=json&
$filter=country%20eq%20'USA'

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/HolidayCalendar('USA')",
"type": "SFOData.HolidayCalendar"
},
"externalCode": "USA",
"name_ko_KR": null,
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "HolidayCalendar",
"mdfSystemVersionId": null,
"name_ru_RU": null,
"lastModifiedDateTime": "/Date(1461164062000+0000)/",
"name_ja_JP": null,
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "935BC7ACBB31419D95265B6AC2699860",
"mdfSystemEntityId": "10AE9CC099AB718BE0530B28080AD5E1",
"name_localized": "USA",
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/Date(1461164062000+0000)/",
"name_es_ES": null,
"createdDate": "/Date(1443711857000)/",
"name_defaultValue": "USA",
"name_fr_FR": null,
"mdfSystemRecordStatus": "N",
"name_en_US": "USA",
"name_pt_BR": null,
"oldName": null,
"name_zh_CN": null,
"country": "USA",
"createdBy": "sfadmin",
"name_de_DE": null,
"lastModifiedBy": "sfadmin",
"createdDateTime": "/Date(1443726257000+0000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDate": "/Date(1461149662000)/",
"name_en_GB": null,
"holidayAssignments": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

660 PUBLIC Time & Attendance Management
 "uri": "https://<api-server>/odata/v2/
HolidayCalendar('USA')/holidayAssignments"
}
},
"countryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
HolidayCalendar('USA')/countryNav"
}
},
"nameTranslationTextNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
HolidayCalendar('USA')/nameTranslationTextNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
HolidayCalendar('USA')/wfRequestNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
HolidayCalendar('USA')/mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
HolidayCalendar('USA')/mdfSystemStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Time Off

16.1.12 ShiftClassification

This object defines the shift classification for either a whole work schedule or a day model. It only holds
information.

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 661
Properties

This table shows the required fields and business keys for this entity. Check the OData API dictionary in your
instance to see the complete list of properties, and check your metadata for navigations and associations.

Property Business Key Required Field Description

externalCode Yes Yes External Code

externalName No Yes External Name for all relevant

languages

country No No Absence counting methods

can be country-specific. If this
one is, the relevant country
appears here.

Code Examples

URI: http://<api-server>/odata/v2/restricted/ShiftClassification('LATE_SHIFT')?$format=JSON

 Sample Code

{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/restricted/
ShiftClassification('LATE_SHIFT')",
"type": "SFOData.ShiftClassification"
},
"externalCode": "LATE_SHIFT",
"externalName_ko_KR": null,
"mdfSystemObjectType": "ShiftClassification",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"externalName_de_DE": "Spätschicht",
"externalName_localized": "Late Shift",
"externalName_defaultValue": "Late Shift",
"externalName_es_MX": null,
"lastModifiedDateTime": "/Date(1464014355000+0000)/",
"externalName_da_DK": null,
"mdfSystemTransactionSequence": "1",
"externalName_fi_FI": null,
"mdfSystemRecordId": "660CD9D767214291B4EF30BF7AC20174",
"mdfSystemEntityId": "35E1CD6E033C4A588BE8AAD064F8F4AE",
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/Date(1464014355000+0000)/",
"externalName_zh_TW": null,
"externalName_en_US": "Late Shift",
"externalName_en_SAP_SLS": null,
"createdDate": "/Date(1464021555000)/",
"externalName_ja_JP": null,
"mdfSystemRecordStatus": "N",
"externalName_pl_PL": null,
"country": "DEU",
"createdBy": "admin",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

662 PUBLIC Time & Attendance Management
 "externalName_it_IT": null,
"externalName_en_RTL": null,
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1464014355000+0000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDate": "/Date(1464021555000)/",
"externalName_en_GB": null,
"externalName_es_ES": null,
"externalName_nl_NL": null,
"externalName_zh_CN": null,
"externalName_en_DEBUG": null,
"externalName_fr_FR": null,
"externalNameTranslationTextNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/restricted/
ShiftClassification('LATE_SHIFT')/externalNameTranslationTextNav"
}
}
}
}

Related Information

SAP API Business Hub: Time Off

16.1.13 TemporaryTimeInformation

This object defines deviating time information for period for a user. It is used, for example, if an employee is on
vacation and someone else needs to take over their work schedule for the vacation period.

Operations Allowed

Operation Query

Get Query a record

Create Create a record

Update Update a record

Upsert Update an existing record or create a new one

Delete Delete a record

Properties

Here you can see the required fields and business keys for this entity. Check the OData API dictionary in your
instance to see the complete list of properties, and check your metadata for navigations, and associations.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 663
Property Business Key Required Field Description

externalCode Yes Yes External Code

startDate No Yes This is the date from which the

Temporary Time Information
applies

endDate No Yes This is the date from which the

Temporary Time Information
applies

comment No No Optional comment field

Navigation Properties

Navigation Property Related Entity Description

workScheduleNav WorkSchedule Navigation to WorkSchedule

userIdNav User Navigation to User

Code Examples

URI: http://<hostname>/odata/v2/restricted/
TemporaryTimeInformation('d9ad6aea798143d599c63e9f4f251048')?$format=JSON{

 Sample Code

{
"d": {
"__metadata":
{ "uri": "https://<hostname>/odata/v2/restricted/
TemporaryTimeInformation('d9ad6aea798143d599c63e9f4f251048')", "type":
"SFOData.TemporaryTimeInformation" }
,
"externalCode": "d9ad6aea798143d599c63e9f4f251048",
"startDate": "/Date(1450569600000)/",
"mdfSystemObjectType": "TemporaryTimeInformation",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"workSchedule": "i90306d711",
"endDate": "/Date(1451088000000)/",
"effectiveStatus": "A",
"lastModifiedDateTime": "/Date(1450424588000+0000)/",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "7E23FCD86F7B49568C902989041B1C94",
"createdBy": "admin",
"mdfSystemEntityId": "552984EB4B424F7481EA66DF3F9C2A7A",
"userId": "mhoff",
"createdDateTime": "/Date(1450424588000+0000)/",
"lastModifiedBy": "admin",
"lastModifiedDate": "/Date(1450428188000)/",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

664 PUBLIC Time & Attendance Management
 "mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDateWithTZ": "/Date(1450424588000+0000)/",
"comment": null,
"createdDate": "/Date(1450428188000)/",
"mdfSystemRecordStatus": "N",
"userIdNav": {
"__deferred":
{ "uri": "https://<hostname>/odata/v2/restricted/
TemporaryTimeInformation('d9ad6aea798143d599c63e9f4f251048')/userIdNav" }
},
"workScheduleNav": {
"__deferred":
{ "uri": "https://<hostname>/odata/v2/restricted/
TemporaryTimeInformation('d9ad6aea798143d599c63e9f4f251048')/workScheduleNav" }
},
"dayModelNav": {
"__deferred":
{ "uri": "https://<hostname>/odata/v2/restricted/
TemporaryTimeInformation('d9ad6aea798143d599c63e9f4f251048')/dayModelNav" }
},
},
"createdByNav": {
"__deferred":
{ "uri": "https://<hostname>/odata/v2/restricted/
TemporaryTimeInformation('d9ad6aea798143d599c63e9f4f251048')/createdByNav" }
},
"wfRequestNav": {
"__deferred":
{ "uri": "https://<hostname>/odata/v2/restricted/
TemporaryTimeInformation('d9ad6aea798143d599c63e9f4f251048')/wfRequestNav" }
},
"lastModifiedByNav": {
"__deferred":
{ "uri": "https://<hostname>/odata/v2/restricted/
TemporaryTimeInformation('d9ad6aea798143d599c63e9f4f251048')/lastModifiedByNav" }
},
"mdfSystemRecordStatusNav": {
"__deferred":
{ "uri": "https://<hostname>/odata/v2/restricted/
TemporaryTimeInformation('d9ad6aea798143d599c63e9f4f251048')/
mdfSystemRecordStatusNav" }
}
}
}

Related Information

SAP API Business Hub: Time Off

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 665
16.1.14 TimeAccount

When an employee has a time profile assigned with time types that refer to time account types, time accounts need
to be created. This is done automatically when you assign a time profile to an employee’s job information and also
during the account creation calendar run.

Operation Allowed Description

GET Query a record

POST Create a new record

PUT Update an existing record

UPSERT/POST Update an existing record or create a new one

DELETE Delete a record

Properties

Here you can see the required fields and business keys for this entity. Check the OData API dictionary in your
instance to see the complete list of properties, and check your metadata for navigations, and associations.

Property Business Key Required Field Description

externalCode Yes Yes External Code

userId No No If userId is entered the work

schedule only applies to one
particular employee

accountType No Yes The time account type to

which it belongs

startDate No Yes Start date of the account

endDate No Yes End date of the account

bookingStartDate No Yes Start date for bookings for the

account

bookingEndDate No Yes End date for bookings for the

account

acountClosed No No Is the account closed?

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

666 PUBLIC Time & Attendance Management
Navigation Properties

Navigation Propertz Related Entity Description

timeAccountDetails TimeAccountDetail Bookings on the account

Code Examples

Example 1
Retrieve data of the time accounts for user Carla Grant of time account type sickness with all included bookings in
JSON.

URI: https://<hostname>/odata/v2/TimeManagementAlertMessage?
TimeManagementAlert_externalCode='d1e3b9e5efa74860807b48af8462018d'&$format=json

Method: GET

Response:

 Sample Code

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<hostname>/odata/v2/
TimeAccount('cgrant_sick_current')",
"type": "SFOData.TimeAccount"
},
"externalCode": "cgrant_sick_current",
"startDate": "/Date(978307200000)/",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "TimeAccount",
"mdfSystemVersionId": null,
"accountClosed": false,
"endDate": "/Date(253402214400000)/",
"lastModifiedDateTime": "/Date(1493903577000+0000)/",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "0D15EB00E6DF6032E0537A54740A259C",
"mdfSystemEntityId": "0D15EB00F5BA6032E0537A54740A259C",
"userId": "cgrant1",
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/Date(1493903577000+0000)/",
"createdDate": "/Date(1351138546000)/",
"mdfSystemRecordStatus": "N",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1351138546000+0000)/",
"bookingEndDate": "/Date(253402214400000)/",
"accountType": "SICKNESS_CURRENT",
"lastModifiedDate": "/Date(1493903577000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"bookingStartDate": "/Date(978307200000)/",
"timeAccountDetails": {
"results": [
{
"__metadata": {
"uri": "https://<hostname>/odata/v2/
TimeAccountDetail(TimeAccount_externalCode='cgrant_sick_current',externalCode='1'
)",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 667
 "type": "SFOData.TimeAccountDetail"
},
"TimeAccount_externalCode": "cgrant_sick_current",
"externalCode": "1",
"mdfSystemObjectType": "TimeAccountDetail",
"mdfSystemEffectiveEndDate": "/
Date(253402214400000)/",
"mdfSystemVersionId": null,
"bookingUnit": "DAYS",
"referenceObject": null,
"bookingType": "ENTITLEMENT",
"changeCalendar": null,
"lastModifiedDateTime": "/Date(1378204814000+0000)/",
"calendarEntry": null,
"payoutAccrualSeparated": null,
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId":
"0D15EB0096146032E0537A54740A259C",
"mdfSystemEntityId":
"0D15EB00F5BB6032E0537A54740A259C",
"advanced": null,
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/
Date(1378204814000+0000)/",
"createdDate": "/Date(1351138546000)/",
"mdfSystemRecordStatus": "N",
"bookingDate": "/Date(1325376000000)/",
"employeeTime": null,
"accrualPeriodId": null,
"bookingAmount": "10",
"createdBy": "admin",
"createdDateTime": "/Date(1351138546000+0000)/",
"lastModifiedBy": "v4admin",
"lastModifiedDate": "/Date(1378204814000)/",
"mdfSystemEffectiveStartDate": "/
Date(-2208988800000)/",
"comment": null,
"employeeTimeNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccountDetail(TimeAccount_externalCode='cgrant_sick_current',externalCode='1'
)/employeeTimeNav"
}
},
"calendarEntryNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccountDetail(TimeAccount_externalCode='cgrant_sick_current',externalCode='1'
)/calendarEntryNav"
}
},
"bookingTypeNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccountDetail(TimeAccount_externalCode='cgrant_sick_current',externalCode='1'
)/bookingTypeNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccountDetail(TimeAccount_externalCode='cgrant_sick_current',externalCode='1'
)/mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

668 PUBLIC Time & Attendance Management
 "uri": "https://<hostname>/odata/v2/
TimeAccountDetail(TimeAccount_externalCode='cgrant_sick_current',externalCode='1'
)/mdfSystemStatusNav"
}
},
"bookingUnitNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccountDetail(TimeAccount_externalCode='cgrant_sick_current',externalCode='1'
)/bookingUnitNav"
}
}
},
{
"__metadata": {
"uri": "https://<hostname>/odata/v2/
TimeAccountDetail(TimeAccount_externalCode='cgrant_sick_current',externalCode='ae
be6e70d4a94c49b1db3bf5e64bff7d')",
"type": "SFOData.TimeAccountDetail"
},
"TimeAccount_externalCode": "cgrant_sick_current",
"externalCode": "aebe6e70d4a94c49b1db3bf5e64bff7d",
"mdfSystemObjectType": "TimeAccountDetail",
"mdfSystemEffectiveEndDate": "/
Date(253402214400000)/",
"mdfSystemVersionId": null,
"bookingUnit": "DAYS",
"referenceObject": null,
"bookingType": "EMPLOYEE_TIME",
"changeCalendar": null,
"lastModifiedDateTime": "/Date(1493903577000+0000)/",
"calendarEntry": "5350e115071f4c5db3c62bfd0c194581",
"payoutAccrualSeparated": null,
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId":
"AC26CE6E8DE241B88344516DA0993525",
"mdfSystemEntityId":
"58183CE6A64D427D8E9061D861779454",
"advanced": false,
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/
Date(1493903577000+0000)/",
"createdDate": "/Date(1493903577000)/",
"mdfSystemRecordStatus": "N",
"bookingDate": "/Date(1493856000000)/",
"employeeTime": "29b4d38647c5493da65722bf3aee8756",
"accrualPeriodId": null,
"bookingAmount": "-1",
"createdBy": "admin",
"createdDateTime": "/Date(1493903577000+0000)/",
"lastModifiedBy": "admin",
"lastModifiedDate": "/Date(1493903577000)/",
"mdfSystemEffectiveStartDate": "/
Date(-2208988800000)/",
"comment": null,
"employeeTimeNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccountDetail(TimeAccount_externalCode='cgrant_sick_current',externalCode='ae
be6e70d4a94c49b1db3bf5e64bff7d')/employeeTimeNav"
}
},
"calendarEntryNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccountDetail(TimeAccount_externalCode='cgrant_sick_current',externalCode='ae
be6e70d4a94c49b1db3bf5e64bff7d')/calendarEntryNav"
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 669
 },
"bookingTypeNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccountDetail(TimeAccount_externalCode='cgrant_sick_current',externalCode='ae
be6e70d4a94c49b1db3bf5e64bff7d')/bookingTypeNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccountDetail(TimeAccount_externalCode='cgrant_sick_current',externalCode='ae
be6e70d4a94c49b1db3bf5e64bff7d')/mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccountDetail(TimeAccount_externalCode='cgrant_sick_current',externalCode='ae
be6e70d4a94c49b1db3bf5e64bff7d')/mdfSystemStatusNav"
}
},
"bookingUnitNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccountDetail(TimeAccount_externalCode='cgrant_sick_current',externalCode='ae
be6e70d4a94c49b1db3bf5e64bff7d')/bookingUnitNav"
}
}
}
]
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccount('cgrant_sick_current')/wfRequestNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccount('cgrant_sick_current')/mdfSystemRecordStatusNav"
}
},
"userIdNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccount('cgrant_sick_current')/userIdNav"
}
},
"accountTypeNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccount('cgrant_sick_current')/accountTypeNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccount('cgrant_sick_current')/mdfSystemStatusNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

670 PUBLIC Time & Attendance Management
Example 2
Create a new time account for user Carla Grant of time account type Standard_ACM for the year 2018

URI: http://<hostname>/odata/v2/TimeAccount?$format=json

Method: POST

Body:

 Sample Code

{
"externalCode": "TA_odata",
"startDate": "/Date(1514764800000)/",
"endDate": "/Date(1546214400000)/",
"userId": "cgrant1",
"bookingEndDate": "/Date(1546214400000)/",
"bookingStartDate": "/Date(1514764800000)/",
"accountTypeNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccountType('Standard_ACM')"
}
}
}

Response:

 Sample Code

{
"d": {
"__metadata": {
"uri": "https://<hostname>/odata/v2/TimeAccount('TA_odata')",
"type": "SFOData.TimeAccount"
},
"startDate": "/Date(1514764800000)/",
"endDate": "/Date(1546214400000)/",
"userId": "cgrant1",
"bookingEndDate": "/Date(1546214400000)/",
"bookingStartDate": "/Date(1514764800000)/",
"externalCode": "TA_odata",
"accountTypeNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/TimeAccount('TA_odata')/
accountTypeNav"
}
}
}
}

Example 3: Close the time account for user Carla Grant of time account type Standard_ACM for
the year 2018
URI: http://<hostname>/odata/v2/TimeAccount('TA_odata')?$format=json

Method: PUT

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 671
Body:

 Sample Code

{
"externalCode": "TA_odata",
"startDate": "/Date(1514764800000)/",
"endDate": "/Date(1546214400000)/",
"userId": "cgrant1",
"bookingEndDate": "/Date(1546214400000)/",
"bookingStartDate": "/Date(1514764800000)/",
"accountClosed": true,
"accountTypeNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccountType('Standard_ACM')"
}
}
}

Example 4: Update or insert a time account for user Carla Grant of time account type
Standard_ACM for the year 2018.
URI: http://<hostname>/odata/v2/upsert?$format=JSON

Method: POST

Body:

 Sample Code

{
"__metadata": {
"uri": "https://<hostname>/odata/v2/TimeAccount('TA_odata')",
"type": "SFOData.TimeAccount"
},
"externalCode": "TA_odata",
"startDate": "/Date(1514764800000)/",
"endDate": "/Date(1546214400000)/",
"userId": "cgrant1",
"bookingEndDate": "/Date(1546214400000)/",
"bookingStartDate": "/Date(1514764800000)/",
"accountTypeNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccountType('Standard_ACM')"
}
}
}

Response:

 Sample Code

{
"d": [
{
"key": null,
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

672 PUBLIC Time & Attendance Management
 "httpCode": 200,
"inlineResults": null
}
]
}

Example 5: Delete a time account

URI:

http://<hostname>/odata/v2/TimeAccount('TA_odata')?$format=JSON

Method: DELETE

Related Information

SAP API Business Hub: Time Off

16.1.15 TimeAccountDetail

The entity describes account bookings resulting from different scenarios such as leave request creation or manual
adjustments.

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

 Tip

We recommend that you only use the OData API to create Time Account Details that use the Manual
Adjustment booking type to adjust the time account accruals which have been calculated by Employee Central
Time Off. The OData API is not intended to create Time Account Details with the Accrual or Entitlement posting
types. These are calculated outside of the system, and Employee Central Time Off is not designed to support
this use case.

 Remember

To query TimeAccountDetails and use filtering you need to query the TimeAccountDetail, not the TimeAccount
object with expand to timeAccountDetails.

Code Examples

Example 1: create a time account detail of “MANUAL_ADJUSTMENT” posting type

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 673
URI: http://<api-server>/odata/v2/upsert

Operation: POST

Headers: Authorization: Basic <Base 64 encoded (“user@company:password”)> Accept: application/json

Content-Type: application/json;charset=utf-8

Payload:

{
"__metadata" : {
"uri" : "http://api-server/odata/v2/
TimeAccountDetail(TimeAccount_externalCode='1dfca28bf0c84c8b846719feffba225d',
externalCode='MyTimeAccountDetail')",
"type" : "SFOData.TimeAccountDetail"
}, "TimeAccount_externalCode" : "1dfca28bf0c84c8b846719feffba225d",
"externalCode" : "MyTimeAccountDetail",
"bookingUnit" : "DAYS",
"referenceObject" : null,
"bookingType" : "MANUAL_ADJUSTMENT",
"bookingDate" : "\/Date(1420070400000)\/",
"employeeTime" : null,
"bookingAmount" : "2.0",
"comment" : null
}
Response:
{
"d" : [
{
"key" : null,
"status" : "OK",
"editStatus" : "UPSERTED",
"message" : null,
"index" : 0,
"httpCode" : 200,
"inlineResults" : null
}
]
}

Example 2: Retrieve data about the specific time account detail

URI: http://api-server/odata/v2/
TimeAccountDetail(TimeAccount_externalCode='1dfca28bf0c84c8b846719feffba225d',externalCode='62d7d936
18244c28922fdc4b94001e53')?$format=json

Operation: GET

Headers: Authorization: Basic <Base 64 encoded (“user@company:password”)>

Response:
{
"d" : {
"__metadata" : {
"uri" : "https://api-server/odata/v2/
TimeAccountDetail(TimeAccount_externalCode='1dfca28bf0c84c8b846719feffba225d',extern
alCode='62d7d93618244c28922fdc4b94001e53')", "type" : "SFOData.TimeAccountDetail"
},
"TimeAccount_externalCode" : "1dfca28bf0c84c8b846719feffba225d",
"externalCode" : "62d7d93618244c28922fdc4b94001e53",
"mdfSystemEffectiveEndDate" : "\/Date(253402214400000)\/", "mdfSystemObjectType" :
"TimeAccountDetail",
"mdfSystemVersionId" : null,
"bookingUnit" : "DAYS",
"referenceObject" : null,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

674 PUBLIC Time & Attendance Management
 "bookingType" : "MANUAL_ADJUSTMENT",
"changeCalendar" : null,
"lastModifiedDateTime" : "\/Date(1440658227000+0000)\/",
"calendarEntry" : null,
"mdfSystemTransactionSequence" : "1",
"mdfSystemRecordId" : "5AF4FF7D85384DC1A5D86E4D3BB0931E",
"mdfSystemEntityId" : "F94ADC562C8E451DAD84E9DC24163256",
"mdfSystemStatus" : "A",
"lastModifiedDateWithTZ" : "\/Date(1440658227000+0000)\/",
"createdDate" : "\/Date(1440665427000)\/",
"mdfSystemRecordStatus" : "N",
"bookingDate" : "\/Date(1420070400000)\/",
"employeeTime" : null,
"accrualPeriodId" : null,
"createdBy" : "country",
"bookingAmount" : "2.0",
"createdDateTime" : "\/Date(1440658227000+0000)\/",
"lastModifiedBy" : "country",
"lastModifiedDate" : "\/Date(1440665427000)\/", "mdfSystemEffectiveStartDate" : "\/
Date(-2208988800000)\/",
"comment" : null, "employeeTimeNav" : {
"__deferred" : {
"uri" : "https://api-server/odata/v2/
TimeAccountDetail(TimeAccount_externalCode='1dfca28bf0c84c8b846719feffba225d',extern
alCode='62d7d93618244c28922fdc4b94001e53')/employeeTimeNav"
}
}, "calendarEntryNav" : {
"__deferred" : {
"uri" : "https://api-server/odata/v2/
TimeAccountDetail(TimeAccount_externalCode='1dfca28bf0c84c8b846719feffba225d',extern
alCode='62d7d93618244c28922fdc4b94001e53')/calendarEntryNav"
}
}, "bookingTypeNav" : {
"__deferred" : {
"uri" : "https://api-server/odata/v2/
TimeAccountDetail(TimeAccount_externalCode='1dfca28bf0c84c8b846719feffba225d',extern
alCode='62d7d93618244c28922fdc4b94001e53')/bookingTypeNav"
}
}, "mdfSystemRecordStatusNav" : {
"__deferred" : {
"uri" : "https://api-server/odata/v2/
TimeAccountDetail(TimeAccount_externalCode='1dfca28bf0c84c8b846719feffba225d',extern
alCode='62d7d93618244c28922fdc4b94001e53')/mdfSystemRecordStatusNav"
}
}, "mdfSystemStatusNav" : {
"__deferred" : {
"uri" : "https://api-server/odata/v2/
TimeAccountDetail(TimeAccount_externalCode='1dfca28bf0c84c8b846719feffba225d',extern
alCode='62d7d93618244c28922fdc4b94001e53')/mdfSystemStatusNav"
}
}, "bookingUnitNav" : {
"__deferred" : {
"uri" : "https://api-server/odata/v2/
TimeAccountDetail(TimeAccount_externalCode='1dfca28bf0c84c8b846719feffba225d',extern
alCode='62d7d93618244c28922fdc4b94001e53')/bookingUnitNav"
}
}
}
}

Related Information

SAP API Business Hub: Time Off

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 675
16.1.16 TimeAccountPayoutProfile

The entity contains payout related information including workflow configuration.

Operations Allowed

Operation Description

GET Query a record

Properties

Here you can see the required fields and business keys for this entity. Check the OData API dictionary in your
instance to see the complete list of properties, and check your metadata for navigations, and associations.

Property Business Key Required Field Description

externalCode Yes Yes External Code

externalName No No External name for the speci­

fied language

country No No TimeAccountPayoutProfiles
can be country specific. If this
one is, the relevant country
appears here.

payComponentGroup No No Contains an ID which referen­

ces a PayComponentGroup.
This field is required to calcu­
late the standard rate for pay­
out. When this field is main­
tained then the pay compo­
nent used for payout is of
amount type.

payComponent No No Contains an ID which referen­

ces a PayComponent. The pay
component can be either an
amount type or number type.
This component is used to
create a spot bonus when the
payout request is approved or
saved.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

676 PUBLIC Time & Attendance Management
 Property Business Key Required Field Description

payComponentTerminatio­ No No Contains an ID which referen­

nAccrualSeparated ces a PayComponent. When
this field is set it enables ac­
crual payout when terminat­
ing. The pay component is an
amount or number type. This
component is considered
when the payout is being
made from the termination
view in Time Off.

payComponentTermination No No Contains an ID which referen­

ces a PayComponent. When
this field is set it enables ter­
mination entitlement payouts.
The pay component is an
amount or number type. This
component is considered
when the payout is being
made from the termination
view in Time Off.

workflowConfiguration No No Contains an ID which referen­

ces a workflow configuration.

payoutMessageText No No This field is filled with instruc­

tional text and guidelines for
your employees that get dis­
played on the UI when re­
questing a self-service payout.

Navigation Properties

Navigation Propertz Related Entity Description

countryNav Country Navigation to a country

payComponentGroupNav PayComponentGroup Navigates to PayComponentGroup

payComponentNav PayComponent Navigates to the PayComponent which is

normally used for payout

payComponentTerminationAccrualSe­ PayComponent Navigates to the PayComponent which is

paratedNav used for accrual payout on termination

payComponentTerminationNav PayComponent Navigates to the PayComponent which is

used for termination entitlement payouts

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 677
Code Examples

Simple request to get the TimeAccountPayoutProfile for 'PayoutProfileAmountBased_odata':

Query:

https://<hostname>/odata/v2/
TimeAccountPayoutProfile('PayoutProfileAmountBased_odata')?$format=json

Response

 Sample Code

{
"d": {
"__metadata": {
"uri": "https://<hostname>/odata/v2/
TimeAccountPayoutProfile('PayoutProfileAmountBased_odata')",
"type": "SFOData.TimeAccountPayoutProfile"
},
"externalCode": "PayoutProfileAmountBased_odata",
"country": null,
"payComponentTerminationAccrualSeparated": null,
"payoutMessageText_de_DE": null,
"externalName_fr_CA": null,
"workflowConfiguration": "Payout_WF",
"payoutMessageText_en_US": "[b] Important:[/b] This is an instructional
text!",
"payoutMessageText_zh_CN": null,
"payoutMessageText_ru_RU": null,
"payoutMessageText_it_IT": null,
"payComponent": "PayComponentAmountBased",
"payComponentGroup": "PayGroupAmountBased",
"externalName_zh_CN": null,
"externalName_localized": "PayoutProfileAmountBased_odata",
"payoutMessageText_defaultValue": "[b] Important:[/b] This is an
instructional text!",
"payComponentTermination": "PayGroupAmountBased",
"payoutMessageText_localized": null,
"externalName_en_GB": null,
"externalName_nl_NL": null,
"payoutMessageText_en_SAP_SLS": null,
"payoutMessageText_th_TH": null,
"externalName_defaultValue": "Payout Profile for odata test",
"payoutMessageText_ar_SA": null,
"externalName_es_MX": null,
"externalName_ar_SA": null,
"externalName_es_ES": null,
"payoutMessageText_pt_BR": null,
"externalName_pt_BR": null,
"payoutMessageText_en_GB": null,
"payoutMessageText_ko_KR": null,
"payoutMessageText_en_DEBUG": null,
"externalName_en_SAP_SLS": null,
"externalName_ru_RU": null,
"externalName_it_IT": null,
"payoutMessageText_fr_CA": null,
"externalName_th_TH": null,
"payoutMessageText_es_MX": null,
"externalName_de_DE": null,
"externalName_ko_KR": null,
"payoutMessageText_es_ES": null,
"payoutMessageText_nl_NL": null,
"externalName_en_US": "Payout Profile for odata test",
"externalName_en_DEBUG": null,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

678 PUBLIC Time & Attendance Management
 "externalNameTranslationTextNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccountPayoutProfile('PayoutProfileAmountBased_odata')/
externalNameTranslationTextNav"
}
},
"payComponentGroupNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccountPayoutProfile('PayoutProfileAmountBased_odata')/payComponentGroupNav"
}
},
"workflowConfigurationNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccountPayoutProfile('PayoutProfileAmountBased_odata')/
workflowConfigurationNav"
}
},
"payComponentNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccountPayoutProfile('PayoutProfileAmountBased_odata')/payComponentNav"
}
},
"payComponentTerminationAccrualSeparatedNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccountPayoutProfile('PayoutProfileAmountBased_odata')/
payComponentTerminationAccrualSeparatedNav"
}
},
"payoutMessageTextTranslationTextNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccountPayoutProfile('PayoutProfileAmountBased_odata')/
payoutMessageTextTranslationTextNav"
}
},
"payComponentTerminationNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccountPayoutProfile('PayoutProfileAmountBased_odata')/
payComponentTerminationNav"
}
},
"countryNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccountPayoutProfile('PayoutProfileAmountBased_odata')/countryNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeAccountPayoutProfile('PayoutProfileAmountBased_odata')/wfRequestNav"
}
}
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 679
16.1.17 TimeAccountPostingRule
Time account posting rule associates a time type with a time account type to determine whether time accounts
should be managed for the time type. For example, you can use it to enable automatic checks against a balance
when time off is requested.

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Code Example

Example – Retrieve data of the time account posting rule which belongs to the time type ’Vacation’

URI: http://<api-server>/odata/v2/
TimeAccountPostingRule(TimeType_externalCode='Vacation',externalCode='Annually_VAC')?$format=json

Headers: Authorization: Basic <Base 64 encoded (“user@company:password”)>

Response:

{
"d" : {
"__metadata" : {
"uri" : "https://localhost:443/odata/v2/
TimeAccountPostingRule(TimeType_externalCode='Vacation',externalCode='Annually_VAC')
", "type" : "SFOData.TimeAccountPostingRule"
},
"TimeType_externalCode" : "Vacation",
"externalCode" : "Annually_VAC",
"mdfSystemEffectiveEndDate" : "\/Date(253402214400000)\/",
"mdfSystemObjectType" : "TimeAccountPostingRule",
"mdfSystemVersionId" : null,
"lastModifiedDateTime" : "\/Date(1422284110000+0000)\/",
"timeAccountType" : "ANNUALLY", "mdfSystemTransactionSequence" : "1", "createdBy" :
"loa",
"mdfSystemRecordId" : "877FE3EF357D4A4B825EF1C8EB0A675A",
"mdfSystemEntityId" : "3009BBBA98A14011A5DA5FC863C43B4F",
"createdDateTime" : "\/Date(1420710506000+0000)\/",
"lastModifiedBy" : "daily",
"mdfSystemStatus" : "A",
"lastModifiedDate" : "\/Date(1422287710000)\/", "mdfSystemEffectiveStartDate" : "\/
Date(-2208988800000)\/",
"lastModifiedDateWithTZ" : "\/Date(1422284110000+0000)\/",
"createdDate" : "\/Date(1420714106000)\/",
"mdfSystemRecordStatus" : "N",
"timeAccountTypeNav" : {
"__deferred" : {
"uri" : "https://localhost:443/odata/v2/
TimeAccountPostingRule(TimeType_externalCode='Vacation',externalCode='Annually_VAC')
/timeAccountTypeNav"
}
},
"mdfSystemRecordStatusNav" : {
"__deferred" : {
"uri" : "https://localhost:443/odata/v2/
TimeAccountPostingRule(TimeType_externalCode='Vacation',externalCode='Annually_VAC')
/mdfSystemRecordStatusNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

680 PUBLIC Time & Attendance Management
 }
},
"mdfSystemStatusNav" : {
"__deferred" : {
"uri" : "https://localhost:443/odata/v2/
TimeAccountPostingRule(TimeType_externalCode='Vacation',externalCode='Annually_VAC')
/mdfSystemStatusNav"
}
}
}
}

Related Information

SAP API Business Hub: Time Off

16.1.18 TimeAccountPurchaseProfile

This profile defines the configuration elements that determine how your leave purchase policy is implemented.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

externalCode External Code is a business key and is required.

country TimeAccountPurchaseProfile can be country specific. If this

one is, the relevant country appears here.

externalName External name for the specified language

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 681
Property Description

workflowConfiguration Contains an ID which references a workflow configuration.

allowDeductionStartDateSelection Boolean. If true it allows users to select a deduction start date

at the time of submitting the request.

If set to false the Deduction Start Date is equal to the Approval

Date.

equivalentUnits The time interval that applies to the profile. Can have the val­
ues:

● NONE
● WEEKS

deductionType Describes how the deductions are assessed for this profile.
Can have the values:

● ONE_TIME
● PRO_RATED

This field is required.

deductionSchedule Can have the values:

● PERIOD_IN_MONTH
● END_DATE

This field is required.

helpText Localized help text. Is shown on the self-service leave purchase

request.

deductionPayComponents Select deduction pay components previously created to assign

to this profile.

Use Case: Query the TimeAccountPurchaseProfile

'TimeAccountPurchaseProfile_odata':

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
TimeAccountPurchaseProfile('27TimeAccountP
urchaseProfile_odata')?$format=json

Response

{
"d": {
"__metadata": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

682 PUBLIC Time & Attendance Management
 "uri": "https://<api-server>/odata/v2/
TimeAccountPurchaseProfile('TimeAccountPurchaseProfile_odata')",
"type": "SFOData.TimeAccountPurchaseProfile"
},
"externalCode": "TimeAccountPurchaseProfile_odata",
"country": null,
"deductionType": "PRO_RATED",
"externalName_fr_CA": null,
"helpText_it_IT": null,
"workflowConfiguration": "Manager_WF",
"helpText_ru_RU": null,
"helpText_de_DE": "[url=https://sap.com]SAP-Homepage[/url]\nWF1 - Workflow
with one approver (Manager)\nEUW - Equivalent Unit: Weeks\nDTPM - Deduction
Prorated in Month\nDSY - Deduction Start Date: Yes\nP0 - Paycomponent: Default\nNA
- County independent",
"helpText_en_US": "[url=https://sap.com]SAP-Homepage[/url]\nWF1 - Workflow
with one approver (Manager)\nEUW - Equivalent Unit: Weeks\nDTPM - Deduction
Prorated in Month\nDSY - Deduction Start Date: Yes\nP0 - Paycomponent: Default\nNA
- County independent",
"externalName_zh_CN": null,
"helpText_localized": "[url=https://sap.com]SAP-Homepage[/url]\nWF1 -
Workflow with one approver (Manager)\nEUW - Equivalent Unit: Weeks\nDTPM -
Deduction Prorated in Month\nDSY - Deduction Start Date: Yes\nP0 - Paycomponent:
Default\nNA - County independent",
"externalName_localized": "Purchase Profile Variant 01 in weeks",
"helpText_pt_BR": null,
"externalName_en_GB": null,
"externalName_nl_NL": null,
"helpText_en_SAP_SLS": null,
"helpText_ar_SA": null,
"externalName_defaultValue": "Purchase profile for odata test",
"helpText_ko_KR": null,
"externalName_es_MX": null,
"helpText_es_ES": null,
"externalName_ar_SA": null,
"externalName_es_ES": null,
"helpText_es_MX": null,
"equivalentUnits": "WEEKS",
"helpText_nl_NL": null,
"externalName_pt_BR": null,
"helpText_th_TH": null,
"helpText_en_GB": null,
"helpText_zh_CN": null,
"externalName_en_SAP_SLS": null,
"externalName_ru_RU": null,
"externalName_it_IT": null,
"helpText_defaultValue": "[url=https://sap.com]SAP-Homepage[/url]\nWF1 -
Workflow with one approver (Manager)\nEUW - Equivalent Unit: Weeks\nDTPM -
Deduction Prorated in Month\nDSY - Deduction Start Date: Yes\nP0 - Paycomponent:
Default\nNA - County independent",
"deductionSchedule": "PERIOD_IN_MONTH",
"externalName_th_TH": null,
"externalName_de_DE": null,
"externalName_ko_KR": null,
"helpText_fr_CA": null,
"helpText_en_DEBUG": null,
"allowDeductionStartDateSelection": true,
"externalName_en_US": "Purchase profile for odata test",
"externalName_en_DEBUG": null,
"externalNameTranslationTextNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountPurchaseProfile('TimeAccountPurchaseProfile_odata')/
externalNameTranslationTextNav"
}
},
"workflowConfigurationNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 683
 "uri": "https://<api-server>/odata/v2/
TimeAccountPurchaseProfile('TimeAccountPurchaseProfile_odata')/
workflowConfigurationNav"
}
},
"deductionScheduleNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountPurchaseProfile('TimeAccountPurchaseProfile_odata')/deductionScheduleNav"
}
},
"deductionPayComponents": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountPurchaseProfile('TimeAccountPurchaseProfile_odata')/
deductionPayComponents"
}
},
"deductionTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountPurchaseProfile('TimeAccountPurchaseProfile_odata')/deductionTypeNav"
}
},
"helpTextTranslationTextNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountPurchaseProfile('TimeAccountPurchaseProfile_odata')/
helpTextTranslationTextNav"
}
},
"countryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountPurchaseProfile('TimeAccountPurchaseProfile_odata')/countryNav"
}
},
"equivalentUnitsNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountPurchaseProfile('TimeAccountPurchaseProfile_odata')/equivalentUnitsNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountPurchaseProfile('TimeAccountPurchaseProfile_odata')/wfRequestNav"
}
}
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

684 PUBLIC Time & Attendance Management
16.1.19 TimeAccountPurchaseProfilePayComponentAssignmen
t

This a wrapper for payComponents. TimeAccountPurchaseProfilePayComponentAssignment holds deduction type

payComponents for purchase leave. It's mainly used to get the relevant payComponents for a
TimeAccountPurchaseProfile.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

TimeAccountPurchaseProfile_externalCode This is a business key. This property is required.

payComponent Referenced payComponent. This property is required.

Navigation Properties

Navigation Propertz Related Entity Description

payComponentNav PayComponent Navigates to the PayComponent

Use Case: Query the payComponents for TimeAccountPurchaseProfile

'TimeAccountPurchaseProfile_odata'

Simple request to get the payComponents for TimeAccountPurchaseProfile 'TimeAccountPurchaseProfile_odata'

Request

Operation Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 685
HTTP Method GET

URI https://<api-server>/odata/v2/
TimeAccountPurchaseProfilePayComponentAssi
gnment?
$filter=TimeAccountPurchaseProfile_externa
lCode eq
'TimeAccountPurchaseProfile_odata'&
$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
TimeAccountPurchaseProfilePayComponentAssignment(TimeAccountPurchaseProfile_external
Code='TimeAccountPurchaseProfile_odata',payComponent='payComponent_odata')",
"type":
"SFOData.TimeAccountPurchaseProfilePayComponentAssignment"
},
"TimeAccountPurchaseProfile_externalCode":
"TimeAccountPurchaseProfile_odata",
"payComponent": "payComponent_odata",
"payComponentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountPurchaseProfilePayComponentAssignment(TimeAccountPurchaseProfile_external
Code='TimeAccountPurchaseProfile_odata',payComponent='payComponent_odata')/
payComponentNav"
}
}
}
]
}
}

16.1.20 TimeAccountSnapshot

This MDF entity contains balance information for a specific time account for a user. It is created while running a
snapshot job for leave liability-related calculation for the user.

Supported Operations

Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

686 PUBLIC Time & Attendance Management
Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Property Related Entity

wfRequestNav wfRequest

unitNav MDFEnumValue

userIdnav UserId

accountTypeNav TimeAccountType

Use Case: Querying the time account of a user

Request

Operation Query

HTTP Method GET

URI https://<<api-server>>/odata/v2/
TimeAccountSnapshot?$format=JSON&
$filter=userId eq '585'

Headers Authorization: Basic <Base 64 encoded (“user@com­

pany:password”)>

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<<api-server>>/odata/v2/restricted/
TimeAccountSnapshot('585_370265_20170221')",
"type": "SFOData.TimeAccountSnapshot"
},
"externalCode": "585_370265_20170221",
"balanceEffectiveDate": "\\/Date(1487635200000)\\/",
"approvedAbsenceBalance": null,
"approvedAbsenceBalanceAccrualSeparated": null,
"asOfPayPeriodEnd": false,
"balanceAccrualSeparated": null,
"unit": "DAYS",
"balance": "23",
"asOfAccountingPeriodEnd": true,
"outdated": false,
"userId": "585",
"accountType": "ENT#--35411_Recurring",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 687
 "wfRequestNav": {
"__deferred": {
"uri": "https://<<api-server>>/odata/v2/restricted/
TimeAccountSnapshot('585_370265_20170221')/wfRequestNav"
}
},
"unitNav": {
"__deferred": {
"uri": "https://<<api-server>>/odata/v2/restricted/
TimeAccountSnapshot('585_370265_20170221')/unitNav"
}
},
"userIdNav": {
"__deferred": {
"uri": "https://<<api-server>>/odata/v2/restricted/
TimeAccountSnapshot('585_370265_20170221')/userIdNav"
}
},
"accountTypeNav": {
"__deferred": {
"uri": "https://<<api-server>>/odata/v2/restricted/
TimeAccountSnapshot('585_370265_20170221')/accountTypeNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Time Off

16.1.21 TimeAccountType

The entity is the template regulating what user-specific time accounts should look like.

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

OData Examples

Example: Get a specific time account type

URI: http://<api-server>/odata/v2/TimeAccountType('Standard_ACM')$format=JSON

Method: GET

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

688 PUBLIC Time & Attendance Management
  Sample Code

{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')",
"type": "SFOData.TimeAccountType"
},
"externalCode": "Standard_ACM",
"pepCalendarAutomationLevel": "NONE",
"timeCollectorType": null,
"accountBookingOffsetInMonths": null,
"externalName_ru_RU": null,
"lastModifiedDateTime": "/Date(1435913291000+0000)/",
"levelOfSimulationPrecision": "CALCULATION",
"calculateSnapshotApprovedAbsenceBalance": null,
"accrualWaitingPeriodUnit": null,
"mdfSystemRecordId": "DB1BCEEA57DD4AACA21F000063594EC6",
"accrualPeriodStartDay": null,
"initialFlexibleAccountStartDateRule": null,
"payComponentTerminationAccrualSeparated": null,
"externalName_en_SAP_SLS": null,
"createdDate": "/Date(1435913291000)/",
"accrualFrequencyStartDate": null,
"payComponentGroup": null,
"accrualCalculationMethod": "STANDARD",
"accountCreationReferenceDate": "REFERENCE_DAY_MONTH",
"payComponentAccrualSeparated": null,
"accountCreationOffsetInMonths": "-10",
"createdBy": "admin",
"createdDateTime": "/Date(1435913291000+0000)/",
"lastModifiedBy": "admin",
"externalName_en_GB": null,
"advancesAllowed": null,
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"externalName_zh_CN": null,
"creation": "RECURRING",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"accrualRule": "Accrual_30",
"postingOrder": null,
"entitlementMethod": "ENTITLED_AS_ACCRUED",
"externalName_localized": "Standard_ACM",
"externalName_fr_CA": null,
"externalName_defaultValue": "Standard_ACM",
"initialAccrualTransferDateRule": null,
"accrualWaitingPeriod": null,
"lastModifiedDateWithTZ": "/Date(1435913291000+0000)/",
"payComponent": null,
"accrualPeriodStartMonth": null,
"hireRule": "Accrual_30",
"mdfSystemObjectType": "TimeAccountType",
"snapshotsAllowed": false,
"externalName_pt_BR": null,
"accrualCreationOffset": null,
"accrualRecalculationPostingMethod": "CLASSIC",
"mdfSystemEntityId": "201EC4A27797499BB651941AB62AF087",
"mdfSystemStatus": "A",
"externalName_en_US": "Standard_ACM",
"terminationRule": null,
"mdfSystemRecordStatus": "N",
"payoutEligibility": "NOT_ELIGIBLE",
"allowPayoutWithSimulation": null,
"minimumBalanceAllowed": null,
"periodEndProcessingRule": null,
"country": null,
"externalName_it_IT": null,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 689
 "payComponentTermination": null,
"externalName_nl_NL": null,
"simulationRule": null,
"terminationRuleDataEffectiveDate": null,
"externalName_ko_KR": null,
"simulateAccruals": true,
"mdfSystemVersionId": null,
"externalName_de_DE": null,
"accrualAutomationLevel": "AUTO_CALENDARS",
"accrualTransferRule": null,
"maximumSimulationHorizonInMonths": null,
"accrualFrequency": "ANNUALLY",
"mdfSystemTransactionSequence": "1",
"secondAccrualCreationOffset": null,
"externalName_ja_JP": null,
"interimRule": null,
"accountCreationMonth": "1",
"accountCreationDay": "1",
"unit": "DAYS",
"accountCreationAutomationLevel": "AUTO_ACCOUNT_CREATION",
"externalName_es_ES": null,
"lastModifiedDate": "/Date(1435913291000)/",
"accrualTransferDateRule": null,
"externalName_fr_FR": null,
"payComponentNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/payComponentNav"
}
},
"postingOrderNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/postingOrderNav"
}
},
"countryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/countryNav"
}
},
"creationNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/creationNav"
}
},
"pepCalendarAutomationLevelNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/pepCalendarAutomationLevelNav"
}
},
"payComponentTerminationNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/payComponentTerminationNav"
}
},
"payComponentTerminationAccrualSeparatedNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/payComponentTerminationAccrualSeparatedNav"
}
},
"externalNameTranslationTextNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

690 PUBLIC Time & Attendance Management
 "uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/externalNameTranslationTextNav"
}
},
"payComponentGroupNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/payComponentGroupNav"
}
},
"terminationRuleDataEffectiveDateNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/terminationRuleDataEffectiveDateNav"
}
},
"accountCreationReferenceDateNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/accountCreationReferenceDateNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/mdfSystemRecordStatusNav"
}
},
"accrualCalculationMethodNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/accrualCalculationMethodNav"
}
},
"unitNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/unitNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/wfRequestNav"
}
},
"accountCreationAutomationLevelNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/accountCreationAutomationLevelNav"
}
},
"accrualAutomationLevelNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/accrualAutomationLevelNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/mdfSystemStatusNav"
}
},
"payComponentAccrualSeparatedNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/payComponentAccrualSeparatedNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 691
 }
},
"allowPayoutWithSimulationNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/allowPayoutWithSimulationNav"
}
},
"accrualRecalculationPostingMethodNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/accrualRecalculationPostingMethodNav"
}
},
"accrualWaitingPeriodUnitNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/accrualWaitingPeriodUnitNav"
}
},
"accrualFrequencyNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/accrualFrequencyNav"
}
},
"payoutEligibilityNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/payoutEligibilityNav"
}
},
"entitlementMethodNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/entitlementMethodNav"
}
},
"levelOfSimulationPrecisionNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountType('Standard_ACM')/levelOfSimulationPrecisionNav"
}
}
}
}

Related Information

SAP API Business Hub: Time Off

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

692 PUBLIC Time & Attendance Management
16.1.22 TimeAccountType<Country/Region>

Country/region-specific entities for TimeAccountType are available. Take a look at the sub-sections to see which
countries and regions are supported with country/region-specific fields. These entities are child entities of
TimeAccountType.

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Australia: TimeAccountTypeAUS

This entity contains an Australia specific boolean field which is used for leave loading calculations in Time.

TimeAccountTypeAUS [page 693]

This entity contains an Australia specific boolean field which is used for leave loading calculations in Time.

16.1.22.1 TimeAccountTypeAUS

This entity contains an Australia specific boolean field which is used for leave loading calculations in Time.

Supported Operations

Operation Description

Query This object is used to store the country specific boolean field
which is used for leave loading calculation in Time for Australia.

Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 693
Properties

Property Description

includeInLeaveLoadingCalculations The option to allow the Time Account Type to be included in

the leave loading calculations.

Use Case : Querying the TimeAccountTypeAUS data for the user

Querying the Time Account Type information for an Australian employee.

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/TimeAccountTypeAUS?
$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https:<API-Server>/odata/v2/
TimeAccountTypeAUS(TimeAccountType_externalCode='TimeAccountTypeAUSAPI',externalCode
=10908L)",
"type": "SFOData.TimeAccountTypeAUS"
},
"externalCode": "10908",
"TimeAccountType_externalCode": "TimeAccountTypeAUSAPI",
"lastModifiedDateTime": "/Date(1589916838000+0000)/",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1589916838000+0000)/",
"mdfSystemRecordStatus": "N",
"includeInLeaveLoadingCalculations": true,
"createdBy": "admin",
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeAccountTypeAUS(TimeAccountType_externalCode='TimeAccountTypeAUSAPI',externalCode
=10908L)/createdByNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeAccountTypeAUS(TimeAccountType_externalCode='TimeAccountTypeAUSAPI',externalCode
=10908L)/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeAccountTypeAUS(TimeAccountType_externalCode='TimeAccountTypeAUSAPI',externalCode
=10908L)/mdfSystemRecordStatusNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

694 PUBLIC Time & Attendance Management
 }
}
}
]
}
}

Related Information

SAP API Business Hub: Time Off

16.1.23 TimeManagementAlert

Time Management alerts draw your attention to something you need to take care of in Time Management.

Operation Allowed Description

GET Query a record

Properties

Here you can see the required fields and business keys for this entity. Check the OData API dictionary in your
instance to see the complete list of properties, and check your metadata for navigations, and associations.

Property Business Key Required Field Description

externalCode Yes Yes External Code

category No Yes Category e.g. the origin of the

time alert. Can have the values

● ABSENCE_RECALCU­
LATE
● ACCRUAL_RECALCU­
LATE
● TRANSFERDATE_RECAL­
CULATE
● TIME_SHEET_RECALCU­
LATE
● TIME_SHEET_GENERATE
or
● TIME_SHEET_IMPORT

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 695
Property Business Key Required Field Description

targetType No Yes Affected target. Currently the

only value is USER.

severity No Yes Severity of the alert. Can be ei­

ther:

● ERROR or
● WARNING

status No Yes Status of the alert. Can be ei­

ther

● NEW or
● CONFIRMED

date No Yes Date on which the alert occur­

red

targetId No No Id of the target of type target­

Type.

Navigation Properties

Navigation Propertz Related Entity Description

timeManagementAlertMessage TimeManagementAlertMessage Navigates to a list of TimeManagementA­

lertMessages.

Code Examples

Example for a request which gets all TimeManagementAlerts for the user with the user id “cgrant”

Query:

https://<hostname>/odata/v2/TimeManagementAlert?targetId'='cgrant'&$format=json

Response:

 Sample Code

"__metadata": {
"uri": "https://<hostname>/odata/v2/
TimeManagementAlert('2fa03156e0b249feb4a12cdb4e0eac0e')",
"type": "SFOData.TimeManagementAlert"
},
"externalCode": "2fa03156e0b249feb4a12cdb4e0eac0e",
"date": "/Date(1531267200000)/",
"concatenatedMessage": "Save Error: This is the text defined in
co_messageDefinition.",
"severity": "ERROR",
"targetId": "cgrant",
"targetType": "USER",
"category": "ACCRUAL_RECALCULATE",
"severityName": "Error",
"status": "NEW",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

696 PUBLIC Time & Attendance Management
 "targetTypeNav": {
"__deferred": {
"uri":
"https://<hostname>/odata/v2/
TimeManagementAlert('2fa03156e0b249feb4a12cdb4e0eac0e')/targetTypeNav"
}
},
"severityNav": {
"__deferred": {
"uri":
"https://<hostname>/odata/v2/
TimeManagementAlert('2fa03156e0b249feb4a12cdb4e0eac0e')/severityNav"
}
},
"statusNav": {
"__deferred": {
"uri":
"https://<hostname>/odata/v2/
TimeManagementAlert('2fa03156e0b249feb4a12cdb4e0eac0e')/statusNav"
}
},
"categoryNav": {
"__deferred": {
"uri":
"https://<hostname>/odata/v2/
TimeManagementAlert('2fa03156e0b249feb4a12cdb4e0eac0e')/categoryNav"
}
},
"targetIdNav": {
"__deferred": {
"uri":
"https://<hostname>/odata/v2/
TimeManagementAlert('2fa03156e0b249feb4a12cdb4e0eac0e')/targetIdNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri":
"https://<hostname>/odata/v2/
TimeManagementAlert('2fa03156e0b249feb4a12cdb4e0eac0e')/wfRequestNav"
}
}
}
]
}
}

16.1.24 TimeManagementAlertMessage

This entity represents a message which is contained in a TimeManagementAlert.

Operation Allowed Description

GET Query a record

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 697
Properties

Here you can see the required fields and business keys for this entity. Check the OData API dictionary in your
instance to see the complete list of properties, and check your metadata for navigations, and associations.

Property Business Key Required Field Description

TimeManagementAlert_exter­ Yes Yes Time Management Alert Ex­

nalCode ternal Code

externalCode Yes Yes External Code

messageKey No Yes The technical name of the er­

ror message that is displayed
localized in the alert tab.

messageParameter1 No No Optional message parameter

messageParameter2 No No Optional message parameter

messageParameter3 No No Optional message parameter

messageParameter4 No No Optional message parameter

messageParameter5 No No Optional message parameter

date No Yes Date on which the message

was raised

defaultMessageText No Yes If the language-dependent

message cannot be gener­
ated, this text is used by de­
fault.

employeeTime No No If this time alert references an

employee time object, the ob­
ject appears here.

employeeTimeSheet No No If this time alert references an

employee time sheet object,
the object appears here.

timeAccount No No If this time alert references a

time account type accrual
transfer, the object appears
here.

timeAccountTypeAccrual­ No No If this time alert references an

Transfer employee time object, the ob­
ject appears here.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

698 PUBLIC Time & Attendance Management
Navigation Properties

Navigation Propertz Related Entity Description

timeAccountNav TimeAccount Navigation to the TimeAccount

employeeTimeNav EmployeeTime Navigation to the EmployeeTime

employeeTimeSheetNav EmployeeTimeSheet Navigates to the EmployeeTimeSheet

Code Examples

Request to get all messages for a TimeManagementAlert which has the externalCode
'd1e3b9e5efa74860807b48af8462018d':

Query:

https://<hostname>/odata/v2/TimeManagementAlertMessage?
TimeManagementAlert_externalCode='d1e3b9e5efa74860807b48af8462018d'&$format=json

Response:

 Sample Code

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<hostname>/odata/v2/
TimeManagementAlertMessage(TimeManagementAlert_externalCode='d1e3b9e5efa74860807b
48af8462018d',externalCode='157d8648c764486da07f77254b9bb813')",
"type": "SFOData.TimeManagementAlertMessage"
},
"TimeManagementAlert_externalCode":
"d1e3b9e5efa74860807b48af8462018d",
"externalCode": "157d8648c764486da07f77254b9bb813",
"date": "/Date(1492905600000)/",
"lastModifiedDateTime": "/Date(1530790622000+0000)/",
"messageParameter3": null,
"messageParameter2": null,
"messageParameter4": null,
"createdDateTime": "/Date(1530790622000+0000)/",
"defaultMessageText": "No main attendance time type is assigned
to your time profile. Please contact your system administrator.",
"employeeTimeSheet": null,
"messageParameter1": null,
"employeeTime": null,
"messageKey":
"TIMEANDLABOR_TS_CONFIGURATION_NO_MAIN_ATTENDANCE_TIME_TYPE_FOR_EMPLOYEE",
"timeAccount": null,
"lastModifiedBy": "admin",
"timeAccountTypeAccrualTransfer": null,
"mdfSystemRecordStatus": "N",
"createdBy": "admin",
"createdByNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeManagementAlertMessage(TimeManagementAlert_externalCode='d1e3b9e5efa74860807b
48af8462018d',externalCode='157d8648c764486da07f77254b9bb813')/createdByNav"
}
},
"lastModifiedByNav": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 699
 "__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeManagementAlertMessage(TimeManagementAlert_externalCode='d1e3b9e5efa74860807b
48af8462018d',externalCode='157d8648c764486da07f77254b9bb813')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeManagementAlertMessage(TimeManagementAlert_externalCode='d1e3b9e5efa74860807b
48af8462018d',externalCode='157d8648c764486da07f77254b9bb813')/
mdfSystemRecordStatusNav"
}
},
"timeAccountNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeManagementAlertMessage(TimeManagementAlert_externalCode='d1e3b9e5efa74860807b
48af8462018d',externalCode='157d8648c764486da07f77254b9bb813')/timeAccountNav"
}
},
"employeeTimeNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeManagementAlertMessage(TimeManagementAlert_externalCode='d1e3b9e5efa74860807b
48af8462018d',externalCode='157d8648c764486da07f77254b9bb813')/employeeTimeNav"
}
},
"employeeTimeSheetNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeManagementAlertMessage(TimeManagementAlert_externalCode='d1e3b9e5efa74860807b
48af8462018d',externalCode='157d8648c764486da07f77254b9bb813')/
employeeTimeSheetNav"
}
}
},
{
"__metadata": {
"uri": "https://<hostname>/odata/v2/
TimeManagementAlertMessage(TimeManagementAlert_externalCode='d1e3b9e5efa74860807b
48af8462018d',externalCode='7afac01127f242a684aa6fa915ae6188')",
"type": "SFOData.TimeManagementAlertMessage"
},
"TimeManagementAlert_externalCode":
"d1e3b9e5efa74860807b48af8462018d",
"externalCode": "7afac01127f242a684aa6fa915ae6188",
"date": "/Date(1493510400000)/",
"lastModifiedDateTime": "/Date(1530790622000+0000)/",
"messageParameter3": null,
"messageParameter2": null,
"messageParameter4": null,
"createdDateTime": "/Date(1530790622000+0000)/",
"defaultMessageText": "No main attendance time type is assigned
to your time profile. Please contact your system administrator.",
"employeeTimeSheet": null,
"messageParameter1": null,
"employeeTime": null,
"messageKey":
"TIMEANDLABOR_TS_CONFIGURATION_NO_MAIN_ATTENDANCE_TIME_TYPE_FOR_EMPLOYEE",
"timeAccount": null,
"lastModifiedBy": "admin",
"timeAccountTypeAccrualTransfer": null,
"mdfSystemRecordStatus": "N",
"createdBy": "admin",
"createdByNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

700 PUBLIC Time & Attendance Management
 "uri": "https://<hostname>/odata/v2/
TimeManagementAlertMessage(TimeManagementAlert_externalCode='d1e3b9e5efa74860807b
48af8462018d',externalCode='7afac01127f242a684aa6fa915ae6188')/createdByNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeManagementAlertMessage(TimeManagementAlert_externalCode='d1e3b9e5efa74860807b
48af8462018d',externalCode='7afac01127f242a684aa6fa915ae6188')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeManagementAlertMessage(TimeManagementAlert_externalCode='d1e3b9e5efa74860807b
48af8462018d',externalCode='7afac01127f242a684aa6fa915ae6188')/
mdfSystemRecordStatusNav"
}
},
"timeAccountNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeManagementAlertMessage(TimeManagementAlert_externalCode='d1e3b9e5efa74860807b
48af8462018d',externalCode='7afac01127f242a684aa6fa915ae6188')/timeAccountNav"
}
},
"employeeTimeNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeManagementAlertMessage(TimeManagementAlert_externalCode='d1e3b9e5efa74860807b
48af8462018d',externalCode='7afac01127f242a684aa6fa915ae6188')/employeeTimeNav"
}
},
"employeeTimeSheetNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/
TimeManagementAlertMessage(TimeManagementAlert_externalCode='d1e3b9e5efa74860807b
48af8462018d',externalCode='7afac01127f242a684aa6fa915ae6188')/
employeeTimeSheetNav"
}
}
}
]
}
}

16.1.25 TimeManagementPriorServiceConfiguration

This entity contains the Prior Service related configuration for Time Management.

Supported Operations

Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 701
Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

country To enable the option for selecting the country for the object.

externalName To enable the option for providing the name for the object.

Use Case : Querying TimeManagementPriorServiceConfiguration data for the

user

Querying the Time Management Prior Service Configuration for an employee.

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
TimeManagementPriorServiceConfiguration?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
TimeManagementPriorServiceConfiguration('1')",
"type": "SFOData.TimeManagementPriorServiceConfiguration"
},
"externalCode": "1",
"country": "AUS",
"externalName_nl_NL": null,
"lastModifiedDateTime": "/Date(1597342452000+0000)/",
"createdDateTime": "/Date(1597342452000+0000)/",
"externalName_defaultValue": "Aus",
"externalName_es_ES": null,
"externalName_fr_CA": null,
"externalName_ja_JP": null,
"externalName_pt_BR": null,
"externalName_en_SAP_SLS": null,
"externalName_ru_RU": null,
"externalName_it_IT": null,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

702 PUBLIC Time & Attendance Management
 "lastModifiedBy": "admin",
"externalName_zh_CN": null,
"externalName_localized": "Aus",
"mdfSystemRecordStatus": "N",
"externalName_fr_FR": null,
"externalName_de_DE": null,
"externalName_ko_KR": null,
"createdBy": "admin",
"externalName_en_US": "Aus",
"externalName_en_GB": null,
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeManagementPriorServiceConfiguration('1')/createdByNav"
}
},
"externalNameTranslationTextNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeManagementPriorServiceConfiguration('1')/externalNameTranslationTextNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeManagementPriorServiceConfiguration('1')/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeManagementPriorServiceConfiguration('1')/mdfSystemRecordStatusNav"
}
},
"countryExtensionAUS": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeManagementPriorServiceConfiguration('1')/countryExtensionAUS"
}
},
"countryNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeManagementPriorServiceConfiguration('1')/countryNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeManagementPriorServiceConfiguration('1')/wfRequestNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 703
16.1.25.1 TimeManagementPriorServiceConfigurationUseCaseD
etailAUS

This entity contains the Prior Service related configuration for Time Management only for Australian employees.

Supported Operations

Query

Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

priorServiceUseCase To enable the option for selecting the prior service use case.

maximumBreakInServiceThreshold To enable the option for selecting the threshold value.

maximumBreakInServiceThresholdUnit To enable the option for selecting the threshold enum (either
‘Days’ or ‘Months’ )

processingOnTimeAccount To enable the option for selecting the enum for processing on
time account (either ‘None’ or ‘Calculate Transfer Date’ )

Use Case : Querying the

TimeManagementPriorServiceConfigurationUseCaseDetailAUS data for a user

Querying the Time Management Prior Service User Case Configuration details for an Australian employee.

Request

Operation Query

HTTP Method GET

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

704 PUBLIC Time & Attendance Management
 URI https://<API-Server>/odata/v2/
TimeManagementPriorServiceConfigurationUseCaseDetailAUS?
$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
TimeManagementPriorServiceConfigurationUseCaseDetailAUS(TimeManagementPriorServiceCo
nfiguration_externalCode='1',externalCode='1')",
"type": "SFOData.TimeManagementPriorServiceConfigurationUseCaseDetailAUS"
},
"TimeManagementPriorServiceConfiguration_externalCode": "1",
"externalCode": "1",
"maximumBreakInServiceThreshold": null,
"priorServiceUseCase": "1",
"lastModifiedDateTime": "/Date(1597342452000+0000)/",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1597342452000+0000)/",
"processingOnTimeAccount": "CALCULATE_TRANSFER_DATE",
"mdfSystemRecordStatus": "N",
"maximumBreakInServiceThresholdUnit": null,
"createdBy": "admin",
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeManagementPriorServiceConfigurationUseCaseDetailAUS(TimeManagementPriorServiceCo
nfiguration_externalCode='1',externalCode='1')/createdByNav"
}
},
"processingOnTimeAccountNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeManagementPriorServiceConfigurationUseCaseDetailAUS(TimeManagementPriorServiceCo
nfiguration_externalCode='1',externalCode='1')/processingOnTimeAccountNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeManagementPriorServiceConfigurationUseCaseDetailAUS(TimeManagementPriorServiceCo
nfiguration_externalCode='1',externalCode='1')/lastModifiedByNav"
}
},
"maximumBreakInServiceThresholdUnitNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeManagementPriorServiceConfigurationUseCaseDetailAUS(TimeManagementPriorServiceCo
nfiguration_externalCode='1',externalCode='1')/
maximumBreakInServiceThresholdUnitNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeManagementPriorServiceConfigurationUseCaseDetailAUS(TimeManagementPriorServiceCo
nfiguration_externalCode='1',externalCode='1')/mdfSystemRecordStatusNav"
}
}
}
]
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 705
 }

16.1.26 TimeType

A time type is created for each type of leave. You can use this entity to read the time types created.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Navigation Property Related Entity Description

timeAccountPostingRules TimeAccountPostingRule Association to GO Time Account Posting

Rule.

Use Case: Get a specific time type including attached time account types

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/TimeType('VACATION')?
$expand=timeAccountPostingRules&$format=JSON

Response

{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/TimeType('VACATION')",
"type": "SFOData.TimeType"
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

706 PUBLIC Time & Attendance Management
 "externalCode": "VACATION",
"mdfSystemObjectType": "TimeType",
"externalName_pt_BR": null,
"requestingOnNonWorkingDaysAllowed": null,
"collisionGrouping": null,
"externalName_ru_RU": null,
"lastModifiedDateTime": "/Date(1401013041000+0000)/",
"balanceCalculationSetting": "STANDARD",
"mdfSystemRecordId": "0D15EB009B066032E0537A54740A259C",
"mdfSystemEntityId": "0D15EB00F5876032E0537A54740A259C",
"activateCancellationWorkflow": null,
"mdfSystemStatus": "A",
"externalName_en_US": "Vacation",
"externalName_en_SAP_SLS": null,
"createdDate": "/Date(1351123200000)/",
"mdfSystemRecordStatus": "N",
"maximumDurationInMonths": null,
"country": null,
"absenceClass": "UNSPECIFIED",
"category": "ABSENCE",
"createdBy": "admin",
"externalName_it_IT": null,
"createdDateTime": "/Date(1351123200000+0000)/",
"lastModifiedBy": "v4admin",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"externalName_en_GB": null,
"externalName_nl_NL": null,
"externalName_zh_CN": null,
"flexibleRequestingAllowed": null,
"workflowConfiguration": "AbsenceRequest",
"accrualRecalculationRelevance": null,
"externalName_ko_KR": null,
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"externalName_de_DE": null,
"externalName_localized": "Vacation",
"loaStartEventReason": null,
"externalName_defaultValue": "Vacation",
"externalName_fr_CA": null,
"mdfSystemTransactionSequence": "1",
"allowedRequestingIncrement": null,
"adminWorkflow": null,
"loaEndEventReason": null,
"allocationStrategy": null,
"lastModifiedDateWithTZ": "/Date(1401013041000+0000)/",
"externalName_ja_JP": null,
"countingMethod": null,
"undeterminedEndDateAllowed": null,
"unit": "DAYS",
"allowedFractionsUnitDay": "HALF_DAY",
"allowedFractionsUnitHour": null,
"calculationMethod": "WORKSCHEDULE",
"externalName_es_ES": null,
"lastModifiedDate": "/Date(1401013041000)/",
"externalName_fr_FR": null,
"allocationStrategyNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/TimeType('VACATION')/
allocationStrategyNav"
}
},
"allowedFractionsUnitDayNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/TimeType('VACATION')/
allowedFractionsUnitDayNav"
}
},
"unitNav": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 707
 "__deferred": {
"uri": "https://<api-server>/odata/v2/TimeType('VACATION')/unitNav"
}
},
"countryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/TimeType('VACATION')/
countryNav"
}
},
"loaStartEventReasonNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/TimeType('VACATION')/
loaStartEventReasonNav"
}
},
"categoryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/TimeType('VACATION')/
categoryNav"
}
},
"calculationMethodNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/TimeType('VACATION')/
calculationMethodNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/TimeType('VACATION')/
wfRequestNav"
}
},
"countingMethodNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/TimeType('VACATION')/
countingMethodNav"
}
},
"adminWorkflowNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/TimeType('VACATION')/
adminWorkflowNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/TimeType('VACATION')/
mdfSystemStatusNav"
}
},
"absenceClassNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/TimeType('VACATION')/
absenceClassNav"
}
},
"loaEndEventReasonNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/TimeType('VACATION')/
loaEndEventReasonNav"
}
},
"balanceCalculationSettingNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/TimeType('VACATION')/
balanceCalculationSettingNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

708 PUBLIC Time & Attendance Management
 }
},
"externalNameTranslationTextNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/TimeType('VACATION')/
externalNameTranslationTextNav"
}
},
"timeAccountPostingRules": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
TimeAccountPostingRule(TimeType_externalCode='VACATION',externalCode='1')",
"type": "SFOData.TimeAccountPostingRule"
},
"TimeType_externalCode": "VACATION",
"externalCode": "1",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "TimeAccountPostingRule",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1401013041000+0000)/",
"timeAccountType": "VACATION_CURRENT",
"mdfSystemTransactionSequence": "1",
"createdBy": "admin",
"mdfSystemRecordId": "0D15EB007E386032E0537A54740A259C",
"mdfSystemEntityId": "0D15EB00F5F26032E0537A54740A259C",
"createdDateTime": "/Date(1359581374000+0000)/",
"lastModifiedBy": "v4admin",
"mdfSystemStatus": "A",
"lastModifiedDate": "/Date(1401013041000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDateWithTZ": "/Date(1401013041000+0000)/",
"createdDate": "/Date(1359581374000)/",
"mdfSystemRecordStatus": "N",
"timeAccountTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountPostingRule(TimeType_externalCode='VACATION',externalCode='1')/
timeAccountTypeNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountPostingRule(TimeType_externalCode='VACATION',externalCode='1')/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeAccountPostingRule(TimeType_externalCode='VACATION',externalCode='1')/
mdfSystemStatusNav"
}
}
}
]
},
"accrualRecalculationRelevanceNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/TimeType('VACATION')/
accrualRecalculationRelevanceNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 709
 "uri": "https://<api-server>/odata/v2/TimeType('VACATION')/
mdfSystemRecordStatusNav"
}
},
"allowedFractionsUnitHourNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/TimeType('VACATION')/
allowedFractionsUnitHourNav"
}
},
"workflowConfigurationNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/TimeType('VACATION')/
workflowConfigurationNav"
}
}
}
}

Related Information

SAP API Business Hub: Time Off

16.1.27 TimeType<Country/Region>

Country/region-specific entities for TimeType are available. Take a look at the sub-sections to see which countries
are supported with country/region-specific fields. These entities are child entities of TimeType.

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Australia: TimeTypeAUS

This entity contains Australia-specific fields, which are used to configure the advance leave payment for absences.

Canada: TimeTypeCAN

This entity contains a Canada-specific enum field, which is used for short term disability in Time.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

710 PUBLIC Time & Attendance Management
Germany: TimeTypeDEU

This entity contains Germany-specific enum fields that are the basis for calculating default values for the continued
pay dates and sick pay supplement dates in Time Off.

Netherlands: TimeTypeNLD

This entity contains a Netherlands-specific enum field which is used for tracking recovery from illness to record
Concurrent Absences in Time Off.

USA: TimeTypeUSA

This entity contains USA-specific enum field, which is used for short term disability in Time.

TimeTypeAUS [page 712]

This entity contains Australia specific fields, which is used to configure the advance leave payment for
absences.

TimeTypeCAN [page 714]

This entity contains a Canada specific enum field, which is used for short term disability in Time.

TimeTypeDEU [page 715]

This entity contains Germany-specific fields that are the basis for calculating default values for continued
pay dates and the sick pay supplement dates.

TimeTypeNLD [page 718]

This entity contains a Netherlands specific enum field which is used for tracking recovery from illness in
Time Off.

TimeTypeUSA [page 720]

This entity contains USA specific enum field, which is used for short term disability in Time.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 711
16.1.27.1 TimeTypeAUS

This entity contains Australia specific fields, which is used to configure the advance leave payment for absences.

Supported Operations

Operation Description

Query This object is used to store the country specific Time Type
fields information to allow the requesting of advance leave pay­
ment for Australia.

Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

leaveAdvancePaymentAllowed The option to enable the option for advance leave payment for the absences.

splitAcrossFinancialYearAllowed The option to enable the option for split advance payment across financial year for
the absences.

Use Case: Getting the Time Type Information for an employee from Australia

Querying the Time Type information for an Australian employee

Request

Operation Query

HTTP Method GET

URI https://<API-server>/odata/v2/TimeTypeAUS?$format=json

Response

{
"d": {
"results": [

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

712 PUBLIC Time & Attendance Management
 {
"__metadata": {
"uri": "https://<API-server>/odata/v2/
TimeTypeAUS(TimeType_externalCode='split_alp',externalCode=10468L)",
"type": "SFOData.TimeTypeAUS"
},
"externalCode": "10468",
"TimeType_externalCode": "split_alp",
"lastModifiedDateTime": "/Date(1580360854000+0000)/",
"lastModifiedBy": "rgopal",
"createdDateTime": "/Date(1580360854000+0000)/",
"splitPaymentAcrossFinancialYearAllowed": true,
"mdfSystemRecordStatus": "N",
"advanceLeavePaymentAllowed": true,
"createdBy": "rgopal",
"createdByNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
TimeTypeAUS(TimeType_externalCode='split_alp',externalCode=10468L)/createdByNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
TimeTypeAUS(TimeType_externalCode='split_alp',externalCode=10468L)/
lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-server>/odata/v2/
TimeTypeAUS(TimeType_externalCode='split_alp',externalCode=10468L)/
mdfSystemRecordStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Time Off

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 713
16.1.27.2 TimeTypeCAN

This entity contains a Canada specific enum field, which is used for short term disability in Time.

Supported Operations

Operation Description

Query This object is used to store the country specific Time Type field
information to allow the requesting of short term disability for
Canada.

Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

sicknessVariant The option to select the Sickness Variant for the absence.

Use Case : Querying the Time Type information for an employee from Canada

Querying the Time Type information for an Canadian employee

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/TimeTypeCAN?$format=json

Response

{
"d": {
"results": [

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

714 PUBLIC Time & Attendance Management
 {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
TimeTypeCAN(TimeType_externalCode='CANADA_STD',externalCode=11029L)",
"type": "SFOData.TimeTypeCAN"
},
"externalCode": "11029",
"TimeType_externalCode": "CANADA_STD",
"lastModifiedDateTime": "/Date(1592891603000+0000)/",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1590901645000+0000)/",
"mdfSystemRecordStatus": "N",
"createdBy": "admin",
"sicknessVariant": "SHORT_TERM_DISABILITY",
"sicknessVariantNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeTypeCAN(TimeType_externalCode='CANADA_STD',externalCode=11029L)/
sicknessVariantNav"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeTypeCAN(TimeType_externalCode='CANADA_STD',externalCode=11029L)/createdByNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeTypeCAN(TimeType_externalCode='CANADA_STD',externalCode=11029L)/
lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeTypeCAN(TimeType_externalCode='CANADA_STD',externalCode=11029L)/
mdfSystemRecordStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Time Off

16.1.27.3 TimeTypeDEU

This entity contains Germany-specific fields that are the basis for calculating default values for continued pay dates
and the sick pay supplement dates.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 715
Supported Operations

Operation Description

Query This object is used to store the country-specific time type field
information to allow the calculation of default values for contin­
ued pay dates and sick pay supplement dates.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

sicknessVariant This field is used to select the sickness variant for the absence.

durationOfContinuedSickPayPeriod This field is used to select the length of the continued sick pay
period.

durationOfContinuedSickPayTimeUnit This field is used to select the time unit for the duration of the
continued pay.

durationOfSickPaySupplementPeriod This field is used to select the duration of the sick pay supple­
ment period.

durationOfSickPaySupplementTimeUnit This field is used to selct the time unit of the duration of the
sick pay supplement period.

Use Case: Querying the Time Type Information for an Employee from Germany

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/TimeTypeDEU?$format=json

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

716 PUBLIC Time & Attendance Management
Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/restricted/
TimeTypeDEU(TimeType_externalCode='TimeTypeDEU',externalCode=13898L)",
"type": "SFOData.TimeTypeDEU"
},
"externalCode": "13898",
"TimeType_externalCode": "TimeTypeDEU",
"lastModifiedDateTime": "/Date(1622732330000+0000)/",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1622732330000+0000)/",
"durationOfContinuedSickPayTimeUnit": null,
"mdfSystemRecordStatus": "N",
"durationOfSickPaySupplementTimeUnit": null,
"durationOfSickPaySupplementPeriod": null,
"createdBy": "admin",
"durationOfContinuedSickPayPeriod": null,
"sicknessVariant": "WITH_MANUAL_ENTRY_OF_SICK_PAY_DATES",
"sicknessVariantNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/restricted/
TimeTypeDEU(TimeType_externalCode='TimeTypeDEU',externalCode=13898L)/
sicknessVariantNav"
}
},
"durationOfSickPaySupplementTimeUnitNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/restricted/
TimeTypeDEU(TimeType_externalCode='TimeTypeDEU',externalCode=13898L)/
durationOfSickPaySupplementTimeUnitNav"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/restricted/
TimeTypeDEU(TimeType_externalCode='TimeTypeDEU',externalCode=13898L)/createdByNav"
}
},
"durationOfContinuedSickPayTimeUnitNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/restricted/
TimeTypeDEU(TimeType_externalCode='TimeTypeDEU',externalCode=13898L)/
durationOfContinuedSickPayTimeUnitNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/restricted/
TimeTypeDEU(TimeType_externalCode='TimeTypeDEU',externalCode=13898L)/
lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/restricted/
TimeTypeDEU(TimeType_externalCode='TimeTypeDEU',externalCode=13898L)/
mdfSystemRecordStatusNav"
}
}
}
]
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 717
 }

Additional Information

The TimeTypeDEU object is delivered as inactive. Please activate the SicknessDEUDefaulting feature toggle to
access this object.

Related Information

SAP API Business Hub: Time Off

16.1.27.4 TimeTypeNLD

This entity contains a Netherlands specific enum field which is used for tracking recovery from illness in Time Off.

Supported Operations

Operation Description

Query This object is used to store the country specific Time Type field
information to allow the tracking of recovery from illness in the
Netherlands.

Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

718 PUBLIC Time & Attendance Management
Properties

Property Description

illnessRecoveryTracking This field is used for recording the illness recovery tracking op­
tions for the Netherlands absence.

Use Case: Querying the Time Type information for an employee from the
Netherlands

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/TimeTypeNLD?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
TimeTypeNLD(TimeType_externalCode='NLD Sickness IRT',externalCode=15496L)",
"type": "SFOData.TimeTypeNLD"
},
"externalCode": "15496",
"TimeType_externalCode": "NLD Sickness IRT",
"lastModifiedDateTime": "/Date(1629180421000+0000)/",
"entityUUID": "AD71A380867B4A0FBFF19E9518DBFCDC",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1628856971000+0000)/",
"mdfSystemRecordStatus": "N",
"illnessRecoveryTracking": "WITH_MANUAL_ENTRY_OF_AVAILABLE_WORK_CAPACITY",
"createdBy": "admin",
"illnessRecoveryTrackingNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeTypeNLD(TimeType_externalCode='NLD Sickness IRT',externalCode=15496L)/
illnessRecoveryTrackingNav"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeTypeNLD(TimeType_externalCode='NLD Sickness IRT',externalCode=15496L)/
createdByNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeTypeNLD(TimeType_externalCode='NLD Sickness IRT',externalCode=15496L)/
lastModifiedByNav"
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 719
 },
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeTypeNLD(TimeType_externalCode='NLD Sickness IRT',externalCode=15496L)/
mdfSystemRecordStatusNav"
}
}
}
]
}
}

Additional Information

TimeTypeNLD object is delivered as inactive. You need to activate it to access this object. This object can be
activated only when the ConcurrentAbsence feature toggle is enabled.

Related Information

SAP API Business Hub: Time Off

16.1.27.5 TimeTypeUSA

This entity contains USA specific enum field, which is used for short term disability in Time.

Supported Operations

Operation Description

Query This object is used to store the country specific Time Type field
information to allow the requesting of short term disability for
USA.

Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

720 PUBLIC Time & Attendance Management
Properties

Property Description

sicknessVariant The option to select the Sickness Variant for the absence.

Use Case : Querying the Time Type information for an employee from USA

Querying the Time Type information for a USA employee

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/TimeTypeUSA?$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
TimeTypeUSA(TimeType_externalCode='usa_std',externalCode=11148L)",
"type": "SFOData.TimeTypeUSA"
},
"externalCode": "11148",
"TimeType_externalCode": "usa_std",
"lastModifiedDateTime": "/Date(1593146495000+0000)/",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1593146495000+0000)/",
"mdfSystemRecordStatus": "N",
"createdBy": "admin",
"sicknessVariant": "SHORT_TERM_DISABILITY ",
"sicknessVariantNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeTypeUSA(TimeType_externalCode='usa_std',externalCode=11148L)/sicknessVariantNav"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeTypeUSA(TimeType_externalCode='usa_std',externalCode=11148L)/createdByNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
TimeTypeUSA(TimeType_externalCode='usa_std',externalCode=11148L)/lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 721
 "uri": "https://<API-Server>/odata/v2/
TimeTypeUSA(TimeType_externalCode='usa_std',externalCode=11148L)/
mdfSystemRecordStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Time Off

16.1.28 TimeTypeProfile

You can use this entity to view the time type profile of an employee. You specify which time types the employee is
allowed to take. The profile is part of an employee's job information.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Navigation Property Target Description

availableTimeTypes AvailableTimeType Navigation to the list of relevant time

types

availableAllowanceTypes AvailableAllowanceType Navigation to the list of relevant allow­

ance time types

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

722 PUBLIC Time & Attendance Management
Use Case: Query Time Type Profile

Request

 Tip

We recommend you to use the new syntax with $filter as shown below for the "GET" operation.

Avoid using the earlier syntax with just the key, e.g: /odata/v2/TimeTypeProfile('CODE').

If you have already used the $filter syntax, there are no issues and no adjustments to the API request are
required.

This example retrieves data to get the single record with external code 'CLT_STD' that is valid as of today

Operation Query

HTTP Method GET

https://<api-server>/odata/v2/TimeTypeProfile?$filter=exter-
nalCode eq 'CLT_STD'

 Note

Today is the date fetched from the tenantPreferredTimezone. If this not configured, the system timezone is
used.

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/TimeTypeProfile('Vacation
CLT')",
"type": "SFOData.TimeTypeProfile"
},
"externalCode": "Vacation CLT",
"mdfSystemObjectType": "TimeTypeProfile",
"mdfSystemEffectiveEndDate": "\/Date(253402214400000)\/",
"mdfSystemVersionId": null,
"mainBreakTimeType": "BREAK CLT",
"externalName_ru_RU": null,
"externalName_defaultValue": "Vacation CLT",
"lastModifiedDateTime": "\/Date(1440400906000+0000)\/",
"timeRecordingVariant": "CLOCK_TIME",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "97613000C22F405FA9B3FB681ABACDD6",
"mdfSystemEntityId": "EB2F5C3870EB43D0A455DF60B09665FF",
"mainAttendanceTimeType": null,
"mdfSystemStatus": "A",
"externalName_en_US": null,
"lastModifiedDateWithTZ": "\/Date(1440400906000+0000)\/",
"createdDate": "\/Date(1440408106000)\/",
"mdfSystemRecordStatus": "N",
"mainESSTimeType": "VACATION CLT",
"country": null,
"createdBy": "daily",
"lastModifiedBy": "daily",
"createdDateTime": "\/Date(1440400906000+0000)\/",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 723
 "externalName_en_GB": "Vacation CLT",
"lastModifiedDate": "\/Date(1440408106000)\/",
"mdfSystemEffectiveStartDate": "\/Date(-2208988800000)\/",
"externalName_en_DEBUG": null,
"countryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeTypeProfile('Vacation CLT')/countryNav"
}
},
"mainBreakTimeTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeTypeProfile('Vacation CLT')/mainBreakTimeTypeNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeTypeProfile('Vacation CLT')/mdfSystemRecordStatusNav"
}
},
"timeRecordingVariantNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeTypeProfile('Vacation CLT')/timeRecordingVariantNav"
}
},
"availableTimeTypes": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeTypeProfile('Vacation CLT')/availableTimeTypes"
}
},
"mainESSTimeTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeTypeProfile('Vacation CLT')/mainESSTimeTypeNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeTypeProfile('Vacation CLT')/mdfSystemStatusNav"
}
},
"mainAttendanceTimeTypeNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
TimeTypeProfile('Vacation CLT')/mainAttendanceTimeTypeNav"
}
}
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

724 PUBLIC Time & Attendance Management
16.1.29 WorkSchedule

A work schedule defines the employee´s working pattern. It is assigned to an employee´s job information, showing
how many days per week the employee is going to work.

There are three models for setting up a work schedule. You specify which one you want to use in the Model field.
Your options are:

● Simple
● Period
● Schedule

Depending on the configuration, different fields are relevant for the work schedule.

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

This table shows the required fields and business keys for this entity. Check the OData API dictionary in your
instance to see the complete list of properties, and check your metadata for navigations and associations.

Property Business Key Required Field Description

externalCode Yes Yes External Code

externalName No No If userId is entered the work

schedule only applies to one
particular employee.

startingDate No Yes Starting date of the work

schedule

country No No Work schedules can be coun­

try specific.

flexibleRequestingAllowed No No Flag whether flexible request­

ing is allowed for this work
schedule

modelCategory No Yes Work schedule model cate­

gory: SIMPLE, PERIOD. or
SCHEDULE.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 725
Property Business Key Required Field Description

periodModel No Yes The period models you have

created and want to include in
this work schedule

averageHoursPerDay No No Average hours per day

averageHoursPerWeek No No Average hours per week

averageHoursPerMonth No No Average hours per month

averageHoursPerYear No No Average hours per year

averageWorkingDaysPerWeek No No Average working days per

week

individualWorkSchedule No Yes Flag whether this work sched­

ule is an individual work
schedule

searchString No No Field is used to search for par­

ticular terms within existing
work schedules

shiftClassification No No Shift classification relevant for

this work schedule

timeRecordingVariant No Yes The specified time recording

variant, either Duration or
Clock Times

workScheduleDays No No List of work schedule day defi-

nitions (only used for SIMPLE
work schedule models)

workScheduleDayModels No No List of work schedule day defi-

nitions (only used for PERIOD
work schedule models)

Navigation Properties

Navigation Property Related Entity Description

userIdNav User Navigation to User

countryNav Country Navigation to Country

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

726 PUBLIC Time & Attendance Management
 Navigation Property Related Entity Description

periodModel WorkSchedule Navigation to WorkSchedule

shiftClassificationNav ShiftClassification Navigation to ShiftClassification

workScheduleDays Work Schedule Day Navigation to

workScheduleDayModels Work Schedule Day Model

Use Case: Query Work Schedule

 Tip

We recommend you to use the new syntax with $filter as shown below for the "GET" operation.

Avoid using the earlier syntax with just the key, e.g: /odata/v2/WorkSchedule('CODE').

If you have already used the $filter syntax, there are no issues and no adjustments to the API request are
required.

This example gets a single work schedule record with external code 'NORM' that is valid as of today.

Operation Query

HTTP Method GET

https://<api-server>/odata/v2/WorkSchedule?$filter=exter-
nalCode eq 'NORM'

 Note

Today means the date fetched from the tenantPreferredTimezone. If this not configured, the system timezone
is used.

Code Examples

Example 1: Retrieve example work schedule defined as SIMPLE model (expand workScheduleDays)

URI: https://<api-server>/odata/v2/WorkSchedule?$filter=externalCode eq 'WS_SIMPLE_TEST'&?

$expand=workScheduleDays &$format=JSON

Method: GET

 Sample Code

{
"d": {
"__metadata": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 727
 "uri": "https://<api-server>/odata/v2/WorkSchedule('WS_SIMPLE_TEST')",
"type": "SFOData.WorkSchedule"
},
"externalCode": "WS_SIMPLE_TEST",
"mdfSystemObjectType": "WorkSchedule",
"lastModifiedDateTime": "/Date(1464090885000+0000)/",
"averageHoursPerDay": "8",
"timeRecordingVariant": "DURATION",
"startingDate": "/Date(978307200000)/",
"mdfSystemRecordId": "5C2CF4E58ABE44738046964DA9FEBE81",
"mdfSystemEntityId": "EF0EA6F4F5F54B57BF33303CB2032F74",
"userId": null,
"mdfSystemStatus": "A",
"externalName_en_US": "Simple Work Schedule Test",
"averageHoursPerMonth": "160",
"externalName_en_SAP_SLS": null,
"createdDate": "/Date(1464098085000)/",
"individualWorkSchedule": false,
"mdfSystemRecordStatus": "N",
"periodModel": null,
"country": null,
"externalName_it_IT": null,
"createdBy": "admin",
"externalName_en_RTL": null,
"createdDateTime": "/Date(1464090885000+0000)/",
"lastModifiedBy": "admin",
"externalName_en_GB": null,
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"externalName_nl_NL": null,
"externalName_zh_CN": null,
"externalName_en_DEBUG": null,
"flexibleRequestingAllowed": false,
"externalName_ko_KR": null,
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"searchString": null,
"externalName_de_DE": null,
"externalName_localized": "Simple Work Schedule Test",
"externalName_es_MX": null,
"externalName_defaultValue": "Simple Work Schedule Test",
"externalName_da_DK": null,
"mdfSystemTransactionSequence": "1",
"externalName_fi_FI": null,
"shiftClassification": null,
"externalName_zh_TW": null,
"lastModifiedDateWithTZ": "/Date(1464090885000+0000)/",
"externalName_ja_JP": null,
"averageHoursPerYear": "8160",
"externalName_pl_PL": null,
"averageWorkingDaysPerWeek": "5",
"modelCategory": "SIMPLE",
"externalName_es_ES": null,
"averageHoursPerWeek": "40",
"lastModifiedDate": "/Date(1464098085000)/",
"externalName_fr_FR": null,
"countryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('WS_SIMPLE_TEST')/
countryNav"
}
},
"modelCategoryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('WS_SIMPLE_TEST')/
modelCategoryNav"
}
},
"workScheduleDayModels": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

728 PUBLIC Time & Attendance Management
 "results": []
},
"periodModelNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('WS_SIMPLE_TEST')/
periodModelNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('WS_SIMPLE_TEST')/
mdfSystemStatusNav"
}
},
"workScheduleDays": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDay(WorkSchedule_externalCode='WS_SIMPLE_TEST',day=6L)",
"type": "SFOData.WorkScheduleDay"
},
"WorkSchedule_externalCode": "WS_SIMPLE_TEST",
"day": "6",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "WorkScheduleDay",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1464090885000+0000)/",
"hoursAndMinutes": "00:00",
"mdfSystemTransactionSequence": "1",
"workingHours": "0",
"mdfSystemRecordId": "C41C48591AF3405D9E7F81A51850C6D5",
"createdBy": "admin",
"mdfSystemEntityId": "FA0B7E6F44684C6FA1D5AABD24D539AC",
"createdDateTime": "/Date(1464090885000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"lastModifiedDate": "/Date(1464098085000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDateWithTZ": "/Date(1464090885000+0000)/",
"createdDate": "/Date(1464098085000)/",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDay(WorkSchedule_externalCode='WS_SIMPLE_TEST',day=6L)/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDay(WorkSchedule_externalCode='WS_SIMPLE_TEST',day=6L)/
mdfSystemStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDay(WorkSchedule_externalCode='WS_SIMPLE_TEST',day=7L)",
"type": "SFOData.WorkScheduleDay"
},
"WorkSchedule_externalCode": "WS_SIMPLE_TEST",
"day": "7",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "WorkScheduleDay",
"mdfSystemVersionId": null,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 729
 "lastModifiedDateTime": "/Date(1464090885000+0000)/",
"hoursAndMinutes": "00:00",
"mdfSystemTransactionSequence": "1",
"workingHours": "0",
"mdfSystemRecordId": "E8807C61A3B34DA59C64BCF09AAFE902",
"createdBy": "admin",
"mdfSystemEntityId": "D27786FC87694948BFE049AC8B109CC1",
"createdDateTime": "/Date(1464090885000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"lastModifiedDate": "/Date(1464098085000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDateWithTZ": "/Date(1464090885000+0000)/",
"createdDate": "/Date(1464098085000)/",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDay(WorkSchedule_externalCode='WS_SIMPLE_TEST',day=7L)/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDay(WorkSchedule_externalCode='WS_SIMPLE_TEST',day=7L)/
mdfSystemStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDay(WorkSchedule_externalCode='WS_SIMPLE_TEST',day=1L)",
"type": "SFOData.WorkScheduleDay"
},
"WorkSchedule_externalCode": "WS_SIMPLE_TEST",
"day": "1",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "WorkScheduleDay",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1464090885000+0000)/",
"hoursAndMinutes": "08:00",
"mdfSystemTransactionSequence": "1",
"workingHours": "8",
"mdfSystemRecordId": "45E4865EF5D544A2B585DE6B2630E1E4",
"createdBy": "admin",
"mdfSystemEntityId": "CA6F7EADDDA6416BA13F09CF8D230751",
"createdDateTime": "/Date(1464090885000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"lastModifiedDate": "/Date(1464098085000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDateWithTZ": "/Date(1464090885000+0000)/",
"createdDate": "/Date(1464098085000)/",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDay(WorkSchedule_externalCode='WS_SIMPLE_TEST',day=1L)/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDay(WorkSchedule_externalCode='WS_SIMPLE_TEST',day=1L)/
mdfSystemStatusNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

730 PUBLIC Time & Attendance Management
 }
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDay(WorkSchedule_externalCode='WS_SIMPLE_TEST',day=2L)",
"type": "SFOData.WorkScheduleDay"
},
"WorkSchedule_externalCode": "WS_SIMPLE_TEST",
"day": "2",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "WorkScheduleDay",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1464090885000+0000)/",
"hoursAndMinutes": "08:00",
"mdfSystemTransactionSequence": "1",
"workingHours": "8",
"mdfSystemRecordId": "61F67B02EA8F4849BEE0D376CB00E111",
"createdBy": "admin",
"mdfSystemEntityId": "6588B07D1A594EC99D3E2D0E954AE5CF",
"createdDateTime": "/Date(1464090885000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"lastModifiedDate": "/Date(1464098085000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDateWithTZ": "/Date(1464090885000+0000)/",
"createdDate": "/Date(1464098085000)/",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDay(WorkSchedule_externalCode='WS_SIMPLE_TEST',day=2L)/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDay(WorkSchedule_externalCode='WS_SIMPLE_TEST',day=2L)/
mdfSystemStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDay(WorkSchedule_externalCode='WS_SIMPLE_TEST',day=3L)",
"type": "SFOData.WorkScheduleDay"
},
"WorkSchedule_externalCode": "WS_SIMPLE_TEST",
"day": "3",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "WorkScheduleDay",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1464090885000+0000)/",
"hoursAndMinutes": "08:00",
"mdfSystemTransactionSequence": "1",
"workingHours": "8",
"mdfSystemRecordId": "790E1A7CCB124D2599BE0A32C3F6FD57",
"createdBy": "admin",
"mdfSystemEntityId": "94AC5AD56F964C679D958B0B05D2B31D",
"createdDateTime": "/Date(1464090885000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"lastModifiedDate": "/Date(1464098085000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDateWithTZ": "/Date(1464090885000+0000)/",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 731
 "createdDate": "/Date(1464098085000)/",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDay(WorkSchedule_externalCode='WS_SIMPLE_TEST',day=3L)/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDay(WorkSchedule_externalCode='WS_SIMPLE_TEST',day=3L)/
mdfSystemStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDay(WorkSchedule_externalCode='WS_SIMPLE_TEST',day=4L)",
"type": "SFOData.WorkScheduleDay"
},
"WorkSchedule_externalCode": "WS_SIMPLE_TEST",
"day": "4",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "WorkScheduleDay",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1464090885000+0000)/",
"hoursAndMinutes": "08:00",
"mdfSystemTransactionSequence": "1",
"workingHours": "8",
"mdfSystemRecordId": "3384506A2AD84A23A977C19D806C30ED",
"createdBy": "admin",
"mdfSystemEntityId": "792E0E542A24401093721D3B57749BE4",
"createdDateTime": "/Date(1464090885000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"lastModifiedDate": "/Date(1464098085000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDateWithTZ": "/Date(1464090885000+0000)/",
"createdDate": "/Date(1464098085000)/",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDay(WorkSchedule_externalCode='WS_SIMPLE_TEST',day=4L)/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDay(WorkSchedule_externalCode='WS_SIMPLE_TEST',day=4L)/
mdfSystemStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDay(WorkSchedule_externalCode='WS_SIMPLE_TEST',day=5L)",
"type": "SFOData.WorkScheduleDay"
},
"WorkSchedule_externalCode": "WS_SIMPLE_TEST",
"day": "5",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "WorkScheduleDay",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

732 PUBLIC Time & Attendance Management
 "mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1464090885000+0000)/",
"hoursAndMinutes": "08:00",
"mdfSystemTransactionSequence": "1",
"workingHours": "8",
"mdfSystemRecordId": "D2F3A6EC1238453982BA21D0F415F7F4",
"createdBy": "admin",
"mdfSystemEntityId": "ADF4EAFBF11A47DF8CD0D5C4D382D45F",
"createdDateTime": "/Date(1464090885000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"lastModifiedDate": "/Date(1464098085000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDateWithTZ": "/Date(1464090885000+0000)/",
"createdDate": "/Date(1464098085000)/",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDay(WorkSchedule_externalCode='WS_SIMPLE_TEST',day=5L)/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDay(WorkSchedule_externalCode='WS_SIMPLE_TEST',day=5L)/
mdfSystemStatusNav"
}
}
}
]
},
"externalNameTranslationTextNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('WS_SIMPLE_TEST')/
externalNameTranslationTextNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('WS_SIMPLE_TEST')/
mdfSystemRecordStatusNav"
}
},
"timeRecordingVariantNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('WS_SIMPLE_TEST')/
timeRecordingVariantNav"
}
},
"userIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('WS_SIMPLE_TEST')/
userIdNav"
}
},
"shiftClassificationNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('WS_SIMPLE_TEST')/
shiftClassificationNav"
}
}
}
}

Example 2: Retrieve example work schedule defined as PERIOD model (expand workScheduleDayModels)

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 733
URI: https://<api-server>/odata/v2/WorkSchedule?$filter=externalCode eq '5DAYS_8HOURS'&?
$expand=workScheduleDays,workScheduleDayModels&$format=JSON

Method: GET

 Sample Code

{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAYS_8HOURS')",
"type": "SFOData.WorkSchedule"
},
"externalCode": "5DAYS_8HOURS",
"mdfSystemObjectType": "WorkSchedule",
"lastModifiedDateTime": "/Date(1433317499000+0000)/",
"averageHoursPerDay": "8",
"timeRecordingVariant": "DURATION",
"startingDate": "/Date(-2208988800000)/",
"mdfSystemRecordId": "6A86982271F541CD884CE18DD95B8808",
"mdfSystemEntityId": "558C5D80215C49548B6F2D5A4DE7F0A5",
"userId": null,
"mdfSystemStatus": "A",
"externalName_en_US": null,
"averageHoursPerMonth": "160",
"externalName_en_SAP_SLS": null,
"createdDate": "/Date(1429632098000)/",
"individualWorkSchedule": false,
"mdfSystemRecordStatus": "N",
"periodModel": null,
"country": null,
"externalName_it_IT": null,
"createdBy": "admin",
"externalName_en_RTL": null,
"createdDateTime": "/Date(1429624898000+0000)/",
"lastModifiedBy": "admin",
"externalName_en_GB": "5 Days 8 Hours",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"externalName_nl_NL": null,
"externalName_zh_CN": null,
"externalName_en_DEBUG": null,
"flexibleRequestingAllowed": false,
"externalName_ko_KR": null,
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"searchString": null,
"externalName_de_DE": null,
"externalName_localized": "5 Days 8 Hours",
"externalName_es_MX": null,
"externalName_defaultValue": "5 Days 8 Hours",
"externalName_da_DK": null,
"mdfSystemTransactionSequence": "1",
"externalName_fi_FI": null,
"shiftClassification": null,
"externalName_zh_TW": null,
"lastModifiedDateWithTZ": "/Date(1433317499000+0000)/",
"externalName_ja_JP": null,
"averageHoursPerYear": "1840",
"externalName_pl_PL": null,
"averageWorkingDaysPerWeek": "5",
"modelCategory": "PERIOD",
"externalName_es_ES": null,
"averageHoursPerWeek": "40",
"lastModifiedDate": "/Date(1433324699000)/",
"externalName_fr_FR": null,
"countryNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

734 PUBLIC Time & Attendance Management
 "uri": "https://<api-server>/odata/v2/WorkSchedule('5DAYS_8HOURS')/
countryNav"
}
},
"modelCategoryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAYS_8HOURS')/
modelCategoryNav"
}
},
"workScheduleDayModels": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=1L)",
"type": "SFOData.WorkScheduleDayModelAssignment"
},
"WorkSchedule_externalCode": "5DAYS_8HOURS",
"day": "1",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "WorkScheduleDayModelAssignment",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1429624898000+0000)/",
"hoursAndMinutes": null,
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "F1EB363BB95D42C89C34E2A966EB4F89",
"mdfSystemEntityId": "DEDAC185C8974157B4EB258AE9014DC9",
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/Date(1429624898000+0000)/",
"createdDate": "/Date(1429632098000)/",
"mdfSystemRecordStatus": "N",
"dayWorkingHours": null,
"dayModel": "8HOURS",
"category": "DAY_MODEL",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1429624898000+0000)/",
"lastModifiedDate": "/Date(1429632098000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"segments": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=1L)/
segments"
}
},
"categoryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=1L)/
categoryNav"
}
},
"dayModelNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=1L)/
dayModelNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=1L)/
mdfSystemRecordStatusNav"
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 735
 "mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=1L)/
mdfSystemStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=2L)",
"type": "SFOData.WorkScheduleDayModelAssignment"
},
"WorkSchedule_externalCode": "5DAYS_8HOURS",
"day": "2",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "WorkScheduleDayModelAssignment",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1429624898000+0000)/",
"hoursAndMinutes": null,
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "14B5EB41E1CB4AC781546FCA0AA5B402",
"mdfSystemEntityId": "23139C1A77664D378F6461E2C8BA1DF3",
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/Date(1429624898000+0000)/",
"createdDate": "/Date(1429632098000)/",
"mdfSystemRecordStatus": "N",
"dayWorkingHours": null,
"dayModel": "8HOURS",
"category": "DAY_MODEL",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1429624898000+0000)/",
"lastModifiedDate": "/Date(1429632098000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"segments": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=2L)/
segments"
}
},
"categoryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=2L)/
categoryNav"
}
},
"dayModelNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=2L)/
dayModelNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=2L)/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

736 PUBLIC Time & Attendance Management
 "uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=2L)/
mdfSystemStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=3L)",
"type": "SFOData.WorkScheduleDayModelAssignment"
},
"WorkSchedule_externalCode": "5DAYS_8HOURS",
"day": "3",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "WorkScheduleDayModelAssignment",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1429624898000+0000)/",
"hoursAndMinutes": null,
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "D8A65407D6D24A8089ED5AD69AB9758A",
"mdfSystemEntityId": "E464D70D77A34247A30F8BF4EECA8002",
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/Date(1429624898000+0000)/",
"createdDate": "/Date(1429632098000)/",
"mdfSystemRecordStatus": "N",
"dayWorkingHours": null,
"dayModel": "8HOURS",
"category": "DAY_MODEL",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1429624898000+0000)/",
"lastModifiedDate": "/Date(1429632098000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"segments": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=3L)/
segments"
}
},
"categoryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=3L)/
categoryNav"
}
},
"dayModelNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=3L)/
dayModelNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=3L)/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=3L)/
mdfSystemStatusNav"
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 737
 }
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=4L)",
"type": "SFOData.WorkScheduleDayModelAssignment"
},
"WorkSchedule_externalCode": "5DAYS_8HOURS",
"day": "4",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "WorkScheduleDayModelAssignment",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1429624898000+0000)/",
"hoursAndMinutes": null,
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "DA9A1A2AF8A249F9A2664570D3B16A89",
"mdfSystemEntityId": "039EF0B7D8D44D1D87ADF1418E935DD6",
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/Date(1429624898000+0000)/",
"createdDate": "/Date(1429632098000)/",
"mdfSystemRecordStatus": "N",
"dayWorkingHours": null,
"dayModel": "8HOURS",
"category": "DAY_MODEL",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1429624898000+0000)/",
"lastModifiedDate": "/Date(1429632098000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"segments": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=4L)/
segments"
}
},
"categoryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=4L)/
categoryNav"
}
},
"dayModelNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=4L)/
dayModelNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=4L)/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=4L)/
mdfSystemStatusNav"
}
}
},
{
"__metadata": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

738 PUBLIC Time & Attendance Management
 "uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=5L)",
"type": "SFOData.WorkScheduleDayModelAssignment"
},
"WorkSchedule_externalCode": "5DAYS_8HOURS",
"day": "5",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "WorkScheduleDayModelAssignment",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1429624898000+0000)/",
"hoursAndMinutes": null,
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "2DB34CF519FC467891C79399141A6282",
"mdfSystemEntityId": "8ED243EBC2DD4916B12D4B29C83AE30E",
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/Date(1429624898000+0000)/",
"createdDate": "/Date(1429632098000)/",
"mdfSystemRecordStatus": "N",
"dayWorkingHours": null,
"dayModel": "8HOURS",
"category": "DAY_MODEL",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1429624898000+0000)/",
"lastModifiedDate": "/Date(1429632098000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"segments": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=5L)/
segments"
}
},
"categoryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=5L)/
categoryNav"
}
},
"dayModelNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=5L)/
dayModelNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=5L)/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=5L)/
mdfSystemStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=6L)",
"type": "SFOData.WorkScheduleDayModelAssignment"
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 739
 "WorkSchedule_externalCode": "5DAYS_8HOURS",
"day": "6",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "WorkScheduleDayModelAssignment",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1429624898000+0000)/",
"hoursAndMinutes": null,
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "C4C69CEF8DB6492CA52A95DD69B26F95",
"mdfSystemEntityId": "C3E23E50761B4A55B5B4782CA66EEAE5",
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/Date(1429624898000+0000)/",
"createdDate": "/Date(1429632098000)/",
"mdfSystemRecordStatus": "N",
"dayWorkingHours": null,
"dayModel": "0HOURS",
"category": "DAY_MODEL",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1429624898000+0000)/",
"lastModifiedDate": "/Date(1429632098000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"segments": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=6L)/
segments"
}
},
"categoryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=6L)/
categoryNav"
}
},
"dayModelNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=6L)/
dayModelNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=6L)/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=6L)/
mdfSystemStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=7L)",
"type": "SFOData.WorkScheduleDayModelAssignment"
},
"WorkSchedule_externalCode": "5DAYS_8HOURS",
"day": "7",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "WorkScheduleDayModelAssignment",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

740 PUBLIC Time & Attendance Management
 "mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1429624898000+0000)/",
"hoursAndMinutes": null,
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "42A021ED54AB4EBFBC0E08C59C668730",
"mdfSystemEntityId": "118DE2C94400456D9179520778D0E94A",
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/Date(1429624898000+0000)/",
"createdDate": "/Date(1429632098000)/",
"mdfSystemRecordStatus": "N",
"dayWorkingHours": null,
"dayModel": "0HOURS",
"category": "DAY_MODEL",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1429624898000+0000)/",
"lastModifiedDate": "/Date(1429632098000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"segments": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=7L)/
segments"
}
},
"categoryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=7L)/
categoryNav"
}
},
"dayModelNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=7L)/
dayModelNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=7L)/
mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='5DAYS_8HOURS',day=7L)/
mdfSystemStatusNav"
}
}
}
]
},
"periodModelNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAYS_8HOURS')/
periodModelNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAYS_8HOURS')/
mdfSystemStatusNav"
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 741
 "workScheduleDays": {
"results": []
},
"externalNameTranslationTextNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAYS_8HOURS')/
externalNameTranslationTextNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAYS_8HOURS')/
mdfSystemRecordStatusNav"
}
},
"timeRecordingVariantNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAYS_8HOURS')/
timeRecordingVariantNav"
}
},
"userIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAYS_8HOURS')/
userIdNav"
}
},
"shiftClassificationNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAYS_8HOURS')/
shiftClassificationNav"
}
}
}
}

Example 3: Retrieve example work schedule defined as SCHEDULE model (expand periodModelNav)

URI: https://<api-server>/odata/v2/WorkSchedule?$filter=externalCode eq 'WS_SCHEDULE_EXAMPLE'&?

$expand=periodModelNav&$format=JSON

Method: GET

 Sample Code

{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('WS_SCHEDULE_EXAMPLE')",
"type": "SFOData.WorkSchedule"
},
"externalCode": "WS_SCHEDULE_EXAMPLE",
"mdfSystemObjectType": "WorkSchedule",
"lastModifiedDateTime": "/Date(1464156863000+0000)/",
"averageHoursPerDay": null,
"timeRecordingVariant": "DURATION",
"startingDate": "/Date(1464739200000)/",
"mdfSystemRecordId": "DE20B024E70446EC8C66FE8B3BE99F73",
"mdfSystemEntityId": "AA994A78C1E84BADB36FE9F60A5388D4",
"userId": null,
"mdfSystemStatus": "A",
"externalName_en_US": "WS Schedule Model Example",
"averageHoursPerMonth": null,
"externalName_en_SAP_SLS": null,
"createdDate": "/Date(1464164063000)/",
"individualWorkSchedule": false,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

742 PUBLIC Time & Attendance Management
 "mdfSystemRecordStatus": "N",
"periodModel": "5DAYS_8HOURS",
"country": null,
"externalName_it_IT": null,
"createdBy": "admin",
"externalName_en_RTL": null,
"createdDateTime": "/Date(1464156863000+0000)/",
"lastModifiedBy": "admin",
"externalName_en_GB": null,
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"externalName_nl_NL": null,
"externalName_zh_CN": null,
"externalName_en_DEBUG": null,
"flexibleRequestingAllowed": false,
"externalName_ko_KR": null,
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"searchString": null,
"externalName_de_DE": null,
"externalName_localized": "WS Schedule Model Example",
"externalName_es_MX": null,
"externalName_defaultValue": "WS Schedule Model Example",
"externalName_da_DK": null,
"mdfSystemTransactionSequence": "1",
"externalName_fi_FI": null,
"shiftClassification": null,
"externalName_zh_TW": null,
"lastModifiedDateWithTZ": "/Date(1464156863000+0000)/",
"externalName_ja_JP": null,
"averageHoursPerYear": null,
"externalName_pl_PL": null,
"averageWorkingDaysPerWeek": null,
"modelCategory": "SCHEDULE",
"externalName_es_ES": null,
"averageHoursPerWeek": null,
"lastModifiedDate": "/Date(1464164063000)/",
"externalName_fr_FR": null,
"countryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkSchedule('WS_SCHEDULE_EXAMPLE')/countryNav"
}
},
"modelCategoryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkSchedule('WS_SCHEDULE_EXAMPLE')/modelCategoryNav"
}
},
"workScheduleDayModels": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkSchedule('WS_SCHEDULE_EXAMPLE')/workScheduleDayModels"
}
},
"periodModelNav": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAYS_8HOURS')",
"type": "SFOData.WorkSchedule"
},
"externalCode": "5DAYS_8HOURS",
"mdfSystemObjectType": "WorkSchedule",
"lastModifiedDateTime": "/Date(1433317499000+0000)/",
"averageHoursPerDay": "8",
"timeRecordingVariant": "DURATION",
"startingDate": "/Date(-2208988800000)/",
"mdfSystemRecordId": "6A86982271F541CD884CE18DD95B8808",
"mdfSystemEntityId": "558C5D80215C49548B6F2D5A4DE7F0A5",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 743
 "userId": null,
"mdfSystemStatus": "A",
"externalName_en_US": null,
"averageHoursPerMonth": "160",
"externalName_en_SAP_SLS": null,
"createdDate": "/Date(1429632098000)/",
"individualWorkSchedule": false,
"mdfSystemRecordStatus": "N",
"periodModel": null,
"country": null,
"externalName_it_IT": null,
"createdBy": "admin",
"externalName_en_RTL": null,
"createdDateTime": "/Date(1429624898000+0000)/",
"lastModifiedBy": "admin",
"externalName_en_GB": "5 Days 8 Hours",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"externalName_nl_NL": null,
"externalName_zh_CN": null,
"externalName_en_DEBUG": null,
"flexibleRequestingAllowed": false,
"externalName_ko_KR": null,
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"searchString": null,
"externalName_de_DE": null,
"externalName_localized": "5 Days 8 Hours",
"externalName_es_MX": null,
"externalName_defaultValue": "5 Days 8 Hours",
"externalName_da_DK": null,
"mdfSystemTransactionSequence": "1",
"externalName_fi_FI": null,
"shiftClassification": null,
"externalName_zh_TW": null,
"lastModifiedDateWithTZ": "/Date(1433317499000+0000)/",
"externalName_ja_JP": null,
"averageHoursPerYear": "1840",
"externalName_pl_PL": null,
"averageWorkingDaysPerWeek": "5",
"modelCategory": "PERIOD",
"externalName_es_ES": null,
"averageHoursPerWeek": "40",
"lastModifiedDate": "/Date(1433324699000)/",
"externalName_fr_FR": null,
"countryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAYS_8HOURS')/
countryNav"
}
},
"modelCategoryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAYS_8HOURS')/
modelCategoryNav"
}
},
"workScheduleDayModels": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAYS_8HOURS')/
workScheduleDayModels"
}
},
"periodModelNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAYS_8HOURS')/
periodModelNav"
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

744 PUBLIC Time & Attendance Management
 "mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAYS_8HOURS')/
mdfSystemStatusNav"
}
},
"workScheduleDays": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAYS_8HOURS')/
workScheduleDays"
}
},
"externalNameTranslationTextNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAYS_8HOURS')/
externalNameTranslationTextNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAYS_8HOURS')/
mdfSystemRecordStatusNav"
}
},
"timeRecordingVariantNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAYS_8HOURS')/
timeRecordingVariantNav"
}
},
"userIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAYS_8HOURS')/
userIdNav"
}
},
"shiftClassificationNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAYS_8HOURS')/
shiftClassificationNav"
}
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkSchedule('WS_SCHEDULE_EXAMPLE')/mdfSystemStatusNav"
}
},
"workScheduleDays": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkSchedule('WS_SCHEDULE_EXAMPLE')/workScheduleDays"
}
},
"externalNameTranslationTextNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkSchedule('WS_SCHEDULE_EXAMPLE')/externalNameTranslationTextNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkSchedule('WS_SCHEDULE_EXAMPLE')/mdfSystemRecordStatusNav"
}
},
"timeRecordingVariantNav": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 745
 "__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkSchedule('WS_SCHEDULE_EXAMPLE')/timeRecordingVariantNav"
}
},
"userIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkSchedule('WS_SCHEDULE_EXAMPLE')/userIdNav"
}
},
"shiftClassificationNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkSchedule('WS_SCHEDULE_EXAMPLE')/shiftClassificationNav"
}
}
}
}

Example 4: Create a work schedule defined as SCHEDULE model

URI: http://<api-server>/odata/v2/WorkSchedule/?$format=JSON

Method: POST

Body

 Sample Code

{
"externalCode":"5DAY8HOURo",
"externalName_defaultValue":"5DAY8HOURo",
"timeRecordingVariant":"DURATION",
"startingDate":"/Date(1136073600000)/",
"individualWorkSchedule":false,
"modelCategory":"SCHEDULE",
"periodModelNav":{
"__deferred":{
"uri":"https://<api-server>/odata/v2/WorkSchedule('5DAY8HOUR')/
periodModelNav"
}
}
}

Response

 Sample Code

{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAY8HOURo')",
"type": "SFOData.WorkSchedule"
},
"externalName_defaultValue": "5DAY8HOURo",
"timeRecordingVariant": "DURATION",
"startingDate": "/Date(1136073600000)/",
"individualWorkSchedule": false,
"modelCategory": "SCHEDULE",
"externalCode": "5DAY8HOURo",
"periodModelNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAY8HOURo')/
periodModelNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

746 PUBLIC Time & Attendance Management
 }
}
}
}

Example 5: Update a work schedule defined as SCHEDULE model

URI: http://<api-server>/odata/v2/WorkSchedule('5DAY8HOURo')/?$format=JSON

Method: PUT

 Sample Code

{
"externalCode":"5DAY8HOURo",
"externalName_defaultValue":"5DAY8HOURo",
"timeRecordingVariant":"DURATION",
"startingDate":"/Date(1167609600000)/",
"individualWorkSchedule":false,
"modelCategory":"SCHEDULE",
"periodModelNav":{
"__deferred":{
"uri":"https://<api-server>/odata/v2/WorkSchedule('5DAY8HOUR')/
periodModelNav"
}
}
}

Example 6: Upsert a work schedule defined as SCHEDULE model

URI: http://<api-server>/odata/v2/upsert?$format=JSON

Method: POST

Body:

 Sample Code

{
"__metadata": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAY8HOURo')",
"type": "SFOData.WorkSchedule"
},
"externalCode": "5DAY8HOURo",
"externalName_defaultValue": "5DAY8HOURo",
"timeRecordingVariant": "DURATION",
"startingDate": "/Date(1136073600000)/",
"individualWorkSchedule": false,
"modelCategory": "SCHEDULE",
"periodModelNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('5DAY8HOUR')/
periodModelNav"
}
}
}

Response:

 Sample Code

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 747
 "d": [
{
"key": null,
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
}

Example 7: Delete a work schedule

URI: http://<api-server>/odata/v2/WorkSchedule('5DAY8HOURo')?$format=JSON

Method: DELETE

 Sample Code

Related Information

SAP API Business Hub: Time Off

16.1.30 WorkScheduleDayModel

With a work schedule day model, you can define how the number of hours worked on a particular day should look.
You can then use the day models in your work schedule if you choose the Period or Schedule models in your work
schedule.

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Navigation Properties

Navigation Property Related Entity Description

countryNav Country Navigation to Country

shiftClassificationNav ShiftClassification Navigation to Shift Classification

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

748 PUBLIC Time & Attendance Management
 Navigation Property Related Entity Description

segments WorkScheduleDayModelAssignmentSeg­ Navigation to WorkScheduleDayMode­

ment lAssignmentSegment

Code Examples

Example 1: Retrieve a specific work schedule day model

URI: http://<api-server>/odata/v2/WorkScheduleDayModel('CLT_0800-1700')?$format=JSON

Method: GET

Response:

 Sample Code

{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModel('CLT_0800-1700')",
"type": "SFOData.WorkScheduleDayModel"
},
"externalCode": "CLT_0800-1700",
"externalName_ko_KR": null,
"mdfSystemObjectType": "WorkScheduleDayModel",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"externalName_pt_BR": null,
"externalName_de_DE": null,
"externalName_localized": "CLT - 08:00 - 17:00 w/ Breaks",
"externalName_defaultValue": "CLT - 08:00 - 17:00 w/ Breaks",
"externalName_fr_CA": null,
"externalName_ru_RU": null,
"lastModifiedDateTime": "/Date(1446562100000+0000)/",
"hoursAndMinutes": "08:00",
"timeRecordingVariant": "CLOCK_TIME",
"mdfSystemTransactionSequence": "1",
"workingHours": "8",
"mdfSystemRecordId": "0D65A9DA816541AAA95A17C7300A40AA",
"shiftClassification": null,
"mdfSystemEntityId": "7CCB5D6266B94FD3AAC92B08E3BD5135",
"description": null,
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/Date(1446562100000+0000)/",
"externalName_en_US": "CLT - 08:00 - 17:00 w/ Breaks",
"externalName_en_SAP_SLS": null,
"createdDate": "/Date(1446562100000)/",
"externalName_ja_JP": null,
"mdfSystemRecordStatus": "N",
"country": null,
"createdBy": "admin",
"externalName_it_IT": null,
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1446562100000+0000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDate": "/Date(1446562100000)/",
"externalName_en_GB": null,
"externalName_es_ES": null,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 749
 "externalName_nl_NL": null,
"externalName_zh_CN": null,
"externalName_fr_FR": null,
"segments": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModel('CLT_0800-1700')/segments"
}
},
"countryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModel('CLT_0800-1700')/countryNav"
}
},
"externalNameTranslationTextNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModel('CLT_0800-1700')/externalNameTranslationTextNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModel('CLT_0800-1700')/wfRequestNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModel('CLT_0800-1700')/mdfSystemRecordStatusNav"
}
},
"timeRecordingVariantNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModel('CLT_0800-1700')/timeRecordingVariantNav"
}
},
"shiftClassificationNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModel('CLT_0800-1700')/shiftClassificationNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModel('CLT_0800-1700')/mdfSystemStatusNav"
}
}
}
}

Example 2: Create a work schedule day model

URI: http://<api-server>/odata/v2/WorkScheduleDayModel?$format=JSON

Method: POST

Body:

 Sample Code

{
"externalCode": "DUR_odata",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

750 PUBLIC Time & Attendance Management
 "externalName_defaultValue": "DUR_odata",
"timeRecordingVariant": "DURATION",
"workingHours": "8"
}

Response:

 Sample Code

{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModel('DUR_odata')",
"type": "SFOData.WorkScheduleDayModel"
},
"externalName_defaultValue": "DUR_odata",
"timeRecordingVariant": "DURATION",
"workingHours": "8",
"externalCode": "DUR_odata"
}
}

Example 3: Update a work schedule day model

URI: http://<api-server>/odata/v2/WorkScheduleDayModel('DUR_odata')?$format=JSON

Method: PUT

Body:

 Sample Code

{
"externalCode": "DUR_odata",
"externalName_defaultValue": "DUR_odata",
"timeRecordingVariant": "DURATION",
"workingHours": "6"
}

Example 4: Upsert a work schedule day model

URI: http://<api-server>/odata/v2/upsert?$format=JSON

Method: POST

Body:

 Sample Code

{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModel('DUR_odata')",
"type": "SFOData.WorkScheduleDayModel"
},
"externalCode": "DUR_odata",
"externalName_defaultValue": "DUR_odata",
"timeRecordingVariant": "DURATION",
"workingHours": "4"
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 751
Response:

 Sample Code

{
"d": [
{
"key": null,
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Example 5: Delete a work schedule day model

URI: http://<api-server>/odata/v2/WorkScheduleDayModel('DUR_odata')?$format=JSON

Method: DELETE

Related Information

SAP API Business Hub: Time Off

16.1.31 WorkScheduleDayModelAssignment

With a work schedule day model assignment, you can define how the number of hours worked on a particular day
should look.

Supported Operations

Query, Insert, Merge, Replace, Upsert, Delete

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

752 PUBLIC Time & Attendance Management
Navigation Properties

Navigation Propertz Related Entitiy Description

dayModelNav WorkScheduleDayModel Navigation to WorkScheduleDayModel

segments WorkScheduleDayModelAssignmentSeg­ Navigation to WorkScheduleDayMode­

ment lAssignmentSegment

Code Examples

For code examples, please read look at Example 2 in the WorkSchedule [page 725] documentation.

Related Information

SAP API Business Hub: Time Off

16.1.32 WorkScheduleDayModelAssignmentSegment

A WorkScheduleDayModelAssignmentSegment is used within a WorkScheduleDayModelAssignment. Such a

segment is used to define the working time as well as the unpaid breaks for a day.

Supported Operations

Query, Insert, Merge, Replace, Upsert, Delete

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Property Description

externalCode External Code. This is a business key and is required.

startTime Start time of the segment. Required.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 753
Property Description

endTime End time of the segment. Required.

duration Duration in minutes between start time and end time

category Work schedule segment model category. Can be SCHED­

ULED_WORKING_TIME or SCHEDULED_UNPAID_BREAK

Use Case: Retrieve the work schedule day model assignments and the
corresponding segments for a defined work schedule

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/
WorkSchedule('WS_PERIOD_TEST')?
$expand=workScheduleDayModels,workScheduleDayModels/
segments&$format=JSON

Response

 Sample Code

{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('WS_PERIOD_TEST')",
"type": "SFOData.WorkSchedule"
},
"externalCode": "WS_PERIOD_TEST",
"mdfSystemObjectType": "WorkSchedule",
"lastModifiedDateTime": "/Date(1464186573000+0000)/",
"averageHoursPerDay": null,
"timeRecordingVariant": "CLOCK_TIME",
"startingDate": "/Date(978307200000)/",
"mdfSystemRecordId": "DA634C4D7BE34AEBBEE92D9A737C0E41",
"mdfSystemEntityId": "961371476F5A4AF599A7C30EA1CF852D",
"userId": null,
"mdfSystemStatus": "A",
"externalName_en_US": "WS Period Test",
"averageHoursPerMonth": null,
"externalName_en_SAP_SLS": null,
"createdDate": "/Date(1464193773000)/",
"individualWorkSchedule": false,
"mdfSystemRecordStatus": "N",
"periodModel": null,
"country": null,
"externalName_it_IT": null,
"createdBy": "admin",
"externalName_en_RTL": null,
"createdDateTime": "/Date(1464186573000+0000)/",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

754 PUBLIC Time & Attendance Management
 "lastModifiedBy": "admin",
"externalName_en_GB": null,
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"externalName_nl_NL": null,
"externalName_zh_CN": null,
"externalName_en_DEBUG": null,
"flexibleRequestingAllowed": false,
"externalName_ko_KR": null,
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"searchString": null,
"externalName_de_DE": null,
"externalName_localized": "WS Period Test",
"externalName_es_MX": null,
"externalName_defaultValue": "WS Period Test",
"externalName_da_DK": null,
"mdfSystemTransactionSequence": "1",
"externalName_fi_FI": null,
"shiftClassification": null,
"externalName_zh_TW": null,
"lastModifiedDateWithTZ": "/Date(1464186573000+0000)/",
"externalName_ja_JP": null,
"averageHoursPerYear": null,
"externalName_pl_PL": null,
"averageWorkingDaysPerWeek": null,
"modelCategory": "PERIOD",
"externalName_es_ES": null,
"averageHoursPerWeek": null,
"lastModifiedDate": "/Date(1464193773000)/",
"externalName_fr_FR": null,
"countryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('WS_PERIOD_TEST')/
countryNav"
}
},
"modelCategoryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('WS_PERIOD_TEST')/
modelCategoryNav"
}
},
"workScheduleDayModels": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='WS_PERIOD_TEST',day=1L)
",
"type": "SFOData.WorkScheduleDayModelAssignment"
},
"WorkSchedule_externalCode": "WS_PERIOD_TEST",
"day": "1",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "WorkScheduleDayModelAssignment",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1464186573000+0000)/",
"hoursAndMinutes": "08:00",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "B007E4B5175A410DB7EA8CDA0301D2B4",
"mdfSystemEntityId": "D799427D28E14D4ABA161D4EA14637B8",
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/Date(1464186573000+0000)/",
"createdDate": "/Date(1464193773000)/",
"mdfSystemRecordStatus": "N",
"dayWorkingHours": "8",
"dayModel": null,
"category": "PLANNED_HOURS",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 755
 "createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1464186573000+0000)/",
"lastModifiedDate": "/Date(1464193773000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"segments": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignmentSegment(WorkScheduleDayModelAssignment_day=1L,WorkS
chedule_externalCode='WS_PERIOD_TEST',externalCode='1')",
"type": "SFOData.WorkScheduleDayModelAssignmentSegment"
},
"WorkScheduleDayModelAssignment_day": "1",
"WorkSchedule_externalCode": "WS_PERIOD_TEST",
"externalCode": "1",
"mdfSystemObjectType": "WorkScheduleDayModelAssignmentSegment",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1464186573000+0000)/",
"endTime": "PT17H",
"mdfSystemTransactionSequence": "1",
"startTime": "PT8H",
"category": "SCHEDULED_WORKING_TIME",
"duration": "540",
"mdfSystemRecordId": "DEA7B2BFB755405985B87EA70A10385E",
"createdBy": "admin",
"mdfSystemEntityId": "8F615EA9BBFC4E4BB4B0EE493778BBE3",
"createdDateTime": "/Date(1464186573000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDate": "/Date(1464193773000)/",
"lastModifiedDateWithTZ": "/Date(1464186573000+0000)/",
"createdDate": "/Date(1464193773000)/",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignmentSegment(WorkScheduleDayModelAssignment_day=1L,WorkS
chedule_externalCode='WS_PERIOD_TEST',externalCode='1')/mdfSystemRecordStatusNav"
}
},
"categoryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignmentSegment(WorkScheduleDayModelAssignment_day=1L,WorkS
chedule_externalCode='WS_PERIOD_TEST',externalCode='1')/categoryNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignmentSegment(WorkScheduleDayModelAssignment_day=1L,WorkS
chedule_externalCode='WS_PERIOD_TEST',externalCode='1')/mdfSystemStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignmentSegment(WorkScheduleDayModelAssignment_day=1L,WorkS
chedule_externalCode='WS_PERIOD_TEST',externalCode='2')",
"type": "SFOData.WorkScheduleDayModelAssignmentSegment"
},
"WorkScheduleDayModelAssignment_day": "1",
"WorkSchedule_externalCode": "WS_PERIOD_TEST",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

756 PUBLIC Time & Attendance Management
 "externalCode": "2",
"mdfSystemObjectType": "WorkScheduleDayModelAssignmentSegment",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1464186573000+0000)/",
"endTime": "PT13H",
"mdfSystemTransactionSequence": "1",
"startTime": "PT12H",
"category": "SCHEDULED_UNPAID_BREAK",
"duration": "60",
"mdfSystemRecordId": "E61122E727BA449A9EFB4B7C48F33682",
"createdBy": "admin",
"mdfSystemEntityId": "E8D69D75BD6747F7ACCD518306110F37",
"createdDateTime": "/Date(1464186573000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDate": "/Date(1464193773000)/",
"lastModifiedDateWithTZ": "/Date(1464186573000+0000)/",
"createdDate": "/Date(1464193773000)/",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignmentSegment(WorkScheduleDayModelAssignment_day=1L,WorkS
chedule_externalCode='WS_PERIOD_TEST',externalCode='2')/mdfSystemRecordStatusNav"
}
},
"categoryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignmentSegment(WorkScheduleDayModelAssignment_day=1L,WorkS
chedule_externalCode='WS_PERIOD_TEST',externalCode='2')/categoryNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignmentSegment(WorkScheduleDayModelAssignment_day=1L,WorkS
chedule_externalCode='WS_PERIOD_TEST',externalCode='2')/mdfSystemStatusNav"
}
}
}
]
},
"categoryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='WS_PERIOD_TEST',day=1L)
/categoryNav"
}
},
"dayModelNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='WS_PERIOD_TEST',day=1L)
/dayModelNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='WS_PERIOD_TEST',day=1L)
/mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 757
 "uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='WS_PERIOD_TEST',day=1L)
/mdfSystemStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='WS_PERIOD_TEST',day=2L)
",
"type": "SFOData.WorkScheduleDayModelAssignment"
},
"WorkSchedule_externalCode": "WS_PERIOD_TEST",
"day": "2",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemObjectType": "WorkScheduleDayModelAssignment",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1464186573000+0000)/",
"hoursAndMinutes": "00:00",
"mdfSystemTransactionSequence": "1",
"mdfSystemRecordId": "DF367A81C8CF4D7CAE37A74C2B8D8B89",
"mdfSystemEntityId": "7DE36BB95882498D924C0D1C780E4616",
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/Date(1464186573000+0000)/",
"createdDate": "/Date(1464193773000)/",
"mdfSystemRecordStatus": "N",
"dayWorkingHours": "0",
"dayModel": null,
"category": "OFF",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1464186573000+0000)/",
"lastModifiedDate": "/Date(1464193773000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"segments": {
"results": []
},
"categoryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='WS_PERIOD_TEST',day=2L)
/categoryNav"
}
},
"dayModelNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='WS_PERIOD_TEST',day=2L)
/dayModelNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='WS_PERIOD_TEST',day=2L)
/mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelAssignment(WorkSchedule_externalCode='WS_PERIOD_TEST',day=2L)
/mdfSystemStatusNav"
}
}
}
]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

758 PUBLIC Time & Attendance Management
 },
"periodModelNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('WS_PERIOD_TEST')/
periodModelNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('WS_PERIOD_TEST')/
mdfSystemStatusNav"
}
},
"workScheduleDays": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('WS_PERIOD_TEST')/
workScheduleDays"
}
},
"externalNameTranslationTextNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('WS_PERIOD_TEST')/
externalNameTranslationTextNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('WS_PERIOD_TEST')/
mdfSystemRecordStatusNav"
}
},
"timeRecordingVariantNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('WS_PERIOD_TEST')/
timeRecordingVariantNav"
}
},
"userIdNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('WS_PERIOD_TEST')/
userIdNav"
}
},
"shiftClassificationNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WorkSchedule('WS_PERIOD_TEST')/
shiftClassificationNav"
}
}
}
}

Related Information

SAP API Business Hub: Time Off

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 759
16.1.33 WorkScheduleDayModelSegment

A WorkScheduleDayModelSegment used within a WorkScheduleDayModel. Such a segment is used to define the

working time as well as the unpaid breaks for a day.

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Code Examples

Example: Get the work schedule day model segments for a work schedule day model

URI: http://<api-server>/odata/v2/WorkScheduleDayModel('08:00-16:00_15MB_60LB')?$expand=segments&
$format=JSON

 Sample Code

{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModel('08:00-16:00_15MB_60LB')",
"type": "SFOData.WorkScheduleDayModel"
},
"externalCode": "08:00-16:00_15MB_60LB",
"externalName_ko_KR": null,
"mdfSystemObjectType": "WorkScheduleDayModel",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"externalName_de_DE": null,
"externalName_localized": "08:00 - 16:00 (15 min MB, 60 min LB)",
"externalName_defaultValue": "08:00 - 16:00 (15 min MB, 60 min LB)",
"externalName_es_MX": null,
"lastModifiedDateTime": "/Date(1464069892000+0000)/",
"externalName_da_DK": null,
"hoursAndMinutes": "06:45",
"timeRecordingVariant": "CLOCK_TIME",
"mdfSystemTransactionSequence": "1",
"externalName_fi_FI": null,
"workingHours": "6.75",
"mdfSystemRecordId": "3F852D69599F47F19619E5A3E539131A",
"shiftClassification": null,
"mdfSystemEntityId": "45571C76E084410EA47AC84183A54B41",
"description": null,
"mdfSystemStatus": "A",
"lastModifiedDateWithTZ": "/Date(1464069892000+0000)/",
"externalName_zh_TW": null,
"externalName_en_US": "08:00 - 16:00 (15 min MB, 60 min LB)",
"externalName_en_SAP_SLS": null,
"createdDate": "/Date(1442412745000)/",
"externalName_ja_JP": null,
"mdfSystemRecordStatus": "N",
"externalName_pl_PL": null,
"country": null,
"createdBy": "admin",
"externalName_it_IT": null,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

760 PUBLIC Time & Attendance Management
 "externalName_en_RTL": null,
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1442405545000+0000)/",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDate": "/Date(1464077092000)/",
"externalName_en_GB": null,
"externalName_es_ES": null,
"externalName_nl_NL": null,
"externalName_zh_CN": null,
"externalName_en_DEBUG": null,
"externalName_fr_FR": null,
"segments": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelSegment(WorkScheduleDayModel_externalCode='08:00-16:00_15MB_6
0LB',externalCode='1')",
"type": "SFOData.WorkScheduleDayModelSegment"
},
"externalCode": "1",
"WorkScheduleDayModel_externalCode": "08:00-16:00_15MB_60LB",
"mdfSystemObjectType": "WorkScheduleDayModelSegment",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1464069892000+0000)/",
"endTime": "PT16H",
"mdfSystemTransactionSequence": "1",
"startTime": "PT8H",
"category": "SCHEDULED_WORKING_TIME",
"duration": "480",
"mdfSystemRecordId": "6209E4F838C3461C949AF6675AF4D771",
"createdBy": "admin",
"mdfSystemEntityId": "EA98C5EF73714B1188385F376468693F",
"createdDateTime": "/Date(1442405545000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDate": "/Date(1464077092000)/",
"lastModifiedDateWithTZ": "/Date(1464069892000+0000)/",
"createdDate": "/Date(1442412745000)/",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelSegment(WorkScheduleDayModel_externalCode='08:00-16:00_15MB_6
0LB',externalCode='1')/mdfSystemRecordStatusNav"
}
},
"categoryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelSegment(WorkScheduleDayModel_externalCode='08:00-16:00_15MB_6
0LB',externalCode='1')/categoryNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelSegment(WorkScheduleDayModel_externalCode='08:00-16:00_15MB_6
0LB',externalCode='1')/mdfSystemStatusNav"
}
}
},
{
"__metadata": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 761
 "uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelSegment(WorkScheduleDayModel_externalCode='08:00-16:00_15MB_6
0LB',externalCode='2')",
"type": "SFOData.WorkScheduleDayModelSegment"
},
"externalCode": "2",
"WorkScheduleDayModel_externalCode": "08:00-16:00_15MB_60LB",
"mdfSystemObjectType": "WorkScheduleDayModelSegment",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1464069892000+0000)/",
"endTime": "PT9H15M",
"mdfSystemTransactionSequence": "1",
"startTime": "PT9H",
"category": "SCHEDULED_UNPAID_BREAK",
"duration": "15",
"mdfSystemRecordId": "7BC3ACCC35764B5280A62ABC4B1E732E",
"createdBy": "admin",
"mdfSystemEntityId": "D4EF84F8BDC7459AA94E16C491399ADE",
"createdDateTime": "/Date(1442405545000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDate": "/Date(1464077092000)/",
"lastModifiedDateWithTZ": "/Date(1464069892000+0000)/",
"createdDate": "/Date(1442412745000)/",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelSegment(WorkScheduleDayModel_externalCode='08:00-16:00_15MB_6
0LB',externalCode='2')/mdfSystemRecordStatusNav"
}
},
"categoryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelSegment(WorkScheduleDayModel_externalCode='08:00-16:00_15MB_6
0LB',externalCode='2')/categoryNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelSegment(WorkScheduleDayModel_externalCode='08:00-16:00_15MB_6
0LB',externalCode='2')/mdfSystemStatusNav"
}
}
},
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelSegment(WorkScheduleDayModel_externalCode='08:00-16:00_15MB_6
0LB',externalCode='3')",
"type": "SFOData.WorkScheduleDayModelSegment"
},
"externalCode": "3",
"WorkScheduleDayModel_externalCode": "08:00-16:00_15MB_60LB",
"mdfSystemObjectType": "WorkScheduleDayModelSegment",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1464069892000+0000)/",
"endTime": "PT13H",
"mdfSystemTransactionSequence": "1",
"startTime": "PT12H",
"category": "SCHEDULED_UNPAID_BREAK",
"duration": "60",
"mdfSystemRecordId": "AC610A4B44754855B15F60873BE2C3EE",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

762 PUBLIC Time & Attendance Management
 "createdBy": "admin",
"mdfSystemEntityId": "90EA084FAE614D3592B6B6EC6509641E",
"createdDateTime": "/Date(1442405545000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"lastModifiedDate": "/Date(1464077092000)/",
"lastModifiedDateWithTZ": "/Date(1464069892000+0000)/",
"createdDate": "/Date(1442412745000)/",
"mdfSystemRecordStatus": "N",
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelSegment(WorkScheduleDayModel_externalCode='08:00-16:00_15MB_6
0LB',externalCode='3')/mdfSystemRecordStatusNav"
}
},
"categoryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelSegment(WorkScheduleDayModel_externalCode='08:00-16:00_15MB_6
0LB',externalCode='3')/categoryNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModelSegment(WorkScheduleDayModel_externalCode='08:00-16:00_15MB_6
0LB',externalCode='3')/mdfSystemStatusNav"
}
}
}
]
},
"countryNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModel('08:00-16:00_15MB_60LB')/countryNav"
}
},
"externalNameTranslationTextNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModel('08:00-16:00_15MB_60LB')/externalNameTranslationTextNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModel('08:00-16:00_15MB_60LB')/mdfSystemRecordStatusNav"
}
},
"timeRecordingVariantNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModel('08:00-16:00_15MB_60LB')/timeRecordingVariantNav"
}
},
"shiftClassificationNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModel('08:00-16:00_15MB_60LB')/shiftClassificationNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/
WorkScheduleDayModel('08:00-16:00_15MB_60LB')/mdfSystemStatusNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 763
 }
}
}
}

Related Information

SAP API Business Hub: Time Off

16.1.34 WorkScheduleDay

Work schedule day defines the working time on a day. This entity is only used for work schedule of type SIMPLE.

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Properties

Here you can see the required fields and business keys for this entity. Check the OData API dictionary in your
instance to see the complete list of properties, and check your metadata for navigations and associations.

Property Business Key Required Field Description

externalCode Yes Yes External Code

day No Yes Day of the work schedule

workingHours No Yes Working hours on that day as

decimal value

hoursAndMinutes No No Working hours on that day in

hours and minutes

Code Examples

For code examples, please look at Example 1 in the WorkSchedule [page 725] documentation.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

764 PUBLIC Time & Attendance Management
Related Information

SAP API Business Hub: Time Off

16.2 Time Recording Objects

In this section, you'll find the APIs available for time recording functionalities. Employees can record their
attendances, overtime, on-call times, and allowances.

Before using any of the time recording entities described here, you need to activate them.

In addition, you need to have permission to use the individual objects in question.

16.2.1 ExternalTimeData

The External Time Data object contains recorded time data from an external system so that it can be included in
the Employee Central Payroll Time Sheet.

The entity must be used every time a customer wants to import external time data into the Employee Central
system.

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Cases

Let's look at some use cases.

Upsert Duration User

This upserts external data for a user who records time on a Duration basis.

Operation Upsert

HTTP method Post

URI http://<api-server>/odata/v2/upsert

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 765
<Payload>
 Sample Code

{
"__metadata":{

"uri":"ExternalTimeData('test1')"
},
"externalCode":"test1",
"startDate":"\/
Date(1511218800000)\/",
"userId":"ashirly1",
"hours":"8.5",
"timeType":"HGB_WORK1"
}

Form Encoding Application/json

 Note

No response is required here because for upserts just return a status 200 OK with a response body indicating
all upsert results.

Upsert Clock Time User

This upserts external data for a user who records time on a Clock Time basis.

Operation Upsert

HTTP method Post

URI http://<api-server>/odata/v2/upsert

<Payload>
 Sample Code

{
"__metadata":{

"uri":"ExternalTimeData('test1')"
},
"externalCode":"test1",
"startDate":"\/
Date(1511218800000)\/",
"userId":"ashirly1",
"startTime":"PT13H20M",
"endTime":"PT13H50M",
"timeType":"HGB_WORK1"
}

Form Encoding Application/json

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

766 PUBLIC Time & Attendance Management
  Note

No response is required here because for upserts just return a status 200 OK with a response body indicating
all upsert results.

Query to read External Time Data

Operation Query

HTTP method Get

URI http://<api-server>/odata/v2/
ExternalTimeData('test10001')

Form Encoding Application/json

Sample Response

 Sample Code

<?xml version="1.0" encoding="utf-8"?>

<entry xmlns="http://www.w3.org/2005/Atom" xmlns:m="http://
schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns:d="http://
schemas.microsoft.com/ado/2007/08/dataservices" xml:base="https://<api-server>/
odata/v2/restricted/">
<id>https://<api-server>/odata/v2/restricted/
ExternalTimeData('test10001')</id>
<title type="text"></title>
<updated>2018-05-24T12:48:28Z</updated>
<author>
<name></name>
</author>
<link rel="edit" title="ExternalTimeData"
href="ExternalTimeData('test10001')"></link>
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/
userIdNav" type="application/atom+xml;type=entry" title="userIdNav"
href="ExternalTimeData('test10001')/userIdNav"></link>
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/
statusNav" type="application/atom+xml;type=entry" title="statusNav"
href="ExternalTimeData('test10001')/statusNav"></link>
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/
wfRequestNav" type="application/atom+xml;type=feed" title="wfRequestNav"
href="ExternalTimeData('test10001')/wfRequestNav"></link>
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/
mdfSystemRecordStatusNav" type="application/atom+xml;type=entry"
title="mdfSystemRecordStatusNav" href="ExternalTimeData('test10001')/
mdfSystemRecordStatusNav"></link>
<category term="SFOData.ExternalTimeData" scheme="http://
schemas.microsoft.com/ado/2007/08/dataservices/scheme"></category>
<content type="application/xml">
<m:properties>
<d:externalCode>test10001</d:externalCode>
<d:hours m:null="true"></d:hours>
<d:lastModifiedDateTime
m:type="Edm.DateTimeOffset">2018-05-24T12:38:38Z</d:lastModifiedDateTime>
<d:endDate m:null="true"></d:endDate>
<d:lastModifiedBy>admin</d:lastModifiedBy>
<d:createdDateTime m:type="Edm.DateTimeOffset">2018-05-24T12:38:38Z</
d:createdDateTime>
<d:timeType m:null="true"></d:timeType>
<d:mdfSystemRecordStatus>N</d:mdfSystemRecordStatus>
<d:userId>croller</d:userId>

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 767
 <d:createdBy>admin</d:createdBy>
<d:deleteExternalTime m:type="Edm.Boolean">false</
d:deleteExternalTime>
<d:startTime m:type="Edm.Time">PT16H</d:startTime>
<d:endTime m:type="Edm.Time">PT17H</d:endTime>
<d:startDate m:type="Edm.DateTime">2018-05-22T00:00:00</d:startDate>
<d:status>NEW</d:status>
</m:properties>
</content>
</entry>

Query to Delete External Data

Operation Delete

HTTP Method Delete

URI http://<api-server>/odata/v2/
ExternalTimeData('test10001')

Form Encoding Application/json

Query to Insert External Data

Operation Insert

HTTP Method Post

URI http://<api-server>/odata/v2/
ExternalTimeData

Form Encoding Application/json

<Payloads>
 Sample Code

{
"__metadata": {
"uri":
"ExternalTimeData('test10001')"
},
"externalCode": "test10001",
"startDate": "/
Date(1526976229000)/",
"startTime": "PT16H00M",
"endTime": "PT17H00M",
"userIdNav" : {
"__deferred": {
"uri": "https://<api-
server>/odata/v2/restricted/
User('croller')"
}
}
}

Sample Response

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

768 PUBLIC Time & Attendance Management
  Sample Code

<?xml version="1.0" encoding="utf-8"?>

<entry xmlns="http://www.w3.org/2005/Atom" xmlns:m="http://
schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns:d="http://
schemas.microsoft.com/ado/2007/08/dataservices" xml:base="https://<api-server>/
odata/v2/restricted/">
<id>https://<api-server>/odata/v2/restricted/
ExternalTimeData('test10001')</id>
<title type="text"></title>
<updated>2018-05-29T12:06:37Z</updated>
<author>
<name></name>
</author>
<link rel="edit" title="ExternalTimeData"
href="ExternalTimeData('test10001')"></link>
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/
userIdNav" type="application/atom+xml;type=entry" title="userIdNav"
href="ExternalTimeData('test10001')/userIdNav"></link>
<category term="SFOData.ExternalTimeData" scheme="http://
schemas.microsoft.com/ado/2007/08/dataservices/scheme"></category>
<content type="application/xml">
<m:properties>
<d:startDate m:type="Edm.DateTime">2018-05-22T08:03:49</d:startDate>
<d:startTime m:type="Edm.Time">PT16H</d:startTime>
<d:endTime m:type="Edm.Time">PT17H</d:endTime>
<d:externalCode>test10001</d:externalCode>
</m:properties>
</content>
</entry>

16.2.2 ExternalTimeRecord

The entity represents a time record created outside of the Employee Central system.

Business Context

The ExternalTimeRecord OData API is used to import employee time records recorded in an external system into
the Employee Central system. After import, the employee time records are converted into time sheet entries. These
time records are later valuated within the Payroll Time Sheet and transferred to Employee Central Payroll.

This OData API performs mass replication of time records from an external time recording system into Employee
Central. It is possible to use the $BATCH directive, which we assume is the standard method to use this API.

Use Case: Creation of an external time record with external time segments

This is a sample use case for the ExternalTimeRecord OData API - the creation of an external time record with
external time segments. This involves uploading an external time record containing time segments into the time
sheet database in the SAP SuccessFactors system.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 769
This use case provides an example of the following:

● Sending a POST request containing a JSON representation of both External Time Record and External Time
Segment MDF entities
● The response to the POST request

OData API ExternalTimeRecord - creation of an external time record with external time segments.

Request Information

Operation POST

URI http://<api-server>/odata/v2/upsert

Headers Authorization: Basic <Base 64 encoded (“user@com­

pany:password”)> Content-Type: application/json charset:
utf-8

Payload
 Sample Code

{
"__metadata":{
"uri":"
ExternalTimeRecord('test1')"
},
"externalCode":"test1",
"date":"\/Date(1453104229000)\/",
"userId":"cgrant1",
"externalTimeSegments":[
{
"externalCode":"",
"hours":4.0
},
{
"externalCode":"",
"hours":4.0
},
{
"externalCode":"",
"hours":1.0
}
]
}

Related Information

SAP API Business Hub: Payroll Time Sheet

16.2.3 TimeCollector
Time collectors are configurable multi-purpose counters that are processed in time valuation.

During time valuation, time collectors can be created, augmented, or reset (to zero) as the result of time valuation
operations ('collector update'). The frequency at which a collector is reset is configurable. Time collectors either

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

770 PUBLIC Time & Attendance Management
contain a number of accumulated minutes ('direct counting') or the number of accumulated threshold events: the
collector is increased by 1 if the threshold is surpassed or not ('event counting').

Time collectors are either transient during time valuation or they are written to the database for consumption by
follow-up processes.

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Code Examples

Retrieve all time collectors for user mhoff:

URI: http://<api-server>/odata/v2/TimeCollector?$filter=userId eq 'mhoff1'&$format=JSON

 Sample Code

Method: GET
Response:
{
"d": {
"results": [
{
"__metadata": {
"uri":
https://<api-server>/odata/v2/
TimeCollector('891f04a35f4b41889a2b3644202000a5')",
"type": "SFOData.TimeCollector"
},
"externalCode": "891f04a35f4b41889a2b3644202000a5",
"startDate": "/Date(1509494400000)/",
"timeCollectorType": "DAILYCOLL",
"bookingDate": "/Date(1512000000000)/",
"endDate": "/Date(1512000000000)/",
"lastModifiedDateTime": "/Date(1519200242000+0000)/",
"collectorValue": "1",
"createdBy": "v4admin",
"userId": "mhoff1",
"createdDateTime": "/Date(1519200242000+0000)/",
"lastModifiedBy": "v4admin",
"changeValue": "0",
"mdfSystemRecordStatus": "N",
"wfRequestNav": {
"__deferred": {
"uri": "https:// <api-server>/odata/v2/
TimeCollector('891f04a35f4b41889a2b3644202000a5')/wfRequestNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https:// <api-server>/odata/v2/
TimeCollector('891f04a35f4b41889a2b3644202000a5')/mdfSystemRecordStatusNav"
}
},
"userIdNav": {
"__deferred": {
"uri": "https:// <api-server>/odata/v2/
TimeCollector('891f04a35f4b41889a2b3644202000a5')/userIdNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 771
 }
}
},
{
"__metadata": {
"uri": "https:// <api-server>/odata/v2/
TimeCollector('187203bbaf8f40968765810c2ed52f37')",
"type": "SFOData.TimeCollector"
},
"externalCode": "187203bbaf8f40968765810c2ed52f37",
"startDate": "/Date(1509494400000)/",
"timeCollectorType": "DAILYCOLL",
"bookingDate": "/Date(1511568000000)/",
"endDate": "/Date(1512000000000)/",
"lastModifiedDateTime": "/Date(1511451977000+0000)/",
"collectorValue": "1",
"createdBy": "root",
"userId": "mhoff1",
"createdDateTime": "/Date(1511451977000+0000)/",
"lastModifiedBy": "root",
"changeValue": "1",
"mdfSystemRecordStatus": "N",
"wfRequestNav": {
"__deferred": {
"uri": "https:// <api-server>/odata/v2/
TimeCollector('187203bbaf8f40968765810c2ed52f37')/wfRequestNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https:// <api-server>/odata/v2/
TimeCollector('187203bbaf8f40968765810c2ed52f37')/mdfSystemRecordStatusNav"
}
},
"userIdNav": {
"__deferred": {
"uri": "https:// <api-server>/odata/v2/
TimeCollector('187203bbaf8f40968765810c2ed52f37')/userIdNav"
}
}
}
]
}
}

16.2.4 EmployeeTimeSheet

This entity contains information related to a time sheet of an employee, including the time recording method and
the time valuation rules. You use this entity to store header information and cumulated time valuation results
referring to one week of an employee’s time recording.

Supported Operations

Query: Retrieves employee time sheet instances.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

772 PUBLIC Time & Attendance Management
Use Case 1: Retrieve a Time Sheet

The following example retrieves the time sheet of user pcount with start date 2020-04-19.

Request

Operation Query

HTTP Method GET

URI https://<API-server>/odata/v2/EmployeeTimeSheet?
$filter=userId eq 'pcounter' and startDate eq
datetime'2020-04-19T00:00:00'&$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://API-server/odata/v2/
EmployeeTimeSheet('aae311f887da443590ea1746dbd48c7f')",
"type": "SFOData.EmployeeTimeSheet"
},
"externalCode": "aae311f887da443590ea1746dbd48c7f",
"lastModifiedDateTime": "/Date(1594041657000+0000)/",
"endDate": "/Date(1587772800000)/",
"createdDateTime": "/Date(1594041657000+0000)/",
"plannedHoursAndMinutes": "40:00",
"workingTimeAccount": null,
"period": "04/19/2020 - 04/25/2020",
"recordedWorkingTime": "0",
"replacedBy": null,
"externalTimesExist": "NO",
"timeRecordingMethod": "POSITIVE",
"mdfSystemRecordStatus": "N",
"workflowAction": "ACTION_SAVE",
"absencesExist": "NO",
"fullWorkscheduleCovered": "NO",
"plannedWorkingTime": "2400",
"timeSheetHash":
"29f16a1faa39c6baeeb4d4838df6e1d5d3492776f41e6f7c7ca22afb17416eb4",
"manualEntriesExist": "NO",
"startDate": "/Date(1587254400000)/",
"approvalStatus": "PENDING",
"singleRecordApprovalMissing": null,
"editable": null,
"replaces": null,
"lastModifiedBy": "v4admin",
"workflowRequestId": null,
"userId": "pcounter",
"generatedEntriesExist": "NO",
"workingTimeAccountHoursAndMinutes": "",
"recordedHoursAndMinutes": "0:00",
"createdBy": "v4admin",
"comment": null,
"userIdNav": {
"__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeSheet('aae311f887da443590ea1746dbd48c7f')/userIdNav"
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 773
 "createdByNav": {
"__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeSheet('aae311f887da443590ea1746dbd48c7f')/createdByNav"
}
},
"employeeTimeSheetEntry": {
"__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeSheet('aae311f887da443590ea1746dbd48c7f')/employeeTimeSheetEntry"
}
},
"approvalStatusNav": {
"__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeSheet('aae311f887da443590ea1746dbd48c7f')/approvalStatusNav"
}
},
"employeeTimeValuationResult": {
"__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeSheet('aae311f887da443590ea1746dbd48c7f')/employeeTimeValuationResult"
}
},
"fullWorkscheduleCoveredNav": {
"__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeSheet('aae311f887da443590ea1746dbd48c7f')/fullWorkscheduleCoveredNav"
}
},
"generatedEntriesExistNav": {
"__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeSheet('aae311f887da443590ea1746dbd48c7f')/generatedEntriesExistNav"
}
},
"replacedByNav": {
"__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeSheet('aae311f887da443590ea1746dbd48c7f')/replacedByNav"
}
},
"singleRecordApprovalMissingNav": {
"__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeSheet('aae311f887da443590ea1746dbd48c7f')/
singleRecordApprovalMissingNav"
}
},
"externalTimesExistNav": {
"__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeSheet('aae311f887da443590ea1746dbd48c7f')/externalTimesExistNav"
}
},
"manualEntriesExistNav": {
"__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeSheet('aae311f887da443590ea1746dbd48c7f')/manualEntriesExistNav"
}
},
"absencesExistNav": {
"__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeSheet('aae311f887da443590ea1746dbd48c7f')/absencesExistNav"
}
},
"replacesNav": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

774 PUBLIC Time & Attendance Management
 "__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeSheet('aae311f887da443590ea1746dbd48c7f')/replacesNav"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeSheet('aae311f887da443590ea1746dbd48c7f')/lastModifiedByNav"
}
},
"workflowActionNav": {
"__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeSheet('aae311f887da443590ea1746dbd48c7f')/workflowActionNav"
}
},
"timeRecordingMethodNav": {
"__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeSheet('aae311f887da443590ea1746dbd48c7f')/timeRecordingMethodNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeSheet('aae311f887da443590ea1746dbd48c7f')/mdfSystemRecordStatusNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeSheet('aae311f887da443590ea1746dbd48c7f')/wfRequestNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Payroll Time Sheet

16.2.5 EmployeeTimeValuationResult

You use the entity to store the results of a time valuation that are displayed on the UI and replicated to payroll.

Supported Operations

Query: Retrieves employee time valuation instances.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 775
Use Case 1: Retrieve Employee Time Valuation Results of a Certain Date

The following example retrieves all approved time valuation results that have the booking date 2020-04-19.

Request

Operation Query

HTTP Method GET

URI https://<API-server>/odata/v2/EmployeeTimeValuationResult?
$filter=bookingDate eq datetime'2020-04-20T00:00:00' and
approvalStatus eq 'APPROVED'&$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://API-server/odata/v2/
EmployeeTimeValuationResult(EmployeeTimeSheet_externalCode='bbaaa857cd2e47ad95c0f79b
5d40bea8',externalCode='167a9e93b7d94e77a91ffae6ccd26365')",
"type": "SFOData.EmployeeTimeValuationResult"
},
"externaAPI-serverlCode": "167a9e93b7d94e77a91ffae6ccd26365",
"EmployeeTimeSheet_externalCode":
"bbaaa857cd2e47ad95c0f79b5d40bea8",
"lastModifiedDateTime": "/Date(1587861082000+0000)/",
"postingTarget": "EC_PAYROLL",
"createdDateTime": "/Date(1587699939000+0000)/",
"hoursAndMinutes": "8:00",
"payTypeExternalName": "Regular Time",
"allowanceType": null,
"approvalStatus": "APPROVED",
"hours": "8",
"costCenter": null,
"lastModifiedBy": "v4admin",
"mdfSystemRecordStatus": "N",
"payTypeName": "RT-CALCPAY",
"timeTypeGroup": "RT-CALCPAY",
"createdBy": "v4admin",
"bookingDate": "/Date(1587340800000)/",
"postingTargetNav": {
"__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeValuationResult(EmployeeTimeSheet_externalCode='bbaaa857cd2e47ad95c0f79b
5d40bea8',externalCode='167a9e93b7d94e77a91ffae6ccd26365')/postingTargetNav"
}
},
"createdByNav": {
"__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeValuationResult(EmployeeTimeSheet_externalCode='bbaaa857cd2e47ad95c0f79b
5d40bea8',externalCode='167a9e93b7d94e77a91ffae6ccd26365')/createdByNav"
}
},
"costCenterNav": {
"__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeValuationResult(EmployeeTimeSheet_externalCode='bbaaa857cd2e47ad95c0f79b
5d40bea8',externalCode='167a9e93b7d94e77a91ffae6ccd26365')/costCenterNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

776 PUBLIC Time & Attendance Management
 }
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeValuationResult(EmployeeTimeSheet_externalCode='bbaaa857cd2e47ad95c0f79b
5d40bea8',externalCode='167a9e93b7d94e77a91ffae6ccd26365')/lastModifiedByNav"
}
},
"approvalStatusNav": {
"__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeValuationResult(EmployeeTimeSheet_externalCode='bbaaa857cd2e47ad95c0f79b
5d40bea8',externalCode='167a9e93b7d94e77a91ffae6ccd26365')/approvalStatusNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://API-server/odata/v2/
EmployeeTimeValuationResult(EmployeeTimeSheet_externalCode='bbaaa857cd2e47ad95c0f79b
5d40bea8',externalCode='167a9e93b7d94e77a91ffae6ccd26365')/mdfSystemRecordStatusNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Payroll Time Sheet

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Time & Attendance Management PUBLIC 777
17 Workflow

Workflow entities allow you to query the data of workflow requests, workflow steps, comments, participators,
allowed actions, as well as other workflow information displayed on the Workflow Details page. You can also use the
workflow function imports to change workflow statuses and post comments.

Permissions

Permission System Required Setting

Role Based
Manage Workflows Manage Workflow Requests

This permission is required for the workflow admin role.

User Based N/A

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

778 PUBLIC Workflow
Workflow Status Transition

The following diagram illustrates the status transition of a workflow request:

 Note

* For Employee Central workflows, only the workflow admin can decline a request. For MDF workflows, the
current approver can decline a request.

** In the case of escalation or delegation, the escalatee or delegatee becomes the current approver. The
workflow request still follows its own course of status transition. Additional statuses are available to indicate the
escalation or delegation progress.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Workflow PUBLIC 779
Entity Relationship Diagram

17.1 WfRequest

This entity stores basic data of a workflow such as the overall status and the current step number. This is the
workflow used by Employee Central as well as MDF objects.

Supported Operations

Operation Description

Query Query the information of workflow requests.

Edit operations are not supported by the entity itself. However, you can use the following function imports to modify
your workflow requests:

● approveWfRequest [page 811]

● commentWfRequest [page 812]
● rejectWfRequest [page 813]
● sendbackWfRequest [page 815]
● withdrawWfRequest [page 816]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

780 PUBLIC Workflow
Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

wfRequestId Workflow request ID. This is a business key.

module The following values are available:

● HRIS: indicates an Employee Central workflow request.

● GENERIC_OBJECT: indicates an MDF workflow request.

parentWfRequestId ID of the parent workflow request.

status Status of the workflow request. Possible values are:

● PENDING: The workflow request is currently pending.

● SENTBACK: The workflow request has been sent back.
● LOCKED: The workflow request has been locked.
● REJECTED: The workflow has been rejected.
● CANCELLED: The workflow has been canceled.
● COMPLETED: The workflow has been completed.

For more information about workflow request statuses, see

Workflow [page 778].

totalSteps Total number of steps in the workflow request.

url A deep link to the workflow details page.

Navigation Property

Navigation Property Related Entity Description

empWfRequestNav EmpWfRequest [page 130] Navigate to the workflow request related

to an employee.

parentWfRequestNav WfRequest Navigate to the parent workflow request.

wfRequestCommentsNav WfRequestComments [page 787] Navigate to the workflow request com­

ments.

wfRequestParticipatorNav WfRequestParticipator [page 788] Navigate to the workflow participators.

wfRequestStepNav WfRequestStep [page 790] Navigate to the workflow request steps.

wfRequestUINav WfRequestUIData [page 792] Navigate to the data as displayed on the

Workflow Details page.

workflowAllowedActionListNav WorkflowAllowedActionList [page 795] Navigate to the list of allowed action for
the workflow request.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Workflow PUBLIC 781
Entity Relation Diagram

For more information, see Workflow [page 778].

Use Case 1: Querying the Basic Information of a Workflow

The following example shows how to query the basic information of a workflow by ID:

Request

Operation Query

HTTP Method GET

URI https://<hostname>/odata/v2/
WfRequest(65L)?$format=JSON

Response

{
"d": {
"__metadata": {
"uri": "https://<hostname>/odata/v2/WfRequest(65L)",
"type": "SFOData.WfRequest"
},
"wfRequestId": "65",
"lastModifiedDateTime": "/Date(1496851039000+0000)/",
"lastModifiedBy": "101013",
"module": "HRIS",
"reminderSentDate": null,
"totalSteps": 1,
"createdDateTime": "/Date(1496851006000+0000)/",
"createdOn": "/Date(1496851006000)/",
"url": "https://<hostname>/sf/hrisworkflowapprovelink?workflowRequestId=V2-
nlxRHnYcTrR1jnB17z3o8Q%3D%3D&prevPage=HOME&company=BESTRUN&username=cgrant",
"lastModifiedOn": "/Date(1496851039000)/",
"parentWfRequestId": null,
"createdBy": "adminJY",
"currentStepNum": 1,
"status": "COMPLETED",
"wfRequestUINav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/WfRequest(65L)/wfRequestUINav"
}
},
"parentWfRequestNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/WfRequest(65L)/
parentWfRequestNav"
}
},
"workflowAllowedActionListNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/WfRequest(65L)/
workflowAllowedActionListNav"
}
},
"empWfRequestNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/WfRequest(65L)/empWfRequestNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

782 PUBLIC Workflow
 }
},
"wfRequestParticipatorNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/WfRequest(65L)/
wfRequestParticipatorNav"
}
},
"wfRequestCommentsNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/WfRequest(65L)/
wfRequestCommentsNav"
}
},
"wfRequestStepNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/WfRequest(65L)/wfRequestStepNav"
}
}
}
}

Use Case 2: Querying All Pending Workflow Requests

This example shows how to query all workflow requests that were pending:

Request

Operation Query

HTTP Method GET

URI https://<hostname>/odata/v2/WfRequest?
$format=JSON&$filter=status eq 'PENDING'

Response
The response returns a full list of pending workflow requests in the system. For demonstration purpose, some
results have been omitted:

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<hostname>/odata/v2/WfRequest(162L)",
"type": "SFOData.WfRequest"
},
"wfRequestId": "162",
"lastModifiedBy": "80286",
"status": "PENDING"
},
{
"__metadata": {
"uri": "https://<hostname>/odata/v2/WfRequest(41L)",
"type": "SFOData.WfRequest"
},
"wfRequestId": "41",
"lastModifiedBy": "101009",
"status": "PENDING"
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Workflow PUBLIC 783
 ... ...

{
"__metadata": {
"uri": "https://<hostname>/odata/v2/WfRequest(740L)",
"type": "SFOData.WfRequest"
},
"wfRequestId": "740",
"lastModifiedBy": "athompson",
"status": "PENDING"
},
{
"__metadata": {
"uri": "https://<hostname>/odata/v2/WfRequest(741L)",
"type": "SFOData.WfRequest"
},
"wfRequestId": "741",
"lastModifiedBy": "athompson",
"status": "PENDING"
}
]
}
}

Related Information

SAP API Business Hub: Workflow

Function Imports [page 811]
Permission Settings [page 15]
How do I access my assigned workflow requests? [page 784]

17.1.1 How do I access my assigned workflow requests?

Use the Todo entity to retrieve your assigned workflow requests. The Todo entity contains the list of tasks assigned
to a user. You will find a workflow item in the following Todo task categories 14 (HRIS Employee Change Requests
Category26), 17 (Generic Object Category), 18 (Absence Management Category), 24 (IT Category), and 25
(Deductions Category).

Tell me more

To retrieve the assigned workflow requests, you have to:

1.Run a Todo query for the relevant task category (14, 17, 18, 24, or 25)

2. Query your workflow for the relevant subjectId.

Run a Todo query for the relevant task category (14, 17, 18, 24, or 25)

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

784 PUBLIC Workflow
For this example, we'll use the task category 14 (HRIS Employee Change Requests Category26):

Sample Request https://<Hostname>/odata/v2/Todo?$filter=categoryId eq '14'

Sample Response

 Sample Code

<m:properties>
<d:categoryId>14</d:categoryId>
<d:todos m:type="Bag(SFOData.ToDoBean)">
<d:element>
<d:categoryId>14</d:categoryId>
<d:completedDate m:null="true" />
<d:dueDate m:null="true" />
<d:dueDateOffSet m:type="Edm.Int32">0</d:dueDateOffSet>
<d:entries m:type="Bag(SFOData.ToDoEntry)">
<d:element>
<d:completedDate m:null="true" />
<d:formDataId m:type="Edm.Int64">0</d:formDataId>
<d:status m:type="Edm.Int32">2</d:status>
<d:statusLabel>Active</d:statusLabel>
<d:subjectFullName>New Hire , Tammy Aberts</d:subjectFullName>
<d:subjectId>462</d:subjectId>
<d:url>https://<hostname>/sf/hrisworkflowapprovelink?
workflowRequestId=V2-ypU9jRAxxzV2pyMHsQn1BQ%3D
%3D&prevPage=HOME&company=ACE1321&username=admin</d:url>
</d:element>
</d:entries>
<d:entryId m:type="Edm.Int32">20375</d:entryId>
<d:name>Requests Waiting for My Approval</d:name>
<d:status m:type="Edm.Int32">2</d:status>
<d:statusLabel>Active</d:statusLabel>
<d:stepDescAlt>Requests Waiting for My Approval</d:stepDescAlt>
<d:todoItemId m:null="true" />
<d:url m:null="true" />
</d:element>
</d:todos>
<d:categoryLabel>Employee Change Requests</d:categoryLabel>
<d:displayOrder m:type="Edm.Int32">14</d:displayOrder>
</m:properties>

Here you can see that there is one workflow item, subjectId 462, in the task category 14 (HRIS Employee Change
Requests Category26). Let's now look at our wfRequest query.

Query your workflow for the relevant subjectId

Sample Request https://<Hostname>/odata/v2/WfRequest?$filter=wfRequestId eq '462'&

$format=JSON

Sample Response

 Sample Code

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<hostname>/odata/v2/WfRequest(462L)",
"type": "SFOData.WfRequest"
},
"wfRequestId": "462",
"module": "HRIS",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Workflow PUBLIC 785
 "status": "PENDING",
"currentStepNum": 1,
"lastModifiedDateTime": "/Date(1391090611000+0000)/",
"lastModifiedOn": "/Date(1391072611000)/",
"totalSteps": 1,
"url": "https://<hostname>/sf/hrisworkflowapprovelink?
workflowRequestId=V2-ypU9jRAxxzV2pyMHsQn1BQ%3D
%3D&prevPage=HOME&company=ACE1321&username=admin",
"reminderSentDate": null,
"createdOn": "/Date(1330523150000)/",
"createdBy": "admin",
"createdDateTime": "/Date(1330541150000+0000)/",
"lastModifiedBy": "admin",
"parentWfRequestId": null,
"workflowAllowedActionListNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/WfRequest(462L)/
workflowAllowedActionListNav"
}
},
"wfRequestCommentsNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/WfRequest(462L)/
wfRequestCommentsNav"
}
},
"parentWfRequestNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/WfRequest(462L)/
parentWfRequestNav"
}
},
"wfRequestParticipatorNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/WfRequest(462L)/
wfRequestParticipatorNav"
}
},
"wfRequestStepNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/WfRequest(462L)/
wfRequestStepNav"
}
},
"empWfRequestNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/WfRequest(462L)/
empWfRequestNav"
}
}
}
]
}

You can use the URL in the response to access your workflow item on the UI.

 Note

We recommend that you use TodoEntryV2 instead of Todo. The Todo entity is user-centric and only returns
the ToDos for the API login user.

You can read up on the Todo and TodoEntryV2 entities and what task categories are supported in Related
Information.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

786 PUBLIC Workflow
Related Information

TodoEntryV2
Todo

17.2 WfRequestComments

The WfRequestComments entity represents WF_REQUEST_COMMENTS table in the SAP SuccessFactors

database. This entity stores comments created for a workflow. This includes information about the initiator of the
comment and the time it was created.

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Cases

API Call Description

https://<api-server>.com/odata/v2/ Get all comments created by admin which have the action type
WfRequestComments?$filter=(actionType eq initiate or decline
'INITIATE' or actionType eq 'DECLINE') and
createdBy eq 'admin'&
$select=createdBy,actionType&$format=JSON

Code Examples

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/WfRequestComments(46L)",
"type": "SFOData.WfRequestComments"
},
"createdBy": "admin",
"actionType": "INITIATE"
}
]
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Workflow PUBLIC 787
Related Information

SAP API Business Hub: Workflow

Permission Settings [page 15]

17.3 WfRequestParticipator

The WfRequestParticipator entity represents WF_REQUEST_PARTICIPATOR table in the SAP SuccessFactors

database. This entity stores information about users who contribute to a but do not have authorization to approve.
These participants are informed about the workflow or, depending on the participant type, can comment on the
item.

Supported Operations

Query

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Case: Retrieve Workflow Participants

Request Information

Operation Query

HTTP Method GET

URI http://<api-server>/odata/v2/
WfRequestParticipator?$top=1&
$filter=actorType eq 'ROLE' &$select
wfRequestParticipatorId, ownerId,
actorType&$format=JSON

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

788 PUBLIC Workflow
Response

 Sample Code

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/WfRequestParticipator(327L)",
"type": "SFOData.WfRequestParticipator"
},
"wfRequestParticipatorId": "327",
"relatedTo": null,
"ownerId": "80295",
"lastModifiedDateTime": "/Date(1471303354000+0000)/",
"lastModifiedOn": "/Date(1471288954000)/",
"participatorType": "CC_ROLE",
"createdOn": "/Date(1471288954000)/",
"wfRequestId": "1325",
"actorType": "ROLE",
"createdBy": "sfadmin",
"processingOrder": "1",
"createdDateTime": "/Date(1471303354000+0000)/",
"lastModifiedBy": "sfadmin",
"roleId": "EM",
"dynamicGroupNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WfRequestParticipator(327L)/
dynamicGroupNav"
}
},
"ownerNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WfRequestParticipator(327L)/
ownerNav"
}
},
"positionNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WfRequestParticipator(327L)/
positionNav"
}
},
"dynamicRoleNav": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/WfRequestParticipator(327L)/
dynamicRoleNav"
}
}
}
]
}
}

Related Information

SAP API Business Hub: Workflow

Permission Settings [page 15]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Workflow PUBLIC 789
17.4 WfRequestStep

This entity contains data of the steps in a workflow.

Supported Operations

Operation Description

Query You can query the information of a workflow step.

Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

wfRequestStepId Business key.

approverType The type of the approver of the workflow step.

For more information about workflow approvers, see Workflow

Participant Types.

role This field contains a value only when approverTpe is "Role".

ownerId If approverTpe is "Dynamic Group" or "Position", this field is

null because this step has multiple owners.

actionType Specify how approvers are allowed to change content of a

workflow transaction:

● No Edit
Approvers do not have in-flight editing capability.
● Edit with Route Change
Approvers can edit a workflow and the workflow route will
be recalculated when they submit the request.
● Edit without Route Change
Approvers can edit a workflow but the workflow route will
not be recalculated when they submit the request.
● Edit Attachments Only
Approver can only edit the attachments of the workflow.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

790 PUBLIC Workflow
 Property Description

relatedTo Determines the approver, based on attributes of the subject

employee or data before or after the change. This field has two
possible values, "Source" and "Target".

For example, when an employee's position changes, the work­

flow maz require the approval from the manager of the em­
ployee. Then relatedTo specifies:

● Source
The manager before the change
● Target
The new manager after the change

 Note
If a data change does not involve a manager change, the
approval requests will be sent to the same person.

For more information about this property, see Creating an Indi­

vidual Workflow.

Use Case: Querying Completed Workflow Steps by Creator and Owner

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
WfRequestStep?$filter=createdBy eq
'cgrant1' and ownerId eq 'cgrant1' and
status eq 'COMPLETED'&
$select=wfRequestStepId,stepNum,ownerId,ap
proverType&$format=JSON

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/WfRequestStep(1L)",
"type": "SFOData.WfRequestStep"
},
"wfRequestStepId": "1",
"stepNum": "1",
"approverType": "ROLE",
"ownerId": "cgrant1"
}
]
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Workflow PUBLIC 791
 }

Related Information

SAP API Business Hub: Workflow

Permission Settings [page 15]

17.5 WfRequestUIData

This entity enables you to query the workflow data displayed on the Workflow Details page. You cannot query this
entity on its own. You can only query the entity as a navigation property through other entities, for example,
TodoEntryV2.

Supported Operations

Operation Description

Query Query operation is only possible when this entity is used as a

navigation property under WfReqeust entity, including its
equivalent navigation property wfRequestNav. For example,
you can query the corresponding workflow request data
through TodoEntryV2 by expanding its navigation proper­
ties: $expand=wfRequestNav/wfRequestUINav.

Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

wfRequestId Id of the corresponding workflow request.

operateUserName Name of the person who operated on the request.

operateUserId userId of the person who operated on the request.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

792 PUBLIC Workflow
 Property Description

subjectUserName Name of the person who is the subject of the request.

subjectUserId userId of the person who is the subject of the request.

isObjectBase Indicates whether the workflow is based on an MDF object.

objectType Name of the MDF object the workflow is based on.

deeplink A deep link to the workflow details page of the request.

todoSubjectLine A description for the related to-do item.

operateType Type of operation performed on the request.

actions Possible actions for the workflow request. Note that the action
is only available for the designated user in the workflow.

Use Case 1: Querying the Workflow Details of a To-Do Item

In this example, we try to query the to-do item 623M and expand to its workflow request, and then further expands
the wfRequestUINav navigation property to fetch the UI data.

Request

Operation Query

HTTP Method GET

URI https://<hostname>/odata/v2/TodoEntryV2(623M)?$format=JSON&
$expand=wfRequestNav/wfRequestUINav

Headers Authorization: Basic <Base 64 encoded (“user@company:password”)>

Response

{
"d": {
"__metadata": {
"uri": "https://<hostname>/odata/v2/TodoEntryV2(623M)",
"type": "SFOData.TodoEntryV2"
},
"todoEntryId": "623",
"lastModifiedDateTime": "/Date(1500336000000+0000)/",
"dueDate": null,
"todoEntryName": "Requests Waiting for My Approval",
"categoryLabel": "Employee Change Requests",
"completedDateTime": null,
"mobileLinkUrl": null,
"subjectId": "162",
"createdDate": "/Date(1500336000000+0000)/",
"linkUrl": null,
"formDataId": null,
"categoryId": "14",
"status": 2,
"userNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/TodoEntryV2(623M)/userNav"

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Workflow PUBLIC 793
 }
},
"recruitingJobOfferNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/TodoEntryV2(623M)/
recruitingJobOfferNav"
}
},
"formContentNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/TodoEntryV2(623M)/
formContentNav"
}
},
"wfRequestNav": {
"__metadata": {
"uri": "https://<hostname>/odata/v2/WfRequest(162L)",
"type": "SFOData.WfRequest"
},
"wfRequestId": "162",
"lastModifiedDateTime": "/Date(1500419437000+0000)/",
"lastModifiedBy": "80286",
"module": "HRIS",
"reminderSentDate": null,
"totalSteps": 1,
"createdDateTime": "/Date(1500419436000+0000)/",
"createdOn": "/Date(1500419436000)/",
"url": "https://<hostname>/sf/hrisworkflowapprovelink?
workflowRequestId=V2-zoaBl%2FCOi7125QbQbbpfgw%3D
%3D&prevPage=HOME&company=BESTRUN&username=userabc",
"lastModifiedOn": "/Date(1500419437000)/",
"parentWfRequestId": null,
"createdBy": "80286",
"currentStepNum": 1,
"status": "PENDING",
"wfRequestUINav": {
"__metadata": {
"uri": "https://<hostname>/odata/v2/WfRequestUIData(162L)",
"type": "SFOData.WfRequestUIData"
},
"wfRequestId": "162",
"businessUnit": "MC Automotive(MC_AUTO)",
"isEffectiveDateType": true,
"isObjectBase": false,
"assigneeUserId": null,
"operateUserName": "April Kennedy",
"assigneeUserName": null,
"jobTitle": "MC Production Operator(MC_ProdOp)",
"legalEntity": "Model Company 2 US(1710)",
"objectType": null,
"division": "MC Automotive Production(MC_AP)",
"receivedOn": null,
"department": "MC Auto Component Production US(MC_US_CP)",
"costCenter": "MC Auto Production US(MC_100021)",
"deeplink": "https://<hostname>/sf/hrisworkflowapprovelink?
workflowRequestId=V2-zoaBl%2FCOi7125QbQbbpfgw%3D
%3D&prevPage=HOME&company=BESTRUN&username=userabc",
"todoSubjectLine": "Term - Probation Failed , Scott Leiter",
"operateType": "Initiated",
"subjectUserId": "80290",
"changedData": null,
"eventReason": "Term - Probation Failed",
"actionType": null,
"isAssigned": false,
"operateUserId": "80286",
"objectName": null,
"location": "Detroit Plant US",
"actions": "[{\"action\":\"approve\"}]",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

794 PUBLIC Workflow
 "operateDate": "July 18, 2017",
"effectiveDate": "August 1, 2017",
"subjectUserName": "Scott Leiter"
},
"parentWfRequestNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/WfRequest(162L)/
parentWfRequestNav"
}
},
"workflowAllowedActionListNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/WfRequest(162L)/
workflowAllowedActionListNav"
}
},
"empWfRequestNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/WfRequest(162L)/
empWfRequestNav"
}
},
"wfRequestParticipatorNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/WfRequest(162L)/
wfRequestParticipatorNav"
}
},
"wfRequestCommentsNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/WfRequest(162L)/
wfRequestCommentsNav"
}
},
"wfRequestStepNav": {
"__deferred": {
"uri": "https://<hostname>/odata/v2/WfRequest(162L)/
wfRequestStepNav"
}
}
}
}
}

17.6 WorkflowAllowedActionList

Describes how this entity lets you see what actions a consumer can take on a the WfRequest entity. Using Boolean
values TRUE/FALSE, you can see what a consumer can or cannot do for a given workflow step. The workflow steps
include returning, withdrawing, commenting, declining, updating, resubmitting, or allowing a delegate to decline,
revoke, or grant a WfRequest.

Supported Operations

Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Workflow PUBLIC 795
Properties and Navigation Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Use Case: Retrieve Allowed Actions for a User

With this query, you're expanding the workflowAllowedAction list to see what actions a consumer can perform on
workflow items that do not have the status completed and have been created by the user, User ID.

Request

Operation Query

HTTP Method GET

URI https://<api-server>/odata/v2/WfRequest?
$filter=status+ne+'COMPLETED'+and
+createdBy+eq+<'User ID>'&
$expand=workflowAllowedActionListNav,wfReq
uestStepNav&$format=JSON

Response

workflowAllowedActionListNav: {
results: [1]
0: {
__metadata: {
uri: "https:/<hostname.com>/odata/v2/
WorkflowAllowedActionList(1563L)"
type: "SFOData.WorkflowAllowedActionList"
}-
wfRequestId: "1563"
allowResubmit: false
allowReject: false
allowDelegateGrant: false
allowDelegateDecline: false
allowApprove: false
allowWithdraw: true
allowSendback: false
allowPostComment: true
allowUpdateRequest: false
allowDelegateRevoke: false
}-
-
}

Related Information

SAP API Business Hub: Workflow

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

796 PUBLIC Workflow
Permission Settings [page 15]

17.7 AutoDelegateConfig

This entity contains the workflow auto delegation configuration of a specified user.

Supported Operations

Operation Description

Query Queries the auto delegation configuration of a specified user

Upsert If the record doesn’t exist, the operation creates a record; if the
record already exists, the operation updates it.

Insert Creates an auto delegation configuration for a specified user

Merge Updates the properties specified in the request and keeps

value of other properties unchanged

Replace Updates the properties specified in the request and clears

value of other nonrequired properties

Delete Deletes the auto delegation configuration of a specified user

Parameters

Parameter Data Type Required/Optional Description

delegator String Required A string that uniquely identi­

fies a user whose auto delega­
tion configuration you want to
operate on

delegationStatus String Required A string that indicates

whether the delegator’s auto
delegation feature is set ON or
OFF

startTime datetimeoffset Optional The time from which auto del­

egation should be effective

endTime datetimeoffset Optional The time after which auto del­

egation should be turned off

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Workflow PUBLIC 797
Parameter Data Type Required/Optional Description

optimisticLockUUID String Optional Version number of an existing

record. We don’t recommand
that you add this parameter to
the payload when you update
or create a record.

autoDelegateDetails AutoDelegateDetail Optional An array that contains all del­

egatees of a specific delegator

Use Case 1: Querying the auto delegation configuration of user vicky

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/AutoDelegateConfig('vicky')?
$format=json

Response

{
"d": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/AutoDelegateConfig('vicky')",
"type": "SFOData.AutoDelegateConfig"
},
"delegator": "vicky",
"lastModifiedDateTime": "/Date(1598001489000+0000)/",
"mdfSystemEffectiveEndDate": "/Date(253402214400000)/",
"createdDateTime": "/Date(1571041761000+0000)/",
"mdfSystemVersionId": null,
"mdfSystemEffectiveStartDate": "/Date(-2208988800000)/",
"mdfSystemStatus": "A",
"mdfSystemEntityId": "71B3342E4FB947A2A3CB8C22B483D6B3",
"startTime": "/Date(1597881600000+0000)/",
"mdfSystemObjectType": "AutoDelegateConfig",
"lastModifiedDate": "/Date(1598001489000)/",
"lastModifiedBy": "admin",
"lastModifiedDateWithTZ": "/Date(1598001489000+0000)/",
"mdfSystemRecordStatus": "N",
"mdfSystemTransactionSequence": "1",
"delegationStatus": "ON",
"optimisticLockUUID": "098E1D42B2B341B091AFC93327A2EC78",
"createdDate": "/Date(1571041761000)/",
"createdBy": "admin",
"mdfSystemRecordId": "DEC52B0ED6244BACA7E8A76795C7128D",
"endTime": "/Date(1598486400000+0000)/",
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/AutoDelegateConfig('vicky')/
mdfSystemStatusNav"
}
},
"createdByNav": {
"__deferred": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

798 PUBLIC Workflow
 "uri": "https://<API-Server>/odata/v2/AutoDelegateConfig('vicky')/
createdByNav"
}
},
"delegatorNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/AutoDelegateConfig('vicky')/
delegatorNav"
}
},
"autoDelegateDetails": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/AutoDelegateConfig('vicky')/
autoDelegateDetails"
}
},
"lastModifiedByNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/AutoDelegateConfig('vicky')/
lastModifiedByNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/AutoDelegateConfig('vicky')/
mdfSystemRecordStatusNav"
}
},
"delegationStatusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/AutoDelegateConfig('vicky')/
delegationStatusNav"
}
},
"wfRequestNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/AutoDelegateConfig('vicky')/
wfRequestNav"
}
}
}
}

Use Case 2: Querying all delegatees of user testemp1

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
AutoDelegateConfig('testemp1')/autoDelegateDetails

Response

{
"d": {
"results": [

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Workflow PUBLIC 799
 {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
AutoDelegateDetail(AutoDelegateConfig_delegator='testemp1',externalCode='f913dfa4044
e4776a7ca191b8d818bcc')",
"type": "SFOData.AutoDelegateDetail"
},
"externalCode": "f913dfa4044e4776a7ca191b8d818bcc",
"AutoDelegateConfig_delegator": "testemp1",
"alwaysOn": true,
"delegatee": "testemp5",
"status": "ON",
"statusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
AutoDelegateDetail(AutoDelegateConfig_delegator='testemp1',externalCode='f913dfa4044
e4776a7ca191b8d818bcc')/statusNav"
}
},
"delegateeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
AutoDelegateDetail(AutoDelegateConfig_delegator='testemp1',externalCode='f913dfa4044
e4776a7ca191b8d818bcc')/delegateeNav"
}
}
}
]
}
}

Use Case 3: Updating the auto delegation configuration of user vicky to set
delegation status as OFF

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert?$format=json

Payload {
"__metadata":{
"uri":"AutoDelegateConfig('vicky')"
},
"delegationStatus": "OFF"
}

Response

{
"d": [
{
"key": "AutoDelegateConfig/delegator=vicky",
"status": "OK",
"editStatus": "UPSERTED",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

800 PUBLIC Workflow
 "message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Use Case 4: Creating an auto delegation configuration for user vicky

Request

Operation Insert

HTTP Method POST

URI https://<API-Server>/odata/v2/AutoDelegateConfig?
$format=json

Payload {
"delegator": "vicky",
"startTime": null,
"delegationStatus": "ON",
"endTime": null,
"autoDelegateDetails":
[{
"alwaysOn": true,
"delegatee": "testemp5",
"status": "ON"
}]
}

Response

{
"d": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/AutoDelegateConfig('vicky')",
"type": "SFOData.AutoDelegateConfig"
},
"startTime": null,
"delegationStatus": "ON",
"endTime": null,
"delegator": "vicky",
"autoDelegateDetails": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/AutoDelegateDetail???",
"type": "SFOData.AutoDelegateDetail"
},
"alwaysOn": true,
"delegatee": "testemp5",
"status": "ON"
}
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Workflow PUBLIC 801
Use Case 5: Updating the auto delegation configuration of user vicky to set
delegation status as OFF and keep values of other fields unchanged

Request

Operation Merge

HTTP Method POST Header: X-HTTP-Method= MERGE

URI https://<API-Server>/odata/v2/AutoDelegateConfig('vicky')?
$format=json

Payload {
"delegationStatus": "OFF"
}

Response

Use Case 6: Updating the auto delegation configuration of user vicky to set
delegation status as OFF and clear values of other fields

Request

Operation Replace

HTTP Method PUT

URI https://<API-Server>/odata/v2/AutoDelegateConfig('vicky')?
$format=json

Payload {
"delegationStatus": "OFF"
}

Response

Use Case 7: Deleting the auto delegation configuration of user vicky

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

802 PUBLIC Workflow
Request

Operation Delete

HTTP Method DELETE

URI https://<API-Server>/odata/v2/AutoDelegateConfig('vicky')

Response

Error Codes

Error Description

NotFoundException AutoDelegateConfig with key ('user') not found!

The error occurs when delegationStatus is assigned “null” as delegationStatus is a required field/association in Object Auto­
value. DelegateConfig.

The error occurs when start time is greater than end time or Enter a start time that is before the end time. Enter a future
end time is a past time. time as the end time.

This error occurs when you update a record and specify an op­ Your changes for AutoDelegateConfig data conflict with those
timisticLockUUID other than the existing record’s optimisti­ made concurrently by another user. Please refresh and resub­
cLockUUID. mit your changes.

COE_MISSING_REQUIRED_PROPERTIES Please add required properties in payload. Required property

delegationStatus is missing. You can check which properties
are required for an entity in Admin Center > OData API Data
Dictionary or the entity metadata.

delegationStatus should be either ON or OFF when you create

the auto delegation configuration.

COE_GENERAL_BAD_REQUEST Enter a start time that is before the end time. Enter a future
time as the end time.

COE_GENERAL_BAD_REQUEST Delegatee is required.

COE_GENERAL_BAD_REQUEST Record '(delegator=user)' of type 'AutoDelegateConfig' already

exists.

COE_GENERAL_BAD_REQUEST delegationStatus is a required field/association in Object Auto

Delegate Config.

COE_GENERAL_BAD_REQUEST Enter a start time that is before the end time. Enter a future
time as the end time.

COE_MISSING_REQUIRED_PROPERTIES Please add required properties in payload. Required property

delegationStatus is missing. You can check which properties
are required for an entity in Admin Center > OData API Data
Dictionary or the entity metadata.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Workflow PUBLIC 803
Error Description

COE_GENERAL_BAD_REQUEST Enter a start time that is before the end time. Enter a future
time as the end time.

COE_RECORD_NOT_FOUND Record for entity AutoDelegateConfig with key AutoDelegate­

Config/delegator='user' does not exist. Please check the key
value.

Related Information

SAP API Business Hub: Workflow

17.8 AutoDelegateDetail

This entity contains delegatee details of the workflow auto delegation configuration of a specified user.

Supported Operations

Using the Delete operation of this entity may result in unexpected errors. For most cases, we recommend that
customers use the AutoDelegateConfig entity instead.

Operation Description

Query Queries delegatees of a specific user

Upsert If the record doesn’t exist, the operation creates a record; if the
record already exists, the operation updates it.

Insert Creates a delegatee for a specified user

Merge Updates the properties specified in the request and keeps

value of other properties unchanged

Replace Updates the properties specified in the request and clears

value of other nonrequired properties

Delete This operation is NOT recommended.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

804 PUBLIC Workflow
Parameters

Parameter Data Type Required/Optional Description

AutoDelegateConfig_d String Required A string that uniquely identi­

elegator fies a user whose auto delega­
tion configuration you want to
operate on

status String Optional Can be any of the following

values:

● ON: The auto delegation

request has been ac­
cepted. For a delegatee to
be active, its status
should be ON and alway­
sOn true.
● OFF: The delegatee isn’t
active.
● PENDING: The Allow
Delegatees to Accept or
Reject a Workflow
Delegation Request op­
tion is enabled and there
is an auto delegation re­
quest awaiting response.
● REJECTED: The auto del­
egation request has been
rejected.
● NONE: None of the above
values are assigned.

alwaysOn Bool Optional It’s used together with status

to determine whether a deleg­
atee is an active delegatee.

delegatee String Required Delegatee

Use Case 1: Querying all delegatees of user testemp1

This use case demonstrates how to retrieve all delegatees of a user through AutoDelegateConfig, instead of
AutoDelegateDetail. This is a recommended practice.

Request

Operation Query

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Workflow PUBLIC 805
HTTP Method GET

URI https://<API-Server>/odata/v2/
AutoDelegateConfig('testemp1')/autoDelegateDetails

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
AutoDelegateDetail(AutoDelegateConfig_delegator='testemp1',externalCode='f913dfa4044
e4776a7ca191b8d818bcc')",
"type": "SFOData.AutoDelegateDetail"
},
"externalCode": "f913dfa4044e4776a7ca191b8d818bcc",
"AutoDelegateConfig_delegator": "testemp1",
"alwaysOn": true,
"delegatee": "testemp5",
"status": "ON",
"statusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
AutoDelegateDetail(AutoDelegateConfig_delegator='testemp1',externalCode='f913dfa4044
e4776a7ca191b8d818bcc')/statusNav"
}
},
"delegateeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
AutoDelegateDetail(AutoDelegateConfig_delegator='testemp1',externalCode='f913dfa4044
e4776a7ca191b8d818bcc')/delegateeNav"
}
}
}
]
}
}

Use Case 2: Querying all delegatees of user testemp1

This use case demonstrates how to retrieve all delegatees of a user through AutoDelegateDetail. We
recommend that you use AutoDelegateConfig instead, as shown in Use Case 1.

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/
AutoDelegateDetail(AutoDelegateConfig_delegator='testemp1',
externalCode='f913dfa4044e4776a7ca191b8d818bcc')

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

806 PUBLIC Workflow
Response

{
"d": {
"__metadata": {
"uri": "https://<API-Server>/odata/v2/
AutoDelegateDetail(AutoDelegateConfig_delegator='testemp1',externalCode='f913dfa4044
e4776a7ca191b8d818bcc')",
"type": "SFOData.AutoDelegateDetail"
},
"externalCode": "f913dfa4044e4776a7ca191b8d818bcc",
"AutoDelegateConfig_delegator": "testemp1",
"alwaysOn": true,
"delegatee": "testemp5",
"status": "ON",
"statusNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
AutoDelegateDetail(AutoDelegateConfig_delegator='testemp1',externalCode='f913dfa4044
e4776a7ca191b8d818bcc')/statusNav"
}
},
"delegateeNav": {
"__deferred": {
"uri": "https://<API-Server>/odata/v2/
AutoDelegateDetail(AutoDelegateConfig_delegator='testemp1',externalCode='f913dfa4044
e4776a7ca191b8d818bcc')/delegateeNav"
}
}
}
}

Use Case 3: Changing the active delegatee to ‘testemp3’ for user testemp1

Request

Operation Upsert

HTTP Method POST

URI https://<API-Server>/odata/v2/upsert?$format=json

Payload {
"__metadata":{

"uri":"AutoDelegateDetail(AutoDelegateConfig_delegator='
testemp1',externalCode='f913dfa4044e4776a7ca191b8d818bcc
')"
},
"delegatee": "testemp3"
}

Response

{
"d": [
{

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Workflow PUBLIC 807
 "key": "AutoDelegateDetail/
AutoDelegateConfig_delegator=testemp1,AutoDelegateDetail/
externalCode=f913dfa4044e4776a7ca191b8d818bcc",
"status": "OK",
"editStatus": "UPSERTED",
"message": null,
"index": 0,
"httpCode": 200,
"inlineResults": null
}
]
}

Use Case 4: Changing the active delegatee for user testemp1 and keeping
values of other fields unchanged

Request

Operation Merge

HTTP Method POST Header: X-HTTP-Method= MERGE

URI https://<API-Server>/odata/v2/
AutoDelegateDetail(AutoDelegateConfig_delegator='testemp1',
externalCode='f913dfa4044e4776a7ca191b8d818bcc')

Payload {
"delegatee": "testemp5"
}

Response

Error Codes

Error Description

NotFoundException AutoDelegateDetail with key (AutoDelegateConfig_delega-

tor=’user’, externalCode='UUID') not found!

The externalCode used when upserting already exists. The delegation setup must be unique.

The status was set to "Pending" or "Rejected". To save this auto delegation configuration, set the status to a
value other than "Pending" or "Rejected".

COE_GENERAL_BAD_REQUEST The delegation setup must be unique.

COE_GENERAL_BAD_REQUEST To save this auto delegation configuration, set the status to a

value other than "Pending" or "Rejected".

COE_GENERAL_BAD_REQUEST Delegatee is required.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

808 PUBLIC Workflow
Related Information

SAP API Business Hub: Workflow

17.9 MyPendingWorkflow

This entity enables you to query all completed workflow requests of which the current login user is a CC user; and
all pending and sent-back workflow requests of which the current login user is a contributor.

Supported Operations

Operation Description

Query Queries all completed workflow requests of which the current

login user is a CC user; and all pending and sent-back workflow
requests of which the current login user is a contributor

Use Case 1: Querying all completed, pending, and sent-back workflow requests

In this use case, we try to query all completed workflow requests of which the current login user is a CC user; and
all pending and sent-back workflow requests of which the current login user is a contributor.

Request

Operation Query

HTTP Method GET

URI https://<API-Server>/odata/v2/MyPendingWorkflow?
$format=json

Response

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/MyPendingWorkflow('V2-
HbJs6b5CpgRbjfs%252FB6ByZA%253D%253D')",
"type": "SFOData.MyPendingWorkflow"
},
"wfRequestId": "V2-HbJs6b5CpgRbjfs%2FB6ByZA%3D%3D",
"subject": "Personal Information change for Alice Fong - effective
09/10/2019",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Workflow PUBLIC 809
 "url": "http://<hostname>/sf/hrisworkflowapprovelink?
workflowRequestId=V2-HbJs6b5CpgRbjfs%2FB6ByZA%3D
%3D&prevPage=PENDING_REQ&prevLocation=/xi/ui/ect/pages/pendingWorkflows/
pendingWorkflowV12.xhtml?selected_user=cgrant&company=BIZXTEST&username=cgrant",
"desc": "Re-initiated by Karl King on 06/22/2020"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/MyPendingWorkflow('V2-
fZTHFa3VUSmYo53lb5iHxQ%253D%253D')",
"type": "SFOData.MyPendingWorkflow"
},
"wfRequestId": "V2-fZTHFa3VUSmYo53lb5iHxQ%3D%3D",
"subject": "Personal Information change for Alice Fong - effective
10/29/2019",
"url": "http://<hostname>/sf/hrisworkflowapprovelink?
workflowRequestId=V2-fZTHFa3VUSmYo53lb5iHxQ%3D
%3D&prevPage=PENDING_REQ&prevLocation=/xi/ui/ect/pages/pendingWorkflows/
pendingWorkflowV12.xhtml?selected_user=cgrant&company=BIZXTEST&username=cgrant",
"desc": "Initiated by Karl King on 10/29/2019"
},
{
"__metadata": {
"uri": "https://<API-Server>/odata/v2/MyPendingWorkflow('V2-
Jx2TNUYUpevF0qD1Jb%252F0qw%253D%253D')",
"type": "SFOData.MyPendingWorkflow"
},
"wfRequestId": "V2-Jx2TNUYUpevF0qD1Jb%2F0qw%3D%3D",
"subject": "Personal Information change for Alice Fong - effective
09/27/2019",
"url": "http://<hostname>/sf/hrisworkflowapprovelink?
workflowRequestId=V2-Jx2TNUYUpevF0qD1Jb%2F0qw%3D
%3D&prevPage=PENDING_REQ&prevLocation=/xi/ui/ect/pages/pendingWorkflows/
pendingWorkflowV12.xhtml?selected_user=cgrant&company=BIZXTEST&username=cgrant",
"desc": "Initiated by Karl King on 09/27/2019"
}
]
}
}

Related Information

SAP API Business Hub: Workflow

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

810 PUBLIC Workflow
17.10 Function Imports

A list of function imports for processing workflow data.

17.10.1 approveWfRequest

Lets you approve a workflow request assuming that you have authorization to approve the next step in the workflow
as described in the topic WorkflowAllowedActionList.

Supported Operations

HTTP Method: POST

Return Type: collection (WfRequestActionResponse)

Support Payload: false

Parameters

Parameter Type Description

wfRequestID Long A number, ending with L, that uniquely

identifies the workflow request

comment String A note for extra information about the

workflow item

Use Case: Approve a Workflow Request

Request

HTTP Method POST

URI https://<api-server>/odata/v2/
approveWfRequest?wfRequestId=1234L

Response

<d:WfRequestActionResponse>
<d:element m:type="SFOData.WfRequestActionResponse">
<d:status>success</d:status>
<d:wfRequestId m:type="Edm.Int64">1234L</d:wfRequestId>
</d:element>

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Workflow PUBLIC 811
 </d:WfRequestActionResponse>

Error Codes

Error Code Description

COE_GENERAL_BAD_REQUEST Message will tell you if the error is due to lack of user authori­
zation or if there is an issue with the workflow itself.

Related Information

SAP API Business Hub: Workflow

17.10.2 commentWfRequest

Lets you comment a workflow request and send email notifications, provided that you have authorization in the
WorkflowAllowedActionList. Notifications are sent to previous step approvers, current step approvers,
contributors, and the initiator.

Supported Operations

HTTP Method: POST

Return Type: collection (WfRequestActionResponse)

Support Payload: false

Parameters

Parameter Description Type

wfRequestID A number, ending with L, that uniquely Long

identifies the workflow request

comment A note for extra information about the String

workflow item

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

812 PUBLIC Workflow
Use Case: Comment a Workflow Request

Request

HTTP Method POST

URI https://<api-server>/odata/v2/
commentWfRequest?
wfRequestId=1234L&comment='test'

Response

<d:WfRequestActionResponse>
<d:element m:type="SFOData.WfRequestActionResponse">
<d:status>success</d:status>
<d:wfRequestId m:type="Edm.Int64">1563</d:wfRequestId>
</d:element>
</d:WfRequestActionResponse>

Error Codes

Error Code Description

COE_GENERAL_BAD_REQUEST Message will tell you if the error is due to lack of user authori­
zation or if there’s an issue with the workflow itself.

Related Information

SAP API Business Hub: Workflow

17.10.3 rejectWfRequest

This function import enables you to reject a workflow request assuming that you have authorization in
WorkflowAllowedActionList, or you are a workflow admin user. To be a workflow admin, you need to have the
role-based permission from Manage Workflows Manage Workflow Requests .

Supported Operations

HTTP Method: POST

Return Type: collection (WfRequestActionResponse)

Support Payload: false

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Workflow PUBLIC 813
Parameters

Parameter Description Type

wfRequestID A number, ending with L, that uniquely Long

identifies the workflow request

comment A note for extra information about the String

workflow item

Use Case: Reject a Workflow Request

Request

HTTP Method POST

URI https://<api-server>/odata/v2/
rejectWfRequest?wfRequestId=1234L

Response

<d:WfRequestActionResponse>
<d:element m:type="SFOData.WfRequestActionResponse">
<d:status>success</d:status>
<d:wfRequestId m:type="Edm.Int64">1234L</d:wfRequestId>
</d:element>
</d:WfRequestActionResponse>

Error Codes

Error Code Description

COE_GENERAL_BAD_REQUEST Message will tell you if the error is due to lack of user authori­
zation or if there is an issue with the workflow itself.

Related Information

SAP API Business Hub: Workflow

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

814 PUBLIC Workflow
17.10.4 sendbackWfRequest

Lets you send back a workflow request assuming that you have authorization in the WorkflowAllowedActionList.

Supported Operations

HTTP Method: POST

Return Type: collection (WfRequestActionResponse)

Support Payload: false

Parameters

Parameter Description Type

wfRequestID A number, ending with L, that uniquely Long

identifies the workflow request

comment A note for extra information about the String

workflow item

Use Case: Send Back a Workflow Request

Request

HTTP Method POST

URI https://<api-server>/odata/v2/
sendbackWfRequest?wfRequestId=1234L

Response

<d:WfRequestActionResponse>
<d:element m:type="SFOData.WfRequestActionResponse">
<d:status>success</d:status>
<d:wfRequestId m:type="Edm.Int64">1234L</d:wfRequestId>
</d:element>
</d:WfRequestActionResponse>

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Workflow PUBLIC 815
Error Codes

Error Code Description

COE_GENERAL_BAD_REQUEST Message will tell you if the error is due to lack of user authori­
zation or if there is an issue with the workflow itself.

Related Information

SAP API Business Hub: Workflow

17.10.5 withdrawWfRequest

Lets you withdraw a workflow request assuming that you have authorization in the WorkflowAllowedActionList.

Supported Operations

HTTP Method: POST

Return Type: collection (WfRequestActionResponse)

Support Payload: false

Parameters

Parameter Description Type

wfRequestID A number, ending with L, that uniquely Long

identifies the workflow request

comment A note for extra information about the String

workflow item

Use Case: Withdraw a Workflow Request

Request

HTTP Method POST

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

816 PUBLIC Workflow
 URI https://<api-server>/odata/v2/
withdrawWfRequest?wfRequestId=1234L

Response

<d:WfRequestActionResponse>
<d:element m:type="SFOData.WfRequestActionResponse">
<d:status>success</d:status>
<d:wfRequestId m:type="Edm.Int64">1234L</d:wfRequestId>
</d:element>
</d:WfRequestActionResponse>

Error Codes

Error Code Description

COE_GENERAL_BAD_REQUEST Message will tell you if the error is due to lack of user authori­
zation or if there is an issue with the workflow itself.

Related Information

SAP API Business Hub: Workflow

17.10.6 getWorkflowPendingData

You can use getWorkflowPendingData to query the changed data in a workflow that is not yet approved or rejected,
as well as fully completed.

 Note

As of Q2 2019, the getWorkflowPendingData API is converted from Beta to Public. If you are using the Beta
version, please change the endpoint URL.

This API supports entities that are in the label: value pair format. Refer to the following list for the supported
entities:

● EmpCompensation
● EmpEmployment
● EmpGlobalAssignment
● EmpJob

 Note

For EmpJob, the DirectReportee, Reportee, Deactivate, and TimeBalanceSection attributes are not
supported, because they do not have corresponding HRIS elements.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Workflow PUBLIC 817
● EmpPensionPayout
● FOPayComponentGroup
● PerAddress
● PerGlobalInfo
● PerPerson
● PerPersonal
● PerPersonRelationship

The following entities are not supported, because there are multiple fields for each record:

● EmpJobRelationships
● EmpPayCompNonRecurring
● EmpPayCompRecurring
● EmpWorkPermit
● PerNationalId

Permissions

You have the Employee Central API Read Permission on All Employee Central HRIS OData Entities
permission.

Supported Operations

HTTP Method: POST

Return Type: collection (WfRequestPendingDataResponse)

Support Payload: false

Properties

Property Description

fieldId The ids of HrisElementField for only the work permit group and
national id group of ESS workflow. For other groups, the value
is null.

id The HrisElementField id.

label The HrisElementField label.

newValue The new value.

oldValue The original value.

payComponents The value is not null only when the workflow involves compen­
sation amount change.

type For label: value pair change set, the value is null. For grid type
of data, which means the data format is a table, the value is
"grid".

title The change set group title, which is the same as displayed in
UI.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

818 PUBLIC Workflow
 Property Description

entityName The OData entity name, which is the same as displayed in the
Metadata file.

fieldName The OData property name, which is the same as displayed in

the Metadata file.

Parameters

Parameter Description Type Required

wfRequestID A number, ending with L, that uniquely identifies Long Yes

the workflow request

Use Case: Get the pending data of a workflow request

Get the pending data of the workflow request <your_wfRequestID>, for example, 2621L

Sample Request

HTTP Method POST

URI http://<hostname>/odata/v2/beta/getWorkflowPending-
Data?wfRequestId=2621L

Response

{
"d": [{
"wfRequestId": "2621",
"workflowAttributeGroups": {
"results": [{
"changeSet": {
"results": [{
"changeSet": {
"results": []
},
"entityName": "EmpGlobalAssignment",
"fieldId": null,
"fieldName": "assignmentType",
"id": "assignment-type",
"label": "Assignment Type",
"newValue": "Short-term assignment",
"oldValue": null,
"payComponents": null,
"type": null
}]
},
"groups": {
"results": [{
"changeSet": {
"results": []
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Workflow PUBLIC 819
 "inlineGroups": {
"results": [{
"changeSet": {
"results": [{
"changeSet": {
"results": []
},
"entityName": "EmpJob",
"fieldId": null,
"fieldName": "company",
"id": "company",
"label": "Company",
"newValue": "Ace Australia (ACE_AUS)",
"oldValue": "",
"payComponents": null,
"type": null
}]
},
"subChangeSetGroups": {
"results": []
},
"title": "Organizational Information"
}...]
},
"subChangeSetGroups": {
"results": []
},
"title": "Job Info "
},
{
"changeSet": {
"results": []
},
"inlineGroups": {
"results": [{
"changeSet": {
"results": [{
"changeSet": {
"results": []
},
"entityName": "EmpJobRelationships",
"fieldId": null,
"fieldName": null,
"id": null,
"label": null,
"newValue": "[[\"Relationship Type\",\"
Name \",\"custom-string1\",\"custom-string2\",\"Test Date Field 1\",\"Test Double
Field 1\",\"Custom String 3\",\"Custom String 5\",\"Custom String 6\",\"Custom
String 7\",\"Custom String 8\",\"Custom String 9\",\"Custom String 10\",\"Custom
String 11\",\"Custom String 12\",\"Custom Date 2\",\"Custom Date 3\",\"Custom Date
5\",\"Custom long 1\",\"Custom long 2\",\"Custom long 3\",\"Custom long 4\",
\"Custom long 6\",\"Custom long 7\",\"Custom long 8\",\"Custom long 9\",\"Custom
long 10\",\"Custom Double2\",\"Custom Double3\",\"Custom Double 20\",\"Custom Long
20\"],[\"Additional Manager\",\"073101 ECT-102904 ty\",\"\",\"\",\"\",\"\",\"\",
\"56565\",\"5656\",\"\",\"\",\"\",\"\",\"\",\"\",\"03/10/2019\",\"\",\"\",\"\",\"\",
\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\"]]",
"oldValue":
"[[,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,],[\"\",\"\",,,,,,\"\",\"\",,,,,,,
\"\",,,,,,,,,,,,,,,]]",
"payComponents": null,
"type": "grid"
}]
},
"subChangeSetGroups": {
"results": []
},
"title": ""
}]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

820 PUBLIC Workflow
 },
"subChangeSetGroups": {
"results": []
},
"title": "Job Relationships"
},
{
"changeSet": {
"results": []
},
"inlineGroups": {
"results": [{
"changeSet": {
"results": [{
"changeSet": {
"results": []
},
"entityName": "EmpCompensation",
"fieldId": null,
"fieldName": "payType",
"id": "pay-type",
"label": "Pay Type",
"newValue": "Hourly",
"oldValue": null,
"payComponents": null,
"type": null
},
{
"changeSet": {
"results": []
},
"entityName": "FOPayComponentGroup",
"fieldId": null,
"fieldName": "CAR",
"id": "CAR",
"label": "Car Allowances (CAR)",
"newValue": "1,200 USD",
"oldValue": null,
"payComponents": {
"results": [{
"label": "Monthly Car (MONCAR)",
"newValue": "1,200",
"oldValue": null
},
{
"label": "Car Allowances (CAR)",
"newValue": "1,200",
"oldValue": null
}]
},
"type": null
},
{
"changeSet": {
"results": []
},
"entityName": "EmpPayCompRecurring",
"fieldId": null,
"fieldName": null,
"id": "Compensation",
"label": "Compensation",
"newValue": "[[\"Pay Component\",\"Amount\",
\"Currency\",\"Frequency\",\"Pay Comp Recurring Custom String 1\",\"Pay Comp
Recurring Custom String 2\",\"Pay Comp Recurring Custom-long20\",\"Pay Comp
Recurring Custom-Double20\",\"Pay Comp Recurring Custom-date10\",\"Pay Comp
Recurring Custom-string18\",\"Pay Comp Recurring Custom-string17\",\"Pay Comp
Recurring Custom18\",\"Pay Comp Recurring Custom19\"],[\"Monthly Car (MONCAR)\",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Workflow PUBLIC 821
 \"200.00\",\"USD\",\"Bi-Monthly (BIM)\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",
\"\"]]",
"oldValue": "[[,,,,,,,,,,,,],[\"\",\"\",
\"\",\"\",,,,,,,,,]]",
"payComponents": null,
"type": "grid"
},
{
"changeSet": {
"results": []
},
"entityName": "EmpPayCompNonRecurring",
"fieldId": null,
"fieldName": null,
"id": null,
"label": "Spot Bonus",
"newValue": "[[\"Issue Date\",\"Type\",
\"Currency Code\",\"Alternative Cost Center\",\"Value\",\"Custom String 2\",
\"Custom String 3\",\"Custom String 4\",\"Custom String 5\",\"Test Date Field 1\",
\"Test Double Field 1\",\"Custom18\",\"Custom19\",\"Custom Double3\",\"Custom
Double6\",\"Custom long 6\",\"Custom long 3\",\"Custom long 4\",\"Custom String
13\",\"Custom String 14\",\"Custom String 15\",\"Custom Date 2\",\"Custom Date 3\",
\"Custom Double 20\",\"Custom Long 20\"],[\"03/19/2019\",\"HOURLY-UK (HR-UK)\",\"GBP
\",\"\",\"7,000\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",
\"\",\"\",\"\",\"\",\"\",\"\",\"\"]]",
"oldValue": "[[,,,,,,,,,,,,,,,,,,,,,,,,],
[,,,,,,,,,,,,,,,,,,,,,,,,]]",
"payComponents": null,
"type": "grid"
}]
},
"subChangeSetGroups": {
"results": []
},
"title": "Compensation Information"
}]
},
"subChangeSetGroups": {
"results": []
},
"title": "Compensation Info"
}]
},
"subChangeSetGroups": {
"results": []
},
"title": "Global Assignment"
}]
}
}]
}

You can map the change to an HRIS element using the entityName and fieldName fields.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

822 PUBLIC Workflow
17.10.7 changeWfRequestApprover

You can use changeWfRequestApprover to change the approver of a workflow step.

Permissions

● Manage Workflows Manage Workflow Requests

Parameters

Parameter Data Type Required/Optional Description

wfRequestId Long Required A number that uniquely identi­

fies the workflow request

wfRequestStepId Long Required A number that uniquely identi­

fies the workflow step whose
approver will be changed

updateToUserId String Optional A string that uniquely identi­

fies the new approver

editTransaction String Optional A string that indicates the new

Edit Transaction type. Leave it
empty to keep the current sta­
tus. Possible values are:

● NO_EDIT: Approvers do
not have in-flight editing
capability.
● EDIT_WITH_ROUTE: Ap­
provers can edit a work­
flow and the workflow
route will be recalculated
when they submit the re­
quest.
● EDIT_WITHOUT_ROUTE:
Approvers can edit a
workflow but the work­
flow route will not be re­
calculated when they
submit the request.
● EDIT_ATTACH­
MENT_ONLY: Approver
can only edit the attach­
ments of the workflow.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Workflow PUBLIC 823
Properties

This section lists only the properties and navigation properties that require special business logic, permission, or
other additional information. For more information, refer to the API dictionary in Admin Center API Center
OData API Data Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/
$metadata.

Property Description

WfRequestActionResponse Reponse of the action.

Use Case 1: Changing the Approver of a Workflow Step

In this use case, we try to change the approver of step 12345 of workflow request 1234 to user1200.

Request

HTTP Method POST

URI https://<API-Server>/odata/v2/changeWfRequestApprover?
workflowReqId=1234L&workflowReqStepId=12345L&userId='user12
00'

Response

{
"d": [
{
"status": "success",
"wfRequestId": "1234"
}
]
}

Error Codes

Error Description

COE_GENERAL_BAD_REQUEST A common message displays, indicating whether the error is

due to lack of user authorization or caused by an issue with the
workflow itself.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

824 PUBLIC Workflow
18 Business Examples

18.1 Adding a New Employee

If you want to save time when adding new employees to your organization, you can use an Upsert operation. This
will prove less time-consuming that adding the employees one-by-one in the Employee Central UI.

At a minimum you can insert the User, PerPerson, EmpEmployment, EmpJob, and PerPersonal entity to add an
employee. The order in which you perform the Upsert operations is critical. Be sure to follow it.

1. User entity
2. PerPerson
3. EmpEmployment
4. EmpJob
5. PerPersonal

 Caution

Before inserting or updating employee information using OData API, check whether an HRIS sync job is
currently running in your instance. An active HRIS sync job may overwrite the values of certain fields, such as
username. This could lead to inconsistent user data. We recommend that you avoid all API edit operations
when an HRIS sync job is running.

Please contact your Implementation Partner to find out whether an HRIS sync job is scheduled for your
instance. If you are no longer working with an Implementation Partner, contact Product Support.

Related Information

User entity upsert [page 826]

PerPerson Upsert [page 827]
EmpEmployment Upsert [page 828]
EmpJob Upsert [page 830]
PerPersonal Upsert [page 831]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Business Examples PUBLIC 825
18.1.1 User entity upsert

When you add a new employee, you need to upsert the User entity. The order in which you upsert your entities for
adding a new employee is crucial and the user entity is the first one. The other ones are PerPerson (2nd upsert),
EmpEmployment (3rd upsert), EmpJob (4th upsert) and PerPersonal (5th upsert).

Good to know

When you upsert the user entity, this also creates the PerPerson and EmpEmployment entity. However, both these
entities remain hidden until you explicitly upsert them.

Please also note that the PerPerson entity will only be visible after you have upserted the EmpEmployment entity.

Sample OData Request

URI: http://<Hostname>.com/odata/v2/upsert

HTTP Method: POST

Payload

 Source Code

{
"__metadata": {
"uri": "User('cgrant')"
},
"username": "carlagrant",
"status": "Active",
"userId": "cgrant"
}}

Form Encoding: application/json

Tip

To see the required fields for this entity for your instance, check your OData dictionary. There you'll see any other
insertable fields available and you can add them to your payload, if required.

Response

When the insert is successful, you'll have the following response. Please note that the operation always returns
status 200 (OK) with a response body indicating all Upsert results. Individual Upsert failures are not reported as
errors.

 Source Code

<feed>
<entry>
<content type="application/xml">
<m:properties>
<d:key>cgrant</d:key>
<d:status>OK</d:status>
<d:editStatus>INSERTED</d:editStatus>
<d:message m:null="true" />
<d:index m:type="Edm.Int32">0</d:index>
<d:httpCode m:type="Edm.Int32">201</d:httpCode>
<d:inlineResults m:type="Bag(SFOData.UpsertResult)" />
</m:properties>
</content>
</entry>

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

826 PUBLIC Business Examples
 </feed>

Next step for adding a new employee: PerPerson Upsert

Related Information

User entity upsert [page 826]

PerPerson Upsert [page 827]
EmpEmployment Upsert [page 828]
EmpJob Upsert [page 830]
PerPersonal Upsert [page 831]

18.1.2 PerPerson Upsert

When you add a new employee, you need to upsert the PerPerson entity. The order in which you upsert your
entities for adding a new employee is crucial and the PerPerson entity is the second one when you use the
minimum number of entities to add a new employee. The other ones are User (first upsert), this one PerPerson
(2nd upsert), EmpEmployment (3rd upsert), EmpJob (4th upsert) and PerPersonal (5th upsert).

Good to know

Although the PerPerson entity is created when the user entity is upserted, it remains hidden. It will only become
visible when:

● It is explicitly upserted as described in this topic

● EmpEmployment has been upserted

Sample OData Request

URI: http://<Hostname>.com/odata/v2/upsert

HTTP Method: POST

Payload

 Source Code

{
"__metadata": {
"uri": "PerPerson('cgrant')"
},
"personIdExternal": "grantcarla",
"userId": "cgrant"
}}

Form Encoding: application/json

Tip

To see the required fields for this entity for your instance, check your OData dictionary. There you'll see any other
insertable fields available and you can add them to your payload, if required.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Business Examples PUBLIC 827
Response

When the insert is successful, you'll have the following response. Please note that the operation always returns
status 200 (OK) with a response body indicating all Upsert results. Individual Upsert failures are not reported as
errors.

 Source Code

<feed>
<entry>
<content type="application/xml">
<m:properties>
<d:key m:null="true" />
<d:status>OK</d:status>
<d:editStatus>UPSERTED</d:editStatus>
<d:message m:null="true" />
<d:index m:type="Edm.Int32">0</d:index>
<d:httpCode m:type="Edm.Int32">200</d:httpCode>
<d:inlineResults m:type="Bag(SFOData.UpsertResult)" />
</m:properties>
</content>
</entry>
</feed>

Next step for adding a new employee:EmpEmployment Upsert

Related Information

User entity upsert [page 826]

EmpEmployment Upsert [page 828]
EmpJob Upsert [page 830]
PerPersonal Upsert [page 831]
generateNextPersonID [page 556]

18.1.3 EmpEmployment Upsert

When you add a new employee, you need to upsert the EmpEmployment entity. The order in which you upsert your
entities for adding a new employee is crucial and the EmpEmployment entity is the third one when you use the
minimum number of entities to add a new employee. The other ones are User (1st upsert), PerPerson (2nd
upsert),this one EmpEmployment (3rd upsert), EmpJob (4th upsert), and PerPersonal (5th upsert).

Good to know

When you upsert EmpEmployment, the PerPerson entity will also become visible assuming that it has been
explicitly upserted (and not just created as a hidden entity during the User upsert).

Sample OData Request

URI: http://<Hostname>.com/odata/v2/upsert

HTTP Method: POST

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

828 PUBLIC Business Examples
Payload

 Sample Code

 Source Code

{"__metadata": {
"uri": "EmpEmployment(personIdExternal='grantcarla',userId='cgrant')"
},
"startDate":"/Date(1388534400000)/",
"personIdExternal":"grantcarla",
"userId":"cgrant"
}}

Form Encoding: application/json

Tip

To see the required fields for this entity, check the OData dictionary in your company instance. You can also see the
other insertable fields and can add them to your payload, if required.

Response

When the insert is successful, you'll have the following response. Please note that the operation always returns
status 200 (OK) with a response body indicating all Upsert results. Individual Upsert failures are not reported as
errors.

 Source Code

<feed>
<entry>
<content type="application/xml">
<m:properties>
<d:key m:null="true" />
<d:status>OK</d:status>
<d:editStatus>UPSERTED</d:editStatus>
<d:message m:null="true" />
<d:index m:type="Edm.Int32">0</d:index>
<d:httpCode m:type="Edm.Int32">200</d:httpCode>
<d:inlineResults m:type="Bag(SFOData.UpsertResult)" />
</m:properties>
</content>
</entry>
</feed>

Next step for adding a new employee: EmpJob Upsert

Related Information

Adding a New Employee [page 825]

User entity upsert [page 826]
PerPerson Upsert [page 827]
EmpJob Upsert [page 830]
PerPersonal Upsert [page 831]

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Business Examples PUBLIC 829
18.1.4 EmpJob Upsert

When you add a new employee, you need to upsert the EmpJob entity. The order in which you upsert your entities
for adding a new employee is crucial and the EmpJob entity is the fourth one when you use the minimum number
of entities to add a new employee. The other ones are User (1st upsert), PerPerson (2nd upsert), EmpEmployment
(3rd upsert), this one, EmpJob (4th upsert), and PerPersonal (5th upsert).

Sample OData Request

URI: http://<Hostname>.com/odata/v2/upsert

HTTP Method: POST

Payload

 Source Code

{"__metadata": {
"uri": "EmpJob"
},
"jobCode":"ADMIN-1",
"userId":"cgrant",
"startDate":"/Date(1388534400000)/",
"eventReason":"HIRNEW",
"company":"ACE_USA",
"businessUnit":"ACE_CORP",
"managerId":"NO_MANAGER"
}
}
}

Form Encoding: application/json

Tip

To see the required fields for this entity for your instance, check your OData dictionary. There you'll see any other
insertable fields available and you can add them to your payload, if required.

Response

When the insert is successful, you'll have the following response. Please note that the operation always returns
status 200 (OK) with a response body indicating all Upsert results. Individual Upsert failures are not reported as
errors.

 Source Code

<feed>
<entry>
<content type="application/xml">
<m:properties>
<d:key m:null="true" />
<d:status>OK</d:status>
<d:editStatus>UPSERTED</d:editStatus>
<d:message m:null="true" />
<d:index m:type="Edm.Int32">0</d:index>
<d:httpCode m:type="Edm.Int32">200</d:httpCode>
<d:inlineResults m:type="Bag(SFOData.UpsertResult)" />
</m:properties>
</content>
</entry>

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

830 PUBLIC Business Examples
 </feed>

Next step for adding a new employee: PerPersonal Upsert

Related Information

Adding a New Employee [page 825]

User entity upsert [page 826]
PerPerson Upsert [page 827]
EmpEmployment Upsert [page 828]
PerPersonal Upsert [page 831]

18.1.5 PerPersonal Upsert

When you add a new employee, you need to upsert the PerPersonal entity. The order in which you upsert your
entities for adding a new employee is crucial and the PerPersonal entity is the last one when you use the minimum
number of entities to add a new employee. The other ones are User (first upsert), PerPerson (2nd upsert),
EmpEmployment (3rd upsert), EmpJob (4th upsert) and this one PerPersonal (5th upsert).

Sample OData Request

URI: http://<Hostname>.com/odata/v2/upsert

HTTP Method: POST

Payload

 Source Code

{ "__metadata":{
"uri":"PerPersonal(personIdExternal='grantcarla',startDate=datetime'2014-01-01T00
:00:00')"},
"personIdExternal":"grantcarla",
"namePrefix": "Ms",
"gender":"F",
"initials": "cg",
"firstName":"Carla",
"lastName":"Grant"
}

Form Encoding: application/json

Tip

To see the required fields for this entity for your instance, check your OData dictionary. There you'll see any other
insertable fields available and you can add them to your payload, if required.

Response

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Business Examples PUBLIC 831
When the insert is successful, you'll have the following response. Please note that the operation always returns
status 200 (OK) with a response body indicating all Upsert results. Individual Upsert failures are not reported as
errors.

 Source Code

<feed>
<entry>
<content type="application/xml">
<m:properties>
<d:key m:null="true" />
<d:status>OK</d:status>
<d:editStatus>UPSERTED</d:editStatus>
<d:message m:null="true" />
<d:index m:type="Edm.Int32">0</d:index>
<d:httpCode m:type="Edm.Int32">200</d:httpCode>
<d:inlineResults m:type="Bag(SFOData.UpsertResult)" />
</m:properties>
</content>
</entry>
</feed>

Related Information

Adding a New Employee [page 825]

User entity upsert [page 826]
PerPerson Upsert [page 827]
EmpEmployment Upsert [page 828]
EmpJob Upsert [page 830]

18.2 Filtering out external user data

Boolean fields, includeAllRecords (added to EmpEmployment, PerAddressDEFLT, PerEmail, PerPhone, PerPerson,

and PerPersonal) and isECRecord (added to EmpEmployment) are available for more flexible filtering.

Background

In this topic, we’re talking about external and internal user data.

External user data refers to non-Employee Central user data. When non-Employee Central modules use Employee
Central entities to store user data (for example, Recruiting might use PerPerson and PerPhone to store details
about an applicant), this type of user data is known as external user data.
Internal user data refers to Employee Central users, that is employees, as well as any users that have a dependent
relationship with an Employee Central user (for example, a spouse, a child, or, an emergency contact).

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

832 PUBLIC Business Examples
What's the benefit?

The Employee Central entities, EmpEmployment, PerAddressDEFLT, PerEmail, PerPhone, PerPerson, and
PerPersonal are often reused by other non-Employee Central modules to store user data. This data is external user
data. Up to now, you haven't been able to filter out this external user data for PerAddressDEFLT, PerEmail,
PerPhone, or for PerPersonal . So, if, for example you’re using Employee Central OData APIs for a scenario such as
payroll replication, your response could include applicants from Recruiting. And, conversely, you have not been able
to include external user data for EmpEmployment or PerPerson. Now, however, we're offering filterable and
selectable fields to model queries to meet your requirements.

How does it work?

We're offering you the following Boolean fields to use with $filter:

● isECRecord: Available for EmpEmployment.

isECRecord=true means that internal user data is returned; isECRecord=false means that external user data is
returned.
● includeAllRecords: Available for EmpEmployment, PerAddressDEFLT, PerEmail, PerPhone, PerPerson, and
PerPersonal.
includeAllRecords=true means that both internal and external records are returned.

For EmpEmployment, you can use this combination to return external user data:

isECRecord = false and includeAllRecords = true

Tell me more: Properties

Upserta­
Field Type Nullable Required Creatable Updatable ble Visible Sortable Filterable

includeAll­ Edm.Boo­ True False False False False False True True
Records lean

isECRe­ Edm.Boo­ True False False False False True False True
cord lean

Good to know

includeAllRecords works on the root entity only. If you specify it on the navigation entity, it won't work.

Works:

Query: https://<hostname>.com/odata/v2/PerPerson?$expand=personalInfoNav&
$filter=includeAllRecords eq true

Query: https://<hostname>.com/odata/v2/PerAddressDEFLT?$filter=includeAllRecords eq true

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Business Examples PUBLIC 833
Won't work - Raises an error message:

Query: https://<hostname>.com/odata/v2/PerPerson?$expand=personalInfoNav&
$filter=personalInfoNav/includeAllRecords eq true

Error message: Unsupported feature: Filter by nav/includeAllRecords is not supported.

How can I use it?

This table tells you how to use the filters.

isECRecord and includeAllRecords in filters

Your want your query to return You'll need to Use the following filter

Internal user data Filter out external user data Option 1: isECRecord=true

Option 2: isECRecord=true, includeAllRe­

cords=false

Option 3: includeAllRecords=false

Option 4: includeAllRecords=true, isE­

CRecord=true

Option 5: no filter

External user data Filter out internal user data isECRecord=false, includeAllRecords=
true
 Note
Only available for EmpEmployment

External and internal user data Include external and internal user data includeAllRecords= true

Show me some use cases

Here are some queries and the responses.

 Note

Please remember that includeAllRecords is a hidden field, so you won't see it in the response.

Filter out external user data for PerPhone

Query: https://<hostname>.com/odata/v2/PerPhone?$filter=includeAllRecords eq false or

Query: https://<hostname>.com/odata/v2/PerPhone

Response

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

834 PUBLIC Business Examples
  Sample Code

Extract from response

<m:properties>
<d:personIdExternal>llll</d:personIdExternal>
<d:phoneType>5845</d:phoneType>
<d:extension m:null="true"></d:extension>
<d:createdOn m:type="Edm.DateTime">2011-03-17T21:39:02</
d:createdOn>
<d:isPrimary m:type="Edm.Boolean">true</d:isPrimary>
<d:phoneNumber>707 2000</d:phoneNumber>
<d:createdBy>admin</d:createdBy>
<d:lastModifiedBy>admin</d:lastModifiedBy>
<d:createdDateTime
m:type="Edm.DateTimeOffset">2011-03-17T21:39:02Z</d:createdDateTime>
<d:lastModifiedOn m:type="Edm.DateTime">2011-03-17T21:39:02</
d:lastModifiedOn>
<d:lastModifiedDateTime
m:type="Edm.DateTimeOffset">2011-03-17T21:39:02Z</d:lastModifiedDateTime>
</m:properties>

Filter out external user data for EmpEmployee

Query: https://<hostname>.com/odata/v2/EmpEmployment?$filter=includeAllRecords eq true
and isECRecord eq false

 Sample Code

Extract from response

<m:properties>
<d:personIdExternal>GAdams</d:personIdExternal>
<d:userId>GAdams</d:userId>
<d:startDate m:type="Edm.DateTime">1900-01-01T00:00:00</
d:startDate>
<d:eligibleForStock m:null="true"></d:eligibleForStock>
<d:initialOptionGrant m:null="true"></d:initialOptionGrant>
<d:payrollEndDate m:null="true"></d:payrollEndDate>
<d:serviceDate m:null="true"></d:serviceDate>
<d:professionalServiceDate m:null="true"></
d:professionalServiceDate>
<d:okToRehire m:null="true"></d:okToRehire>
<d:regretTermination m:null="true"></d:regretTermination>
<d:customString23 m:null="true"></d:customString23>
<d:endDate m:null="true"></d:endDate>
<d:lastModifiedDateTime
m:type="Edm.DateTimeOffset">2016-06-21T08:54:09Z</d:lastModifiedDateTime>
<d:eligibleForSalContinuation m:null="true"></
d:eligibleForSalContinuation>
<d:StockEndDate m:null="true"></d:StockEndDate>
<d:assignmentClass m:null="true"></d:assignmentClass>
<d:lastDateWorked m:null="true"></d:lastDateWorked>
<d:salaryEndDate m:null="true"></d:salaryEndDate>
<d:isECRecord m:type="Edm.Boolean">false</d:isECRecord>
<d:originalStartDate m:null="true"></d:originalStartDate>
<d:benefitsEndDate m:null="true"></d:benefitsEndDate>
<d:lastModifiedOn m:type="Edm.DateTime">2016-06-21T08:54:09</
d:lastModifiedOn>
<d:initialStockGrant m:null="true"></d:initialStockGrant>
<d:bonusPayExpirationDate m:null="true"></
d:bonusPayExpirationDate>
<d:createdOn m:type="Edm.DateTime">2016-06-21T08:54:09</
d:createdOn>
<d:createdBy>v4admin</d:createdBy>

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Business Examples PUBLIC 835
 <d:lastModifiedBy>v4admin</d:lastModifiedBy>
<d:createdDateTime
m:type="Edm.DateTimeOffset">2016-06-21T08:54:09Z</d:createdDateTime>
<d:seniorityDate m:null="true"></d:seniorityDate>
</m:properties>

Return internal and external user data

Query: https://<hostname>.com/odata/v2/EmpEmployment?$filter=includeAllRecords eq true

Response

 Sample Code

Extract from response

<m:properties>
<d:personIdExternal>121</d:personIdExternal>
<d:userId>121</d:userId>
<d:startDate m:type="Edm.DateTime">2011-12-05T00:00:00</
d:startDate>
<d:eligibleForStock m:type="Edm.Boolean">false</
d:eligibleForStock>
<d:initialOptionGrant m:null="true"></d:initialOptionGrant>
<d:payrollEndDate m:type="Edm.DateTime">2011-11-28T00:00:00</
d:payrollEndDate>
<d:serviceDate m:null="true"></d:serviceDate>
<d:professionalServiceDate m:null="true"></
d:professionalServiceDate>
<d:okToRehire m:null="true"></d:okToRehire>
<d:regretTermination m:type="Edm.Boolean">false</
d:regretTermination>
<d:customString23 m:null="true"></d:customString23>
<d:endDate m:null="true"></d:endDate>
<d:lastModifiedDateTime
m:type="Edm.DateTimeOffset">2011-12-06T00:00:42Z</d:lastModifiedDateTime>
<d:eligibleForSalContinuation m:type="Edm.Boolean">false</
d:eligibleForSalContinuation>
<d:StockEndDate m:type="Edm.DateTime">2011-11-28T00:00:00</
d:StockEndDate>
<d:assignmentClass>ST</d:assignmentClass>
<d:lastDateWorked m:type="Edm.DateTime">2011-11-28T00:00:00</
d:lastDateWorked>
<d:salaryEndDate m:type="Edm.DateTime">2011-11-28T00:00:00</
d:salaryEndDate>
<d:isECRecord m:type="Edm.Boolean">true</d:isECRecord>
<d:originalStartDate m:type="Edm.DateTime">2011-05-11T00:00:00</
d:originalStartDate>
<d:benefitsEndDate m:type="Edm.DateTime">2011-11-28T00:00:00</
d:benefitsEndDate>
<d:lastModifiedOn m:type="Edm.DateTime">2011-12-06T00:00:42</
d:lastModifiedOn>
<d:initialStockGrant m:null="true"></d:initialStockGrant>
<d:bonusPayExpirationDate m:null="true"></
d:bonusPayExpirationDate>
<d:createdOn m:type="Edm.DateTime">2011-12-06T00:00:41</
d:createdOn>
<d:createdBy>nnnn</d:createdBy>
<d:lastModifiedBy>nnnn</d:lastModifiedBy>
<d:createdDateTime
m:type="Edm.DateTimeOffset">2011-12-06T00:00:41Z</d:createdDateTime>

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

836 PUBLIC Business Examples
 <d:seniorityDate m:type="Edm.DateTime">2011-12-05T00:00:00</
d:seniorityDate>
</m:properties>

18.3 Exposing person UUID for intergration and import

scenarios

A person UUID (unique universal identifier) is now available for integration and import scenarios.

Background

We’ve introduced the concept of a person UUID for the entire SAP SuccessFactors HXM Suite. When a new hire or
user is created, the system generates this identifier – called “perPersonUuid”. This field is immutable meaning that
once the field is populated with a value, it cannot be changed.

What's the benefit?

In SAP SuccessFactors HXM Suite, you can now expose perPersonUuid for integration and import scenarios for all
employees. So even if the employment field IS_EC_SYSTEM_OF_RECORD=F and the record is for a non-Employee
Central user, the perPersonUuid can be exposed.

How does it work?

perPersonUuid is a field in the new entity PersonKey.

perPersonUuid cannot be queried directly, but is available from the User entity with the new navigation
personKeyNav.

perPersonUuid is exposed regardless of data model configuration, RBP settings, or provisioning settings.
perPersonUuid can also be added to PerPerson.

Good to know

● Minimum UI Version: v12.

● perPersonUuid is not available on the UI. It is for integration and import scenarios only.
● perPersonUuid maximum length is 32 characters.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Business Examples PUBLIC 837
● personKeyNav in the User entity is independent of the provisioning settings.
● Available in PerPerson as an upsertable and visible field.

 Note

Note - to add it to PerPerson, you have to:

○ Add <hris-field id="per-person-uuid" visibility="both"> to personInfo hris-element in your data model
configuration.
○ Enable RBP and EDDP in provisioning

 Remember

As a customer, you don't have access to Provisioning. To complete tasks in Provisioning, contact
your implementation partner or Account Executive. For any non-implementation tasks, contact
Product Support.

● The only way to expose this field in a query is with $expand from the User entity. If you try to query the entity
directly, the error message <COE_UNSUPPORTED_FEATURE> is raised.

How can I use it?

To query it, personKeyNav has now been added to the User entity and you use $expand to expose perPersonUuid.

Show me a use case: $expand

Request: https://<api-server>/odata/v2/User('admin')?$format=json&$expand=personKeyNav&
$select=personKeyNav

Response

 Sample Code

Extract from response

{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/User('admin')",
"type": "SFOData.User"
},
"personKeyNav": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/PersonKey('admin')",
"type": "SFOData.PersonKey"
},
"personIdExternal": "admin",
"personId": "2",
"perPersonUuid": "3A085DB0D9184B49B0E3E70D6F07EB1A"
}
}
},

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

838 PUBLIC Business Examples
Show me a use case: Filtering perPersonUuid

Request: https://<api-server>/odata/v2/User('admin')?$format=json&$expand=personKeyNav&
$filter=personKeyNav/pePersonUuid eq "3A085DB0D9184B49B0E3E70D6F07EB1A"

Response

 Sample Code

Extract from response

Response:
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/User('admin')",
"type": "SFOData.User"
},
....
},
"personKeyNav": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/PersonKey('admin')",
"type": "SFOData.PersonKey"
},
"personIdExternal": "admin",
"personId": "2",
"perPersonUuid": "3A085DB0D9184B49B0E3E70D6F07EB1A"
}

Related Information

PersonKey [page 572]

18.4 Using wfStepApproverNav for more detailed workflow

configuration information

You can use wfStepApproverNav to get more detailed workflow information.

Background

FOWfConfig contains workflow information but - as with all entity fields - you can only read the fields that have the
attribute visible=true. In FOWfConfig, this means that you couldn't read the following fields:

actionType, approverRole, approverType, context, relationshipToApprover, respectRBP, skipType, and stepNum

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Business Examples PUBLIC 839
However, you can use this nav, wfStepApproverNav to navigate to FOWfConfigStepApprover where these fields
have the attribute visible=true.

What's the benefit?

Being able to read these fields means that you can get much more detailed workflow information.

How can I use these fields in my workflow configurations?

You can access these fields for more detailed information as follows:

● With FOWfConfig, you can use $expand=wfStepApproverNav.

● With FOWfConfigStepApprover, you can use a direct query.

Tell me more

wfStepApproverNav: Properties

 Sample Code

Extract from $metadata

<NavigationProperty Name="wfStepApproverNav"
sap:required="false"
sap:creatable="false"
sap:updatable="false"
sap:upsertable="false"
sap:visible="true"
sap:sortable="true"
sap:filterable="true"
Relationship="SFOData.FOWfConfig_FOWfConfigStepApprover"
FromRole="FOWfConfig" ToRole="FOWfConfigStepApprover_ref"
sap:label="wfStepApproverNav">
</NavigationProperty>

FOWfConfigStepApprover: Properties

 Sample Code

Extract from $metadata focussing on the fields that have the attribute visible=true (up to now only available in
FOWfConfig with the attribute visible=false)

<EntityType Name="FOWfConfigStepApprover">

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

840 PUBLIC Business Examples
 <Property Name="actionType" Type="Edm.String" Nullable="true"
sap:required="false" sap:creatable="false" sap:updatable="false"
sap:upsertable="false" sap:visible="true" sap:sortable="false"
sap:filterable="false" sap:label="Edit Transaction"></Property>
<Property Name="approverRole" Type="Edm.String" Nullable="true"
sap:required="false" sap:creatable="false" sap:updatable="false"
sap:upsertable="false" sap:visible="true" sap:sortable="false"
sap:filterable="false" sap:label="Approver Role"></Property>
<Property Name="approverType" Type="Edm.String" Nullable="true"
sap:required="false" sap:creatable="false" sap:updatable="false"
sap:upsertable="false" sap:visible="true" sap:sortable="false"
sap:filterable="false" MaxLength="32" sap:label="Approver Type"></Property>
<Property Name="context" Type="Edm.String" Nullable="true"
sap:required="false" sap:creatable="false" sap:updatable="false"
sap:upsertable="false" sap:visible="true" sap:sortable="false"
sap:filterable="false" MaxLength="32" sap:label="Context"></Property>
<Property Name="relationshipToApprover" Type="Edm.String"
Nullable="true" sap:required="false" sap:creatable="false" sap:updatable="false"
sap:upsertable="false" sap:visible="true" sap:sortable="false"
sap:filterable="false" sap:label="relationshipToApprover"></Property>
<Property Name="respectRBP" Type="Edm.Boolean" Nullable="true"
sap:required="false" sap:creatable="false" sap:updatable="false"
sap:upsertable="false" sap:visible="true" sap:sortable="false"
sap:filterable="false" sap:label="respectRBP"></Property>
<Property Name="skipType" Type="Edm.String" Nullable="true"
sap:required="false" sap:creatable="false" sap:updatable="false"
sap:upsertable="false" sap:visible="true" sap:sortable="false"
sap:filterable="false" sap:label="skipType"></Property>
<Property Name="stepNum" Type="Edm.Int64" Nullable="false"
sap:required="true" sap:creatable="false" sap:updatable="false"
sap:upsertable="false" sap:visible="true" sap:sortable="true"
sap:filterable="true" sap:label="stepNum"></Property>
</EntityType>

Show me some use cases

$expand with FOWfConfig

Request: https://<hostname>.com/odata/v2/FOWfConfig('LOA')?$format=json&
$expand=wfStepApproverNav

Response

 Sample Code

{
"d": {
"__metadata": {
"uri": "https://<hostname>.com/odata/v2/FOWfConfig('LOA')",
"type": "SFOData.FOWfConfig"
},
"externalCode": "LOA",
"createdOn": "/Date(1300533482000)/",
"futureDatedAlternateWorkflow": null,
"createdBy": "admin",
"description": "HR Business Partner assigned to manager's business unit",
"name": "Leave of Absence",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1300533482000+0000)/",
"remindIndays": null,
"lastModifiedOn": "/Date(1323196467000)/",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Business Examples PUBLIC 841
 "lastModifiedDateTime": "/Date(1323196467000+0000)/",
"isDelegateSupported": null,
"wfStepApproverNav": {
"results": [
{
"__metadata": {
"uri": "https://<hostname>.com/odata/v2/
FOWfConfigStepApprover(externalCode='LOA',stepNum=1L)",
"type": "SFOData.FOWfConfigStepApprover"
},
"stepNum": "1",
"externalCode": "LOA",
"approverPositionRelationship": null,
"lastModifiedDateTime": "/Date(1323196467000+0000)/",
"actionType": "NO_EDIT",
"skipType": null,
"approverRole": "EH",
"relationshipToApprover": null,
"approverType": "ROLE",
"createdBy": "admin",
"lastModifiedBy": "admin",
"createdDateTime": "/Date(1311812907000+0000)/",
"context": "SOURCE",
"respectRBP": null,
"relationshipToPosition": null,
"approverDynamicRoleNav": {
"__deferred": {
"uri": "https://<hostname>.com/odata/v2/
FOWfConfigStepApprover(externalCode='LOA',stepNum=1L)/approverDynamicRoleNav"
}
},
"approverGroupNav": {
"__deferred": {
"uri": "https://<hostname>.com/odata/v2/
FOWfConfigStepApprover(externalCode='LOA',stepNum=1L)/approverGroupNav"
}
},
"approverPositionNav": {
"__deferred": {
"uri": "https://<hostname>.com/odata/v2/
FOWfConfigStepApprover(externalCode='LOA',stepNum=1L)/approverPositionNav"
}
}
}
]
},
"descriptionTranslationNav": {
"__deferred": {
"uri": "https://<hostname>.com/odata/v2/FOWfConfig('LOA')/
descriptionTranslationNav"
}
},
"futureDatedAlternateWorkflowNav": {
"__deferred": {
"uri": "https://<hostname>.com/odata/v2/FOWfConfig('LOA')/
futureDatedAlternateWorkflowNav"
}
},
"nameTranslationNav": {
"__deferred": {
"uri": "https://<hostname>.com/odata/v2/FOWfConfig('LOA')/
nameTranslationNav"
}
}
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

842 PUBLIC Business Examples
Direct query using FOWfConfigStepApprover
Request: https://<hostname>.com/odata/v2/FOWfConfigStepApprover

Response

 Sample Code

Extract from response

....
<entry>
<id>https://<hostname>.com/odata/v2/
FOWfConfigStepApprover(externalCode='LOA',stepNum=1L)</id>
<title type="text"></title>
<updated>2016-10-11T08:22:03Z</updated>
<author>
<name></name>
</author>
<link rel="edit" title="FOWfConfigStepApprover"
href="FOWfConfigStepApprover(externalCode='LOA',stepNum=1L)"></link>
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/
approverDynamicRoleNav" type="application/atom+xml;type=feed"
title="approverDynamicRoleNav"
href="FOWfConfigStepApprover(externalCode='LOA',stepNum=1L)/
approverDynamicRoleNav"></link>
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/
approverGroupNav" type="application/atom+xml;type=entry"
title="approverGroupNav"
href="FOWfConfigStepApprover(externalCode='LOA',stepNum=1L)/approverGroupNav"></
link>
<link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/
approverPositionNav" type="application/atom+xml;type=feed"
title="approverPositionNav"
href="FOWfConfigStepApprover(externalCode='LOA',stepNum=1L)/
approverPositionNav"></link>
<category term="SFOData.FOWfConfigStepApprover" scheme="http://
schemas.microsoft.com/ado/2007/08/dataservices/scheme"></category>
<content type="application/xml">
<m:properties>
<d:stepNum m:type="Edm.Int64">1</d:stepNum>
<d:externalCode>LOA</d:externalCode>
<d:approverPositionRelationship m:null="true"></
d:approverPositionRelationship>
<d:lastModifiedDateTime
m:type="Edm.DateTimeOffset">2011-12-06T18:34:27Z</d:lastModifiedDateTime>
<d:actionType>NO_EDIT</d:actionType>
<d:skipType m:null="true"></d:skipType>
<d:approverRole>EH</d:approverRole>
<d:relationshipToApprover m:null="true"></
d:relationshipToApprover>
<d:approverType>ROLE</d:approverType>
<d:createdBy>admin</d:createdBy>
<d:lastModifiedBy>admin</d:lastModifiedBy>
<d:createdDateTime
m:type="Edm.DateTimeOffset">2011-07-28T00:28:27Z</d:createdDateTime>
<d:context>SOURCE</d:context>
<d:respectRBP m:null="true"></d:respectRBP>
<d:relationshipToPosition m:null="true"></
d:relationshipToPosition>
</m:properties>
</content>
</entry>

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Business Examples PUBLIC 843
Related Information

FOWfConfig [page 240]

FOWfConfigStepApprover [page 242]

18.5 Differentiating primary from secondary employment

during concurrent employment replication

What's new?

The mdf entities, SecondaryAssignments and SecondaryAssignmentsItem are now available. This means that it is
now possible to know which employment contract is the primary one for replication scenarios. In a nutshell you can
now build a concurrent employment replication from Employee Central to other 3rd Party systems using OData
APIs. Please note that secondary employment is also known as concurrent employment.

What's the benefit?

Previously it was not possible to differentiate primary from secondary employments using OData APIs. By offering
SecondaryAssignments and SecondaryAssignmentsItems, important data has been made available in one single
API call and you benefit from:

● Simplified API consumption

● Faster integration since you no longer have to deal with logic on middleware
● Extracting data from the integration center
● Not having to build multiple queries to identify secondary employments

How does it work?

The PerPerson entity now has a navigation secondaryAssignmentsNav that lets you navigate to the MDF entity
SecondaryAssignments.

Tell me more

SecondaryAssignments has a business key externalCode (Person ID External) meaning that it references a person.
It has a one to multiple association with the MDF entity SecondaryAssignmentsItem.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

844 PUBLIC Business Examples
SecondaryAssignmentsItems contains the userSysId (Employment/User ID) – this is the unique user ID generated
when a secondary employment is created. It is a child entity of SecondaryAssignments. These assignments are
created and maintained automatically based on the creation or editing of Concurrent Employment.

Good to know

Both entities are effective-dated. If the concept of effective dating is new to you, please take a look at Effective
Dating so that you can make the most out of this new entity.

How can I use it?

In the PerPerson entity, you use the secondaryAssignmentsNav, a visible, sortable, and filterable field to build a
query that navigates to the entity SecondaryAssignments.

Show me a use case: GET

GET Operation: Retrieves the secondaryAssignmentsNav which in turn will return the
SecondaryAssignmentsItems, that is information about the secondary employment.

Request: https://<hostname>.com/odata/v2/PerPerson?$format=json&$filter=personIdExternal
%20eq%20'jsmith'&$expand=secondaryAssignmentsNav/allSfProcesses

Response

 Sample Code

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<hostname>.com/odata/v2/PerPerson('jsmith')",
"type": "SFOData.PerPerson"
},
"personIdExternal": "jsmith",
"dateOfBirth": null,
"lastModifiedOn": "/Date(1303743709000)/",
"lastModifiedDateTime": "/Date(1303743709000+0000)/",
"dateOfDeath": null,
"createdOn": "/Date(1303743708000)/",
"countryOfBirth": null,
"createdBy": "v4admin",
"regionOfBirth": null,
"createdDateTime": "/Date(1303743708000+0000)/",
"lastModifiedBy": "v4admin",
"personId": "11",
"personRerlationshipNav": {
"__deferred": {
"uri": "https://<hostname>.com/odata/v2/
PerPerson('jsmith')/personRerlationshipNav"
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Business Examples PUBLIC 845
 },
"emergencyContactNav": {
"__deferred": {
"uri": "https://<hostname>.com/odata/v2/
PerPerson('jsmith')/emergencyContactNav"
}
},
"phoneNav": {
"__deferred": {
"uri": "https://<hostname>.com/odata/v2/
PerPerson('jsmith')/phoneNav"
}
},
"personalInfoNav": {
"__deferred": {
"uri": "https://<hostname>.com/odata/v2/
PerPerson('jsmith')/personalInfoNav"
}
},
"homeAddressNavDEFLT": {
"__deferred": {
"uri": "https://<hostname>.com/odata/v2/
PerPerson('jsmith')/homeAddressNavDEFLT"
}
},
"secondaryAssignmentsNav": {
"results": [
{
"__metadata": {
"uri": "https://<hostname>.com/odata/v2/
SecondaryAssignments(effectiveStartDate=datetime'2016-06-24T00:00:00',externalCod
e='jsmith')",
"type": "SFOData.SecondaryAssignments"
},
"effectiveStartDate": "/Date(1466726400000)/",
"externalCode": "jsmith",
"mdfSystemObjectType": "SecondaryAssignments",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/Date(1467020470000+0000)/",
"mdfSystemTransactionSequence": "1",
"effectiveEndDate": "/Date(1468108800000)/",
"createdBy": "admin",
"mdfSystemRecordId":
"566D79D0BE2340BC83CC882FF39AAE62",
"mdfSystemEntityId":
"BD0ABACF60354252BFC0E4EDB7F2BE02",
"createdDateTime": "/Date(1467020470000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"lastModifiedDate": "/Date(1467020470000)/",
"lastModifiedDateWithTZ": "/
Date(1467020470000+0000)/",
"createdDate": "/Date(1467020470000)/",
"mdfSystemRecordStatus": "N",
"wfRequestNav": {
"__deferred": {
"uri": "https://<hostname>.com/odata/v2/
SecondaryAssignments(effectiveStartDate=datetime'2016-06-24T00:00:00',externalCod
e='jsmith')/wfRequestNav"
}
},
"allSfProcesses": {
"results": [
{
"__metadata": {
"uri": "https://<hostname>.com/
odata/v2/
SecondaryAssignmentsItem(SecondaryAssignments_effectiveStartDate=datetime'2016-06

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

846 PUBLIC Business Examples
 -24T00:00:00',SecondaryAssignments_externalCode='jsmith',externalCode='c95d6999d0
2e46878dcad5ef2a02397c')",
"type":
"SFOData.SecondaryAssignmentsItem"
},
"SecondaryAssignments_externalCode":
"jsmith",

"SecondaryAssignments_effectiveStartDate": "/Date(1466726400000)/",
"externalCode":
"c95d6999d02e46878dcad5ef2a02397c",
"mdfSystemEffectiveEndDate": "/
Date(253402214400000)/",
"mdfSystemObjectType":
"SecondaryAssignmentsItem",
"mdfSystemVersionId": null,
"lastModifiedDateTime": "/
Date(1467020470000+0000)/",
"usersSysId": "181",
"mdfSystemTransactionSequence": "1",
"createdBy": "admin",
"mdfSystemRecordId":
"448E51556F414997A79F1360D837CD29",
"mdfSystemEntityId":
"DCAF412BC16D46408FB7D3EEDB7DDF63",
"createdDateTime": "/
Date(1467020470000+0000)/",
"lastModifiedBy": "admin",
"mdfSystemStatus": "A",
"lastModifiedDate": "/
Date(1467020470000)/",
"mdfSystemEffectiveStartDate": "/
Date(-2208988800000)/",
"lastModifiedDateWithTZ": "/
Date(1467020470000+0000)/",
"createdDate": "/Date(1467020470000)/",
"mdfSystemRecordStatus": "N",
"usersSysIdNav": {
"__deferred": {
"uri": "https://<hostname>.com/
odata/v2/
SecondaryAssignmentsItem(SecondaryAssignments_effectiveStartDate=datetime'2016-06
-24T00:00:00',SecondaryAssignments_externalCode='jsmith',externalCode='c95d6999d0
2e46878dcad5ef2a02397c')/usersSysIdNav"
}
},
"mdfSystemRecordStatusNav": {
"__deferred": {
"uri": "https://<hostname>.com/
odata/v2/
SecondaryAssignmentsItem(SecondaryAssignments_effectiveStartDate=datetime'2016-06
-24T00:00:00',SecondaryAssignments_externalCode='jsmith',externalCode='c95d6999d0
2e46878dcad5ef2a02397c')/mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<hostname>.com/
odata/v2/
SecondaryAssignmentsItem(SecondaryAssignments_effectiveStartDate=datetime'2016-06
-24T00:00:00',SecondaryAssignments_externalCode='jsmith',externalCode='c95d6999d0
2e46878dcad5ef2a02397c')/mdfSystemStatusNav"
}
}
}
]
},
"mdfSystemRecordStatusNav": {

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Business Examples PUBLIC 847
 "__deferred": {
"uri": "https://<hostname>.com/odata/v2/
SecondaryAssignments(effectiveStartDate=datetime'2016-06-24T00:00:00',externalCod
e='jsmith')/mdfSystemRecordStatusNav"
}
},
"mdfSystemStatusNav": {
"__deferred": {
"uri": "https://<hostname>.com/odata/v2/
SecondaryAssignments(effectiveStartDate=datetime'2016-06-24T00:00:00',externalCod
e='jsmith')/mdfSystemStatusNav"
}
}
}
]
},
"nationalIdNav": {
"__deferred": {
"uri": "https://<hostname>.com/odata/v2/
PerPerson('jsmith')/nationalIdNav"
}
},
"countryOfBirthNav": {
"__deferred": {
"uri": "https://<hostname>.com/odata/v2/
PerPerson('jsmith')/countryOfBirthNav"
}
},
"emailNav": {
"__deferred": {
"uri": "https://<hostname>.com/odata/v2/
PerPerson('jsmith')/emailNav"
}
},
"socialAccountNav": {
"__deferred": {
"uri": "https://<hostname>.com/odata/v2/
PerPerson('jsmith')/socialAccountNav"
}
},
"employmentNav": {
"__deferred": {
"uri": "https://<hostname>.com/odata/v2/
PerPerson('jsmith')/employmentNav"
}
}
}
]
}
}

Show me a use case: Upsert

Upsert Operation: Retrieves the secondaryAssignmentsNav which in turn will return the
SecondaryAssignmentsItems, that is information about the secondary employment. There is not often a business
case for this operation but it has been provided to support the cloning or transfer of data between similar instances
in a different environment. In this example here, user system ID (represented by the externalcode) for the primary
employment is PrimaryEmployment and the userSysID for secondary employment is represented by 301 (a
number automatically generated when a secondary employment is created).

Request: https://<hostname>.com/odata/v2/upsert

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

848 PUBLIC Business Examples
Payload Data

 Sample Code

{
"__metadata": { "uri": "SecondaryAssignments"},
"effectiveStartDate" : "/Date(1420066800000)/",
"externalCode" : "mjaschob",
"allSfProcesses": {
"__metadata": { "uri": "SecondaryAssignmentsItem"},
"SecondaryAssignments_effectiveStartDate" : "/Date(1420066800000)/",
"SecondaryAssignments_externalCode" : "mjaschob",
"externalCode" : "myexternalcode55",
"usersSysId" : "301"
}
}

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Business Examples PUBLIC 849
19 FAQs

You can take a look at the tips and FAQs here to see if they can answer your questions or help you with your APIs. In
some cases, you'll find a brief explanation, and others will guide you to existing topics for your answer.

19.1 Admin Access to OData: What does it mean?

The Allow Admin to Access OData API through Basic Authentication permission lets admins use Basic
Authentication to make API calls. It's available in Role-Based Permissions under Administrator Settings in Manage
Integration Tools.

Two authentication types are available in OData APIs - HTTP Basic Authorization and OAuth 2.0.

HTTP Basic Authorization is less secure but simpler to set up and use - so you might want to use it for testing or in
test clients. OAuth is more complex to set up but more secure.

 Caution

HTTP Basic Authentication will soon be retired. Please migrate to OAuth as soon as possible. For detailed
retirement plan, see the related link.

Related Information

Deprecation of HTTP Basic Authentication

HTTP Basic Authentication (Deprecated)
Authentication Using OAuth 2.0

19.2 API: Do I use OData or Compound Employee API for

Employee Central entities?

 Note

Please don't use SOAP APIs or Ad hoc APIs for building new integrations in Employee Central. The only
exception to this rule is the SOAP based Compound Employee API (CE API).

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

850 PUBLIC FAQs
 What do you need? Use OData API Use CE API

Query only and employee master data No Yes

has to be replicated in full, delta or snap­
shot mode for Employee Central entities

Support of Employee Central entities Yes No

such as Foundation, Person, Employ­
ment, Time-Off, Time Sheet, Position
Management

Historical information? Yes No (because only partial historical infor­

mation is available; not all objects are
covered)

RBP checks Yes Yes

Support of MDF objects Yes No (because only user-based MDF ob­

jects are supported)

Usage in HCP Yes No

UI consumption Yes No

Write or update data Yes No

19.3 APIs are missing or not up-to-date in the OData API Data
Dictionary?

Sometimes you cannot find an entity in the OData API Data Dictionary, or the definition in the dictionary is out of
dated. That might be because the entity is an MDF object and it is not exposed to OData API properly.

For detailed steps on how to solve this problem, see Exposing MDF Objects.

19.4 Broken APIs: What causes them?

Sometimes a system is changed in a way that leads to an API breaking. More often than not, such incompatible
changes are made during configuration of the system and not by the API consumers. Take a look at this list to see
what actions could lead to an incompatible change - by avoiding these actions in the first place, you should be free
of incompatible changes in your system.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

FAQs PUBLIC 851
Incompatible changes that might break APIs

● Removing any field that is exposed by an API from the MDF object definition or HRIS succession data model
will break that API.
● Changing the visibility of any field that is exposed by an API in the MDF object definition or HRIS succession
data model from visible/enabled to invisible/none will break that API
● Removing permissions or provisioning settings for OData APIs will break the API
● Renaming the identifier of customString field in the succession datamodel - this breaks the API because
technically what is actually happening is the deletion of the customString field and creation of a new one.
● Changing the field type from picklist to string
● Deleting codes from picklists

In contrast to these incompatible changes, compatible changes will not break the APIs. Some examples of
compatible changes include:

● Adding a new field

● Renaming a field label
● Changing the RBP setting for a field from read-only to view not allowed

19.5 Duplicate Records?

Tips on avoiding duplicate records

If your're having problems with duplicate records, take a look at these tips.

Duplicate Records: Checklist

Picklists

When you use a picklist label (picklistLabels) in a $filter query, specify the locale to avoid duplicate records.

Background: When a picklist has more than one locale and this is not defined in a query, all the locales will be
queried. This could result in duplicate records.

You must define the locale in your query as follows:

$filter=<entity>Nav/picklistLabels/locale eq 'en_US'

Paging

If pages have duplicates or missing records, one possible reason is undefined sorting. Try using orderBy on the
whole business key to fix this issue.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

852 PUBLIC FAQs
19.6 Error message: Behavior in upsert statements

Upsert statements have a single record error message behavior; for each record that fails, an error message is
issued.

Example: Wrong Gender

Sample Request: https://<Hostname>/odata/v2/Upsert

Content Type: Content-Type: application/json;charset=utf-8

Payload Information:

 Sample Code

[
{
"__metadata" : {
"uri" : "https://<Hostname>/odata/v2/
PerPersonal(personIdExternal='aaaa',startDate=datetime'1990-01-01T00:00:00')",
"type" : "SFOData.PerPersonal"
}, "startDate" : "\/Date(631152000000)\/", "personIdExternal" : "aaaa",
"initials" : "LT", "gender" : "M", "namePrefix" : "LT"
}, {
"__metadata" : {
"uri" : "https://<Hostname>/odata/v2/
PerPersonal(personIdExternal='dddd',startDate=datetime'1990-01-01T00:00:00')",
"type" : "SFOData.PerPersonal"
}, "startDate" : "\/Date(631152000000)\/", "personIdExternal" : "dddd",
"initials" : "LT", "gender" : "H", "namePrefix" : "LT"
}, {
"__metadata" : {
"uri" : "https://<Hostname>/odata/v2/
PerPersonal(personIdExternal='hhhh',startDate=datetime'1990-01-01T00:00:00')",
"type" : "SFOData.PerPersonal"
}, "startDate" : "\/Date(631152000000)\/", "personIdExternal" : "hhhh",
"initials" : "LT", "gender" : "M", "namePrefix" : "LT"
}
]

Response:

 Sample Code

<feed>
<entry>
<content type="application/xml">
<m:properties>
<d:key m:null="true" />
<d:status>OK</d:status>
<d:editStatus>UPSERTED</d:editStatus>
<d:message m:null="true" />
<d:index m:type="Edm.Int32">0</d:index>
<d:httpCode m:type="Edm.Int32">200</d:httpCode>
<d:inlineResults m:type="Bag(SFOData.UpsertResult)" />
</m:properties>
</content>
</entry>
<entry>
<content type="application/xml">
<m:properties>

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

FAQs PUBLIC 853
 <d:key>PerPersonal/personIdExternal=dddd,PerPersonal/
startDate=1990-01-01T00:00:00.000-05:00</d:key>
<d:status>ERROR</d:status>
<d:editStatus m:null="true" />
<d:message>Field Gender is Invalid. Field Gender takes "M" / "m" for Male, "F" /
"f" for Female and " " for No Gender. Failed record info: {PerPersonal/
startDate=1990-01-01T00:00:00.000-05:00, PerPersonal/personIdExternal=dddd,
PerPersonal/initials=LT, PerPersonal/gender=H, PerPersonal/namePrefix=LT}.</
d:message>
<d:index m:type="Edm.Int32">1</d:index>
<d:httpCode m:type="Edm.Int32">500</d:httpCode>
<d:inlineResults m:type="Bag(SFOData.UpsertResult)" />
</m:properties>
</content>
</entry>
<entry>
<content type="application/xml">
<m:properties>
<d:key m:null="true" />
<d:status>OK</d:status>
<d:editStatus>UPSERTED</d:editStatus>
<d:message m:null="true" />
<d:index m:type="Edm.Int32">2</d:index>
<d:httpCode m:type="Edm.Int32">200</d:httpCode>
<d:inlineResults m:type="Bag(SFOData.UpsertResult)" />
</m:properties>
</content>
</entry>
</feed>

19.7 Expanded entities: Handling deleted objects

Describes how deleted objects in $expand can be handled as a change in certain Employee Central OData APIs.

The standard behavior in Employee Central OData API queries, such as the one below, is to ignore any records that
have been deleted.

In this type of query https://<hostname>/odata/v2/PerPerson?$expand=emailNav&

$filter=personIdExternal eq '106015' and emailNav/lastModifiedDateTime ge
datetimeoffset'2000-01-01T01:00:00.000Z', the standard behavior leads to an empty response in which
all person and e-mail records are missing when the root entity is empty. This is because the engine is filtering for
the e-mail info based on the last modified date - however since the object has been deleted, the system cannot find
anything. You now have the chance to capture the deleted operation and update your response with an empty value
for the deleted object, rather than just having an empty response. This ensures that any person synchronization is
accurate.

To override this standard behavior, go to Admin Center Manage Employee Central Settings , and turn on the
switch for Consider Deletion of Expanded Entities As A Change.

Supported Entities: PerEmail, PerPhone, PerAddressDEFLT, EmpJobRelations, PerNationalId,

EmpPayCompNonRecurring, PerEmergencyContact, and EmpWorkPermit.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

854 PUBLIC FAQs
Examples: With and without the feature "Consider Deletion of Expanded
Entities As A Change"

Example: Without "Consider Deletion of Expanded Entities As A Change"

This query shows you any changes to the e-mail records for the employee and time frame specified:

https://<hostname>/odata/v2/PerPerson?$expand=emailNav&$filter=personIdExternal eq
'106015' and emailNav/lastModifiedDateTime ge datetimeoffset'2000-01-01T01:00:00.000Z'

 Sample Code

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://qaautocand-api.lab-rot.ondemand.com/odata/v2/
PerPerson('106015')",
"type": "SFOData.PerPerson"
},
"personIdExternal": "106015",
"lastModifiedDateTime": "/Date(1441580677000+0000)/",
"createdDateTime": "/Date(1441568467000+0000)/",
"createdOn": "/Date(1441568467000)/",
"countryOfBirth": "AUS",
"lastModifiedBy": "admindlr",
"perPersonUuid": "BE297AA97D004D29ADCBE89546F323EA",
"lastModifiedOn": "/Date(1441580677000)/",
"createdBy": "admindlr",
"personId": "339",

....

"emailNav": {
"results": [
{
"__metadata": {
"uri": "https://qaautocand-api.lab-
rot.ondemand.com/odata/v2/PerEmail(emailType='8448',personIdExternal='106015')",
"type": "SFOData.PerEmail"
},
"emailType": "8448",
"personIdExternal": "106015",
"lastModifiedDateTime": "/Date(1441833666000+0000)/",
"createdDateTime": "/Date(1441833666000+0000)/",
"createdOn": "/Date(1441833666000)/",
"emailAddress": "[email protected]",
"customDouble1": null,
"isPrimary": true,
"customDate1": null,
"lastModifiedBy": "admindlr",
"customString5": null,
"customString4": null,
"customString3": null,
"customString2": null,
"customString8": null,
"customString7": null,
"customString6": null,
"lastModifiedOn": "/Date(1441833666000)/",
"customString1": null,
"createdBy": "admindlr",
"customLong1": null,

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

FAQs PUBLIC 855
 "customString3Nav": {
"__deferred": {
"uri": "https://qaautocand-api.lab-
rot.ondemand.com/odata/v2/PerEmail(emailType='8448',personIdExternal='106015')/
customString3Nav"
}
},

....
}
]
}
}
]
}
}

Example: Without "Consider Deletion of Expanded Entities As A Change" and

after an agent has deleted the e-mail information for the employee in the
system

Let's run the query again, https://<hostname>/odata/v2/PerPerson?$expand=emailNav&

$filter=personIdExternal eq '106015' and emailNav/lastModifiedDateTime ge
datetimeoffset'2000-01-01T01:00:00.000Z'

 Sample Code

Response

{
"d": {
"results": []
}
}

All records of the employee have been removed. This causes issues - if instead of e-mail information, for example,
an address or a dependent is deleted - the system responds in the same way to the lastmodified query. Instead of
updating the response with an empty value for deleted object, all records are removed.

Example: With "Consider Deletion of Expanded Entities As A Change" and after

an agent has deleted the e-mail information for the employee in the system

 Sample Code

{
"d": {
"results": [
{
"__metadata": {
"uri": "https://qaautocand-api.lab-rot.ondemand.com/odata/v2/
PerPerson('106015')",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

856 PUBLIC FAQs
 "type": "SFOData.PerPerson"
},
"personIdExternal": "106015",
"lastModifiedDateTime": "/Date(1441580677000+0000)/",
"createdDateTime": "/Date(1441568467000+0000)/",
"createdOn": "/Date(1441568467000)/",
"countryOfBirth": "AUS",
"lastModifiedBy": "admindlr",
"dateOfBirth": "/Date(-520387200000)/",
"perPersonUuid": "BE297AA97D004D29ADCBE89546F323EA",
"lastModifiedOn": "/Date(1441580677000)/",
"createdBy": "admindlr",
"regionOfBirth": null,
"personId": "339",
....

"emailNav": {
"results": []
}
}
]
}
}

Instead of an empty response without any e-mail or person information, the e-mail information (the expanded
entity that was deleted) has been updated with an empty value and the other information appears in the response.

19.8 How to have more than one pay component on the same
pay date

When an employee is due more than one non-recurring payment on the same pay date, an additional business key,
sequenceNumber, can be added to EmpPayCompNonRecurring.

You can configure the data model to add this field as an additional business key (as long as it is upsertable in the
data model).

Related Information

EmpPayCompNonRecurring [page 148]

19.9 Inactive users: Do Employee Central OData APIs ignore

them?

To ignore inactive users in your Employee Central OData API calls, you have to explicitly select them in the User
entity using the property status. Terminated employees will still appear on entities such as PerPerson or EmpJob so
the only way to exclude them is by using the User entity and filtering by the property status which supports the

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

FAQs PUBLIC 857
values "t / f / T / F / e / d" or "active / inactive / active_external / inactive_external / active_external_suite /
inactive_external_suite".

For more information, see Querying Different Types of Users.

19.10 Linking to custom MDF objects

Explains how to link MDF objects to Employee Central OData APIs.

If you want to link to a custom MDF object, you will need a combination of UPSERT and POST. This is because the
upserts for MDF objects and Employee Central OData APIs are not compatible.

Example

Let's assume that you want to add information about where an employee's office is located in the employee job
information. To do this, you will need the following:

1. Create (Post) an MDF object for office.

 Note

This is a prerequisite. Even if you update the EmpJob entity with a business key for office and then upsert,
the office will not be created. Updating the entity with the key allows you to link to an existing object only.

2. Add the business key for the MDF object (which already exists) to EmpJob

19.11 Performance: How to improve it

Here are some tips on how to improve API performance and consumption:

To be avoided Try this instead

Too many deep filters in a query Make sure you are using all the direct available fields in the en­
tity

Massive result sets Use $select to limit the result set.

$expand for unnecessary navigations Do you really need those navigations? Are they directly availa­
ble fields in the entity.

Merging API calls using navigation (if this is negatively impact­ Use $BATCH instead
ing performance)

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

858 PUBLIC FAQs
 To be avoided Try this instead

Full loads Use last modified queries

Calculated fields in expanded entities in empCompensation­ Use rules instead in custom fields to persist the values
Calculated and empCompensationGroupSumCalculated

Writing data using incremental update Use full purge instead, if possible.

Writing data including triggering of rules for job information Disable Triggering of Rules in Company and Logo settings and
(EmpJob) calculate values for rules in consumer.

19.12 Roundtrips: Why are there errors in some upserts?

If you're getting roundtrip errors, this might be down to a conflict between the user locale and the fileLocale.

You can resolve this problem by making sure that your user locale and fileLocale are both en_US. Take a look
atfileLocale [page 52] for more information.

19.13 Side Effect: What Is It?

A side effect is sometimes triggered when an API consumer performs a write operation.

The side effects triggered by the write operation are different in the OData API from the side effects triggered in UI.
Sometimes the difference is profound. For example, a workflow is triggered in the UI but not in the OData API.
Sometimes the difference is minor. When an HRIS Sync is triggered directly in the UI but indirectly in the API or
data imports via an asynchronous sync job sending e-mails when the job starts and finishes.

Take a look at these examples to get an overview of what side effects are triggered:

● Triggering of workflows: OData APIs and data imports have the same behaviors. For how to create an approval
process by configuring workflows to review data being imported, see Configuring Workflows for Data Imports.
● Triggering of business rules: OData APIs and data imports have the same behaviors. For how to configure
business rules during data imports, see Configuring Business Rules for Data Imports.

 Note

You can use the API rule context to determine whether specific OnChange or OnSave rules are required to
be triggered during an API upsert. For details, see Adding Contexts for Business Rules.

● Triggering of HRIS sync: If there is at least one recurring HRIS Sync job configured in your company instance,
an HRIS element import triggers an HRIS Sync job run. Only one HRIS Sync job can run at a time. For more
information, see the EC Data Import or User Data Changes Through API section in Triggering HRIS Sync.
● Triggering of Intelligence Services: Intelligence services are triggered by rules only. For the list of the Intelligent
Services events published by Employee Central and how to configure rules for the events, see Employee
Central Events for Intelligent Services and its child topics.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

FAQs PUBLIC 859
● Triggering of hard-coded business logic in Position Management, Global Assignment and Time Off: An
asynchronous process synchronizes Position and Time-off data in these products and this event is hard-coded.
The only OData API that can trigger this hard-coded business logic is EmpJob.

19.14 Upsert Behavior in a $batch ChangeSet

Learn how upsert works in a $batch ChangeSet.

Upsert operations in a $batch ChangeSet follow the "all-or-nothing" rule. That means, if one record fails to upsert,
all other changes will roll back.

 Caution

Upsert parameter strictTransactionIsolate is ignored in a ChangeSet.

Adding Upsert Parameters

You can add upsert parameters in a $batch ChangeSet. Here's an example:

--batch_202010071357
Content-Type: multipart/mixed; boundary=changeset_202010071357
Content-Length: 100
--changeset_202010071357
Content-Transfer-Encoding: binary
Content-Type: application/http
POST upsert?purgeType=full HTTP/1.1
Content-Type: application/json;charset=utf-8
accept:application/json
<JSON/Atom representation of an upsert operation>
--changeset_202010071357--

--batch_202010071357--

Returning All Upsert Errors in a ChangeSet

By default, if errors occur to an upsert operation in a $batch ChangeSet, only the first error is returned no matter
how many entities are in the upsert payload. However, you can use parameter
enableUpsertResponseExtensionInChangeset to control whether all error messages of an upsert operation
in a ChangeSet are returned. To return all upsert error messages, set the parameter to true in the request.

This is an example of the complete upsert errors returned in batch operation:

{
"error": {
"code": "COE_GENERAL_SERVER_FAILURE",
"message": {
"lang": "en-US",

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

860 PUBLIC FAQs
 "value": "ChangeSet index 1 - Upsert error"
},
"innererror": {
"errordetails": [
{
"code": "cust_MDF35137/
effectiveStartDate=2000-01-01T00:00:00.000Z,cust_MDF35137/externalCode=P1",
"message": "Invalid value 'DummyValue' for the Generic Object
field 'cust_gof'.;Invalid Picklist value: 'DummyValue'.;Invalid User ID: 'abc123'.",
"severity": "error",
"target": ""
},
{
"code": "cust_MDF35137/
effectiveStartDate=2000-01-01T00:00:00.000Z,cust_MDF35137/externalCode=P1",
"message": "Invalid value 'DummyValue' for the Generic Object
field 'cust_gof'.;Invalid Picklist value: 'DummyValue'.;Invalid User ID: 'abc123'.",
"severity": "error",
"target": ""
},
{
"code": "cust_MDF35137/
effectiveStartDate=2001-01-01T00:00:00.000Z,cust_MDF35137/externalCode=P1",
"message": "Invalid User ID: 'abc123'.",
"severity": "error",
"target": ""
}
]
}
}
}

Related Information

enableUpsertResponseExtensionInChangeset

19.14.1 strictTransactionIsolate

strictTransactionIsolate is an upsert parameter for determining if partial upsert applies during multiple-
record upserts.

Parameter Values

 Caution

The strictTransactionIsolate parameter is used to ensure data integrity during upsert. Using the
parameter could result in performance degradation, the extent of which depends on the single record
processing time and the batch size.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

FAQs PUBLIC 861
Value Description

false (default) Standard upsert behavior: one failed record during upsert
causes all records to fail.

true ● When you upsert multiple records, the upsert status of

one record doesn't affect the others.
● When you upsert multiple records in a $batch request, if
one record fails, the entire changeset rolls back.

Use Case

The value of strictTransactionIsolate can be applied in the following use cases:

● Multiple record upserts

● Upserts of entities that don’t support full purge

If you upsert a single record, this parameter is ignored.

19.15 $filter: How does it work with fromDate?

If you're puzzled by the results you get from queries such as https://<api-server>/odata/v2/EmpJob?
$filter=standardHours+gt+'20'&fromDate=2000-12-31, then take a quick look at the examples in
fromDate and toDate (Date Range) Query.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

862 PUBLIC FAQs
Important Disclaimers and Legal Information

Hyperlinks
Some links are classified by an icon and/or a mouseover text. These links provide additional information.
About the icons:

● Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your agreements
with SAP) to this:

● The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.
● SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any
damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.

● Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering a SAP-hosted Web site. By using such links, you
agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this information.

Videos Hosted on External Platforms

Some videos may point to third-party video hosting platforms. SAP cannot guarantee the future availability of videos stored on these platforms. Furthermore, any
advertisements or other content hosted on these platforms (for example, suggested videos or by navigating to other videos hosted on the same site), are not within the
control or responsibility of SAP.

Beta and Other Experimental Features

Experimental features are not part of the officially delivered scope that SAP guarantees for future releases. This means that experimental features may be changed by SAP at
any time for any reason without notice. Experimental features are not for productive use. You may not demonstrate, test, examine, evaluate or otherwise use the
experimental features in a live operating environment or with data that has not been sufficiently backed up.
The purpose of experimental features is to get feedback early on, allowing customers and partners to influence the future product accordingly. By providing your feedback
(e.g. in the SAP Community), you accept that intellectual property rights of the contributions or derivative works shall remain the exclusive property of SAP.

Example Code
Any software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax and
phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of example
code unless damages have been caused by SAP's gross negligence or willful misconduct.

Bias-Free Language
SAP supports a culture of diversity and inclusion. Whenever possible, we use unbiased language in our documentation to refer to people of all cultures, ethnicities, genders,
and abilities.

SAP SuccessFactors Employee Central OData API: Reference Guide (V2)

Important Disclaimers and Legal Information PUBLIC 863
www.sap.com/contactsap

© 2022 SAP SE or an SAP affiliate company. All rights reserved.

No part of this publication may be reproduced or transmitted in any form

or for any purpose without the express permission of SAP SE or an SAP
affiliate company. The information contained herein may be changed
without prior notice.

Some software products marketed by SAP SE and its distributors

contain proprietary software components of other software vendors.
National product specifications may vary.

These materials are provided by SAP SE or an SAP affiliate company for

informational purposes only, without representation or warranty of any
kind, and SAP or its affiliated companies shall not be liable for errors or
omissions with respect to the materials. The only warranties for SAP or
SAP affiliate company products and services are those that are set forth
in the express warranty statements accompanying such products and
services, if any. Nothing herein should be construed as constituting an
additional warranty.

SAP and other SAP products and services mentioned herein as well as
their respective logos are trademarks or registered trademarks of SAP
SE (or an SAP affiliate company) in Germany and other countries. All
other product and service names mentioned are the trademarks of their
respective companies.

Please see https://www.sap.com/about/legal/trademark.html for

additional trademark information and notices.

THE BEST RUN