Public
Leaves

Update a leave request

patch/v1/public/leaves/{leaveId}

Path parameters

leaveIdstring required

Request body

memberIdstring

The member (employee) UID to associate to the leave can be empty if the memberCode is set

memberCodestring

The member (employee) code to associate to the leave can be empty if the memberUId is set

bankNamestring

The name of the leave bank associated to the leave. Can be empty if bankCode or bankId is set

bankCodestring

The code of the leave bank associated to the leave. Can be empty if bankName or bankId is set

bankIdstring

The UID of the leave bank associated to the leave. Can be empty if bankCode or bankName is set.If bankId and bankCode and/or bankName are set, they must all refer to the same bank or else a conflict exception is thrown

fromDatestring

The starting date of the leave. In ISO-8601 format.

toDatestring

The ending date of the leave. In ISO-8601 format.

reasonstring

The reason of the leave

timeZonestring
fromAllDayboolean

When true the leave first day has no specific time range

toAllDayboolean

When true the leave last day has no specific time range

assignedManagerIdstring

The member (a manager) UID who must approve this leave can be empty if the AssignedManagerId is set

assignedManagerCodestring

The member (a manager) UID who must approve this leave can be empty if the AssignedManagerCode is set

hoursToWithdrawnumber required

The total number of hours to withdraw from the employee bank specified by bankName and bankCode

teamIdstring

TeamId used to link with integration can be empty. teamId or teamCode can be set to determine team

teamCodestring

TeamCode used to link with integration can be empty. teamId or teamCode can be set to determine team

skillIdstring

SkillId used to link with integration can be empty skillId. or skillCode can be set to determine skill

skillCodestring

SkillCode used to link with integration can be empty. skillId or skillCode can be set to determine skill

locationIdstring

LocationId used to link with integration can be empty. locationId or locationCode can be set to determine location

locationCodestring

LocationCode used to link with integration can be empty. locationId or locationCode can be set to determine location

managerNotestring required

this note will be only available for other manager

Example request

{
  "fromDate": "2021-01-01T00:00:00.000-05:00",
  "toDate": "2021-01-02T00:00:00.000-05:00"
}

Response

uidstring required

unique leave id

status'PENDING' | 'DECLINED' | 'APPROVED' | 'PAID' required

The approval status of the leave

bankIdstring required

The UID of the leave bank linked to this leave

bankNamestring required

The name of the leave bank linked to this leave

bankCodestring required

The code of the leave bank linked to this leave

memberIdstring required

The member (employee) UID linked to this leave

memberCodestring required

The member (employee) code linked to this leave

memberHourlyWagenumber

Contains the member hourly wage specific to the skill of the leave or the member base hourlyWage.

createdAtstring required

Leave creation date and time. In ISO-8601 format

createdByMemberIdstring required

The member (an employee or manager) UID who created this leave

createdByMemberCodestring required

The member (an employee or manager) code who created this leave

fromstring required

The starting date of the leave. In ISO-8601 format.

tostring required

The ending date of the leave. In ISO-8601 format.

fromAllDayboolean required

When true the leave first day has no specific time range

toAllDayboolean required

When true the leave last day has no specific time range

hoursToWithdrawnumber required

The total number of hours to withdraw from the employee bank specified by bankName, bankCode and bankId

reasonstring required

The reason of the leave

declineReasonstring required

The reason the manager declined the leave

timeZonestring required

The leave time zone.

assignedManagerIdstring required

The member (a manager) UID who must approve this leave

assignedManagerCodestring required

The member (a manager) code who must approve this leave

bankedboolean required

When true the value is banked

bankedAtstring required

The date at which the hours have been banked. In ISO-8601 format.

teamIdstring

The team id linked to this leave

teamCodestring

The team code linked to this leave

skillIdstring

The skill (position) id linked to this leave

skillCodestring

The skill (position) code linked to this leave

locationIdstring

The location id linked to this leave

locationCodestring

The location code linked to this leave

Example response

{
  "from": "2021-01-01T00:00:00.000-05:00",
  "to": "2021-01-02T00:00:00.000-05:00",
  "timeZone": "America/New_York",
  "bankedAt": "2021-01-02T00:00:00.000-05:00"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.