CRM Objects

CRM objects are pre-defined system objects that are built in to the platform. They become available when the Sales Force Automation application is installed. They are customizable, but some functionality is fixed. (Custom Objects, in contrast, are created by platform developers. They are fully configurable, and become available when custom applications are developed or installed.)

Note: Other Built-in Objects are available, as well.

For Developers

Service Providers should consider the characteristics of Custom Objects vs CRM Objects and Built-in Objects when building applications. Custom Objects are more customizable and generally more flexible, but the CRM Objects and Built-in Objects may have special functionality that is desirable.

Tip: The CRM Objects and Built-in Objects are due to be replaced by newer, more customizable versions in a future release. To minimize any impact on your applications, prefer Custom Objects, if at all possible.

Note: Some objects will be displayed as tabs in the application, while others are hidden from view

Important: When searching the CRM Objects using the REST API, you need to use the (mostly uppercase) REST versions of the field names when specifying Field Lists and Filter Expressions in the Dynamic Search Parameters. Those field names are returned, as well. For example: OWNERID. When you do an HTTP GET, on the other hand, tags are returned in lowercase, with underscores. For example: owner_id. Those tag names must be specified when doing an HTTP PUT. Those are also the field names you use in the GUI and in the Java APIs. CRM Objects ACCOUNT LEAD CONTACT CONTRACT CASE OPPORTUNITY PRODUCT PRICE BOOK

Property Limitations

• The following Property options are not available in Built-in or CRM Objects:

• Display Styles - Only Sectional Layout and Horizontal Tabbed Layout are supported for CRM Objects. No Display Styles are available for Built-In Objects.
• Record Locators can not be changed
• Cannot make an object Active or Inactive

• Inactive objects are not used in an application
• Data in an Inactive object cannot be viewed, edited or deleted

• Cannot set the object to be Web Enabled; exception: Prospects can be Web Enabled

Note: Web Enabled objects can use the Web Forms tool

• The Help URL is set by default, and cannot be changed
• Campaign Tracking is enabled by default, and cannot be changed

Other Considerations

• Object Inheritance is not supported
• Lookup fields to Built-in or CRM Objects do not include Record Selection Criteria or Post-selection Javascipt
• Workflows are not supported
• Built-in or CRM Objects cannot be deleted, but can be hidden from view
• Fields associated with the Record Id are clickable in Built-in or CRM Objects

• Clicking the link to an Account Name, Contact Name, or other Built-in or CRM Object fields opens the record for viewing
• By contrast, Custom Objects provide a Details link to open the record for viewing

CRM Object Type Identifiers

CRM Objects are listed here, showing the names that appear in the UI, along with the object-type identifiers used in the APIs.

Built-in or CRM Objects (As shown in the Platform UI)	Object Type Identifiers
Accounts	ACCOUNT
Cases	CASE
Contacts	CONTACT
Contracts	CONTRACT
Prospect	LEAD
Opportunity	OPPORTUNITY_V2
Price Book	PRICE BOOK
Product	PRODUCT
Notes	NOTE

CRM Object Attributes

This section provides reference tables for the fields in the CRM Objects defined in the CRM application. The tables include Field Name, Display Type and Description for each Object.

• Required Fields are highlighted, in italics

This state describes the default field property in a new instance of the platform. Users with appropriate Data Access Permissions can change field properties without notice.

• Additional fields may be returned. Such fields are generally intended for internal use, or for backward compatibility. Common fields intended for internal use include:

• CALL_ACTION
• VIEW_ACTION

Reference for Related Objects

• Dependencies between fields in related objects must be considered; See these topics:
  • Relating Contacts and Opportunities
  • Relating Objects

Relating Contacts and Opportunities

By default, Contacts and Opportunities can be related to an Account or LEAD (Prospect) object in the platform.

When accessing Contacts and Opportunities, these fields must be specified:

• reference_type contains the name of the object (either ACCOUNT or LEAD)
• reference_id_name contains the name of the Account or Lead
• related_to_id contains the identifier of the Account or Lead record

Relating Objects

When building a relationship between objects, the fields reference_type and reference_id are used as follows.

Example

Object B (Expense Item) is related to Object A (Expense Report), therefore, a record in Object B (Expense Item) contains:

• reference_type the name (or Object Type Identifier) of Object A (Expense Report)
• reference_id the identifier of the record in Object A (Expense Report)

Standard Fields

The standard system fields are:

• Common to, and predefined in, all Objects.
• Created automatically when an object is created.
• Populated automatically when a record is added or updated in the GUI.
• Required when a record is added or updated using an API.

Field Name	REST Search Name	GUI Label	Display Type	Description
object_id	object_id	Object ID	Number	Unique identifier for the object. (This field is always present, but is only displayed when examining Object metadata (the data that defines the object).
record_id	id	Record ID	Number	Unique record identifier
owner_id	OWNERID	Owner	String	Unique identifier of the record's owner
owner_team_id	OWNER_TEAM_ID	n/a	String	Unique identifier of record owner's primary team. (This is a virtual field that does not actually exist in the record. The actual field is in the User object. It is returned in APIs, to keep from having to access the database a second time to check permissions.)
created_id	CREATEDID	Created By	String	Unique identifier of the user who created the record
date_created	DATECREATED	Date Created	String	Date the record was created: UTC Format in the REST API. User's Date Format in the GUI and the Java API.
date_modified	DATEMODIFIED	Date Modified	String	Date the record was last modified: UTC Format in the REST API. User's Date Format in the GUI and the Java API.
modified_id	MODIFIEDID	Modified By	String	Unique identifier of the user who last modified the record

ACCOUNT Object

Object ID

ACCOUNT

Available Fields

• Required Fields are highlighted, in italics

This state describes the default field property in a new instance of the platform. Users with appropriate Data Access Permissions can change field properties without notice.

• Additional fields may be returned. Such fields are generally intended for internal use, or for backward compatibility. Common fields intended for internal use include:

• CALL_ACTION
• VIEW_ACTION

Field Name	REST Search Name	Display Type	Description
description	DESCRIPTION	text	Description
agent_id	AGENT	Number	Agency ID
billing_account_id	BILLING_ACCOUNT	String	Billing Account ID, if it is separate from the actual Account ID
city	CITY	String	City part of the Account's address
country	COUNTRY	String	Country part of the Account's address
county	COUNTY	String	County part of the Account's address
do_not_call	DO_NOT_CALL	Boolean	Boolean value to indicate whether you can call the Account or not
do_not_fax	DO_NOT_FAX	Boolean	Boolean value to indicate whether you can send a fax to the Account or not
duns_number	DUNS	String	DUNS number of the Account
employees	EMPLOYEES	Number	Number of employees of the Account
fax	FAX	Phone	Fax number of the Account
industry	INDUSTRY	String	Type of industry the Account belongs to
infousa_business_id	InfoUSA	String	InfoUSA business ID of the Account
last_activity	LAST_ACTIVITY	Date	Date of the last activity that was performed on this Account
lead_source	LEAD_SOURCE	String	Lead/Prospect source of the Account
name	NAME	String	Account name
number	ACCOUNT_NO	String	Account Number
ownership	OWNERSHIP	String	Company Ownership
parent_id	PARENT_ACCOUNT	String	ID of the parent Account
phone	PHONE	Phone	Phone number of the Account
primary_contact_id	PRIMARY_CONTACT	Number	Primary Contact ID of the Account
rating	RATING	String	Rating of the Account
revenue	REVENUE	Currency	Revenue of the Account
siccode	SICCODE	String	SIC code of the Account
state	STATE	String	State part of the Account's address
street	STREET	String	Street part of the Account's address
zip	ZIP	String	Zip code part of the Account's address
ticker	TICKER	String	Ticker symbol of the Account
type	TYPE	String	Account type
website	WEBSITE	URL	URL of the Account's website

A REST search returns these fields, as well. (Most are from Related Records. They can't be specified when adding or updating a record, but they can be seen when searching.)

REST Search Name	Display Type	Description
record_locator	String	The concatenation of record identifier fields specified in the object's Record Locator tab.
CONTACT_EMAIL	String	Primary contact's email address.
FAX	String	Primary contact's FAX number.
MOBILE_PHONE	String	Primary contact's cell phone.
PRIMARY_CONTACT_PHONE_NUMBER	String	Primary contact's main number.
TITLE	String	Primary contact's title

LEAD Object

This is the object used for a Prospect.

Object ID

LEAD

Available Fields

• Required Fields are highlighted, in italics

This state describes the default field property in a new instance of the platform. Users with appropriate Data Access Permissions can change field properties without notice.

• Additional fields may be returned. Such fields are generally intended for internal use, or for backward compatibility. Common fields intended for internal use include:

• CALL_ACTION
• VIEW_ACTION

Field Name	REST Search Name	Display Type	Description
description	DESCRIPTION	text	Description
city	CITY	String	City part of the Lead/Prospect's address
country	COUNTRY	String	Country part of the Lead/Prospect's address
duns_number	DUNS	String	DUNS number of the Lead/Prospect
fax	FAX	Phone	Fax number of the Lead/Prospect
industry	INDUSTRY	String	Type of industry the Lead/Prospect belongs to
infousa_business_id	INFOUSA	String	InfoUSA business ID of the Lead/Prospect
last_activity	LAST_ACTIVITY	Date	Date of the last activity that was performed on this Lead/Prospect
lead_source	SOURCE	String	Source of the Lead/Prospect
name	COMPANY_NAME	String	Lead/Prospect Name
phone	PHONE	Phone	Phone number of the Lead/Prospect
primary_contact_id	PRIMARY_CONTACT	String	Primary Contact for the Lead/Prospect
stage	STAGE	String	Stage in the sales cycle
state	STATE	String	State part of the Lead/Prospect's address
street	STREET	String	Street part of the Lead/Prospect's address
zip	ZIP	String	Zip code of the Contact
website	WEBSITE	URL	URL of the Lead/Prospect's website
is_account	IS_ACCOUNT	Boolean	True if the Lead was converted to an Account.
converted_to_account	CONVERTED_TO_ACCOUNT	String	ID of the Account the Lead was converted to.
CONVERTED_BY_ID	CONVERTED_BY	String	The ID of the person of who converted the Lead to an Account. (In this one case, the Java field is in all capitals.)
date_converted	DATE_CONVERTED	Date	Date the Lead was converted to an Account

A REST search returns these fields, as well. (They can't be specified when adding or updating a record, but they can be seen when searching.)

REST Search Name	Display Type	Description
record_locator	String	The concatenation of record identifier fields specified in the object's Record Locator tab.
CONTACT_EMAIL	String	Email address.
CONTACT_FAX	String	Fax number.
CONTACT_MOBILE_PHONE	String	Cell phone
CONTACT_PHONE	String	Phone number
CONTACT_TITLE	String	Contact's title.
DO_NOT_FAX	Boolean	Whether or not you can send a fax.

CONTACT Object

Object ID

CONTACT

Available Fields

• Required Fields are highlighted, in italics

This state describes the default field property in a new instance of the platform. Users with appropriate Data Access Permissions can change field properties without notice.

• Additional fields may be returned. Such fields are generally intended for internal use, or for backward compatibility. Common fields intended for internal use include:

• CALL_ACTION
• VIEW_ACTION

Field Name	REST Search Name	Display Type	Description
description	DESCRIPTION	text	Description
assistant	ASSISTANT	String	Assistant to this Contact
assistant_phone	ASSISTANTPHONE	Phone	Phone number of the assistant
birth_date	BIRTHDATE	Date	Birth Date of the Contact
city	CITY	String	City part of the Contact's address
country	COUNTRY	String	Country part of the Contact's address
department	DEPARTMENT	String	Department to which the Contact belongs
do_not_call	DO_NOT_CALL	Boolean	Do not call flag for the Contact
do_not_email	DO_NOT_SPAM	Boolean	Do not email flag for the Contact
do_not_fax	DO_NOT_FAX	Boolean	Do not fax flag for the Contact
email	EMAIL	Email	Email Address of the Contact
fax	FAX	Phone	Fax number of the Contact
first_name	FIRSTNAME	String	First name of the Contact
flag_primary_contact	IS_PRIMARY_CONTACT	Boolean	Flag to specify that this Contact is the Primary Contact
home_phone	HOMEPHONE	Phone	Home Phone number of the Contact
last_name	LASTNAME	String	Last name of the Contact
mail_format_preference	FORMAT_PREFERENCE	Boolean	Flag to specify the Contact preference for text or HTML email; True indicates a preference for text email, false for HTML
mobile_phone	MOBILEPHONE	Phone	Mobile Phone number of the Contact
other_phone	OTHERPHONE	Phone	Other Phone number of the Contact
phone	PHONE	Phone	Phone number of the Contact
related_to_type	RELATED_TO_TYPE	String	The type of record this contact is related to: ACCOUNT or LEAD
related_to_id	RELATED_TO_ID	String	The record_id of the Account or Lead (Prospect) this contact is related to
reports_to	REPORTS_TO	String	ID of another Contact to which the Contact reports.
salutation	SALUTATION	String	Salutation
state	STATE	String	State part of the Contact's address
street	STREET	String	Street part of the Contact's address
title	TITLE	String	Title of the Contact
zip	ZIP	String	Zip code of the Contact

A REST search returns these fields, as well. (Most are from Related Records. They can't be specified when adding or updating a record, but they can be seen when searching.)

REST Search Name	Display Type	Description
record_locator	String	The concatenation of record identifier fields specified in the object's Record Locator tab.
CONTACTNAME	String	Concatenation of Contact's first name and last name fields.
ACCOUNT_NO	String	Account Number
ACCT_DATE_CREATED	String	Date the Account was created
ACCT_DATE_MODIFIED	String	Date the Account was last modified
ACCT_NAME	String	Account name
ACCT_OWNER	String	Unique identifier of the Account record's owner
ACCT_STATE	String	State part of the Account's address
ACCT_ZIP	String	Zip code part of the Account's address
INDUSTRY	String	Type of industry the Account belongs to
LAST_ACTIVITY	Date	Date of the last activity that was performed on this Account
SICCODE	String	SIC code of the Account
TYPE	String	Account type
WEBSITE	URL	URL of the Account's website

CONTRACT Object

Object ID

CONTRACT

Available Fields

• Required Fields are highlighted, in italics

This state describes the default field property in a new instance of the platform. Users with appropriate Data Access Permissions can change field properties without notice.

• Additional fields may be returned. Such fields are generally intended for internal use, or for backward compatibility. Common fields intended for internal use include:

• CALL_ACTION
• VIEW_ACTION

Field Name	REST Search Name	Display Type	Description
description	DESCRIPTION	text	Description
account_id	account_id	Number	ID of the Account this Contract is related to
agent_id	AGENT_NAME	Number	Partner/Agency Account ID
amount	CONTRACT_AMOUNT	Currency	Amount of the Contract
company_signed_by	SIGNED_BY_APPROVER	String	Name of the Approver
company_signed_date	APPROVER_SIGNING_DATE	Date	Date the Approver signed the Contract
company_signed_title	APPROVER_TITLE_OF_SIGNATORY	String	Approver Title of Signatory
contact_id	CONTACTNAME	Number	ID of the Primary Contact
customer_signed_by	SIGNED_BY	String	Name of the person who signed the Contract
customer_signed_date	SIGNED_DATE	String	Date the person signed the Contract
customer_signed_title	TITLE_OF_SIGNATORY	String	Signatory title of the person who signed the Contract
end_date	CONTRACT_ENDDATE	Date	End date of the Contract
name	CONTRACT_NAME	String	Name of the Contract
notify	RENEWAL_REMINDER	Number	Renewal reminder days
number	NUMBER	String	Contract Number
opportunity_id	OPPORTUNITYNAME	Number	ID of the Opportunity to which this Contract is related
renewal_date	CONTRACT_RENEWALDATE	Date	Renewal date of the Contract
special_terms	SPECIAL_TERMS	String	Special Terms in the Contract
start_date	CONTRACT_STARTDATE	Date	Start Date of the Contract
status	STATUS	String	Status of the Contract
type	CONTRACT_TYPE	String	Type of the Contract

A REST search returns these fields, as well. (They can't be specified when adding or updating a record, but they can be seen when searching.)

REST Search Name	Display Type	Description
record_locator	String	The concatenation of record identifier fields specified in the object's Record Locator tab.

OPPORTUNITY Object

Object ID

OPPORTUNITY_V2

Available Fields

• Required Fields are highlighted, in italics

This state describes the default field property in a new instance of the platform. Users with appropriate Data Access Permissions can change field properties without notice.

• Additional fields may be returned. Such fields are generally intended for internal use, or for backward compatibility. Common fields intended for internal use include:

• CALL_ACTION
• VIEW_ACTION

Field Name	REST Search Name	Display Type	Description
description	DESCRIPTION	text	Description
related_to_id	RELATED_TO_ID	Number	Related to Account or Lead/Prospect ID
agent_id	AGENT_ID	Number	Agency ID
close_date	CLOSEDATE	Date	Closing Date of the Opportunity
discount	DISCOUNT	Percentage	Discount in percentage
lead_source	LEAD_SOURCE	String	Lead/Prospect Source of the Opportunity
marketing_campaign_id	MARKETING_CAMPAIGN	String	Marketing Campaign ID related to the the Opportunity
name	OPPORTUNITY_NAME	String	Name of the Opportunity
pre_discount_amount	PREDISCOUNTAMOUNT	Currency	Sub Total before applying the discount
primary_contact_id	CONTACT_NAME	Number	Primary Contact for the Opportunity
probability	PROBABILITY	Percentage	Probability in percentage depending upon the Opportunity's stage
reference_type	RELATED_TO_TYPE	String	Related to Type; Possible values are Lead/Prospect or Account
reference_id_name		String	Related to Lead/Prospect Name or Account Name
stage	STAGE	String	Stage related to the Opportunity
total_amount	AMOUNT	Currency	Total Amount of the Opportunity
type		String	Type of Opportunity

A REST search returns these fields, as well. (They can't be specified when adding or updating a record, but they can be seen when searching.)

REST Search Name	Display Type	Description
record_locator	String	The concatenation of record identifier fields specified in the object's Record Locator tab.
ACCT_NAME	String	Name of the Prospect or Account to which this opportunity is attached.
CONTACTPHONE	String	Contact's phone number.

CASE Object

Object ID

CASE

Available Fields

• Required Fields are highlighted, in italics

This state describes the default field property in a new instance of the platform. Users with appropriate Data Access Permissions can change field properties without notice.

• Additional fields may be returned. Such fields are generally intended for internal use, or for backward compatibility. Common fields intended for internal use include:

• CALL_ACTION
• VIEW_ACTION

Field Name	REST Search Name	Display Type	Description
description	description	text	Description
account_id	account_id	Number	ID of the Account that this Case is related to
close_date	close_date	Date	Date when the case is closed
contact_id	contact_id	Number	ID of the Contact related to this Case
name	name	String	Case ID/Name
notify_status_change	notify_status_change	Boolean	Flag to notify when case status changes
origin	origin	String	Case Origin
priority	priority	String	Priority of the Case
project_id	project_id	String	ID of the Project related to this Case
reason	reason	String	Case reason
status	status	String	Case status (New, Closed, and so on.)
subject	subject	String	Case Subject
type	type	String	Case type (Issue, Feature Request, and so on)

PRICE BOOK Object

Object ID

PRICE_BOOK

Available Fields

• Required Fields are highlighted, in italics

This state describes the default field property in a new instance of the platform. Users with appropriate Data Access Permissions can change field properties without notice.

• Additional fields may be returned. Such fields are generally intended for internal use, or for backward compatibility. Common fields intended for internal use include:

• CALL_ACTION
• VIEW_ACTION

Field Name	REST Search Name	Display Type	Description
description	DESCRIPTION	text	Description
flag_active	ACTIVE	boolean	Active
name	PRICE_BOOK_NAME	text	On add, update or HTTP GET, this field contains the name of the Price Book. When returned in a REST search, it contains the information necessary to construct a link, in the form: {price book ID};;{price book name} For example: 1099725901;;My Price Book

A REST search returns these fields, as well. (They can't be specified when adding or updating a record, but they can be seen when searching.)

REST Search Name	Display Type	Description
record_locator	String	The concatenation of record identifier fields specified in the object's Record Locator tab.

PRODUCT Object

Object ID

PRODUCT

Available Fields

• Required Fields are highlighted, in italics

This state describes the default field property in a new instance of the platform. Users with appropriate Data Access Permissions can change field properties without notice.

• Additional fields may be returned. Such fields are generally intended for internal use, or for backward compatibility. Common fields intended for internal use include:

• CALL_ACTION
• VIEW_ACTION

Field Name	REST Search Name	Display Type	Description
description	DESCRIPTION	text	Description
std_price	STDPRICE	currency	Standard Price
min_units	MINUNITS	number	Minimum number of units
active	ACTIVE	boolean	Active
name	PRODUCT_NAME	text	name of the Product
product_category	CATEGORY	string	Category
product_code	CODE	String	Code
product_image	product_image	String	Identifier for a graphic image that portrays the product, in the form: {file_name}:{image_retrieval_id}

A REST search returns these fields, as well. (They can't be specified when adding or updating a record, but they can be seen when searching.)

REST Search Name	Display Type	Description
record_locator	String	The concatenation of record identifier fields specified in the object's Record Locator tab.