Skip to main content

Interface: User

Defined in: type/User.ts:9

Object class for User

Properties​

bankAccount?​

optional bankAccount?: string

Defined in: type/User.ts:33

The Bank Account Number of the user

bic?​

optional bic?: string

Defined in: type/User.ts:35

The Bank Identification Code of the user

cocNumber?​

optional cocNumber?: string

Defined in: type/User.ts:57

The CoC number of the user.

company?​

optional company?: string

Defined in: type/User.ts:61

The company of the user.

createdAt?​

optional createdAt?: string

Defined in: type/User.ts:51

createdAt field

dateOfBirth?​

optional dateOfBirth?: string

Defined in: type/User.ts:45

The date of birth of the contact.

debtorId?​

optional debtorId?: string

Defined in: type/User.ts:13

debtorId field

email​

email: string

Defined in: type/User.ts:27

The email of the user.

expires?​

optional expires?: string

Defined in: type/User.ts:41

The expiration date of the contact. After this date expires contact will be disabled.

externalId?​

optional externalId?: string

Defined in: type/User.ts:43

External ID

firstName​

firstName: string

Defined in: type/User.ts:17

The first name of the user.

gender?​

optional gender?: Gender

Defined in: type/User.ts:15

The gender of the user.

iban?​

optional iban?: string

Defined in: type/User.ts:31

The International Bank Account Number of the user

isLoggedIn?​

optional isLoggedIn?: boolean

Defined in: type/User.ts:49

isLoggedIn field

lastModifiedAt?​

optional lastModifiedAt?: string

Defined in: type/User.ts:53

lastModifiedAt field

lastName​

lastName: string

Defined in: type/User.ts:21

The last name of the user.

login?​

optional login?: string

Defined in: type/User.ts:29

The login name (email) the account is linked to, generally the same as email address. When null a account has not been linked yet.

loginRoot?​

optional loginRoot?: number

Defined in: type/User.ts:59

The propeller access root for this user. Users with a login root can log into the backoffice and have a supervisor role on the api's

mailingList?​

optional mailingList?: YesNo

Defined in: type/User.ts:47

mailingList field

managedCompanies?​

optional managedCompanies?: Company[]

Defined in: type/User.ts:63

Companies managed by the user.

middleName?​

optional middleName?: string

Defined in: type/User.ts:19

The middle name of the user.

mobile?​

optional mobile?: string

Defined in: type/User.ts:25

The mobile number of the user.

notes?​

optional notes?: string

Defined in: type/User.ts:37

notes field

phone?​

optional phone?: string

Defined in: type/User.ts:23

The phone number of the user.

primaryLanguage?​

optional primaryLanguage?: string

Defined in: type/User.ts:39

The primary language of the user

taxNumber?​

optional taxNumber?: string

Defined in: type/User.ts:55

The Tax number of the user.

userId​

userId: number

Defined in: type/User.ts:11

The id of the user.