Attendance

Security

Authorization

apiKey	API Key
Name	x-access-token
In	header

/v1/people/attendance

GET

Summary

Search attendance details.

Description

API to search attendance details.

Parameters

Name	Located in	Description	Required	Schema
filter	query	filter	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
searchField	query	searchField	No	string
searchString	query	searchString	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string
userType	query	userType	No	string

Responses

Code	Description	Schema
200	Attendance details have been fetched successfully.	AttendanceDetailDTO
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Save attendance punching data

Description

API to save attendance punching details.

Parameters

Name	Located in	Description	Required	Schema
punchDTO	body	punchDTO	Yes	PunchDTO

Responses

Code	Description	Schema
200	OK	PunchDTO
201	Attendance punching data has been posted successfully	PunchDTO
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

/v1/people/attendance/bulk

POST

Summary

Save attendance punching data in bulk

Description

API to save attendance punching details.

Parameters

Name	Located in	Description	Required	Schema
attendanceBulkRequestDto	body	attendanceBulkRequestDto	Yes	AttendanceBulkRequestDto

Responses

Code	Description	Schema
200	OK	AttendanceBulkResponseDto
201	Attendance punching data has been posted successfully	AttendanceBulkResponseDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

/v1/people/attendance/export/punchlog

POST

Summary

getAttendanceDetailsForExport

Parameters

Name	Located in	Description	Required	Schema
exportAttendanceDetailsWithPunchLogDTO	body	exportAttendanceDetailsWithPunchLogDTO	Yes	AttendanceAndLogExportRequestDto

Responses

Code	Description	Schema
200	OK	[ AttendanceAndPunchLogRespose ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

/v1/people/attendance/getAttendanceExportData

GET

Summary

getAttendanceExportData

Parameters

Name	Located in	Description	Required	Schema
designation	query	designation	No	string
month	query	month	Yes	integer
shift_id	query	shift_id	No	string
year	query	year	Yes	integer

Responses

Code	Description	Schema
200	OK	AttendanceExportResponseDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

/v1/people/attendance/migrate

GET

Summary

calculate punch logs migration

Description

API to calculate punch logs migration

Responses

Code	Description
200	attendance calculated punching data has been updated successfully
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

/v1/people/attendance/proxy

POST

Summary

Save proxy attendance punching data

Description

API to save proxy attendance punching details.

Parameters

Name	Located in	Description	Required	Schema
punchDTO	body	punchDTO	Yes	PunchDTO

Responses

Code	Description	Schema
200	OK	PunchDTO
201	Proxy attendance punching data has been posted successfully	PunchDTO
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Updated proxy attendance punching data

Description

API to update proxy attendance punching details.

Parameters

Name	Located in	Description	Required	Schema
punchingUpdateDto	body	punchingUpdateDto	Yes	PunchingUpdateDto

Responses

Code	Description	Schema
200	OK	PunchingUpdateDto
201	Proxy attendance punching data has been updated successfully	PunchingUpdateDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

/v1/people/attendance/proxy/bulk

PUT

Summary

Add bulk proxy attendance punching data

Description

API to add bulk proxy attendance punching details.

Parameters

Name	Located in	Description	Required	Schema
punchingUpdateDto	body	punchingUpdateDto	Yes	[ PunchingUpdateDto ]

Responses

Code	Description	Schema
200	OK	BulkAttendanceResponse
201	Bulk proxy attendance punching data has been addedd successfully	BulkAttendanceResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

/v1/people/attendance/self

GET

Summary

Get logged-in user attendance details.

Description

API to get logged-in user attendance details.

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Attendance details have been fetched successfully.	AttendanceDetailDTO
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

/v1/people/attendance/shifts/payrun

POST

Summary

getAttendanceDetailsByPeriodForPayrun

Parameters

Name	Located in	Description	Required	Schema
employeeAttendanceRequest	body	employeeAttendanceRequest	Yes	EmployeeAttendanceRequest

Responses

Code	Description	Schema
200	OK	EmployeeAttendance
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

/v1/people/attendance/swagger

GET

Summary

home

Responses

Code	Description	Schema
200	OK	string
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

/v1/people/attendance/terminate

POST

Summary

Update Terminated

Description

API to update attendance for user to terminated.

Parameters

Name	Located in	Description	Required	Schema
terminateAttendanceRequestDto	body	terminateAttendanceRequestDto	Yes	TerminateAttendanceRequestDto

Responses

Code	Description
200	Successfully updated the terminated flag
201	Created
400	Something went wring
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Models

AttendanceAndLogExportRequestDto

Name	Type	Description	Required
designations	string	Designations
Example: "Admin"	No
iamUserIds	[ long ]	IamUserIds	No
month	integer	count of month i.e. 1 = Jan
Example: 1	No
year	integer	Year
Example: 2022	No

AttendanceAndPunchLogRespose

Name	Type	Description	Required
clockIn	string		No
clockOut	string		No
date	date		No
day	string		No
designation	string		No
employeeId	string		No
iamUserId	long		No
name	string		No
remark	string		No
totHours	string		No
totHoursByPunchLog	string		No
type	string		No

AttendanceBulkRequestDto

Name	Type	Description	Required
attendanceRecords	[ AttendanceImportDetailsDto ]	Attendance details	No
dateFormat	string	Date format	No

AttendanceBulkResponseDto

Name	Type	Description	Required
failed	[ AttendanceImportDetailsDto ]	Users attendance failed records detail dto	No
invalid	[ AttendanceImportDetailsDto ]	Users attendance invalid records detail dto	No
message	string	Success message
Example: "Attendance Imported successfully"	No
status	string	Success
Example: "success"	No
success	[ AttendanceImportDetailsDto ]	Users attendance success records detail dto	No

AttendanceDetailDTO

Name	Type	Description	Required
clockIn	dateTime	Clock-in Time
Example: "2021-08-08 09:00:00"	No
clockInAddress	string	address for punch-in
Example: "Deskera"	No
clockInLatitude	string	latitude value for punch-in
Example: 103.84933902295474	No
clockInLongitude	string	longitude value for punch-in
Example: 1.2798478269079867	No
clockOut	dateTime	Clock-out Time
Example: "2021-08-08 18:00:00"	No
clockOutAddress	string	address for punch-out
Example: "Deskera"	No
clockOutLatitude	string	latitude value for punch-out
Example: 103.84933902295474	No
clockOutLongitude	string	longitude value for punch-out
Example: 1.2798478269079867	No
designation	string	IAM User Id
Example: 1234	No
employeeId	string	IAM User Id
Example: 1234	No
employeeName	string	IAM User Id
Example: 1234	No
entryOffsetMinutes	integer	Entry offset in minutes
Example: 0	No
exitOffsetMinutes	integer	Exit offset in minutes
Example: 0	No
iamUserId	long	IAM User Id
Example: 1234	No
id	long	Attendance Id
Example: 1	No
overtimeMinutes	integer	Over time in minutes
Example: 0	No
punchingLogs	[ PunchDTO ]	punched logs
Example: "Deskera"	No
shiftName	string	name of the shift
Example: "Shift 1"	No
shift_id	string	shift Id
Example: 1234	No
totalMinutes	integer	Total time worked between Clock-in and Clock-out in minutes
Example: 450	No
totalMinutesByPunchLogs	integer	Total time worked between every Punch In and Out in minutes
Example: 380	No
underMinutes	integer	Under time in minutes
Example: 0	No

AttendanceExportResponseDto

Name	Type	Description	Required
attendanceDetails	[ [ string ] ]		No
headers	[ string ]		No

AttendanceImportDetailsDto

Name	Type	Description	Required
consolidatedError	string	User does not exist
Example: "errors"	No
email	string	User's email Id
Example: "kojal01@getnada.com"	No
employeeId	string	EmployeeDetails Id
Example: "0001"	No
firstName	string	User's first name
Example: "Kojak"	No
lastName	string	User's last name
Example: "Dis"	No
punchDate	dateTime	Punch Date
Example: "05/02/2022"	No
punchTime	string	Punch time
Example: "09:00"	No
punchType	string	Punch type
Example: "Entry"	No

BulkAttendanceResponse

Name	Type	Description	Required
failedRecords	[ PunchingUpdateDto ]		No
succeedRecords	[ PunchingUpdateDto ]		No

EmployeeAttendance

Name	Type	Description	Required
employee	[ EmployeeAttendanceMeta ]		No
shifts	[ string ]		No

EmployeeAttendanceMeta

Name	Type	Description	Required
daysWorked	number		No
employeeId	string		No
hrsWorked	number		No
iamUserId	long		No
overtime	[ OvertimeDto ]		No
unpaidDays	number		No

EmployeeAttendanceRequest

Name	Type	Description	Required
from	string	From Date
Example: "2022-08-01"	No
iamUserIds	[ long ]	IamUserIds	No
payrunCalcCriteria	string	Payrun Payable days setting
Example: "numberOfCalendarDaysInMonth"	No
to	string	To Date
Example: "2022-08-31"	No

FilterConfig

Name	Type	Description	Required
numberOfElements	string		No
numberOfRecords	string		No
page	string		No
sizePerPage	string		No
totalPage	string		No

OvertimeDto

Name	Type	Description	Required
rate	number		No
units	number		No
value	number		No

Pageable

Name	Type	Description	Required
offset	long		No
pageNumber	integer		No
pageSize	integer		No
paged	boolean		No
sort	Sort		No
unpaged	boolean		No

PageableAttendanceDetailDTO

Name	Type	Description	Required
attendances	[ AttendanceDetailDTO ]		No
filterConfig	FilterConfig		No

Page«AttendanceDetailDTO»

Name	Type	Description	Required
content	[ AttendanceDetailDTO ]		No
empty	boolean		No
first	boolean		No
last	boolean		No
number	integer		No
numberOfElements	integer		No
pageable	Pageable		No
size	integer		No
sort	Sort		No
totalElements	long		No
totalPages	integer		No

PunchDTO

Name	Type	Description	Required
address	string	address for punch-in
Example: "Deskera"	No
allowProxyPunch	boolean	Allow Admin to do proxy Punch In/Out
Example: false	No
clockIn	dateTime	This is clock in time
Example: "2021-01-01 12:00"	No
iamUserId	long		No
id	long	Punch log id
Example: 1234	No
isFromGrid	boolean	Example: false	No
latitude	string	latitude value for punch-in
Example: 103.84933902295474	No
longitude	string	longitude value for punch-in
Example: 1.2798478269079867	No
punchAt	dateTime	This is punching time
Example: "2021-01-01 12:00"	No
remark	string	Remark for a proxy Clock In/Out
Example: "Manually added by ADMIN"	No
shiftId	string	shift Id
Example: 1234	No
shiftName	string	name of the shift
Example: "Shift 1"	No
type	string	This is punching type

Enum: "CLOCK_IN", "CLOCK_OUT" Example: "CLOCK_IN" | No |

PunchingResponseDto

Name	Type	Description	Required
address	string	address for punch-in
Example: "Deskera"	No
clockIn	dateTime	Clock in time
Example: "2021-01-01 12:OO"	No
clockOut	dateTime	Clock out time
Example: "2021-01-01 12:OO"	No
latitude	string	latitude value for punch-in
Example: 103.84933902295474	No
longitude	string	longitude value for punch-in
Example: 1.2798478269079867	No
workPeriodEndTime	string	Work period end time
Example: "09:00 AM"	No
workPeriodStartTime	string	Work period start time
Example: "09:00 AM"	No

PunchingUpdateDto

Name	Type	Description	Required
clockIn	dateTime	This is clock in time
Example: "2021-01-01 12:00"	No
clockOut	dateTime	This is clock out time
Example: "2021-01-01 12:00"	No
iamUserId	long		No
id	long		No
isFromGrid	boolean		No
isPunchLog	boolean		No
remark	string		No
type	string	Enum: "CLOCK_IN", "CLOCK_OUT"	No

Sort

Name	Type	Description	Required
empty	boolean		No
sorted	boolean		No
unsorted	boolean		No

TerminateAttendanceRequestDto

Name	Type	Description	Required
userId	long		No