CustomerCriteria


Description

Specifies the criteria to use when retrieving a list of customer summary objects. Only customer summary objects that match the specified criteria will be returned. For the best performance, create criteria that uses only the properties marked with the dagger (†). These properties correspond to indexed columns in the database.

Properties

Property

Type

Description

Id

BetweenRestrictionOfString

A string restriction specifying the ID for the customer.

Name

LikeRestrictionOfString

A string restriction specifying the name of the customer.

IsActive

RestrictionOfNullableOfBoolean

A boolean restriction specifying the active status of the customer.

IsOnHold

RestrictionOfNullableOfBoolean

A boolean restriction specifying the hold status of the customer.

SalespersonId

LikeRestrictionOfString

A string restriction specifying the salesperson associated with the customer.

ClassId

LikeRestrictionOfString

A string restriction specifying the class associated with the customer.

CorporateAccountId

LikeRestrictionOfString

A string restriction specifying the corporate account for the customer.

State

LikeRestrictionOfString

A string restriction specifying the state for the customer.

PhoneNumber

LikeRestrictionOfString

A string restriction specifying the phone number for the customer.

CreatedDate

BetweenRestrictionOfNullableOfDateTime

A date/time restriction specifying the date the customer was created.

ModifiedDate

BetweenRestrictionOfNullableOfDateTime

A date/time restriction specifying the date the customer was modified. The value is in Coordinated Universal Time (UTC). Both the date and time portions of the value must be specified for the criteria.

LastModifiedDate

BetweenRestrictionOfNullableOfDateTime

A date/time restriction specifying the date the customer was modified. The value is in Coordinated Universal Time (UTC). Both the date and time portions of the value must be specified for the criteria.

Scope

CustomerScope

A property in criteria used to determine the level of filtering to be used when returning customer data.


Inherits from

Criteria


Documentation Feedback