Interface User

interface User {
    _id: string;
    approverId: string;
    avatar: string;
    departmentId: string;
    email: string;
    employeeId: string;
    firstName: string;
    holidayCountryLanguage: string;
    holidayIds: any[];
    holidaySubregion: string;
    icsLink: string;
    inheritHolidays: boolean;
    isApprover: boolean;
    language: "de" | "en";
    lastName: string;
    locationId: string;
    name: string;
    notes: string;
    role: string;
    roleId: string;
    status: UserStatus;
    teamId: string[];
    vacationDays: number;
    workingDays: WorkingDays;
}

Hierarchy

Properties

_id: string

unique identifier

approverId: string

the default approver for this user. If not set it will inherit the approver from the department

avatar: string

the id for the user avatar/image

departmentId: string

the department this user belongs to

email: string

email used for authentication. On update, a verification email will be sent to the new address

employeeId: string

an optional custom identifier for the user

firstName: string
holidayCountryLanguage: string

the region used to determine the translated names of the holidays. Seperation to region needed when setting to custom.

holidayIds: any[]

the actual holidays this user has assigned

holidaySubregion: string

the region used to rectrieve the holidays for this user. eg. "de-by"

icsLink: string

ics link for viewing absences in external applications, prefix?: https://app.absence.io/

inheritHolidays: boolean

indicates if holidays are to be inherited from the location

isApprover: boolean

if the user is only of role User, this field enables him to be set as an approver. If this is set to false for Owner,HR, Admin then these users will not appear in the approver selection combos. Technically they can still approve.

language: "de" | "en"

the language the UI will be displayed in

lastName: string
locationId: string

the location this user belongs to

name: string

first and last name concatentated for your convenience

notes: string

comment field on the user

role: string

the role assigned to the user

roleId: string

the role of this user

status: UserStatus

the status of the user

teamId: string[]

array of team ids this user belongs to

vacationDays: number

the current default vaction days for this user. if not specified on creation, the companys default vactaionDays will be set.

workingDays: WorkingDays

defines the working days for the user. see below for details