Customer
Customer entity representing individual customers and end users.
External entity from the customer service that provides customer identification and profile information. Used as a reference for customer-specific attributes and personalization features within the attribute system.
type Customer implements IBaseUser {
customerId: Int!
addresses(
type: AddressType
isDefault: YesNo
): [Address!]!
attributes(
input: AttributeResultSearchInput
): AttributeResultResponse
magicTokens: [MagicToken!]!
favoriteLists(
input: FavoriteListsBaseSearchInput
): FavoriteListsResponse
orderlist: OrderlistsResponse
orderlists(
input: OrderlistSearchInput
): OrderlistsResponse!
pricesheets: [Pricesheet!]
userId: Int
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
parentUsergroupId: Int!
usergroup: Usergroup @deprecated
sources: [Source!]!
usergroupPath: [Usergroup!]!
}
Fields
Customer.customerId
● Int!
non-null scalar
Unique identifier for the customer.
Primary key used to reference the customer throughout the system and establish relationships with orders, transactions, and other customer-specific data.
Customer.addresses
● [Address!]!
non-null object
Customer.addresses.type
● AddressType
enum
Customer.addresses.isDefault
● YesNo
enum
Customer.attributes
● AttributeResultResponse
object
Lists attributes for this customer based on the search input.
Customer.attributes.input
● AttributeResultSearchInput
input
Customer.magicTokens
● [MagicToken!]!
non-null object
Get all magic tokens for a customer
Customer.favoriteLists
● FavoriteListsResponse
object
Customer.favoriteLists.input
● FavoriteListsBaseSearchInput
input
Customer.orderlist
● OrderlistsResponse
object
Order lists that are assigned to or accessible by this customer.
Returns a paginated collection of order lists where this customer has been granted access. The customer will be able to see and order from these lists based on their permissions. Results can be filtered using the input parameter for more specific queries.
Customer.orderlists
● OrderlistsResponse!
non-null object
Customer.orderlists.input
● OrderlistSearchInput
input
Search and filtering criteria for order lists assigned to this customer.
Filters the results to show only order lists that are assigned to or accessible by this specific customer. All standard search criteria can be applied in addition to the customer-specific filtering.
If not provided, returns all order lists accessible to this customer with default pagination settings.
Validation: All provided search criteria must be valid according to their respective field requirements.
Customer.pricesheets
● [Pricesheet!]
list object
Customer.userId
● Int
scalar
Unique identifier for the user.
Primary key used to reference the user throughout the system and establish relationships with other entities.
Customer.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.
Customer.gender
● Gender
enum
Gender identity of the user.
Used for personalization and communication preferences. Respects privacy preferences and is not required for account functionality.
Customer.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.
Customer.middleName
● String
scalar
Middle name or initial of the user.
Additional name component used for formal identification and complete name display when available.
Customer.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.
Customer.phone
● String
scalar
Primary phone number for voice communication.
Landline or office phone number used for business communications and account verification.
Customer.mobile
● String
scalar
Mobile phone number for direct communication.
Cell phone number used for SMS notifications, two-factor authentication, and urgent communications.
Customer.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.
Customer.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.
Customer.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.
Customer.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.