opportunityproduct EntityType

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Description: Association between an opportunity and a product.

Entity Set path:[organization URI]/api/data/v8.2/opportunityproducts

Base Type: crmbaseentity EntityType

Display Name: Opportunity Product

Primary Key: opportunityproductid

Primary Name Attribute: productidname

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Operations bound to opportunityproduct

Operations using the opportunityproduct entity type.

Properties

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

Name

Type

Details

baseamount

Edm.Decimal

Description: 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

Description: Shows the Amount field converted to the system's default base currency. The calculation uses the exchange rate specified in the Currencies area.

Display Name: Amount (Base)

Read-only property

createdon

Edm.DateTimeOffset

Description: Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.

Display Name: Created On

Read-only property

description

Edm.String

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

Display Name: Description

entityimage

Edm.Binary

Description: The default image for the entity.

Display Name: Entity Image

entityimage_timestamp

Edm.Int64

Description:

Read-only property

entityimage_url

Edm.String

Description:

Read-only property

entityimageid

Edm.Guid

Description: For internal use only.

Display Name: Entity Image Id

Read-only property

exchangerate

Edm.Decimal

Description: 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 property

extendedamount

Edm.Decimal

Description: 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

Description: Shows the Extended Amount field converted to the system's default base currency. The calculation uses the exchange rate specified in the Currencies area.

Display Name: Extended Amount (Base)

Read-only property

importsequencenumber

Edm.Int32

Description: Unique identifier of the data import or data migration that created this record.

Display Name: Import Sequence Number

ispriceoverridden

Edm.Boolean

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

Default Options:

1 : Override Price
0 : Use Default

Display Name: Price Overridden

isproductoverridden

Edm.Boolean

Description: For system use only.

Default Options:

1 : Write-In
0 : Existing

Display Name: Select Product

lineitemnumber

Edm.Int32

Description: 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

Description: 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

Description: Shows the Manual Discount field converted to the system's default base currency for reporting purposes. The calculation uses the exchange rate specified in the Currencies area.

Display Name: Manual Discount Amount (Base)

Read-only property

modifiedon

Edm.DateTimeOffset

Description: Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.

Display Name: Modified On

Read-only property

opportunityproductid

Edm.Guid

Description: Unique identifier of the opportunity product.

Display Name: Opportunity Product

opportunitystatecode

Edm.Int32

Description: Select the status of the opportunity product.

Default Options:

0 : Open
1 : Won
2 : Lost

Display Name: Opportunity Status

Read-only property

overriddencreatedon

Edm.DateTimeOffset

Description: Date and time that the record was migrated.

Display Name: Record Created On

owningbusinessunit

Edm.Guid

Description: Unique identifier of the business unit that owns the opportunity product.

Display Name: Owning Business Unit

Read-only property

owninguser

Edm.Guid

Description: Unique identifier of the user who owns the opportunity product.

Display Name: Owning User

Read-only property

parentbundleid

Edm.Guid

Description: Choose the parent bundle associated with this product

Display Name: Parent Bundle

priceperunit

Edm.Decimal

Description: 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

Description: Shows the Price Per Unit field converted to the system's default base currency for reporting purposes. The calculation uses the exchange rate specified in the Currencies area.

Display Name: Price Per Unit (Base)

Read-only property

pricingerrorcode

Edm.Int32

Description: Select the pricing error for the opportunity product.

Default Options:

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

Display Name: Pricing Error

productassociationid

Edm.Guid

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

Display Name: Bundle Item Association

productdescription

Edm.String

Description: 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

producttypecode

Edm.Int32

Description: Product Type

Default Options:

1 : Product
2 : Bundle
3 : Required Bundle Product
4 : Optional Bundle Product
5 : Project-based Service

Display Name: Product type

propertyconfigurationstatus

Edm.Int32

Description: Status of the property configuration.

Default Options:

0 : Edit
1 : Rectify
2 : NotConfigured

Display Name: Property Configuration

quantity

Edm.Decimal

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

Display Name: Quantity

sequencenumber

Edm.Int32

Description: Shows the ID of the data that maintains the sequence.

Display Name: Sequence Number

tax

Edm.Decimal

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

Display Name: Tax

tax_base

Edm.Decimal

Description: Shows the Tax field converted to the system's default base currency for reporting purposes. The calculation uses the exchange rate specified in the Currencies area.

Display Name: Tax (Base)

Read-only property

timezoneruleversionnumber

Edm.Int32

Description: For internal use only.

Display Name: Time Zone Rule Version Number

utcconversiontimezonecode

Edm.Int32

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

Display Name: UTC Conversion Time Zone Code

versionnumber

Edm.Int64

Description: Version number of the opportunity product.

Display Name: Version Number

Read-only property

volumediscountamount

Edm.Decimal

Description: 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 property

volumediscountamount_base

Edm.Decimal

Description: Shows the Volume Discount field converted to the system's default base currency for reporting purposes. The calculation uses the exchange rate specified in the Currencies area.

Display Name: Volume Discount (Base)

Read-only property

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.

_opportunityid_value

opportunityid

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

_ownerid_value

Unique identifier of the user or team who owns the opportunity product.

_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 EntityType

lk_opportunityproductbase_createdby

createdonbehalfby

systemuser EntityType

lk_opportunityproduct_createdonbehalfby

modifiedby

systemuser EntityType

lk_opportunityproductbase_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_opportunityproduct_modifiedonbehalfby

opportunityid

opportunity EntityType

product_opportunities

parentbundleid_opportunityproduct

opportunityproduct EntityType

opportunityproduct_parent_opportunityproduct

productassociationid_productassociation

productassociation EntityType

productAssociation_opportunity_product

productid

product EntityType

opportunity_products

transactioncurrencyid

transactioncurrency EntityType

transactioncurrency_opportunityproduct

uomid

uom EntityType

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 EntityType

regardingobjectid_opportunityproduct

OpportunityProduct_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_opportunityproduct

OpportunityProduct_Dynamicpropertyinstance

dynamicpropertyinstance EntityType

regardingobjectid_opportunityproduct

opportunityproduct_parent_opportunityproduct

opportunityproduct EntityType

parentbundleid_opportunityproduct

OpportunityProduct_SyncErrors

syncerror EntityType

regardingobjectid_opportunityproduct_syncerror

Operations bound to opportunityproduct

The following operations are bound to the opportunityproduct entity type.

Name

Bound to

RetrieveProductProperties Function

Entity

Operations using the opportunityproduct entity type.

The following operations use the opportunityproduct entity type in a parameter or return type.

Name

How used

Description

RetrieveProductProperties Function

entity Parameter

Retrieve all the property instances (dynamic property instances) for a product added to an opportunity, quote, order, or invoice.

See Also

Use the Microsoft Dynamics 365 Web API
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright