CRM Objects

CRM Objects

From LongJump Support Wiki

CRM Objects
Jump to: navigation, search

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.)

File:notepad.png

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

Contents

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.

File:thumbsup.gif

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

File:warn.png

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

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
CasesCASE
ContactsCONTACT
ContractsCONTRACT
ProspectLEAD
OpportunityOPPORTUNITY_V2
Price BookPRICE BOOK
ProductPRODUCT
NotesNOTE

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

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 NumberUnique 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 NumberUnique record identifier
owner_id OWNERID Owner StringUnique identifier of the record's owner
owner_team_id OWNER_TEAM_ID n/a StringUnique 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 StringUnique identifier of the user who created the record
date_created DATECREATED Date Created StringDate the record was created:
date_modified DATEMODIFIED Date Modified StringDate the record was last modified:
modified_id MODIFIEDID Modified By StringUnique 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
descriptionDESCRIPTION textDescription
agent_idAGENT NumberAgency ID
billing_account_idBILLING_ACCOUNT StringBilling Account ID, if it is separate from the actual Account ID
cityCITY StringCity part of the Account's address
countryCOUNTRY StringCountry part of the Account's address
countyCOUNTY StringCounty part of the Account's address
do_not_callDO_NOT_CALL BooleanBoolean value to indicate whether you can call the Account or not
do_not_faxDO_NOT_FAX BooleanBoolean value to indicate whether you can send a fax to the Account or not
duns_numberDUNS StringDUNS number of the Account
employeesEMPLOYEES NumberNumber of employees of the Account
faxFAX PhoneFax number of the Account
industryINDUSTRY StringType of industry the Account belongs to
infousa_business_idInfoUSA StringInfoUSA business ID of the Account
last_activityLAST_ACTIVITY DateDate of the last activity that was performed on this Account
lead_sourceLEAD_SOURCE StringLead/Prospect source of the Account
name NAME String Account name
numberACCOUNT_NO StringAccount Number
ownershipOWNERSHIP StringCompany Ownership
parent_idPARENT_ACCOUNT StringID of the parent Account
phonePHONE PhonePhone number of the Account
primary_contact_idPRIMARY_CONTACT NumberPrimary Contact ID of the Account
ratingRATING StringRating of the Account
revenueREVENUE CurrencyRevenue of the Account
siccodeSICCODE StringSIC code of the Account
stateSTATE StringState part of the Account's address
streetSTREET StringStreet part of the Account's address
zipZIP StringZip code part of the Account's address
tickerTICKER StringTicker symbol of the Account
typeTYPE StringAccount type
websiteWEBSITE URLURL 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
descriptionDESCRIPTION textDescription
cityCITY StringCity part of the Lead/Prospect's address
countryCOUNTRY StringCountry part of the Lead/Prospect's address
duns_numberDUNS StringDUNS number of the Lead/Prospect
faxFAX PhoneFax number of the Lead/Prospect
industryINDUSTRY StringType of industry the Lead/Prospect belongs to
infousa_business_idINFOUSA StringInfoUSA business ID of the Lead/Prospect
last_activityLAST_ACTIVITY DateDate of the last activity that was performed on this Lead/Prospect
lead_sourceSOURCE StringSource of the Lead/Prospect
name COMPANY_NAME String Lead/Prospect Name
phonePHONE PhonePhone number of the Lead/Prospect
primary_contact_idPRIMARY_CONTACT StringPrimary Contact for the Lead/Prospect
stageSTAGE StringStage in the sales cycle
stateSTATE StringState part of the Lead/Prospect's address
streetSTREET StringStreet part of the Lead/Prospect's address
zipZIP StringZip code of the Contact
websiteWEBSITE URLURL 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
descriptionDESCRIPTION textDescription
assistantASSISTANT StringAssistant to this Contact
assistant_phoneASSISTANTPHONE PhonePhone number of the assistant
birth_dateBIRTHDATE DateBirth Date of the Contact
cityCITY StringCity part of the Contact's address
countryCOUNTRY StringCountry part of the Contact's address
departmentDEPARTMENT StringDepartment to which the Contact belongs
do_not_callDO_NOT_CALL BooleanDo not call flag for the Contact
do_not_emailDO_NOT_SPAM BooleanDo not email flag for the Contact
do_not_faxDO_NOT_FAX BooleanDo not fax flag for the Contact
emailEMAIL EmailEmail Address of the Contact
faxFAX PhoneFax number of the Contact
first_nameFIRSTNAME StringFirst name of the Contact
flag_primary_contactIS_PRIMARY_CONTACT BooleanFlag to specify that this Contact is the Primary Contact
home_phoneHOMEPHONE PhoneHome Phone number of the Contact
last_name LASTNAME String Last name of the Contact
mail_format_preferenceFORMAT_PREFERENCE BooleanFlag to specify the Contact preference for text or HTML email; True indicates a preference for text email, false for HTML
mobile_phoneMOBILEPHONE PhoneMobile Phone number of the Contact
other_phoneOTHERPHONE PhoneOther Phone number of the Contact
phonePHONE PhonePhone number of the Contact
related_to_typeRELATED_TO_TYPE StringThe type of record this contact is related to: ACCOUNT or LEAD
related_to_idRELATED_TO_ID StringThe record_id of the Account or Lead (Prospect) this contact is related to
reports_to REPORTS_TO StringID of another Contact to which the Contact reports.
salutationSALUTATION StringSalutation
stateSTATE StringState part of the Contact's address
streetSTREET StringStreet part of the Contact's address
titleTITLE StringTitle of the Contact
zipZIP StringZip 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 StringAccount Number
ACCT_DATE_CREATED StringDate the Account was created
ACCT_DATE_MODIFIED StringDate the Account was last modified
ACCT_NAME StringAccount name
ACCT_OWNER StringUnique identifier of the Account record's owner
ACCT_STATE StringState part of the Account's address
ACCT_ZIP StringZip code part of the Account's address
INDUSTRY StringType of industry the Account belongs to
LAST_ACTIVITY DateDate of the last activity that was performed on this Account
SICCODE StringSIC code of the Account
TYPE StringAccount type
WEBSITE URLURL 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
descriptionDESCRIPTION textDescription
account_idaccount_id NumberID of the Account this Contract is related to
agent_idAGENT_NAME NumberPartner/Agency Account ID
amount CONTRACT_AMOUNT Currency Amount of the Contract
company_signed_bySIGNED_BY_APPROVER StringName of the Approver
company_signed_dateAPPROVER_SIGNING_DATE DateDate the Approver signed the Contract
company_signed_titleAPPROVER_TITLE_OF_SIGNATORY StringApprover Title of Signatory
contact_idCONTACTNAME NumberID of the Primary Contact
customer_signed_bySIGNED_BY StringName of the person who signed the Contract
customer_signed_dateSIGNED_DATE StringDate the person signed the Contract
customer_signed_titleTITLE_OF_SIGNATORY StringSignatory 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
notifyRENEWAL_REMINDER NumberRenewal reminder days
numberNUMBER StringContract Number
opportunity_idOPPORTUNITYNAME NumberID of the Opportunity to which this Contract is related
renewal_dateCONTRACT_RENEWALDATE DateRenewal date of the Contract
special_termsSPECIAL_TERMS StringSpecial Terms in the Contract
start_date CONTRACT_STARTDATE Date Start Date of the Contract
statusSTATUS StringStatus of the Contract
typeCONTRACT_TYPE StringType 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
descriptionDESCRIPTION textDescription
related_to_id RELATED_TO_ID Number Related to Account or Lead/Prospect ID
agent_idAGENT_ID NumberAgency ID
close_date CLOSEDATE Date Closing Date of the Opportunity
discountDISCOUNT PercentageDiscount in percentage
lead_sourceLEAD_SOURCE StringLead/Prospect Source of the Opportunity
marketing_campaign_idMARKETING_CAMPAIGN StringMarketing Campaign ID related to the the Opportunity
name OPPORTUNITY_NAME String Name of the Opportunity
pre_discount_amountPREDISCOUNTAMOUNT CurrencySub Total before applying the discount
primary_contact_idCONTACT_NAME NumberPrimary Contact for the Opportunity
probabilityPROBABILITY PercentageProbability in percentage depending upon the Opportunity's stage
reference_typeRELATED_TO_TYPE StringRelated to Type; Possible values are Lead/Prospect or Account
reference_id_name StringRelated 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 StringType 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
descriptiondescription textDescription
account_id account_id Number ID of the Account that this Case is related to
close_dateclose_date DateDate 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_changenotify_status_change BooleanFlag to notify when case status changes
originoriginStringCase Origin
prioritypriorityStringPriority of the Case
project_idproject_id StringID of the Project related to this Case
reasonreasonStringCase reason
status status String Case status (New, Closed, and so on.)
subject subject String Case Subject
typetypeStringCase 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
descriptionDESCRIPTION textDescription
flag_activeACTIVE booleanActive
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
descriptionDESCRIPTION textDescription
std_price STDPRICE currency Standard Price
min_units MINUNITS number Minimum number of units
activeACTIVE booleanActive
name PRODUCT_NAME text name of the Product
product_categoryCATEGORY stringCategory
product_codeCODE StringCode
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.
Personal tools