Skip to main content

Interface: Contact

Defined in: type/Contact.ts:15

Object class for Contact

Properties​

attributes?​

optional attributes?: AttributeResultResponse

Defined in: type/Contact.ts:19

Lists attributes for this contacts based on the search input.

bankAccount?​

optional bankAccount?: string

Defined in: type/Contact.ts:49

The Bank Account Number of the user

bic?​

optional bic?: string

Defined in: type/Contact.ts:51

The Bank Identification Code of the user

companies?​

optional companies?: CompaniesResponse

Defined in: type/Contact.ts:77

All the companies that a contact belongs to

company?​

optional company?: Company

Defined in: type/Contact.ts:73

company field

contactId​

contactId: number

Defined in: type/Contact.ts:17

The unique identifier of the contact.

createdAt?​

optional createdAt?: string

Defined in: type/Contact.ts:67

createdAt field

dateOfBirth?​

optional dateOfBirth?: string

Defined in: type/Contact.ts:61

The date of birth of the contact.

email​

email: string

Defined in: type/Contact.ts:43

The email of the user.

expires?​

optional expires?: string

Defined in: type/Contact.ts:57

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

externalId?​

optional externalId?: string

Defined in: type/Contact.ts:59

External ID

favoriteLists?​

optional favoriteLists?: FavoriteListsResponse

Defined in: type/Contact.ts:23

favoriteLists field

firstName​

firstName: string

Defined in: type/Contact.ts:33

The first name of the user.

gender?​

optional gender?: Gender

Defined in: type/Contact.ts:31

The gender of the user.

iban?​

optional iban?: string

Defined in: type/Contact.ts:47

The International Bank Account Number of the user

isLoggedIn?​

optional isLoggedIn?: boolean

Defined in: type/Contact.ts:65

isLoggedIn field

lastModifiedAt?​

optional lastModifiedAt?: string

Defined in: type/Contact.ts:69

lastModifiedAt field

lastName​

lastName: string

Defined in: type/Contact.ts:37

The last name of the user.

login?​

optional login?: string

Defined in: type/Contact.ts:45

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

magicTokens​

magicTokens: MagicToken[]

Defined in: type/Contact.ts:21

Get all magic tokens for a contact

mailingList?​

optional mailingList?: YesNo

Defined in: type/Contact.ts:63

mailingList field

managedCompanies?​

optional managedCompanies?: Company[]

Defined in: type/Contact.ts:75

Companies managed by the contact.

middleName?​

optional middleName?: string

Defined in: type/Contact.ts:35

The middle name of the user.

mobile?​

optional mobile?: string

Defined in: type/Contact.ts:41

The mobile number of the user.

notes?​

optional notes?: string

Defined in: type/Contact.ts:53

notes field

orderlists?​

optional orderlists?: OrderlistsResponse

Defined in: type/Contact.ts:25

orderlists field

parentCompanyId​

parentCompanyId: number

Defined in: type/Contact.ts:71

The company id of parent company.

phone?​

optional phone?: string

Defined in: type/Contact.ts:39

The phone number of the user.

pricesheets?​

optional pricesheets?: Pricesheet[]

Defined in: type/Contact.ts:27

pricesheets field

primaryLanguage?​

optional primaryLanguage?: string

Defined in: type/Contact.ts:55

The primary language of the user

purchaseAuthorizationConfigs?​

optional purchaseAuthorizationConfigs?: PurchaseAuthorizationConfigResponse

Defined in: type/Contact.ts:81

All purchase authorization config entities for this contact

sources​

sources: Source[]

Defined in: type/Contact.ts:79

sources field

userId?​

optional userId?: number

Defined in: type/Contact.ts:29

The unique identifier of the user.