Attendance Transaction API

Modified on Thu, 10 Jun 2021 at 11:45 AM

API Details

ParticularsDescription
API NameAttendance Transaction
MethodPOST
URLhttps://portal.zinghr.com/2015/route/TNA/Employeeattendancetransactions
Description
This API returns every employee’s shift details and attendance status details
Input format
JSON
Output format
JSON



Input

Property NameData TypeDescriptionMandatoryRemarks
SubscriptionName
string
Subscription name of the account
Yes
Max length = 10 characters
TokenstringSecurity check. To verify the account and request
Yes
Actionfromdate
string
For shift details starting from the mentioned date
Date format: dd-mm-yyyy
Optional
Actiontodate
stringFor shift details till the mentioned date
Date format: dd-mm-yyyy
Optional

Attendancestatus
stringIf specified then API returns details for the status that is passed.
Possible values: A, P, WOFF, HD
Optional

EmployeeCode
string
Returns attendance details for the specific employee. Only one employee code can be passed at a time
Optional



Response

Property NameData TypeDescription
MessagestringResponse message from the server
CodeintResponse code from the server
AttendanceDetails
array
List of Attendance Transaction



Response Code and Message

CodeMessageRemarks
1Success
Successful API call
2
Employee not found
Employee code passed in parameter could not find an employee in the system
3Invalid Token
The token passed in the API did not match the token in the system. Validate the token from the Setup Circle in ZingHR portal
4Internal Server Error
The API execution faced an unexpected error
5Invalid date format
Use date format as dd-mm-yyyy
6Token expired
The token is expired and needs to be generated again. Token can be generated from the Setup Circle in ZingHR portal



Attendance Transaction

Property Name

Data Type

Description

EmployeeCode

string

Employee code of the employee as in the system

Shiftname

string

Shift name to which the employee is assigned to

Shiftdate

string

Date when the Shift applies to the employee

Shiftstartdate

string

Shift start time in hh:mm

Shiftenddate

string

Shift end time in hh:mm

Actualstarttime

string

First swipe of the employee

Actualendtime

string

Last swipe of the employee

Attendancestatus

string

Employee’s attendance status on the particular date

Managercode

string

Employee code of the employee’s manager

RegIn

string

Regularization In Time hh : mm

RegOut

string

Regularization Out Time hh : mm

ODIn

string

Outdoor In Time hh : mm

ODOut

string

Outdoor Out Time hh : mm

InTimeSourceStringBiometric, ZingHR App, Regularization, OutDoor or Leave
InTimeLocationStringBiometric Id incase source is biometric, Geo Location incase of ZingHR App and blank in other cases
OutTimeSourceStringBiometric, ZingHR App, Regularization, OutDoor or Leave
OutTimeLocationStringBiometric Id incase source is biometric, Geo Location incase of ZingHR App and blank in other cases
ODApprovedByStringOutDoor Approved By
ODApprovedOnStringOutDoor Approved Time hh: mm
RegApprovedByStringRegularization Approved By
RegApprovedOnStringRegularization Approved Time hh: mm
Leave Approved ByStringLeave Approved By 
Leave Approved On StringLeave Approved Time hh: mm



Approved Backdated  Transaction-


This  will return transactions which are approved on the date which is given in input .The column and response is same as Attendance Transaction Section .









Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article