Create Leave Request

Creates a new leave request for an employee.

Request

POST https://apisg.yourpayroll.io/api/v2/business/{businessId}/employee/{employeeId}/leaverequest

Path parameters

Parameter name Value Description Additional
businessId string Required
employeeId string Required

Request body

The request body takes a complete UnitLeaveRequestModel resource, containing the following writable properties:

{
    "attachment": {
        "dateCreated": "date-time",
        "dateScanned": "date-time",
        "friendlyName": "string",
        "id": "int32",
        "isInfected": "boolean",
        "url": "string"
    },
    "automaticallyApprove": "boolean",
    "employeeId": "int32",
    "fromDate": "date-time",
    "id": "int32",
    "leaveCategoryId": "int32",
    "notes": "string",
    "requireNotesForLeaveRequests": "boolean",
    "toDate": "date-time",
    "units": "double"
}

Properties

Name Type Description
attachment object AttachmentModel
attachment.dateCreated date-time Nullable
attachment.dateScanned date-time Nullable
attachment.friendlyName string String
attachment.id int32 Nullable
attachment.isInfected boolean Nullable
attachment.url string String
automaticallyApprove boolean Boolean
employeeId int32 Int32
fromDate date-time DateTime
id int32 Int32
leaveCategoryId int32 Nullable
notes string String
requireNotesForLeaveRequests boolean Boolean
toDate date-time DateTime
units double Decimal

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

 UnitLeaveRequestResponseModel