January 9th 2025, Release Notes: HS| Platform 5.130: GET Timecards API v5 Enhancements

Summary

Select the release feature from the table below to be taken directly to that section of the release note.

Release date for all features: January 9th, 2025

GET Timecards API v5 Enhancements 

• Enabled by default? - No
• Set up by customer admin? - No
• Enable via support ticket? - Yes
• Affects configuration or data? - No
• Roles affected: - N/A

What's Changing?

The GET Timecards API v5 introduces the following enhancements:

1. Contemplates the stores time zone in closed punches, so that timestamp data is HS UI:
   • The values of Clockin/ ClockOut & BreakStart/ BreakEnd for closed punches in the API response now contain the times exactly as displayed in the UI. The correct time zone is displayed, corresponding to the store's actual one at the moment of the request. 
2. Includes ovtTtl, regTtl, dtTtl data for open punches. 
   • The values on "ovtTtl", "regTtl", "dtTtl" for punches are a result of calculating wage *Hrs, so that the value shown in "Ttl" is always consistent. 
     • The values of "ovtTtl" for an open punch is = to ovtWage * ovtHrs
     • The values of "regTtl" for an open punch is = to regWage*  regHrs
     • The values of "dtTtl" for an open punch is = to dtWage * dtHrs
3. Optimized to improve it's performance. 
   • The API can now support double the number of stores, going from begin limited to 500 stores to now 1000 stores. 
4. Accepts both Store ID Num and Alpha Numeric Store ID. 
   • Considers the store ID format sed by the company. Whether the company uses the Store ID Num or the Alpha Numeric Store ID, users can successfully make the call. 

Reason for the Change

These enhancements were made to improve the usability, accuracy, and scalability of the GET Timecards API v5. 

• Store Time Zone alignment: There were discrepancies between the time displayed in the API and the HS UI for closed punches. By reflecting the store's time zone, the API now ensures consistency and avoids confusion. 
• Data Completeness for Open Punches: Adding "ovtTtl", "regTtl," and "dtTtl" data for open punches as they have for closed punches. 
• Performance Optimization: The increases in supported store limits from 500 to 1,000 stores improves scalability, enabling larger customers to efficiently use the API without encountering performance constraints. This comes as a result of the ongoing efforts to improve the methods' performance. 
• Flexible Store IS usage: By allowing both Store ID Num and Alpha Numeric Store IF, the API becomes more versatile, accommodating both possible clients' configurations and simplifying its adoption. 

Customers Affected

Time and Attendance customers with less than 1000 stores. 

Release Note Info/Steps

Full API specifications, including request and response examples, will be delivered through the standard channels.