Share via


salesorderdetail EntityType

 

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

Description: Line item in a sales order.

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

Base Type: crmbaseentity EntityType

Display Name: Order Product

Primary Key: salesorderdetailid

Primary Name Attribute: productidname

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Operations bound to salesorderdetail

Operations using the salesorderdetail 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 order 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 order product, such as manufacturing details or acceptable substitutions.

Display Name: Description

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 order product, based on the sum of the unit price, quantity, discounts, and tax.

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

iscopied

Edm.Boolean

Description: Select whether the invoice line item is copied from another item or data source.

Default Options:

1 : Yes
0 : No

Display Name: Copied

ispriceoverridden

Edm.Boolean

Description: Select whether the price per unit is fixed at the value in the specified price list or can be overridden by users who have edit rights to the order product.

Default Options:

1 : Override Price
0 : Use Default

Display Name: Pricing

isproductoverridden

Edm.Boolean

Description: Select whether the product exists in the Microsoft Dynamics 365 product catalog or is a write-in product specific to the order.

Default Options:

1 : Write In
0 : Existing

Display Name: Select Product

lineitemnumber

Edm.Int32

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

Display Name: Line Item Number

manualdiscountamount

Edm.Decimal

Description: Type the manual discount amount for the order product to deduct any negotiated or other savings from the product total on the order.

Display Name: Manual Discount

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 (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

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 order product.

Display Name: Owning Business Unit

Read-only property

owninguser

Edm.Guid

Description: Unique identifier of the user who owns the order 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: Type the price per unit of the order product. The default is the value in the price list specified on the order for existing products.

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 type of pricing error, such as a missing or invalid product, or missing quantity.

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 sales order

Display Name: Bundle Item Association

productdescription

Edm.String

Description: Type a name or description to identify the type of write-in product included in the order.

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 ordered by the customer.

Display Name: Quantity

quantitybackordered

Edm.Decimal

Description: Type the amount or quantity of the product that is back ordered for the order.

Display Name: Quantity Back Ordered

quantitycancelled

Edm.Decimal

Description: Type the amount or quantity of the product that was canceled.

Display Name: Quantity Canceled

quantityshipped

Edm.Decimal

Description: Type the amount or quantity of the product that was shipped for the order.

Display Name: Quantity Shipped

requestdeliveryby

Edm.DateTimeOffset

Description: Enter the delivery date requested by the customer for the order product.

Display Name: Requested Delivery Date

salesorderdetailid

Edm.Guid

Description: Unique identifier of the product specified in the order.

Display Name: Order Product

salesorderispricelocked

Edm.Boolean

Description: Tells whether product pricing is locked for the order.

Default Options:

1 : Yes
0 : No

Display Name: Order Is Price Locked

Read-only property

salesorderstatecode

Edm.Int32

Description: Shows the status of the order that the order detail is associated with.

Default Options:

0 : Active
1 : Submitted
2 : Canceled
3 : Fulfilled
4 : Invoiced

Display Name: Order Status

Read-only property

sequencenumber

Edm.Int32

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

Display Name: Sequence Number

shipto_addressid

Edm.Guid

Description: Unique identifier of the shipping address.

Display Name: Ship To Address ID

shipto_city

Edm.String

Description: Type the city for the customer's shipping address.

Display Name: Ship To City

shipto_contactname

Edm.String

Description: Type the primary contact name at the customer's shipping address.

Display Name: Ship To Contact Name

shipto_country

Edm.String

Description: Type the country or region for the customer's shipping address.

Display Name: Ship To Country/Region

shipto_fax

Edm.String

Description: Type the fax number for the customer's shipping address.

Display Name: Ship To Fax

shipto_freighttermscode

Edm.Int32

Description: Select the freight terms to make sure shipping orders are processed correctly.

Default Options:

1 : FOB
2 : No Charge

Display Name: Freight Terms

shipto_line1

Edm.String

Description: Type the first line of the customer's shipping address.

Display Name: Ship To Street 1

shipto_line2

Edm.String

Description: Type the second line of the customer's shipping address.

Display Name: Ship To Street 2

shipto_line3

Edm.String

Description: Type the third line of the shipping address.

Display Name: Ship To Street 3

shipto_name

Edm.String

Description: Type a name for the customer's shipping address, such as "Headquarters" or "Field office", to identify the address.

Display Name: Ship To Name

shipto_postalcode

Edm.String

Description: Type the ZIP Code or postal code for the shipping address.

Display Name: Ship To ZIP/Postal Code

shipto_stateorprovince

Edm.String

Description: Type the state or province for the shipping address.

Display Name: Ship To State/Province

shipto_telephone

Edm.String

Description: Type the phone number for the customer's shipping address.

Display Name: Ship To Phone

tax

Edm.Decimal

Description: Type the tax amount for the order 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 sales order detail.

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

willcall

Edm.Boolean

Description: Select whether the order product should be shipped to the specified address or held until the customer calls with further pick up or delivery instructions.

Default Options:

1 : Will Call
0 : Address

Display Name: Ship To

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

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

_ownerid_value

Enter the user or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user.

_productid_value

productid

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

_salesorderid_value

salesorderid

Shows the order for the product. The ID is used to link product pricing and other details to the total amounts and other information on the order.

_salesrepid_value

salesrepid

Choose the user responsible for the sale of the order product.

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

createdonbehalfby

systemuser EntityType

lk_salesorderdetail_createdonbehalfby

modifiedby

systemuser EntityType

lk_salesorderdetailbase_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_salesorderdetail_modifiedonbehalfby

parentbundleid_salesorderdetail

salesorderdetail EntityType

salesorderdetail_parent_salesorderdetail

productassociationid_productassociation

productassociation EntityType

productAssociation_salesorder_details

productid

product EntityType

product_order_details

salesorderid

salesorder EntityType

order_details

salesrepid

systemuser EntityType

system_user_salesorderdetail

transactioncurrencyid

transactioncurrency EntityType

transactioncurrency_salesorderdetail

uomid

uom EntityType

unit_of_measurement_order_details

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

SalesOrderDetail_AsyncOperations

asyncoperation EntityType

regardingobjectid_salesorderdetail

SalesOrderDetail_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_salesorderdetail

SalesOrderDetail_Dynamicpropertyinstance

dynamicpropertyinstance EntityType

regardingobjectid_salesorderdetail

salesorderdetail_parent_salesorderdetail

salesorderdetail EntityType

parentbundleid_salesorderdetail

SalesOrderDetail_SyncErrors

syncerror EntityType

regardingobjectid_salesorderdetail_syncerror

Operations bound to salesorderdetail

The following operations are bound to the salesorderdetail entity type.

Name

Bound to

RetrieveProductProperties Function

Entity

Operations using the salesorderdetail entity type.

The following operations use the salesorderdetail 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