EVevolia
Public
Leaves Bank

Get leave banks

Changed on

Retrieves a list of leave banks for the specified group

get/v1/public/leaves/banks

Request

Query parameters

includeRelationshipsboolean

if true, beside returning the leave banks, the relationships property will include data related to the leave banks: skills, locations and teams

Response

uidstring required

Unique leave bank id.

namesobject required

The name of the bank in various locales. Accepted locales are en, fr, es.

codestring

A human readable ID that can be use has an ID for other API calls. The code is also used to map a leave bank to an external system structural element.

paidboolean required

if true, leaves for this bank is paid to the employee.

unit'HOURS' | 'DAYS' | 'AMOUNT' required

The bank type of unit

teamIdsstring[]

An array of team UID indicating on which team the bank is applied to.

teamCodesstring[]

An array of team code indicating on which team the bank is applied to.

skillIdsstring[]

An array of skill UID indicating on which skill (position) the bank is applied to.

skillCodesstring[]

An array of skill code indicating on which skill (position) the bank is applied to.

locationIdsstring[]

An array of location UID indicating on which location the bank is applied to.

locationCodesstring[]

An array of location code indicating on which location the bank is applied to.

minimumDelayInDaysnumber

The minimum number of days required between a leave request submission and the leave's start date.

blockNegativeBalanceCreationboolean
blockNegativeBalanceApprobationboolean

When true, leave requests for this bank cannot be approved if the balance is negative.

amountRequiredboolean

If true, leave requests submitted for this bank must specify an amount greater than zero.

reasonRequiredboolean

If true, leave requests submitted for this bank must specify a reason.

organizationalStructureRequiredboolean

If true, leave requests submitted for this bank must be associated to organizational structure elements (team, location, skill).

excludeFromOvertimeboolean

If true, leave hours for this bank won't count towards overtime calculations.

excludeFromHolidaysboolean

If true, leave hours for this bank won't count towards holiday calculations.

excludeFromExperienceboolean

If true, leave hours for this bank won't count towards employee experience calculations.

hideBankboolean

If true, the bank balance is hidden from the employees' profile.

workdayDurationInMnumber

Only relevant when unit is PublicLeaveBankUnit.DAYS.Indicates the typical duration of a workday in minutes. For 8 hours the value is be 480

exportToPayrollboolean required

If true, leave requests for this bank will be included in the timesheet report and exported to the payroll system.

payrollExportHourlyWageboolean

This property is only relevant if "exportToPayroll" is true. If true, exported leave requests for this bank will include hourly wage

payrollEarningCodestring

This property is only relevant if "exportToPayroll" is true. If specified, exported leave requests for this bank will have this earning code. If not specified, the code property is used.

payrollBankUnit'HOURS' | 'DAYS' | 'AMOUNT'

This property is only relevant if "exportToPayroll" is true. The unit type of the leave bank balance in the payroll system. A conversion will occur if different from unit

importBalancesboolean required

If true, this bank's leave balances will be synchronized with data from the HR or payroll system.

Example response

[
  {
    "names": {
      "en": "Holidays",
      "fr": "Vacances"
    }
  }
]

Changes