User
Individual user entity in the system.
type User implements IBaseUser {
userId: Int!
addresses(
type: AddressType
isDefault: YesNo
): [Address!]!
debtorId: String
gender: Gender
firstName: String!
middleName: String
lastName: String!
phone: String
mobile: String
email: String!
login: String
iban: String
bankAccount: String
bic: String
notes: String
primaryLanguage: String
expires: DateTime
externalId: String
dateOfBirth: DateTime
mailingList: YesNo
isLoggedIn: Boolean
createdAt: DateTime
lastModifiedAt: DateTime
taxNumber: String
cocNumber: String
loginRoot: Int
company: String
parentUsergroupId: Int!
managedCompanies: [Company!]
usergroup: Usergroup @deprecated
usergroupPath: [Usergroup!]! @deprecated
}
Fields
User.userId ● Int! non-null scalar
Unique identifier for the user.
Primary key used to reference the user throughout the system and establish relationships with other entities.
User.addresses ● [Address!]! non-null object
User.addresses.type ● AddressType enum
User.addresses.isDefault ● YesNo enum
User.debtorId ● String scalar
Financial identifier for billing and accounting purposes.
Links the user to financial records and billing systems for transaction processing and account management.
User.gender ● Gender enum
Gender identity of the user.
Used for personalization and communication preferences. Respects privacy preferences and is not required for account functionality.
User.firstName ● String! non-null scalar
Given name of the user.
Primary name used for personal identification and communication. Required for account creation and user recognition.
User.middleName ● String scalar
Middle name or initial of the user.
Additional name component used for formal identification and complete name display when available.
User.lastName ● String! non-null scalar
Family name of the user.
Surname used for formal identification and complete name display. Required for account creation and user recognition.
User.phone ● String scalar
Primary phone number for voice communication.
Landline or office phone number used for business communications and account verification.
User.mobile ● String scalar
Mobile phone number for direct communication.
Cell phone number used for SMS notifications, two-factor authentication, and urgent communications.
User.email ● String! non-null scalar
Primary email address for digital communication.
Main contact email used for account notifications, password resets, and business communications. Must be unique and in valid email format.
User.login ● String scalar
Authentication email address for system access.
Email address used for login credentials and account authentication. When null, no account access has been configured. Usually matches the primary email address.
User.iban ● String scalar
International Bank Account Number for financial transactions.
Standardized bank account identifier used for direct debits, payments, and financial processing. Must be in valid IBAN format.
User.bankAccount ● String scalar
Local bank account number for financial transactions.
Domestic bank account identifier used for payments and financial processing in regions where IBAN is not standard.
User.bic ● String scalar
Bank Identification Code for international transfers.
SWIFT/BIC code identifying the user's bank for international wire transfers and financial communications.
User.notes ● String scalar
Additional notes and comments about the user.
Free-form text field for storing special instructions, preferences, or important information about the user account.
User.primaryLanguage ● String scalar
Preferred language for user interface and communications.
Language code (e.g., 'NL', 'EN', 'DE') used for localizing the user interface and determining the language for automated communications.
User.expires ● DateTime scalar
Account expiration date and time.
Date when the user's access expires and the account becomes inactive. After this date, the user cannot authenticate or access system resources.
User.externalId ● String scalar
External system reference identifier.
Unique identifier used to link this user with records in external systems, legacy databases, or third-party integrations.
User.dateOfBirth ● DateTime scalar
Date of birth for age verification and personalization.
Used for age-restricted features, birthday communications, and demographic analysis. Must be in the past and in YYYY-MM-DD format.
User.mailingList ● YesNo enum
Marketing communication subscription preference.
Indicates whether the user has opted in to receive marketing emails, newsletters, and promotional communications.
User.isLoggedIn ● Boolean scalar
Current authentication status indicator.
Shows whether the user is currently logged into the system. Updated automatically during login and logout processes.
User.createdAt ● DateTime scalar
Timestamp when the user account was created.
Automatically set when the user is first created in the system. Used for auditing, analytics, and account age calculations.
User.lastModifiedAt ● DateTime scalar
Timestamp when the user information was last updated.
Automatically updated whenever any user information is modified. Used for auditing, synchronization, and change tracking.
User.taxNumber ● String scalar
Tax identification number for financial reporting.
Official tax registration number used for tax compliance and financial reporting purposes. Format varies by jurisdiction and tax authority requirements.
User.cocNumber ● String scalar
Chamber of Commerce registration number.
Official business registration number issued by the Chamber of Commerce. Used for business verification and legal compliance purposes.
User.loginRoot ● Int scalar
Administrative access level identifier.
Determines the user's access level to administrative functions and system management capabilities. Higher values indicate greater administrative privileges.
User.company ● String scalar
Associated company name for organizational context.
Name of the company or organization the user represents. Used for organizational identification and context.
User.parentUsergroupId ● Int! non-null scalar
Parent usergroup identifier for hierarchical organization.
References the usergroup that contains this user in the organizational hierarchy. Used for permission inheritance and organizational structure.
User.managedCompanies ● [Company!] list object
Companies under this user's management authority.
List of companies that this user has management permissions for. Used to determine which companies the user can administer and modify.
User.usergroup ● Usergroup deprecated object
This field is deprecated and will be removed in a future version
Parent usergroup containing this user.
The organizational unit that this user belongs to, providing hierarchical structure and permission inheritance.
User.usergroupPath ● [Usergroup!]! deprecated non-null object
This field is deprecated and will be removed in a future version
Hierarchical path from this user to the organizational root.
Array of usergroups representing the path from this user's usergroup to the root of the organizational hierarchy. Used for inheritance calculations and permission resolution.
Interfaces
IBaseUser interface
Base interface for all user types in the system.
Defines common properties shared across users, contacts, and customers. This interface provides a unified structure for user-related data while allowing for type-specific implementations.