Skip to main content

Interface: CustomerContactInfo

Contact and address information for a customer.

CustomerContactInfo contains the business contact details and location information for a customer organization. This information is used for communication, documentation, and business relationship management.

Extends​

Extended by​

Properties​

address?​

optional address: string

Street address for the customer organization.

This primary address information is used for official communications, invoicing, and legal documentation. It typically represents the headquarters or main business location.

city?​

optional city: string

City where the customer organization is located.

This city information completes the physical address and is used for regional targeting, shipping calculations, and business analytics.

country?​

optional country: string

Country where the customer organization is based.

This information is essential for international operations, taxation, compliance, and localization. It may affect available features, pricing, and currency settings.

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.

Inherited from​

CustomerGeneric.customerId

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.

Inherited from​

CustomerGeneric.customerName

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.

Inherited from​

CustomerGeneric.displayName

logoS3Path?​

optional logoS3Path: string

Relative path to the customer's logo image.

This image appears in the configurator interface, generated PDFs, and other branded touchpoints. A high-quality logo ensures consistent brand representation across all customer interactions.

phone?​

optional phone: string

Primary contact phone number for the customer organization.

This number can be used for direct communication regarding account management, support issues, or business opportunities.

website?​

optional website: string

URL of the customer's website.

This provides a reference to the customer's online presence and can be used for verification, linking, or integration purposes.

zipcode?​

optional zipcode: string

Postal code for the customer's location.

This code is used for mail delivery and can also serve in geographical targeting for region-specific content or pricing.