opportunityproduct EntityType

Association between an opportunity and a product.

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

Properties

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

Name Type Details
baseamount Edm.Decimal

Shows the total price of the opportunity product, based on the price per unit, volume discount, and quantity.

Display Name: Amount

baseamount_base Edm.Decimal

Value of the Amount in base currency.

Display Name: Amount (Base)

Read Only
createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
description Edm.String

Type additional information to describe the opportunity product, such as manufacturing details.

Display Name: Description

entityimage Edm.Binary

The default image for the entity.

Display Name: Entity Image

entityimage_timestamp Edm.Int64
Read Only
entityimage_url Edm.String
Read Only
entityimageid Edm.Guid
Read Only
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
extendedamount Edm.Decimal

Shows the total amount due for the opportunity product, calculated on the Amount value minus the Manual Discount amount.

Display Name: Extended Amount

extendedamount_base Edm.Decimal

Value of the Extended Amount in base currency.

Display Name: Extended Amount (Base)

Read Only
importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

ispriceoverridden Edm.Boolean

Select whether the pricing on the opportunity product reflects an override of the product catalog pricing.

Display Name: Price Overridden

Default Options
Value Label
1 Override Price
0 Use Default
isproductoverridden Edm.Boolean

For system use only.

Display Name: Select Product

Default Options
Value Label
1 Write-In
0 Existing
lineitemnumber Edm.Int32

Type the line item number for the opportunity product to easily identify the product in the opportunity documents and make sure it's listed in the correct order.

Display Name: Line Item Number

manualdiscountamount Edm.Decimal

Type the manual discount amount for the opportunity product to deduct any negotiated or other savings from the product total.

Display Name: Manual Discount Amount

manualdiscountamount_base Edm.Decimal

Value of the Manual Discount Amount in base currency.

Display Name: Manual Discount Amount (Base)

Read Only
modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
msdyn_billingmethod Edm.Int32

Billing method for the project opportunity line. Valid values are Time and Material and Fixed Price

Display Name: Billing Method

Default Options
Value Label
192350000 Time and Material
192350001 Fixed Price
msdyn_budgetamount Edm.Decimal

Enter the customer budget amount for this opportunity line.

Display Name: Budget Amount

msdyn_budgetamount_base Edm.Decimal

Value of the Budget Amount in base currency.

Display Name: Budget Amount (Base)

Read Only
msdyn_costamount Edm.Decimal

Shows the total cost price of the product based on the cost price per unit and quantity.

Display Name: Cost Amount

msdyn_costamount_base Edm.Decimal

Value of the Cost Amount in base currency.

Display Name: Cost Amount (Base)

Read Only
msdyn_costpriceperunit Edm.Decimal

Cost price per unit of the product. The default is the cost price of the product.

Display Name: Cost Price Per Unit

msdyn_costpriceperunit_base Edm.Decimal

Value of the Cost Price Per Unit in base currency.

Display Name: Cost Price Per Unit (Base)

Read Only
msdyn_duration Edm.Int32

Enter the duration of the agreement

Display Name: Duration

msdyn_enddate Edm.DateTimeOffset

Enter the end date of the agreement

Display Name: End Date

msdyn_linetype Edm.Int32

The field to distinguish the order lines to be of project service or field service

Display Name: Line Type

Default Options
Value Label
690970000 Project Service Line
690970001 Field Service Line
msdyn_startdate Edm.DateTimeOffset

Start date of the Agreement

Display Name: Start Date

opportunityproductid Edm.Guid

Unique identifier of the opportunity product.

Display Name: Opportunity Product

opportunitystatecode Edm.Int32

Select the status of the opportunity product.

Display Name: Opportunity Status

Read Only
overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

parentbundleid Edm.Guid

Choose the parent bundle associated with this product

Display Name: Parent Bundle

priceperunit Edm.Decimal

Shows the price per unit of the opportunity product, based on the price list specified on the parent opportunity.

Display Name: Price Per Unit

priceperunit_base Edm.Decimal

Value of the Price Per Unit in base currency.

Display Name: Price Per Unit (Base)

Read Only
pricingerrorcode Edm.Int32

Select the pricing error for the opportunity product.

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
productassociationid Edm.Guid

Unique identifier of the product line item association with bundle in the opportunity

Display Name: Bundle Item Association

productdescription Edm.String

Type a detailed product description or additional notes about the opportunity product, such as talking points or product updates, that will assist the sales team when they discuss the product with the customer.

Display Name: Write-In Product

productname Edm.String

Calculated field that will be populated by name and description of the product.

Display Name: Product Name

producttypecode Edm.Int32

Product Type

Display Name: Product type

Default Options
Value Label
1 Product
2 Bundle
3 Required Bundle Product
4 Optional Bundle Product
5 Project-based Service
propertyconfigurationstatus Edm.Int32

Status of the property configuration.

Display Name: Property Configuration

Default Options
Value Label
0 Edit
1 Rectify
2 Not Configured
quantity Edm.Decimal

Type the amount or quantity of the product the customer would like to purchase.

Display Name: Quantity

sequencenumber Edm.Int32

Shows the ID of the data that maintains the sequence.

Display Name: Sequence Number

tax Edm.Decimal

Type the tax amount to be applied on the opportunity product.

Display Name: Tax

tax_base Edm.Decimal

Value of the Tax in base currency.

Display Name: Tax (Base)

Read Only
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

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
volumediscountamount Edm.Decimal

Shows the discount amount per unit if a specified volume is purchased. Configure volume discounts in the Product Catalog in the Settings area.

Display Name: Volume Discount

Read Only
volumediscountamount_base Edm.Decimal

Value of the Volume Discount in base currency.

Display Name: Volume Discount (Base)

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
_createdby_value createdby

Shows who created the record.

_createdonbehalfby_value createdonbehalfby

Shows who created the record on behalf of another user.

_modifiedby_value modifiedby

Shows who last updated the record.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who last modified the opportunityproduct.

_msdyn_pricelist_value msdyn_pricelist

Select a price list for the opportunity line

_msdyn_project_value msdyn_Project

Select the project for this opportunity line.

_msdyn_serviceaccount_value msdyn_serviceaccount

Select the service account for the opportunity line

_opportunityid_value opportunityid

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

_ownerid_value createdby

Owner Id

_owningbusinessunit_value createdby

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.

_productid_value productid

Choose the product to include on the opportunity to link the product's pricing and other information to the opportunity.

_transactioncurrencyid_value transactioncurrencyid

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

_uomid_value uomid

Choose the unit of measurement for the base unit quantity for this purchase, such as each or dozen.

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
createdby systemuser lk_opportunityproductbase_createdby
createdonbehalfby systemuser lk_opportunityproduct_createdonbehalfby
modifiedby systemuser lk_opportunityproductbase_modifiedby
modifiedonbehalfby systemuser lk_opportunityproduct_modifiedonbehalfby
msdyn_pricelist pricelevel msdyn_pricelevel_opportunityproduct_PriceList
msdyn_Project msdyn_project msdyn_msdyn_project_opportunityproduct_Project
msdyn_serviceaccount account msdyn_account_opportunityproduct_ServiceAccount
opportunityid opportunity product_opportunities
owningteam team team_opportunityproduct
owninguser systemuser user_opportunityproduct
parentbundleid_opportunityproduct opportunityproduct opportunityproduct_parent_opportunityproduct
productassociationid_productassociation productassociation productAssociation_opportunity_product
productid product opportunity_products
transactioncurrencyid transactioncurrency transactioncurrency_opportunityproduct
uomid uom unit_of_measurement_opportunity_products

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
OpportunityProduct_AsyncOperations asyncoperation regardingobjectid_opportunityproduct
OpportunityProduct_BulkDeleteFailures bulkdeletefailure regardingobjectid_opportunityproduct
OpportunityProduct_Dynamicpropertyinstance dynamicpropertyinstance regardingobjectid_opportunityproduct
opportunityproduct_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_opportunityproduct
opportunityproduct_parent_opportunityproduct opportunityproduct parentbundleid_opportunityproduct
opportunityproduct_principalobjectattributeaccess principalobjectattributeaccess objectid_opportunityproduct
OpportunityProduct_ProcessSessions processsession regardingobjectid_opportunityproduct
OpportunityProduct_SyncErrors syncerror regardingobjectid_opportunityproduct_syncerror

Operations

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

Name Binding
CalculatePrice Not Bound
RetrieveProductProperties Entity

Solutions

The following solutions include the opportunityproduct entity type.

Name Description
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.
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