opportunity EntityType

Entity Set Path
[organization URI]/api/data/v9.0/opportunities
Base Type
crmbaseentity
Display Name
Opportunity
Primary Key
opportunityid
Primary Key Attribute
name
Operations Supported
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
actualclosedate Edm.Date

Shows the date and time when the opportunity was closed or canceled.

Display Name: Actual Close Date

actualvalue Edm.Decimal

Type the actual revenue amount for the opportunity for reporting and analysis of estimated versus actual sales. Field defaults to the Est. Revenue value when an opportunity is won.

Display Name: Actual Revenue

actualvalue_base Edm.Decimal

Value of the Actual Revenue in base currency.

Display Name: Actual Revenue (Base)

Read Only
budgetamount Edm.Decimal

Type a value between 0 and 1,000,000,000,000 to indicate the lead's potential available budget.

Display Name: Budget Amount

budgetamount_base Edm.Decimal

Value of the Budget Amount in base currency.

Display Name: Budget Amount (Base)

Read Only
budgetstatus Edm.Int32

Select the likely budget status for the lead's company. This may help determine the lead rating or your sales approach.

Display Name: Budget

Default Options
Value Label
0 No Committed Budget
1 May Buy
2 Can Buy
3 Will Buy
captureproposalfeedback Edm.Boolean

Choose whether the proposal feedback has been captured for the opportunity.

Display Name: Proposal Feedback Captured

Default Options
Value Label
1 No
0 Yes
closeprobability Edm.Int32

Type a number from 0 to 100 that represents the likelihood of closing the opportunity. This can aid the sales team in their efforts to convert the opportunity in a sale.

Display Name: Probability

completefinalproposal Edm.Boolean

Select whether a final proposal has been completed for the opportunity.

Display Name: Final Proposal Ready

Default Options
Value Label
1 completed
0 mark complete
completeinternalreview Edm.Boolean

Select whether an internal review has been completed for this opportunity.

Display Name: Complete Internal Review

Default Options
Value Label
1 completed
0 mark complete
confirminterest Edm.Boolean

Select whether the lead confirmed interest in your offerings. This helps in determining the lead quality and the probability of it turning into an opportunity.

Display Name: Confirm Interest

Default Options
Value Label
1 No
0 Yes
createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
currentsituation Edm.String

Type notes about the company or organization associated with the opportunity.

Display Name: Current Situation

customerneed Edm.String

Type some notes about the customer's requirements, to help the sales team identify products and services that could meet their requirements.

Display Name: Customer Need

customerpainpoints Edm.String

Type notes about the customer's pain points to help the sales team identify products and services that could address these pain points.

Display Name: Customer Pain Points

decisionmaker Edm.Boolean

Select whether your notes include information about who makes the purchase decisions at the lead's company.

Display Name: Decision Maker?

Default Options
Value Label
1 completed
0 mark complete
description Edm.String

Type additional information to describe the opportunity, such as possible products to sell or past purchases from the customer.

Display Name: Description

developproposal Edm.Boolean

Select whether a proposal has been developed for the opportunity.

Display Name: Develop Proposal

Default Options
Value Label
1 completed
0 mark complete
discountamount Edm.Decimal

Type the discount amount for the opportunity if the customer is eligible for special savings.

Display Name: Opportunity Discount Amount

discountamount_base Edm.Decimal

Value of the Opportunity Discount Amount in base currency.

Display Name: Opportunity Discount Amount (Base)

Read Only
discountpercentage Edm.Decimal

Type the discount rate that should be applied to the Product Totals field to include additional savings for the customer in the opportunity.

Display Name: Opportunity Discount (%)

emailaddress Edm.String

The primary email address for the entity.

Display Name: Email Address

estimatedclosedate Edm.Date

Enter the expected closing date of the opportunity to help make accurate revenue forecasts.

Display Name: Est. Close Date

estimatedvalue Edm.Decimal

Type the estimated revenue amount to indicate the potential sale or value of the opportunity for revenue forecasting. This field can be either system-populated or editable based on the selection in the Revenue field.

Display Name: Est. Revenue

estimatedvalue_base Edm.Decimal

Value of the Est. Revenue in base currency.

Display Name: Est. Revenue (Base)

Read Only
evaluatefit Edm.Boolean

Select whether the fit between the lead's requirements and your offerings was evaluated.

Display Name: Evaluate Fit

Default Options
Value Label
1 No
0 Yes
exchangerate Edm.Decimal

Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.

Display Name: Exchange Rate

Read Only
filedebrief Edm.Boolean

Choose whether the sales team has recorded detailed notes on the proposals and the account's responses.

Display Name: File Debrief

Default Options
Value Label
1 completed
0 mark complete
finaldecisiondate Edm.Date

Enter the date and time when the final decision of the opportunity was made.

Display Name: Final Decision Date

freightamount Edm.Decimal

Type the cost of freight or shipping for the products included in the opportunity for use in calculating the Total Amount field.

Display Name: Freight Amount

freightamount_base Edm.Decimal

Value of the Freight Amount in base currency.

Display Name: Freight Amount (Base)

Read Only
identifycompetitors Edm.Boolean

Select whether information about competitors is included.

Display Name: Identify Competitors

Default Options
Value Label
1 completed
0 mark complete
identifycustomercontacts Edm.Boolean

Select whether the customer contacts for this opportunity have been identified.

Display Name: Identify Customer Contacts

Default Options
Value Label
1 completed
0 mark complete
identifypursuitteam Edm.Boolean

Choose whether you have recorded who will pursue the opportunity.

Display Name: Identify Sales Team

Default Options
Value Label
1 completed
0 mark complete
importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

initialcommunication Edm.Int32

Choose whether someone from the sales team contacted this lead earlier.

Display Name: Initial Communication

Default Options
Value Label
0 Contacted
1 Not Contacted
isrevenuesystemcalculated Edm.Boolean

Select whether the estimated revenue for the opportunity is calculated automatically based on the products entered or entered manually by a user.

Display Name: Revenue

Default Options
Value Label
1 System Calculated
0 User Provided
lastonholdtime Edm.DateTimeOffset

Contains the date time stamp of the last on hold time.

Display Name: Last On Hold Time

modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
msdyn_ordertype Edm.Int32

Internal use only.

Display Name: Order Type

Default Options
Value Label
192350001 Work based
192350000 Item based
690970002 Service-Maintenance Based
name Edm.String

Type a subject or descriptive name, such as the expected order or company name, for the opportunity.

Display Name: Topic

need Edm.Int32

Choose how high the level of need is for the lead's company.

Display Name: Need

Default Options
Value Label
0 Must have
1 Should have
2 Good to have
3 No need
onholdtime Edm.Int32

Shows the duration in minutes for which the opportunity was on hold.

Display Name: On Hold Time (Minutes)

Read Only
opportunityid Edm.Guid

Unique identifier of the opportunity.

Display Name: Opportunity

opportunityratingcode Edm.Int32

Select the expected value or priority of the opportunity based on revenue, customer status, or closing probability.

Display Name: Rating

Default Options
Value Label
1 Hot
2 Warm
3 Cold
overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

participatesinworkflow Edm.Boolean

Information about whether the opportunity participates in workflow rules.

Display Name: Participates in Workflow

Default Options
Value Label
1 Yes
0 No
presentfinalproposal Edm.Boolean

Select whether the final proposal has been presented to the account.

Display Name: Present Final Proposal

Default Options
Value Label
1 completed
0 mark complete
presentproposal Edm.Boolean

Select whether a proposal for the opportunity has been presented to the account.

Display Name: Presented Proposal

Default Options
Value Label
1 completed
0 mark complete
pricingerrorcode Edm.Int32

Pricing error for the opportunity.

Display Name: Pricing Error

Default Options
Value Label
0 None
1 Detail Error
2 Missing Price Level
3 Inactive Price Level
4 Missing Quantity
5 Missing Unit Price
6 Missing Product
7 Invalid Product
8 Missing Pricing Code
9 Invalid Pricing Code
10 Missing UOM
11 Product Not In Price Level
12 Missing Price Level Amount
13 Missing Price Level Percentage
14 Missing Price
15 Missing Current Cost
16 Missing Standard Cost
17 Invalid Price Level Amount
18 Invalid Price Level Percentage
19 Invalid Price
20 Invalid Current Cost
21 Invalid Standard Cost
22 Invalid Rounding Policy
23 Invalid Rounding Option
24 Invalid Rounding Amount
25 Price Calculation Error
26 Invalid Discount Type
27 Discount Type Invalid State
28 Invalid Discount
29 Invalid Quantity
30 Invalid Pricing Precision
31 Missing Product Default UOM
32 Missing Product UOM Schedule
33 Inactive Discount Type
34 Invalid Price Level Currency
35 Price Attribute Out Of Range
36 Base Currency Attribute Overflow
37 Base Currency Attribute Underflow
prioritycode Edm.Int32

Select the priority so that preferred customers or critical issues are handled quickly.

Display Name: Priority

Default Options
Value Label
1 Default Value
processid Edm.Guid

Contains the id of the process associated with the entity.

Display Name: Process Id

proposedsolution Edm.String

Type notes about the proposed solution for the opportunity.

Display Name: Proposed Solution

purchaseprocess Edm.Int32

Choose whether an individual or a committee will be involved in the purchase process for the lead.

Display Name: Purchase Process

Default Options
Value Label
0 Individual
1 Committee
2 Unknown
purchasetimeframe Edm.Int32

Choose how long the lead will likely take to make the purchase.

Display Name: Purchase Timeframe

Default Options
Value Label
0 Immediate
1 This Quarter
2 Next Quarter
3 This Year
4 Unknown
pursuitdecision Edm.Boolean

Select whether the decision about pursuing the opportunity has been made.

Display Name: Decide Go/No-Go

Default Options
Value Label
1 No
0 Yes
qualificationcomments Edm.String

Type comments about the qualification or scoring of the lead.

Display Name: Qualification Comments

quotecomments Edm.String

Type comments about the quotes associated with the opportunity.

Display Name: Quote Comments

resolvefeedback Edm.Boolean

Choose whether the proposal feedback has been captured and resolved for the opportunity.

Display Name: Feedback Resolved

Default Options
Value Label
1 No
0 Yes
salesstage Edm.Int32

Select the sales stage of this opportunity to aid the sales team in their efforts to win this opportunity.

Display Name: Sales Stage

Default Options
Value Label
0 Qualify
1 Develop
2 Propose
3 Close
salesstagecode Edm.Int32

Select the sales process stage for the opportunity to indicate the probability of closing the opportunity.

Display Name: Process Code

Default Options
Value Label
1 Default Value
schedulefollowup_prospect Edm.DateTimeOffset

Enter the date and time of the prospecting follow-up meeting with the lead.

Display Name: Scheduled Follow up (Prospect)

schedulefollowup_qualify Edm.DateTimeOffset

Enter the date and time of the qualifying follow-up meeting with the lead.

Display Name: Scheduled Follow up (Qualify)

scheduleproposalmeeting Edm.DateTimeOffset

Enter the date and time of the proposal meeting for the opportunity.

Display Name: Schedule Proposal Meeting

sendthankyounote Edm.Boolean

Select whether a thank you note has been sent to the account for considering the proposal.

Display Name: Send Thank You Note

Default Options
Value Label
1 completed
0 mark complete
stageid Edm.Guid

Contains the id of the stage where the entity is located.

Display Name: Stage Id

statecode Edm.Int32

Shows whether the opportunity is open, won, or lost. Won and lost opportunities are read-only and can't be edited until they are reactivated.

Display Name: Status

Default Options
Value Label
0 Open
1 Won
2 Lost
statuscode Edm.Int32

Select the opportunity's status.

Display Name: Status Reason

Default Options
Value Label
1 In Progress
2 On Hold
3 Won
4 Canceled
5 Out-Sold
stepid Edm.Guid

Shows the ID of the workflow step.

Display Name: Step

stepname Edm.String

Shows the current phase in the sales pipeline for the opportunity. This is updated by a workflow.

Display Name: Pipeline Phase

timeline Edm.Int32

Select when the opportunity is likely to be closed.

Display Name: Timeline

Default Options
Value Label
0 Immediate
1 This Quarter
2 Next Quarter
3 This Year
4 Not known
timespentbymeonemailandmeetings Edm.String

Total time spent for emails (read and write) and meetings by me in relation to the opportunity record.

Display Name: Time Spent by me

Read Only
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

totalamount Edm.Decimal

Shows the total amount due, calculated as the sum of the products, discounts, freight, and taxes for the opportunity.

Display Name: Total Amount

totalamount_base Edm.Decimal

Value of the Total Amount in base currency.

Display Name: Total Amount (Base)

Read Only
totalamountlessfreight Edm.Decimal

Shows the total product amount for the opportunity, minus any discounts. This value is added to freight and tax amounts in the calculation for the total amount of the opportunity.

Display Name: Total Pre-Freight Amount

totalamountlessfreight_base Edm.Decimal

Value of the Total Pre-Freight Amount in base currency.

Display Name: Total Pre-Freight Amount (Base)

Read Only
totaldiscountamount Edm.Decimal

Shows the total discount amount, based on the discount price and rate entered on the opportunity.

Display Name: Total Discount Amount

totaldiscountamount_base Edm.Decimal

Value of the Total Discount Amount in base currency.

Display Name: Total Discount Amount (Base)

Read Only
totallineitemamount Edm.Decimal

Shows the sum of all existing and write-in products included on the opportunity, based on the specified price list and quantities.

Display Name: Total Detail Amount

totallineitemamount_base Edm.Decimal

Value of the Total Detail Amount in base currency.

Display Name: Total Detail Amount (Base)

Read Only
totallineitemdiscountamount Edm.Decimal

Shows the total of the Manual Discount amounts specified on all products included in the opportunity. This value is reflected in the Total Detail Amount field on the opportunity and is added to any discount amount or rate specified on the opportunity.

Display Name: Total Line Item Discount Amount

totallineitemdiscountamount_base Edm.Decimal

Value of the Total Line Item Discount Amount in base currency.

Display Name: Total Line Item Discount Amount (Base)

Read Only
totaltax Edm.Decimal

Shows the total of the Tax amounts specified on all products included in the opportunity, included in the Total Amount field calculation for the opportunity.

Display Name: Total Tax

totaltax_base Edm.Decimal

Value of the Total Tax in base currency.

Display Name: Total Tax (Base)

Read Only
traversedpath Edm.String

A comma separated list of string values representing the unique identifiers of stages in a Business Process Flow Instance in the order that they occur.

Display Name: Traversed Path

utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version Number

Display Name: Version Number

Read Only

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Retrieve data about lookup properties.

Name Single-valued navigation property Description
_accountid_value

Unique identifier of the account with which the opportunity is associated.

_campaignid_value campaignid

Shows the campaign that the opportunity was created from. The ID is used for tracking the success of the campaign.

_contactid_value

Unique identifier of the contact associated with the opportunity.

_createdby_value createdby

Shows who created the record.

_createdonbehalfby_value createdonbehalfby

Shows who created the record on behalf of another user.

_customerid_value customerid_accountcustomerid_contact

Select the customer account or contact to provide a quick link to additional customer details, such as address, phone number, activities, and orders.

_modifiedby_value modifiedby

Shows who last updated the record.

_modifiedonbehalfby_value modifiedonbehalfby

Shows who last updated the record on behalf of another user.

_msdyn_accountmanagerid_value msdyn_AccountManagerId

The account manager responsible for the opportunity.

_msdyn_contractorganizationalunitid_value msdyn_ContractOrganizationalUnitId

The organizational unit in charge of the opportunity.

_msdyn_workordertype_value msdyn_workordertype

Unique identifier for Work Order Type associated with Opportunity.

_originatingleadid_value originatingleadid

Choose the lead that the opportunity was created from for reporting and analytics. The field is read-only after the opportunity is created and defaults to the correct lead when an opportunity is created from a converted lead.

_ownerid_value ownerid

Owner Id

_owningbusinessunit_value owningbusinessunit

Unique identifier for the business unit that owns the record

_owningteam_value owningteam

Unique identifier for the team that owns the record.

_owninguser_value owninguser

Unique identifier for the user that owns the record.

_parentaccountid_value parentaccountid

Choose an account to connect this opportunity to, so that the relationship is visible in reports and analytics, and to provide a quick link to additional details, such as financial information and activities.

_parentcontactid_value parentcontactid

Choose a contact to connect this opportunity to, so that the relationship is visible in reports and analytics.

_pricelevelid_value pricelevelid

Choose the price list associated with this record to make sure the products associated with the campaign are offered at the correct prices.

_slaid_value sla_opportunity_sla

Choose the service level agreement (SLA) that you want to apply to the opportunity record.

_slainvokedid_value slainvokedid_opportunity_sla

Last SLA that was applied to this opportunity. This field is for internal use only.

_transactioncurrencyid_value transactioncurrencyid

Choose the local currency for the record to make sure budgets are reported in the correct currency.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
campaignid campaign campaign_opportunities
createdby systemuser lk_opportunitybase_createdby
createdonbehalfby systemuser lk_opportunity_createdonbehalfby
customerid_account account opportunity_customer_accounts
customerid_contact contact opportunity_customer_contacts
modifiedby systemuser lk_opportunitybase_modifiedby
modifiedonbehalfby systemuser lk_opportunity_modifiedonbehalfby
msdyn_AccountManagerId systemuser msdyn_accountmanager_opportunity
msdyn_ContractOrganizationalUnitId msdyn_organizationalunit msdyn_organizationalunit_opportunity
msdyn_workordertype msdyn_workordertype msdyn_msdyn_workordertype_opportunity_WorkOrderType
originatingleadid lead opportunity_originating_lead
ownerid principal owner_opportunitys
owningbusinessunit businessunit business_unit_opportunities
owningteam team team_opportunities
owninguser systemuser opportunity_owning_user
parentaccountid account opportunity_parent_account
parentcontactid contact opportunity_parent_contact
pricelevelid pricelevel price_level_opportunties
sla_opportunity_sla sla manualsla_opportunity
slainvokedid_opportunity_sla sla sla_opportunity
stageid_processstage processstage processstage_opportunity
transactioncurrencyid transactioncurrency transactioncurrency_opportunity

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
CreatedOpportunity_BulkOperationLogs bulkoperationlog createdobjectid_opportunity
lead_qualifying_opportunity lead qualifyingopportunityid
msdyn_opportunity_msdyn_opportunitypricelist_Opportunity msdyn_opportunitypricelist msdyn_Opportunity
msdyn_opportunity_msdyn_workorder msdyn_workorder msdyn_opportunityid
opportunity_actioncard actioncard regardingobjectid_opportunity_actioncard
opportunity_activity_parties activityparty partyid_opportunity
Opportunity_ActivityPointers activitypointer regardingobjectid_opportunity
Opportunity_Annotation annotation objectid_opportunity
Opportunity_Appointments appointment regardingobjectid_opportunity_appointment
Opportunity_AsyncOperations asyncoperation regardingobjectid_opportunity
Opportunity_BulkDeleteFailures bulkdeletefailure regardingobjectid_opportunity
opportunity_connections1 connection record1id_opportunity
opportunity_connections2 connection record2id_opportunity
Opportunity_DuplicateBaseRecord duplicaterecord baserecordid_opportunity
Opportunity_DuplicateMatchingRecord duplicaterecord duplicaterecordid_opportunity
Opportunity_Emails email regardingobjectid_opportunity_email
Opportunity_Faxes fax regardingobjectid_opportunity_fax
opportunity_invoices invoice opportunityid
opportunity_leadtoopportunitysalesprocess leadtoopportunitysalesprocess opportunityId
Opportunity_Letters letter regardingobjectid_opportunity_letter
Opportunity_MailboxTrackingFolder mailboxtrackingfolder regardingobjectid_opportunity
opportunity_msdyn_approvals msdyn_approval regardingobjectid_opportunity_msdyn_approval
opportunity_msdyn_bookingalerts msdyn_bookingalert regardingobjectid_opportunity_msdyn_bookingalert
Opportunity_OpportunityClose opportunityclose opportunityid
opportunity_OpportunityCloses opportunityclose regardingobjectid_opportunity_opportunityclose
opportunity_opportunitysalesprocess opportunitysalesprocess opportunityid
opportunity_OrderCloses orderclose regardingobjectid_opportunity_orderclose
Opportunity_Phonecalls phonecall regardingobjectid_opportunity_phonecall
opportunity_PostFollows postfollow regardingobjectid_opportunity
opportunity_PostRegardings postregarding regardingobjectid_opportunity
opportunity_principalobjectattributeaccess principalobjectattributeaccess objectid_opportunity
Opportunity_ProcessSessions processsession regardingobjectid_opportunity
opportunity_QuoteCloses quoteclose regardingobjectid_opportunity_quoteclose
opportunity_quotes quote opportunityid
Opportunity_RecurringAppointmentMasters recurringappointmentmaster regardingobjectid_opportunity_recurringappointmentmaster
opportunity_sales_orders salesorder opportunityid
Opportunity_ServiceAppointments serviceappointment regardingobjectid_opportunity_serviceappointment
Opportunity_SharepointDocumentLocation sharepointdocumentlocation regardingobjectid_opportunity
Opportunity_SocialActivities socialactivity regardingobjectid_opportunity_socialactivity
Opportunity_SyncErrors syncerror regardingobjectid_opportunity_syncerror
Opportunity_Tasks task regardingobjectid_opportunity_task
opportunity_Teams team regardingobjectid_opportunity
opportunitycompetitors_association competitor opportunitycompetitors_association
product_opportunities opportunityproduct opportunityid
slakpiinstance_opportunity slakpiinstance regarding_opportunity

Operations

The following operations can be used with the opportunity entity type.

Name Binding
CalculateActualValueOpportunity Entity
CalculatePrice Not Bound
GetQuantityDecimal Entity
GrantAccess Not Bound
IsValidStateTransition Not Bound
LoseOpportunity Not Bound
ModifyAccess Not Bound
msdyn_CloseAllOpportunityQuotes Entity
msdyn_CreateQuoteFromOpportunity Entity
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound
Rollup Not Bound
WinOpportunity Not Bound
WinQuote Not Bound

Solutions

The following solutions include the opportunity entity type.

Name Description
App for Outlook
Field Service Microsoft Dynamics 365 for Field Service allows organizations of any size to deliver intelligent, world class field service, managing all aspects of the end-to-end field service management cycle. Features include scheduling, mobile, asset management, inventory control, customer notifications, and resource utilization controls that help maximize efficiency and minimize costs.
CRM Extensions For internal use only.
Marketing Sales For internal use only.
Sales Dynamics 365 workload for sales.
Project Service Automation Microsoft Dynamics 365 for Project Service Automation is an end-to-end solution that helps sales and delivery teams engage customers and deliver billable projects on time and within budget. Project Service gives you the tools you need to: Estimate, quote, and contract work; Plan and assign resources; Enable team collaboration; Capture time, expense, and progress data for real-time insights and accurate invoicing.

See Also