Client Entity: Keys and Descriptions

If a client changes their last name, does an updated record appear in each of the tenant's locations?

If a client changes their last name, the updated client record would appear in a location's deltas as long as the client exists at that location. For example, if the client has a local record at Location A and Location B and changes their name at Location A, requesting deltas from Location A would return that client with the new last name, as would requesting deltas at Location B.

Keys and Descriptions

Note: References to "client profile" indicate that this data or value was set from the Meevo front-end. A client profile is what a user sees when viewing a client record in Meevo.

Client

Column Name

Data Type

Definition

TenantId

int

The ID of the tenant to whom this client belongs.

Client_TId
(Column Alias: EntityID)

uniqueidentifier (GUID)

A GUID assigned to the client across the entire tenant. This is the key to all other tables that link to this client.  

Make sure to ID reference keys in every table

HomeLocationId

int

The ID of the client's home location; i.e., where the client usually receives services.

Is this actually where the profile was originally created?

EntityVersion  

timestamp

A random value that is applied each time this record is updated.

For uniqueness, this column may use the following Column Alias: ClientTenantEntityVersion

Where else do we use aliases in each entity?

CreatedBy_User_TId

uniqueidentifier (GUID)

The GUID of the user who created this client record in Meevo.

DateCreated

datetimeoffset(7)

Date the client record was created.

DateUpdated

datetimeoffset(7)

Date the client record was last updated.

ExternalId

nvarchar(255)

The record's ID from an external system, if provided.

Prefix

nvarchar(16)

The client's Prefix as defined in the client profile.

FirstName

nvarchar(128)

The client's First Name as defined in the client profile.

MiddleName

nvarchar(128)

The client's Middle Name as defined in the client profile.

LastName

nvarchar(128)

The client's Last Name as defined in the client profile.

GenderEnum

int

The client's Gender as defined in the client profile. Enum values can be found here.

BirthMonth

int

The client's Birthday month as defined in the client profile.

BirthDay

int

The client's Birthday day of the month as defined in the client profile.

BirthYear

int

The client's Birthday year as defined in the client profile.

AnniversaryDate

date

The client's Anniversary as defined in the client profile.

EmailAddress

nvarchar(256)

The client's Email Address as defined in the client profile. All email addresses are unique within the tenant.

EmailCommOptedInStateEnum

int

Indicates if the client is opted-into email notifications. Enum values can be found here.

Address1

nvarchar(128)

The client's Address 1 as defined in the client profile.

Address2

nvarchar(128)

The client's Address 2 as defined in the client profile.

State

nvarchar(64)

The client's State as defined in the client profile.

City

nvarchar(128)

The client's City as defined in the client profile.

ZipCode

nvarchar(32)

The client's Zip Code as defined in the client profile.

Country

nvarchar(64)

The client's Country as defined in the client profile.

IsNotDeliverable

bit

Indicates an undeliverable state from Amazon Web Services, usually due to an invalid email address.

IsRestricted

bit

Indicates if Restricted is enabled on the client profile.

IsMinor

bit

Indicates if Minor is enabled on the client profile.

ContactName

nvarchar(256)

If this client is a minor, this field is the Parent/Guardian's First Name and Last Name, as defined in the Parent/Guardian profile.

ContactEmail

nvarchar(256)

If this client is a minor, this field is the Parent/Guardian's Email Address as defined in the Parent/Guardian profile.

ContactPhone

varchar(32)

If this client is a minor, this field is the Parent/Guardian's Number as defined in the Parent/Guardian profile.

HeadOfHousehold_Client_TId

uniqueidentifier (GUID)

If this client is part of a family, this field is the unique GUID of the client who has been marked as the Head of Household of the family in Meevo.

FileGuid

uniqueidentifier (GUID)

The GUID of the client profile image that was uploaded to the client profile.

GuardianID

uniqueidentifier (GUID)

If this client is a minor, this field is the GUID of the record that has been marked as the Parent/Guardian of this minor in Meevo.

ClientNumericId

int

This is the Numeric identifier that appears on the client profile.

ThirdPartyId

nvarchar(64)

This is the 3rd Party ID that appears on the client profile.

DoNotConfirm

bit

Indicates if the client has Do Not Confirm enabled on the client profile.

FrequencyOfVisit

int

Indicates the Overall frequency of visit, in number of weeks, as defined in the Booking Preferences tab of the client profile.

IsMarketingEmailEnabled

bit

Indicates if Use email for marketing is enabled on the client profile.

Client_TId_MergedTo

uniqueidentifier (GUID)

If the client profile was merged with another client profile, this is the new client ID (GUID) of the resulting profile.  

LocationId

int

 This is the location from which the client data is being processed. Certain data, such as referral information, is specific to each location. A client will appear in a location's Full Data Export if they have at least one service visit to that location.

ObjectStateEnum

int

Indicates if the client profile status is merged, deleted, inactive, active, or purged. Enum values can be found here.

ReferredByEnum

int

The Referral Type as defined in the client profile. Enum values can be found here.

ReferredByClient_TId

uniqueidentifier (GUID)

A unique GUID for the referring client selected in this client's profile.

ReferredByEmployee_User_TId

uniqueidentifier (GUID)

A unique GUID for the referring employee selected in this client's profile.

ReferredByReferral_TId

uniqueidentifier (GUID)

A unique GUID for a custom referral type. You can call our referralTypes endpoint to retrieve a list of Referral Types in a specific location.

OnlineBookingAccess

bit

Indicates if the client is able to book online as defined in the client profile.

IsTransient

bit

Indicates if the client is marked as Transient in the client profile.

ExcludeFromReceivingPoints

bit

Indicates if Exclude this client from receiving points is enabled in the client profile.

ExternalURL

nvarchar(255)

The External URL field on the client profile.

NoSellSharePersonalInfo

bit

Indicates if the option on the client's profile is enabled or disabled.

 

ClientPhone

Column Name

Data Type

Definition

TenantId

int

The ID of the tenant to whom this client belongs.

Client_TId
(Column Alias: EntityID)

uniqueidentifier (GUID)

A GUID assigned to the client across the entire tenant. This is the key to all other tables that link to this client.  

Make sure to ID reference keys in every table

PhoneTypeEnum

int

Indicates if the phone Type as defined in the client profile. Enum values can be found here.

CountryCode

varchat(10)

Country code for this client based on the selected Country on the client profile.

PhoneNumber

varchar(32)

The Number as defined in the client profile.

PhoneExtension

varchar(8)

For the "work" PhoneType, this is the Extension as defined in the client profile.

IsPrimary

bit

Indicates if this is the client's primary phone, as defined in the client profile.

SMSCommOptedInStateEnum

int

Indicates if the client is opted into text notifications as defined in the client profile.

SMSOptInStateDateUpdated

datetimeoffset(0)

The date and time that the client's text message opt-in status was most recently updated.

FullPhoneNumber

varchar(42)

The client's full primary phone number as defined in the client profile.