Payroll | Calendar Event
Overview
| URL | api/{tenantKey}/{orgKey}/payroll/calendarEvents |
| Methods Supported | GET |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
GET Get Vacations Summary
Returns a employee vacations summary by year.
The following elements are required:
| employeeId | (Guid) EmployeeId. |
| year | (int) Year. |
Response:
| When successful, the response body contains a resource of type 'EmployeeVacationsSummary'. See EmployeeVacationsSummary. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payroll/calendarEvents/getVacationsSummary/{employeeId}/{year}
GET /payroll/calendarEvents/getVacationsSummary/{employeeId}/{year}
GET Get Employee Calendar
Custom operation 'GetEmployeeCalendar'.
The following elements are required:
| employeeId | (Guid) EmployeeId. |
| from | (DateTime?) From. |
| to | (DateTime?) To. |
Response:
| When successful, the response body contains a list of resources of type 'EmployeeCalendarSummary'. See EmployeeCalendarSummary. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payroll/calendarEvents/getEmployeeCalendar/{employeeId}
GET /payroll/calendarEvents/getEmployeeCalendar/{employeeId}
GET Get Current Absence
Gets the last day of actual absence.
The following elements are required:
| employeeId | (Guid) EmployeeId. |
Response:
| When successful, the response body contains a resource of type 'EmployeeCurrentAbsence'. See EmployeeCurrentAbsence. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payroll/calendarEvents/getCurrentAbsence/{employeeId}
GET /payroll/calendarEvents/getCurrentAbsence/{employeeId}
Resources
EmployeeCalendarSummary
The following elements are optional:
| date | (DateTime) Date. |
| eventType | (int) 1 - Vacations | 2 - NonWorkingDays. |
| description | (string) Description. |
| eventUnit | (int) 1 - Hours | 2- Days | 3 - HalfDays. |
EmployeeCurrentAbsence
The following elements are required:
| isAbsent | (bool) Is Absent. |
The following elements are optional:
| endDate | (DateTime) End Date. |
EmployeeVacationsSummary
The following elements are optional:
| totalDays | (decimal) Total Days. |
| scheduledDays | (decimal) Scheduled Days. |
| spentDays | (decimal) Spent Days. |
| notScheduledDays | (decimal) Not Scheduled Days. |