GetClient()

Description

Returns a client object you can use to update and delete that client.

Return Value

Object

Parameters
Remarks

Object has the following structure:

Field

Type

Length

Description

iId

Integer

4

Primary Key - Unique Identifier.

dDateDeleted

DateTime

8

Date deleted.

iGlobalId

Integer

4

Client Global Id.

eObjectState

Enumeration

1

Indicates the status of the object.

-1 = Unchanged

0 = New/Added

1 = Changed

2 = Deleted

cLastName

String

20

Client last name.

cFirstName

String

15

Client first name.

cAddress1

String

40

Address (Line 1).

cAddress2

String

40

Address (Line 2).

cCity

String

25

City.

cState

String

3

State.

cZipCode

String

10

Zip code.

cPostalSortCode

String

5

Postal Sort

lIsNonDeliverableAddress

Boolean

1

Indicates whether the address is non-deliverable.

cHomeAreaCode

String

4

Area code for home phone.

cHomePhoneNumber

String

8

Home phone.

cBusinessAreaCode

String

4

Area code for business phone.

cBusinessPhoneNumber

String

8

Business phone.

cBusinessExtension

String

5

Extension for business phone.

dFirstVisitDate

DateTime

8

First visit date.

dLastVisitDate

DateTime

8

Last visit date.

iNumberOfVisits

Integer

4

Total number of visits.

iPrimaryEmployeeId

Integer

4

Primary Employee Id.  Foreign Key to Employee iId.

nAge

Decimal

3,0

Client age.

dBirthday

DateTime

8

Client date of birth.

lHasChildren

Boolean

1

Indicates whether the client has children.

lIsMarried

Boolean

1

Indicates whether the client is married.

lIsPrimaryResidence

Boolean

1

Indicates whether the client is the primary resident at their address.

dAnniversaryDate

DateTime

8

Anniversary date.

nSex

Decimal

1,0

Client gender.

1 = Male

2 = Female

lChecksAllowed

Boolean

1

Indicates whether the client has children.

lNoMailingsAllowed

Boolean

1

Indicates whether the client wants to receive mailings.

lIsInactive

Boolean

1

Indicates whether the client is inactive.

lDisplayNotesInRegister

Boolean

1

Indicates whether the client's notes display on the Register.

lConfirmAppointments

Boolean

1

Indicates whether the client receives appointment confirmations.

iGuestId

Integer

4

Id for the client in the property management system.

cHotelRoomNumber

String

8

Room number for the client in the property management system .

dDateCreated

DateTime

8

Date/time created.

lAllowPoints

Boolean

1

Indicates whether client can accrue points.

lDisplayNotesInAppointmentBook

Boolean

1

Indicates whether the client's notes display on the Appointment Book.

cConfirmationSequence

String

7

Appointment confirmation sequence.

A = Auto-Confirm

C = Cell

E = Email

F = Fax

H = Home

S = SMS

W = Work

lDisplayUDFInRegister

Boolean

1

Indicates whether entries in user defined fields display on the Register in Millennium.

lDisplayUDFInAppointmentBook

Boolean

1

Indicates whether entries in user defined fields display on the Appointment Book in Millennium.

dLastChangedDateTime

DateTime

8

Date/time last changed.

cNotes

String

 

Client notes.

cLicenseNumber

String

20

Driver's license number.

cEmailAddress

String

40

Client email address.

cFaxAreaCode

String

4

Fax area code.

cFaxPhoneNumber

String

8

Fax number.

cCellAreaCode

String

4

Cell phone area code.

cCellPhoneNumber

String

8

Cell phone number.

nCreditLimit

Decimal

8,2

Credit limit for the client's account.

iTermId

Integer

4

 

iReferralTypeId

Integer

4

Referral Type Id.  Foreign Key to Referrals iId.

iReferredByClientId

Integer

4

Id of the referring client (if applicable).

lCanViewApptsOnline

Boolean

1

Indicates whether the client can view appointments in Online Booking.

lCanBookApptsOnline

Boolean

1

Indicates whether the client can book appointments in Online Booking.

lAllowAccountCharge

Boolean

1

Indicates whether the client can charge purchases to an account.

lSendEmails

Boolean

1

Indicates whether the client wants to receive emails.

lConfirmViaEmail

Boolean

1

Indicates whether the client wants to receive appointment confirmations by email.

lConfirmViaHomePhone

Boolean

1

Indicates whether the client wants to receive appointment confirmations on their home phone.

lConfirmViaBusinessPhone

Boolean

1

Indicates whether the client wants to receive appointment confirmations on their business phone.

lConfirmViaFax

Boolean

1

Indicates whether the client wants to receive appointment confirmations by fax.

lConfirmViaCellPhone

Boolean

1

Indicates whether the client wants to receive appointment confirmations on their cell phone.

lConfirmViaSMS

Boolean

1

Indicates whether the client wants to receive appointment confirmations by SMS text message.

lConfirmViaAutoConfirmation

Boolean

1

Indicates whether the client wants to receive automated appointment confirmations on their phone (TeleVox clients only).

iConfirmDaysInAdvance

Integer

4

Number of days before an appointment that the client wants to receive a confirmation.

lHasMemberships

Boolean

1

Indicates whether the client has a membership.

lHasCreditCardOnFile

Boolean

1

Indicates whether the client has their credit card details saved in their profile.

lIsCreditCardValid

Boolean

1

Indicates whether the credit card on file is valid.

iProfessionId

Integer

4

Id of the client's profession.

 

 

Contact Us | Send Feedback