Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Pega Customer Service data model - 8.2 and 8.3

Updated on September 10, 2021

This article provides a data dictionary for the Pega Customer Service application, describing the structure of the database as well as the relationships between its elements. The following tables are described in this article:

Account

Provides application access to customer account data, such as the account number, owner name, relationship value, account creation date, and other key data.

Pega Internal Name: PegaCA-Interface-Account

 

AccountBalance

 

Label: Account balance
Type: Decimal

 

AccountCloseDate

 

Label: Account close date
Type: Date

 

AccountNumber

 

Label: Account Number
Type: Text

 

AccountOpenDate

 

Label: Account Open Date
Type: Date

 

AccountOwner

 

Label: Account Owner
Type: Text

 

AccountTenure

 

Label: Account tenure
Type: Date

 

AccountType

 

Label: Account Type
Type: Text

 

Active

 

Label: Active
Type: TrueFalse

 

Address

 

Label: Address
Type: Text

 

AddressLine1

 

Label: Address line one
Type: Text

 

AvailableBalance

 

Label: Available Balance
Type: Decimal

 

City

 

Label: City
Type: Text

 

Country

 

Label: Country
Type: Text

 

CountryCode

 

Label: CountryCode
Type: Text

 

CustomerValue

 

Label: Customer Value
Type: Text

 

Email

 

Label: Email
Type: Text

 

FirstName

 

Label: First Name
Type: Text

 

Language

 

Label: Language
Type: Text

 

LastName

 

Label: Last Name
Type: Text

 

MinimumDue

 

Label: Minimum Due
Type: Decimal

 

Phone

 

Label: Phone
Type: Text

 

PhoneNumber

 

Label: Phone Number
Type: Text

 

RoleDescription

 

Label: Role Description
Type: Text

 

RoleName

 

Label: Role name
Type: Text

 

SocialSecurityNumber

 

Label: Social security number
Type: Text

 

State

 

Label: State
Type: Text

 

StateCode

 

Label: State Code
Type: Text

 

ZipCode

 

Label: Zip code
Type: Text

Account Owner

Provides application access to account owner data, such as the primary contact ID used by the Customer Service application.

Pega Internal Name: PegaCA-Interface-AccountOwner

 

AccountCloseDate

 

Label: Account close date
Type: Date

 

AccountOpenDate

 

Label: Account open date
Type: Date

 

AccountOwner

 

Label: AccountOwner
Type: Text

 

AccountTenure

 

Label: Account tenure
Type: Date

 

AccountType

 

Label: Account Type
Type: Text

 

Active

 

Label: Active
Type: TrueFalse

 

AddressLine1

 

Label: Address line one
Type: Text

 

AvailableBalance

 

Label: Available balance
Type: Decimal

 

BusinessPhone

 

Label: Business Phone
Type: Text

 

City

 

Label: City
Type: Text

 

Country

 

Label: Country
Type: Text

 

CountryCode

 

Label: CountryCode
Type: Text

 

CustomerValue

 

Label: Customer Value
Type: Text

 

Email

 

Label: Email
Type: Text

 

Fax

 

Label: Fax Number
Type: Text

 

FirstName

 

Label: First name
Type: Text

 

FullName

 

Label: Full name
Type: Text

 

Language

 

Label: Language
Type: Text

 

LastName

 

Label: Last Name
Type: Text

 

LastStatementDate

 

Label: LastStatementDate
Type: Date

 

Phone

 

Label: Phone
Type: Text

 

PhoneNumber

 

Label: Phone Number
Type: Text

 

RoleDescription

 

Label: Role Description
Type: Text

 

RoleName

 

Label: Role name
Type: Text

 

SocialSecurityNumber

 

Label: Social security number
Type: Text

 

State

 

Label: State
Type: Text

 

StateCode

 

Label: State Code
Type: Text

 

Status

 

Label: Status
Type: Text

 

ZipCode

 

Label: Zip code
Type: Text

Account Role

Provides application access to account role data that is used by the Customer Service application, such as role type, role name, and roleId.

Pega Internal Name: PegaCA-Interface-Roles

 

Active

 

Label: Active
Type: Text

 

AddressLine1

 

Label: Address line one
Type: Text

 

City

 

Label: City
Type: Text

 

Country

 

Label: Country
Type: Text

 

CountryCode

 

Label: CountryCode
Type: Text

 

CustomerValue

 

Label: Customer Value
Type: Text

 

Description

 

Label: Description
Type: Text

 

Email

 

Label: Email
Type: Text

 

Language

 

Label: Language
Type: Text

 

PhoneNumber

 

Label: Phone Number
Type: Text

 

RoleDescription

 

Label: Role Description
Type: Text

 

RoleId

 

Label: RoleId
Type: Text

 

RoleName

 

Label: Role name
Type: Text

 

RoleType

 

Label: RoleType
Type: Text

 

SocialSecurityNumber

 

Label: Social security number
Type: Text

 

StateCode

 

Label: State Code
Type: Text

 

ZipCode

 

Label: Zip code
Type: Text

Account Statement

Provides application access to account statement data, such as account type, account open and close dates, statement ID, status, and other statement-related data.

Pega Internal Name: PegaCA-Interface-Statements

 

AccountCloseDate

 

Label: Account close date
Type: Date

 

AccountOpenDate

 

Label: Account Open Date
Type: Date

 

AccountTenure

 

Label: Account tenure
Type: Date

 

AccountType

 

Label: Account Type
Type: Text

 

AddressLine1

 

Label: Address line one
Type: Text

 

BusinessPhone

 

Label: Business Phone
Type: Text

 

City

 

Label: City
Type: Text

 

Country

 

Label: Country
Type: Text

 

CountryCode

 

Label: CountryCode
Type: Text

 

CustomerValue

 

Label: Customer Value
Type: Text

 

Email

 

Label: Email
Type: Text

 

Fax

 

Label: Fax Number
Type: Text

 

FullName

 

Label: Full name
Type: Text

 

Language

 

Label: Language
Type: Text

 

Phone

 

Label: Phone
Type: Text

 

PhoneNumber

 

Label: Phone Number
Type: Text

 

RoleDescription

 

Label: Role Description
Type: Text

 

RoleName

 

Label: Role name
Type: Text

 

SocialSecurityNumber

 

Label: Social security number
Type: Text

 

State

 

Label: State
Type: Text

 

StateCode

 

Label: State Code
Type: Text

 

StatementId

 

Label: Statement ID
Type: Identifier

 

Status

 

Label: Status
Type: Text

 

ZipCode

 

Label: Zip code
Type: Text

Account Transaction

Provides application access to account transaction data, such as transaction description, transaction ID, transaction code, transaction post date, and other transaction-related data.

Pega Internal Name: PegaCA-Interface-Transactions

 

AccountCloseDate

 

Label: Account close date
Type: Date

 

AccountOpenDate

 

Label: Account Open Date
Type: Date

 

AccountTenure

 

Label: Account tenure
Type: Date

 

AddressLine1

 

Label: Address line one
Type: Text

 

BusinessPhone

 

Label: Business Phone
Type: Text

 

City

 

Label: City
Type: Text

 

Country

 

Label: Country
Type: Text

 

CountryCode

 

Label: CountryCode
Type: Text

 

CustomerValue

 

Label: Customer Value
Type: Text

 

TransactionTypeDescription

 

Label: Description for transaction type
Type: Text

 

Email

 

Label: Email
Type: Text

 

Fax

 

Label: Fax Number
Type: Text

 

FullName

 

Label: Full name
Type: Text

 

Language

 

Label: Language
Type: Text

 

Phone

 

Label: Phone
Type: Text

 

PhoneNumber

 

Label: Phone Number
Type: Text

 

RoleDescription

 

Label: Role Description
Type: Text

 

RoleName

 

Label: Role name
Type: Text

 

SocialSecurityNumber

 

Label: Social security number
Type: Text

 

State

 

Label: State
Type: Text

 

StateCode

 

Label: State Code
Type: Text

 

Status

 

Label: Status
Type: Text

 

TransactionAmount

 

Label: Transaction Amount
Type: Decimal

 

TransactionDate

 

Label: Transaction date
Type: DateTime

 

TransactionDescription

 

Label: Transaction description
Type: Text

 

TransactionId

 

Label: Transaction ID
Type: Text

 

TransactionPostDate

 

Label: Transaction post date
Type: DateTime

 

TransactionType

 

Label: Transaction type
Type: Text

 

ZipCode

 

Label: Zip code
Type: Text

Address Relations

Provides application access to address relation data, such as address type, address details (city, state, province, country, postal code), and other address-related data.

Pega Internal Name: PegaCA-Interface-PartyAddress

 

AddressLine2

 

Label: Address line 2
Type: Text

 

AddressLine1

 

Label: Address line one
Type: Text

 

AddressType

 

Label: Address Type
Type: Text

 

pyCity

 

Label: City
Type: Text

 

City

 

Label: City
Type: Text

 

Country

 

Label: Country
Type: Text

 

CountryCode

 

Label: Country Code
Type: Text

 

CustomerValue

 

Label: Customer Value
Type: Text

 

Email

 

Label: Email
Type: Text

 

IsPrimary

 

Label: Is primary
Type: TrueFalse

 

Language

 

Label: Language
Type: Text

 

PhoneNumber

 

Label: Phone Number
Type: Text

 

pyPostalCode

 

Label: Postal Code
Type: Text

 

Province

 

Label: Province
Type: Text

 

Region

 

Label: Region
Type: Text

 

RoleDescription

 

Label: Role Description
Type: Text

 

RoleName

 

Label: Role name
Type: Text

 

SocialSecurityNumber

 

Label: Social security number
Type: Text

 

pyState

 

Label: State
Type: Identifier

 

State

 

Label: State
Type: Text

 

StateCode

 

Label: State Code
Type: Text

 

pyStreet

 

Label: Street
Type: Text

 

ZipCode

 

Label: Zip code
Type: Text

Contact

Provides application access to contact data, such as name, phone numbers, email address, account roles, social ID’s, and other key data.

Pega Internal Name: PegaCA-Interface-Contact

 

Active

 

Label: Active
Type: Text

 

Addresses

 

Label: Addresses
Type: List
Of Type: Customer address

 

AddressLine1

 

Label: Address line one
Type: Text

 

AssistantEmail

 

Label: Assistant email
Type: Text

 

AssistantName

 

Label: Assistant name
Type: Text

 

AssistantPhone

 

Label: Assistant phone
Type: Text

 

BestTimeToCall

 

Label: Best time to call
Type: Text

 

ChildContacts

 

Label: Child Contacts
Type: List
Of Type: Contact to contact relationship

 

City

 

Label: City
Type: Text

 

CommPreferenceByEmail

 

Label: Communication preference by Email
Type: Text

 

CommPreferenceByFax

 

Label: Communication preference by Fax
Type: Text

 

CommPreferenceByMail

 

Label: Communication preference by Mail
Type: Text

 

CommPreferenceByPhone

 

Label: Communication preference by Phone
Type: Text

 

CompanyName

 

Label: Company name
Type: Text

 

ContactFullName

 

Label: ContactFullName
Type: Text

 

ContactId

 

Label: Contact identifier
Type: Identifier

 

ContactType

 

Label: Contact type
Type: Text

 

Country

 

Label: Country
Type: Text

 

CountryCode

 

Label: CountryCode
Type: Text

 

CustomerValue

 

Label: Customer Value
Type: Text

 

DateOfBirth

 

Label: Date of birth
Type: Date

 

DepartmentName

 

Label: Department name
Type: Text

 

Email

 

Label: Email
Type: Text

 

FacebookID

 

Label: Facebook ID
Type: Text

 

FacebookURL

 

Label: Facebook URL
Type: Text

 

Fax

 

Label: Fax
Type: Text

 

FirstName

 

Label: First Name
Type: Text

 

Gender

 

Label: Gender
Type: Text

 

HomeContactNumber

 

Label: Home Contact Number
Type: Text

 

JobTitle

 

Label: Job title
Type: Text

 

Language

 

Label: Language
Type: Text

 

LanguagePreference

 

Label: Language preference
Type: Text

 

LastName

 

Label: Last Name
Type: Text

 

LinkedinId

 

Label: Linkedin identifier
Type: Text

 

LinkedinURL

 

Label: Linkedin URL
Type: Text

 

MaritalStatus

 

Label: Marital status
Type: Text

 

MarketingByEmail

 

Label: Marketing by email
Type: Text

 

MarketingByMail

 

Label: Marketing by mail
Type: Text

 

MarketingByPhone

 

Label: Marketing by phone
Type: Text

 

MiddleName

 

Label: Middle name
Type: Text

 

MobilePhone

 

Label: Mobile Phone
Type: Text

 

NationalId

 

Label: National identifier
Type: Text

 

ParentContactId

 

Label: Parent contact identifier
Type: Text

 

PhoneNumber

 

Label: Phone Number
Type: Text

 

PrimaryEmail

 

Label: PrimaryEmail
Type: Text

 

PrimaryEmailType

 

Label: Primary Email Type
Type: Text

 

PrimaryPhoneNumber

 

Label: Primary phone number
Type: Text

 

PrimaryPhoneType

 

Label: Primary Phone Type
Type: Text

 

PriorityNote

 

Label: Priority note
Type: Text

 

RoleDescription

 

Label: Role Description
Type: Text

 

RoleName

 

Label: Role name
Type: Text

 

SecondaryEmail

 

Label: SecondaryEmail
Type: Text

 

SecondaryEmailType

 

Label: Secondary Email Type
Type: Text

 

SecondaryPhoneNumber

 

Label: Secondary phone number
Type: Text

 

SecondaryPhoneType

 

Label: Secondary Phone Type
Type: Text

 

SocialSecurityNumber

 

Label: Social security number
Type: Text

 

StateCode

 

Label: State Code
Type: Text

 

Suffix

 

Label: Suffix
Type: Text

 

TerritoryId

 

Label: Territory ID
Type: Text

 

TertiaryPhoneNumber

 

Label: Tertiary Phone Number
Type: Text

 

TertiaryPhoneType

 

Label: Tertiary Phone Type
Type: Text

 

TimeZone

 

Label: TimeZone
Type: Text

 

TwitterID

 

Label: Twitter ID
Type: Text

 

TwitterURL

 

Label: Twitter URL
Type: Text

 

ZipCode

 

Label: Zip code
Type: Text

Customer Address

Provides application access to customer address data, such as address details (address lines 1-5, city, state, province, country, postal code), and related contact info, such as contact ID, first and last name, and other customer address data.

Pega Internal Name: PegaCA-Interface-Address

 

Active

 

Label: Active
Type: Text

 

AddressId

 

Label: Address Identifier
Type: Text

 

Address1

 

Label: Address line 1
Type: Text

 

Address2

 

Label: Address line 2
Type: Text

 

Address3

 

Label: Address line 3
Type: Text

 

Address4

 

Label: Address line 4
Type: Text

 

Address5

 

Label: Address line 5
Type: Text

 

AddressType

 

Label: Address Type
Type: Text

 

pyCity

 

Label: City
Type: Text

 

City

 

Label: City
Type: Text

 

DomainId

 

Label: Contact Id
Type: Identifier

 

Country

 

Label: Country
Type: Text

 

CustomerValue

 

Label: Customer Value
Type: Text

 

DomainType

 

Label: Domain type
Type: Identifier

 

Email

 

Label: Email
Type: Text

 

FromDate

 

Label: From date
Type: DateTime

 

IsPrimary

 

Label: Is primary
Type: TrueFalse

 

Language

 

Label: Language
Type: Text

 

PostalCode

 

Label: Postal code
Type: Text

 

pyPostalCode

 

Label: Postal Code
Type: Text

 

Comments

 

Label: Property for Comments
Type: Text

 

RoleDescription

 

Label: Role Description
Type: Text

 

RoleName

 

Label: Role name
Type: Text

 

RoleType

 

Label: RoleType
Type: Text

 

SocialSecurityNumber

 

Label: Social security number
Type: Text

 

pyState

 

Label: State
Type: Identifier

 

State

 

Label: State
Type: Text

 

pyStreet

 

Label: Street
Type: Text

 

SubRegion

 

Label: Sub region
Type: Text

 

ToDate

 

Label: To date
Type: DateTime

 

ZipCode

 

Label: Zip code
Type: Text

Organization

Provides application access to business unit data, such as the related account owner, address, business unit ID, and other key data used by the Customer Service application.

Pega Internal Name: PegaCA-Interface-BusinessUnit

 

Active

 

Label: Active
Type: Text

 

Addresses

 

Label: Addresses
Type: List
Of Type: Customer address

 

AddressLine1

 

Label: Address line one
Type: Text

 

BusinessUnitId

 

Label: Business Unit ID
Type: Text

 

ChildOrganizations

 

Label: Child Organizations
Type: List
Of Type: Organization to organization relationship

 

City

 

Label: City
Type: Text

 

Contacts

 

Label: Contacts
Type: List
Of Type: Contact to organization relationship

 

Country

 

Label: Country
Type: Text

 

CountryCode

 

Label: CountryCode
Type: Text

 

CustomerLogo

 

Label: Customer logo
Type: Text

 

CustomerType

 

Label: Customer Type
Type: Text

 

CustomerValue

 

Label: Customer Value
Type: Text

 

Description

 

Label: Description
Type: Text

 

Email

 

Label: Email
Type: Text

 

EmployeeCount

 

Label: EmployeeCount
Type: Text

 

EndDate

 

Label: End Date
Type: Date

 

FacebookId

 

Label: FacebookId
Type: Text

 

FacebookURL

 

Label: FacebookURL
Type: Text

 

Fax

 

Label: Fax number
Type: Text

 

Industry

 

Label: Industry
Type: Text

 

IsParent

 

Label: IsParent
Type: Text

 

Language

 

Label: Language
Type: Text

 

LegalEntityType

 

Label: Legal Entity Type
Type: Text

 

LinkedinId

 

Label: LinkedinId
Type: Text

 

LinkedinURL

 

Label: LinkedinURL
Type: Text

 

OrganizationId

 

Label: Organization ID
Type: Text

 

OrganizationName

 

Label: Organization name
Type: Text

 

OrganizationType

 

Label: Organization type
Type: Text

 

BusinessUnitName

 

Label: Organization unit name
Type: Text

 

PhoneNumber

 

Label: Phone Number
Type: Text

 

PrimaryEmailId

 

Label: Primary Email Id
Type: Text

 

PrimaryPhoneNumber

 

Label: Primary phone number
Type: Text

 

Revenue

 

Label: Revenue
Type: Text

 

RoleDescription

 

Label: Role Description
Type: Text

 

RoleName

 

Label: Role name
Type: Text

 

SecondaryEmailId

 

Label: Secondary Email Id
Type: Text

 

SecondaryPhoneNumber

 

Label: Secondary phone number
Type: Text

 

SocialSecurityNumber

 

Label: Social security number
Type: Text

 

StartDate

 

Label: Start Date
Type: Date

 

StateCode

 

Label: State Code
Type: Text

 

TaxId

 

Label: Tax Id
Type: Text

 

TerritoryId

 

Label: Territory ID
Type: Text

 

TwitterId

 

Label: TwitterId
Type: Text

 

TwitterURL

 

Label: TwitterURL
Type: Text

 

Website

 

Label: Website
Type: Text

 

ZipCode

 

Label: Zip code
Type: Text

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us