Difference between revisions of "OPPORTUNITY"

From LongJump Support Wiki
imported>Aeric
imported>Aeric
 
(17 intermediate revisions by the same user not shown)
Line 4: Line 4:


{{objectdisclaimer}}  
{{objectdisclaimer}}  
<noinclude>{{objectattributeAPInote}}
 
:{| border="1" cellpadding="5" cellspacing="0"
</noinclude>
::{| border="1" cellpadding="5" cellspacing="0"
!Field Name
!Field Name
!REST Search Name
!Display Type
!Display Type
!Description
!Description
|-
|-
|record_id *||Number||Unique record identifier
|description||DESCRIPTION ||text||Description
|-
|-
|owner_id  *||String||Unique record owner identifier
|{{Colorhighlight}}|''related_to_id''
|-
|{{Colorhighlight}}|''RELATED_TO_ID''
|date_modified  *||String||Date the record was last modified
|-
|date_created  *||String||Date the record was created
|-
|created_id  *||String||Unique identifier of the the user who created the record
|-
|modified_id  *||String||Unique identifier of the user who last modified the record
|-
|{{Colorhighlight}}|related_to_id
|{{Colorhighlight}}|Number
|{{Colorhighlight}}|Number
|{{Colorhighlight}}|Related to Account or Lead/Prospect ID
|{{Colorhighlight}}|Related to Account or Lead/Prospect ID
|-
|-
|agent_id||Number||Agency ID
|agent_id||AGENT_ID ||Number||Agency ID
|-
|-
|{{Colorhighlight}}|close_date
|{{Colorhighlight}}|''close_date''
|{{Colorhighlight}}|''CLOSEDATE''
|{{Colorhighlight}}|Date
|{{Colorhighlight}}|Date
|{{Colorhighlight}}|Closing Date of the Opportunity
|{{Colorhighlight}}|Closing Date of the Opportunity
|-
|-
|description||String||Description about this Opportunity
|discount||DISCOUNT ||Percentage||Discount in percentage
|-
|discount||Percentage||Discount in percentage
|-
|-
|lead_source||String||Lead/Prospect Source of the Opportunity
|lead_source||LEAD_SOURCE ||String||Lead/Prospect Source of the Opportunity
|-
|-
|marketing_campaign_id||String||Marketing Campaign ID related to the the Opportunity
|marketing_campaign_id||MARKETING_CAMPAIGN ||String||Marketing Campaign ID related to the the Opportunity
|-
|-
|{{Colorhighlight}}|name
|{{Colorhighlight}}|''name''
|{{Colorhighlight}}|''OPPORTUNITY_NAME''
|{{Colorhighlight}}|String
|{{Colorhighlight}}|String
|{{Colorhighlight}}|Name of the Opportunity
|{{Colorhighlight}}|Name of the Opportunity
|-
|-
|pre_discount_amount||Currency||Sub Total before applying the discount
|pre_discount_amount||PREDISCOUNTAMOUNT ||Currency||Sub Total before applying the discount
|-
|-
|primary_contact_id||Number||Primary Contact for the Opportunity
|primary_contact_id||CONTACT_NAME ||Number||Primary Contact for the Opportunity
|-
|-
|probability||Percentage||Probability in percentage depending upon the Opportunity's stage
|probability||PROBABILITY ||Percentage||Probability in percentage depending upon the Opportunity's stage
|-
|-
|reference_type||String||Related to Type; Possible values are Lead/Prospect or  Account
|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
|reference_id_name|| ||String||Related to Lead/Prospect Name or  Account Name
|-
|-
|{{Colorhighlight}}|stage
|{{Colorhighlight}}|''stage''
|{{Colorhighlight}}|''STAGE''
|{{Colorhighlight}}|String
|{{Colorhighlight}}|String
|{{Colorhighlight}}|Stage related to the Opportunity
|{{Colorhighlight}}|Stage related to the Opportunity
|-
|-
|{{Colorhighlight}}|total_amount
|{{Colorhighlight}}|''total_amount''
|{{Colorhighlight}}|''AMOUNT''
|{{Colorhighlight}}|Currency
|{{Colorhighlight}}|Currency
|{{Colorhighlight}}|Total Amount of the Opportunity
|{{Colorhighlight}}|Total Amount of the Opportunity
|-
|-
|type||String||Type of 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.)
:{| border="1" cellpadding="5" cellspacing="0"
!REST Search Name
!Display Type
!Description
 
|-
| record_locator || String || The concatenation of [[Record_Locator#Record_Identifier_Fields|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.
 
|}
|}
<noinclude>
;Standard Fields:
{{:System Fields}}


<noinclude>[[Category:CRM Objects]]</noinclude>
[[Category:CRM Objects]]
</noinclude>

Latest revision as of 00:53, 24 November 2011

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.
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:
date_modified DATEMODIFIED Date Modified String Date the record was last modified:
modified_id MODIFIEDID Modified By String Unique identifier of the user who last modified the record