Interface NewUser

interface NewUser {
    approverId?: 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;
    notes?: string;
    role: string;
    roleId: string;
    status?: UserStatus;
    teamId?: string[];
    vacationDays?: number;
    workingDays?: WorkingDays;
}

Properties

approverId? departmentId email employeeId? firstName holidayCountryLanguage holidayIds? holidaySubregion icsLink? inheritHolidays? isApprover? language? lastName locationId notes? role roleId status? teamId? vacationDays? workingDays?

Properties

Optional approverId

approverId?: string

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

departmentId

departmentId: string

the department this user belongs to

email

email: string

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

Optional employeeId

employeeId?: string

an optional custom identifier for the user

firstName

firstName: string

holidayCountryLanguage

holidayCountryLanguage: string

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

Optional holidayIds

holidayIds?: any[]

the actual holidays this user has assigned

holidaySubregion

holidaySubregion: string

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

Optional icsLink

icsLink?: string

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

Optional inheritHolidays

inheritHolidays?: boolean

indicates if holidays are to be inherited from the location

Optional isApprover

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.

Optional language

language?: "de" | "en"

the language the UI will be displayed in

lastName

lastName: string

locationId

locationId: string

the location this user belongs to

Optional notes

notes?: string

comment field on the user

role

role: string

the role assigned to the user

roleId

roleId: string

the role of this user

Optional status

status?: UserStatus

the status of the user

Optional teamId

teamId?: string[]

array of team ids this user belongs to

Optional vacationDays

vacationDays?: number

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

Optional workingDays

workingDays?: WorkingDays

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc