Skip to main content

Interface: CustomerGeneric

Basic customer identification properties.

CustomerGeneric provides the minimal identifying information required to reference a customer account within the system. These core properties serve as the foundation for more detailed customer representations.

Extended by​

Properties​

customerId​

customerId: string

Unique identifier for this customer account.

This ID uniquely identifies the customer throughout the system and is used as the primary key for database operations and API calls. All customer data and configurations are associated with this identifier.

customerName?​

optional customerName: string

Official registered name of the customer organization.

This is the formal name of the customer entity as registered in business systems. It serves as the default display name when no display name is specified.

displayName?​

optional displayName: string

Optional user-friendly display name for the customer.

When specified, this name is shown in user interfaces instead of the more technical customer name. It can include spaces, special characters, and be formatted for optimal readability.