Leave
Holds all leave requests for an account
Endpoints
| Method | Endpoint | Summary | Premium/Enterprise |
|---|---|---|---|
| GET | /api/v1/resource/Leave | Return a list of all leave requests | Both |
| GET | /api/v1/resource/Leave/INFO | Return details of the leave request resource | Both |
| GET | /api/v1/resource/Leave/{id} | Return details of a specific leave request | Both |
| POST | /api/v1/resource/Leave/{id} | Update details of a specific leave request | Both |
| POST | /api/v1/resource/Leave/QUERY | Query for a specific leave record. Can be used to view associated objects. | Both |
Data element | Data Type | What Is It? | Mandatory |
|---|---|---|---|
Employee | Integer | Employee id associated with the leave request | Yes |
EmployeeHistory | Integer | employeeHistory id associated with this leave request | Yes |
Company | Integer | Location ID associated to the request | Yes |
LeaveRule | Integer | Leave rule associated to the request | No |
DateStart | Date | start date of leave request | No |
DateEnd | Date | end date of leave request | No |
Days | fractional representation of days (scheduled hours/days) | No | |
ApproverTime | Integer | id of employee who approved time for this request | No |
ApproverPay | Integer | id of employee who approved pay for this request | No |
Comment | String | text field for additional comments | No |
Status | Integer | status of leave request 0 - Awaiting approval | Yes |
ApprovalComment | String | approval comment text field | Yes |
TotalHours | total no. of hours represented by the leave request | No | |
ExternalID | Integer | external ID to correspond this leave request to another system (such as a HR System, Payroll System, etc) | No |
Creator | Integer | internal ID of employee who created employee contract | No |
Created | Date | date and time when this record was originally created | No |
Modified | Date | date and when this record was last modified | No |
Id | Integer | The unique id of this record | No |
Updated 12 days ago