SAP Knowledge Base Article - Public

2711536 - b1811: Time Account Snapshot API Public Release

Symptom

Prior to 1808 release, TimeAccountSnapshot entity is classified as restricted / internal cannot be used publicly in API

TImeAccountSnapshotAPIQuery.png

Image/data in this KBA is from SAP internal systems, sample data, or demo systems. Any resemblance to real data is purely coincidental.

Environment

  • SAP SuccessFactors Employee Central
  • SAP SuccessFactors Employee Central Time Off

Resolution

With 1811 release, TimeAccountSnapshot entity has been added to public namespace and is now available for public usage in API.

Sample Time Account Snapshot Record:

TimeAccountSnapshotSampleRecord.png

Response Payload:

TimeAccountSnapshotAPIQuery1.png

Frequently Asked Questions (FAQ):

1. What is a Time Account Snapshot?

Time Account Snapshot is an MDF entity from Time Management module which contains the balance information of a specific time account for a user as of a particular point in time. It is used for employee's leave liability calculation and for payroll processing.

Field

Description

User

This is the user that the snapshot applies to.

As of Pay Period End

Yes means that the leave balance appears on the user's payslip and is replicated to Employee Central Payroll.

As of Accounting Period End

Yes means that the snapshot is for leave liability reporting and is replicated to Employee Central Payroll.

Time Account Type

This must be a time account type that has Snapshots Allowed set to Yes.

Balance

This is the balance of the time accounts for the associated time account type that are open and valid. If simulation is active, the balance also includes the simulated result.

Unit

This can be hours or days, but must match the time unit of the associated time account type.

Balance Effective Date

This is the date that balances are calculated on.

External Code

This is auto-generated code used by the system to identify the snapshot record. Default format of external code is userId_Time Account Type InternalCode_Snapshot Balance As of EffectiveDate YYYYMMdd

Outdated

Payroll Integration indicates that the snapshot is out of date.

Balance Not Considering Pending Requests

If Do Not Consider Pending Requests When Calculating Balance is set to Yes in the associated time account type, this field contains the balance excluding pending absences.

Balance Accrual Separated

If the entitlement method in the time account type is Entitled as Transferred, the balance accrual separated contains the sum of accruals after the last transfer.

If the entitlement method in the time account type is Entitled as Accrued, the field is empty.

2. How are Time Account Snapshots created?

Time Account Snapshot can be created by creating and running a Snapshot Creation calendar in Manage Time Off Calendars. For more information on how to use the fields in the New Calendar for Snapshot Creation, refer to Setting Up Time Account Snapshots Feature under See Also section of this article.

ManageTimeOffStructures_SnapshotCreation.png

3. Is there a prerequisite to be able to publicly use the TimeAccountSnapshot entity in API?

Yes. Time Off feature must be enabled. To validate if Time Off feature is enabled in your environment, login to Provisioning then check if "Enable Time Off" must be checked in Provisioning. As an administrator, you may also check in Admin Center > Manage Employee Central Settings if 'Time Off' switch is turned on.

TimeOffEmployeeCentralSettings.png

3. What are the supported operations for the TimeAccountSnapshot entity?

As of this time, only GET operation is supported. Currently, PUT, MERGE, DELETE, UPSERT and POST operations are not supported.

See Also

For more information about Time Account Snapshot feature, refer to the following sections of our EC Time Off Implementation Guide:

Keywords

TimeAccountSnapshot, API, MDF, Leave Liability, Time Account Snapshot, Snapshot Creation, TIM-6478 , KBA , LOD-SF-EC-TIM , Time Off , LOD-SF-INT-ODATA , OData API Framework , Product Enhancement

Product

SAP SuccessFactors Employee Central 1808 ; SAP SuccessFactors Employee Central 1811