Interface Customer

Represents a customer in the system.

interface Customer {
    Active?: boolean;
    AdditionalAttributes: CustomerAttributeType[];
    Addresses: Address[];
    AddressLine1: string;
    AddressLine2: string;
    AdminContent: string;
    AffiliateId?: number;
    ApplyDefaultStyling: boolean;
    Approvers: string[];
    BillingAddress: Address;
    BudgetManagers: string[];
    City: string;
    CompanyName: string;
    Country: string;
    CreatedOn?: Date;
    Custom1: string;
    Custom2: string;
    Custom3: string;
    CustomerRoles: string[];
    DateOfBirth?: Date;
    Department: string | number;
    Email: string;
    Fax: string;
    FirstName: string;
    FullName: string;
    Gender?: string;
    Guid?: string;
    Id?: number;
    IsAdmin: boolean;
    IsTaxExempt?: boolean;
    LastActivityDate?: Date;
    LastIpAddress: string;
    LastName: string;
    LastVisitedPage: string;
    LoginMessage: string;
    MisConfigurations: MisConfigType[];
    NotifyMis: boolean;
    Password: string;
    Phone: string;
    PrintLocationId: string;
    PrintLocationName: string;
    PromotionCardNumber: string;
    PromotionCardPoints?: number;
    ShippingAddress: Address;
    StateProvince: string;
    TimeZoneId: string;
    Title: string;
    Username: string;
    VatNumber: string;
    VatNumberStatus?: number;
    WorkflowTrustLevel?: number;
    WorkflowTrustLevelEnabled: boolean;
    ZipPostalCode: string;
}

Properties

Active? AdditionalAttributes Addresses AddressLine1 AddressLine2 AdminContent AffiliateId? ApplyDefaultStyling Approvers BillingAddress BudgetManagers City CompanyName Country CreatedOn? Custom1 Custom2 Custom3 CustomerRoles DateOfBirth? Department Email Fax FirstName FullName Gender? Guid? Id? IsAdmin IsTaxExempt? LastActivityDate? LastIpAddress LastName LastVisitedPage LoginMessage MisConfigurations NotifyMis Password Phone PrintLocationId PrintLocationName PromotionCardNumber PromotionCardPoints? ShippingAddress StateProvince TimeZoneId Title Username VatNumber VatNumberStatus? WorkflowTrustLevel? WorkflowTrustLevelEnabled ZipPostalCode

Properties

OptionalActive

Active?: boolean

Indicates if the customer is active.

AdditionalAttributes

AdditionalAttributes: CustomerAttributeType[]

Additional custom attributes associated with the customer.

Addresses

Addresses: Address[]

List of addresses associated with the customer.

AddressLine1

AddressLine1: string

The first address line of the customer.

AddressLine2

AddressLine2: string

The second address line of the customer.

AdminContent

AdminContent: string

Additional administrative content related to the customer.

OptionalAffiliateId

AffiliateId?: number

The affiliate identifier of the customer.

ApplyDefaultStyling

ApplyDefaultStyling: boolean

Indicates if default styling should be applied to the customer interface.

Approvers

Approvers: string[]

List of approvers assigned to the customer.

BillingAddress

BillingAddress: Address

The billing address of the customer.

BudgetManagers

BudgetManagers: string[]

List of budget managers assigned to the customer.

City

City: string

The city of residence of the customer.

CompanyName

CompanyName: string

The company name of the customer.

Country

Country: string

The country of residence of the customer.

OptionalCreatedOn

CreatedOn?: Date

The date when the customer account was created.

Custom1

Custom1: string

Custom field 1 for additional customer information.

Custom2

Custom2: string

Custom field 2 for additional customer information.

Custom3

Custom3: string

Custom field 3 for additional customer information.

CustomerRoles

CustomerRoles: string[]

The roles assigned to the customer.

OptionalDateOfBirth

DateOfBirth?: Date

The date of birth of the customer.

Department

Department: string | number

The department identifier or name of the customer.

Email

Email: string

The email address of the customer.

Fax

Fax: string

The fax number of the customer.

FirstName

FirstName: string

The first name of the customer.

FullName

FullName: string

The full name of the customer.

OptionalGender

Gender?: string

The gender of the customer.

OptionalGuid

Guid?: string

The GUID of the customer.

OptionalId

Id?: number

The unique identifier of the customer.

IsAdmin

IsAdmin: boolean

Indicates if the customer is an administrator.

OptionalIsTaxExempt

IsTaxExempt?: boolean

Indicates if the customer is tax-exempt.

OptionalLastActivityDate

LastActivityDate?: Date

The date of the last activity by the customer.

LastIpAddress

LastIpAddress: string

The IP address of the customer's last login.

LastName

LastName: string

The last name of the customer.

LastVisitedPage

LastVisitedPage: string

The last visited page by the customer.

LoginMessage

LoginMessage: string

Login message displayed to the customer.

MisConfigurations

MisConfigurations: MisConfigType[]

List of MIS (Management Information System) configurations associated with the customer.

NotifyMis

NotifyMis: boolean

Indicates if the MIS should be notified about the customer.

Password

Password: string

The password of the customer.

Phone

Phone: string

The phone number of the customer.

PrintLocationId

PrintLocationId: string

The print location identifier of the customer.

PrintLocationName

PrintLocationName: string

The name of the print location assigned to the customer.

PromotionCardNumber

PromotionCardNumber: string

The promotion card number associated with the customer.

OptionalPromotionCardPoints

PromotionCardPoints?: number

The promotion card points associated with the customer.

ShippingAddress

ShippingAddress: Address

The shipping address of the customer.

StateProvince

StateProvince: string

The state or province of residence of the customer.

TimeZoneId

TimeZoneId: string

The timezone identifier for the customer.

Title

Title: string

The title of the customer.

Username

Username: string

The username of the customer.

VatNumber

VatNumber: string

The VAT number of the customer.

OptionalVatNumberStatus

VatNumberStatus?: number

The status of the VAT number.

OptionalWorkflowTrustLevel

WorkflowTrustLevel?: number

The workflow trust level assigned to the customer.

WorkflowTrustLevelEnabled

WorkflowTrustLevelEnabled: boolean

Indicates if workflow trust level is enabled for the customer.

ZipPostalCode

ZipPostalCode: string

The ZIP or postal code of the customer.

Settings

Member Visibility

On This Page

Properties