SAP SuccessFactors Employee Central OData API: Reference …

1 PUBLIC. Document Version: 2H 2021 2021-12-23. SAP SuccessFactors Employee Central OData API: Reference guide 2021 SAP SE or an SAP affiliate company. All rights reserved. THE BEST RUN. Content 1 About Employee Central OData APIs..15. Getting Started.. 15. Getting the most out of this guide .. 15. What is Employee Central ?..17. What is an Entity?.. 17. What is an Employee Central OData API?.. 18. When is an Employee Central OData API used?.. 19. What's does Admin and User Mode mean?.. 19. Getting users up and running: Provisioning ..20. Getting Users up and Running: Permission Settings.. 20. Employee Central Entity Relationships.. 23. Entity Association & Navigation.. 29. Navigation to the Picklist entity.. 30. Navigation to the User entity.. 30. Navigation to MDF entity.. 30. Foundation Object Navigation.. 30. Navigation to Territory entity.

2 31. CSF Entity Navigation.. 31. Person Entity Navigation.. 31. Employment Entity Navigation.. 32. Navigation from User and MDF Entities to Employee Central Entities.. 32. Country/Region-Specific Logic.. 32. EmpCompensation/EmpJob/EmpEmployment.. 33. PerGlobalInfo<Country/Region>..33. FOCorporateAddressDEFLT / HrisEmergencyContactAddressDEFLT.. 33. PerAddressDEFLT.. 34. FOLegalEntityLocal<Country/Region> .. 34. FOJobClassLocal<Country/Region>.. 35. PerNationalId .. 35. Date Handling for Employee Central Entities.. 35. Effective Dating .. 36. Getting your time zones right.. 47. Employee Central Entity Properties.. 49. Retrieving changes to records..49. Business keys.. 50. Property Attribute Configuration.. 53. SAP SuccessFactors Employee Central OData API: Reference guide 2 PUBLIC Content Processing Parameters for Upsert.. 54. suppressUpdateOfIdenticalData.

3 54. fileLocale.. 55. Pagination.. 56. Use &&NO_OVERWRITE&& When Upserting Entities.. 59. External Users' Access to Employee Central OData APIs..60. 2 Advances.. 62. AdvancesAccumulation..62. AdvancesEligibility.. 63. NonRecurringPayment.. 63. 3 Apprentice Management.. 65. Apprentice.. 65. ApprenticeEventType.. 67. ApprenticeInternalTrainingEvent.. 68. ApprenticePracticalTrainingEvent..70. ApprenticeSchool.. 72. ApprenticeSchoolEvent.. 73. 4 Contingent Workforce..75. VendorInfo.. 75. WorkOrder.. 79. 5 Deductions.. 85. DeductionScreenId.. 85. OneTimeDeduction.. 86. RecurringDeduction.. 87. 6 Employment Objects.. 88. EmpBeneficiary .. 88. EmpCompensation..88. EmpCompensationCalculated.. 95. EmpCompensationGroupSumCalculated..97. EmpEmployment.. 100. EmpEmploymentTermination.. 107. EmpGlobalAssignment..112. EmpJob.. 115. EmpJobRelationships.

4 121. EmpPensionPayout.. 124. EmpWfRequest.. 125. EmpWorkPermit.. 128. EmpPayCompNonRecurring .. 143. SAP SuccessFactors Employee Central OData API: Reference guide Content PUBLIC 3. EmpPayCompRecurring .. 146. EmpTimeAccountBalance.. 149. HireDateChange.. 154. EmpCostDistribution.. 156. EmpCostDistributionItem.. 162. SecondaryAssignments.. 167. SecondaryAssignmentsItem.. 171. 7 Employee Central for Public Sector.. 173. HDTempAssignment.. 173. EmpCostAssignment.. 177. EmpCostAssignmentItem.. 183. FundGO.. 186. FundCenterGO.. 189. GrantGO..193. BudgetPeriodGO..196. FunctionalAreaGO.. 199. 8 Fiscal Year Objects.. 203. FiscalYearVariant.. 203. FiscalYearToCountryMap..205. 9 Foundation Objects.. 207. Foundation Object Structure in OData API..207. FODynamicRole ..209. FOEventReason.. 211. FOFrequency.. 213. FOGeozone..215. FOLocation.

5 216. FOLocationGroup.. 220. FOPayComponent.. 221. FOPayComponentGroup.. 224. FOPayGrade..226. FOPayRange..227. FOWfConfig.. 230. FOWfConfigStepApprover.. 232. Working with Migrated Foundation Objects (MDF FOs).. 235. Basic Tasks.. 237. Associations.. 238. Country/region-Specific Fields.. 238. Difference Between FO Upsert and MDF Upsert.. 253. CurrencyExchangeRate.. 253. SAP SuccessFactors Employee Central OData API: Reference guide 4 PUBLIC Content FOBusinessUnit..258. FOCostCenter.. 262. FOCompany.. 266. FODepartment.. 271. FODivision..275. FOLegalEntityLocal<Country/Region>.. 279. FOJobClassLocal<Country/Region>.. 287. JobClassificationCountry.. 291. FOJobFunction.. 295. FOJobCode.. 299. FOPayGroup.. 310. PayCalendar.. 314. 10 Global Benefits Objects.. 321. Benefit.. 321. BenefitAutomaticActionConfiguration.. 322. BenefitBalanceCarryForward.

6 323. BenefitClaimAccumulation.. 326. BenefitCompanyCarAllowedModels.. 327. BenefitCompanyCarLeaseServiceProvider.. 328. BenefitsConfirmationStatementConfigurati on.. 329. BenefitCompanyCarRecommendedVendors.. 331. BenefitContact.. 332. BenefitDeductibleDetails.. 333. BenefitDocuments.. 335. BenefitEmployeeClaim.. 336. BenefitEnrollment..338. BenefitEnrollmentDependencyConfiguration .. 340. BenefitEnrollmentDependencyDetails.. 341. BenefitEnrollmentOptoutDetail.. 343. BenefitEmployeeOptoutRequests..345. BenefitEventDetermination.. 346. BenefitEventProcessingLog.. 347. BenefitOpenEnrollmentCycleConfiguration. . 349. BenefitsException.. 351. BenefitHyperlinkConfiguration..352. BenefitInsurancePlan.. 354. BenefitInsurancePlanEnrollmentDetails.. 357. BenefitInsurancePlanUSA.. 359. BenefitInsuranceDependentDetail.. 361. BenefitInsuranceCoverage.

7 363. BenefitInsuranceProvider.. 366. SAP SuccessFactors Employee Central OData API: Reference guide Content PUBLIC 5. BenefitInsuranceEnrolleeOptions.. 368. BenefitInsuranceRateChart.. 370. BenefitInsuranceRateChartEnrollee.. 373. BenefitInsuranceRateChartFixedAmount.. 375. BenefitInsuranceCoverageOptions.. 378. BenefitInsuranceCoverageDetails.. 380. BenefitInsuranceEnrolleeType.. 383. BenefitOverviewHyperlinkConfiguration.. 385. BenefitOverviewHyperlinkDetails.. 386. BenefitProgramEnrollment.. 387. BenefitProgram.. 388. BenefitSavingsPlanEnrollmentDetails..390 . BenefitSavingsPlanCatchUpDetail.. 392. BenefitSavingsPlanContingentBeneficiary. . 393. BenefitSavingsPlanERContributionConfigDe tail.. 394. BenefitSavingsPlanERContributionConfig.. 396. BenefitSavingsPlanPrimaryBeneficiary.. 397. BenefitSavingsPlanTierConfiguration.. 398.

8 BenefitSchedulePeriod.. 399. BenefitSchedules.. 401. BenefitEffectiveDate.. 402. BenefitEvent.. 404. BenefitLifeEvent.. 405. BenefitDeductibleAllowanceEnrollment.. 407. BenefitsIntegrationRecurringInfo.. 408. ConfigurationProcessingLogDetails.. 411. EventDeterminationRuleConfiguration.. 413. EmployeeDismissalProtection.. 414. EmployeeDismissalProtectionDetail.. 417. EmployeeWithEmployerMatchContributions.. 420. EmployeeWithEmployerMatchContributionEnt ries.. 422. LegalEntityListForEventRule.. 425. BenefitPensionMinMaxContributionLimits.. 426. BenefitPensionAdditionalContributionLimi ts.. 429. PensionBandingConfiguration.. 432. PensionBandingConfigurationDetails.. 434. IRSP remiumTable.. 436. ImputedCostForAgeRanges.. 439. 11 Payment Information Objects.. 441. Bank.. 442. PaymentInformationDetailV3 GHA and PaymentInformationDetailV3 SUR.

9 445. SAP SuccessFactors Employee Central OData API: Reference guide 6 PUBLIC Content PaymentInformationDetailV3 ZAF..448. PaymentInformationDetailV3 MOZ.. 459. 12 Payroll.. 464. DataReplicationProxy.. 464. EmployeePayrollRunResults.. 465. EmployeePayrollRunResultsItems.. 472. PayrollDataMaintenanceTask.. 472. PayrollDataMaintenanceTaskConfiguration. . 475. PayrollSystemConfiguration.. 480. SAPS ystemConfiguration.. 497. 13 Person Objects..499. PerAddressDEFLT.. 499. PerEmail.. 502. PersonEmpTerminationInfo.. 505. PerEmergencyContacts .. 506. PerGlobalInfo<Country/Region>.. 509. PerNationalId.. 515. PerPerson.. 518. generateNextPersonID.. 521. PerPersonal.. 524. PerPersonRelationship.. 529. PerPhone..533. PerSocialAccount.. 536. PersonKey.. 537. PersonType.. 539. PersonTypeUsage.. 541. 14 Position Management..545. PositionRightToReturn.

10 546. Position.. 547. PositionCompetencyMappingEntity.. 554. PositionEntity.. 559. 15 Service Center.. 564. ServiceCenterConfiguration.. 564. LandingPageConfiguration.. 570. CreateTicketPageConfiguration.. 574. 16 Time & Attendance Management.. 578. Time Off Objects.. 578. AbsenceCountingMethod.. 578. SAP SuccessFactors Employee Central OData API: Reference guide Content PUBLIC 7. AccrualCalculationBase.. 580. AvailableTimeType..582. EmployeeTime.. 584. EmployeeTime<Country/Region>..586. EmployeeTimeCalendar.. 605. EmployeeTimeGroup.. 606. EmployeeTimeGroupItem.. 610. Holiday.. 615. HolidayAssignment.. 617. HolidayCalendar.. 621. ShiftClassification.. 622. Temporary Time Information API..624. TimeAccount..627. TimeAccountDetail.. 634. TimeAccountPayoutProfile.. 637. TimeAccountPostingRule.. 641. TimeAccountPurchaseProfile.. 642.