salesorder EntityType
Description: Quote that has been accepted.
Entity Set path: [organization URI]/api/data/v8.0/salesorders
Base Type: crmbaseentity EntityType
Display Name: Order
Primary Key: salesorderid
Primary Name Attribute: name
Properties
Single-valued navigation properties
Collection-valued navigation properties
Operations bound to salesorder
Operations using the salesorder entity type.
Properties
Properties represent fields of data stored in the entity. Some properties are not writable.
| Name | Type | Details |
|---|---|---|
_accountid_value |
Edm.Guid |
Description: Shows the parent account related to the record. This information is used to link the sales order to the account selected in the Customer field for reporting and analytics. Computed property Read-only property |
_campaignid_value |
Edm.Guid |
Description: Shows the campaign that the order was created from. Computed property Read-only property |
_contactid_value |
Edm.Guid |
Description: Shows the parent contact related to the record. This information is used to link the contract to the contact selected in the Customer field for reporting and analytics. Computed property Read-only property |
_createdby_value |
Edm.Guid |
Description: Shows who created the record. Computed property Read-only property |
_createdonbehalfby_value |
Edm.Guid |
Description: Shows who created the record on behalf of another user. Computed property Read-only property |
_customerid_value |
Edm.Guid |
Description: Select the customer account or contact to provide a quick link to additional customer details, such as account information, activities, and opportunities. |
_modifiedby_value |
Edm.Guid |
Description: Shows who last updated the record. Computed property Read-only property |
_modifiedonbehalfby_value |
Edm.Guid |
Description: Shows who last updated the record on behalf of another user. Computed property Read-only property |
_opportunityid_value |
Edm.Guid |
Description: Choose the related opportunity so that the data for the order and opportunity are linked for reporting and analytics. Computed property Read-only property |
_ownerid_value |
Edm.Guid |
Description: 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. |
_owningbusinessunit_value |
Edm.Guid |
Description: Shows the business unit that the record owner belongs to. Computed property Read-only property |
_owningteam_value |
Edm.Guid |
Description: Unique identifier of the team who owns the order. Computed property Read-only property |
_owninguser_value |
Edm.Guid |
Description: Unique identifier of the user who owns the order. Computed property Read-only property |
_pricelevelid_value |
Edm.Guid |
Description: Choose the price list associated with this record to make sure the products associated with the campaign are offered at the correct prices. Computed property Read-only property |
_quoteid_value |
Edm.Guid |
Description: Choose the related quote so that order data and quote data are linked for reporting and analytics. Computed property Read-only property |
_transactioncurrencyid_value |
Edm.Guid |
Description: Choose the local currency for the record to make sure budgets are reported in the correct currency. Computed property Read-only property |
billto_addressid |
Edm.Guid |
Description: Unique identifier of the billing address. Display Name: Bill To Address ID |
billto_city |
Edm.String |
Description: Type the city for the customer's billing address. Display Name: Bill To City |
billto_composite |
Edm.String |
Description: Shows the complete Bill To address. Display Name: Bill To Address Read-only property |
billto_contactname |
Edm.String |
Description: Type the primary contact name at the customer's billing address. Display Name: Bill To Contact Name |
billto_country |
Edm.String |
Description: Type the country or region for the customer's billing address. Display Name: Bill To Country/Region |
billto_fax |
Edm.String |
Description: Type the fax number for the customer's billing address. Display Name: Bill To Fax |
billto_line1 |
Edm.String |
Description: Type the first line of the customer's billing address. Display Name: Bill To Street 1 |
billto_line2 |
Edm.String |
Description: Type the second line of the customer's billing address. Display Name: Bill To Street 2 |
billto_line3 |
Edm.String |
Description: Type the third line of the billing address. Display Name: Bill To Street 3 |
billto_name |
Edm.String |
Description: Type a name for the customer's billing address, such as "Headquarters" or "Field office", to identify the address. Display Name: Bill To Name |
billto_postalcode |
Edm.String |
Description: Type the ZIP Code or postal code for the billing address. Display Name: Bill To ZIP/Postal Code |
billto_stateorprovince |
Edm.String |
Description: Type the state or province for the billing address. Display Name: Bill To State/Province |
billto_telephone |
Edm.String |
Description: Type the phone number for the customer's billing address. Display Name: Bill To Phone |
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 CRM options. Display Name: Created On Read-only property |
datefulfilled |
Edm.DateTimeOffset |
Description: Enter the date that all or part of the order was shipped to the customer. Display Name: Date Fulfilled |
description |
Edm.String |
Description: Type additional information to describe the order, such as the products or services offered or details about the customer's product preferences. Display Name: Description |
discountamount |
Edm.Decimal |
Description: Type the discount amount for the order if the customer is eligible for special savings. Display Name: Order Discount Amount |
discountamount_base |
Edm.Decimal |
Description: Shows the Order 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: Order Discount Amount (Base) Read-only property |
discountpercentage |
Edm.Decimal |
Description: Type the discount rate that should be applied to the Detail Amount field to include additional savings for the customer in the order. Display Name: Order Discount (%) |
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 |
freightamount |
Edm.Decimal |
Description: Type the cost of freight or shipping for the products included in the order for use in calculating the Total Amount field. Display Name: Freight Amount |
freightamount_base |
Edm.Decimal |
Description: Shows the Freight Amount 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: Freight Amount (Base) Read-only property |
freighttermscode |
Edm.Int32 |
Description: Select the freight terms to make sure shipping charges are processed correctly. Default Options: 1 : FOB Display Name: Freight Terms |
importsequencenumber |
Edm.Int32 |
Description: Unique identifier of the data import or data migration that created this record. Display Name: Import Sequence Number |
ispricelocked |
Edm.Boolean |
Description: Select whether prices specified on the invoice are locked from any further updates. Default Options: 1 : Yes Display Name: Prices Locked |
lastbackofficesubmit |
Edm.DateTimeOffset |
Description: Enter the date and time when the order was last submitted to an accounting or ERP system for processing. Display Name: Last Submitted to Back Office |
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 CRM options. Display Name: Modified On Read-only property |
name |
Edm.String |
Description: Type a descriptive name for the order. Display Name: Name |
ordernumber |
Edm.String |
Description: Shows the order number for customer reference and to use in search. The number cannot be modified. Display Name: Order ID |
overriddencreatedon |
Edm.DateTimeOffset |
Description: Date and time that the record was migrated. Display Name: Record Created On |
paymenttermscode |
Edm.Int32 |
Description: Select the payment terms to indicate when the customer needs to pay the total amount. Default Options: 1 : Net 30 Display Name: Payment Terms |
pricingerrorcode |
Edm.Int32 |
Description: Select the type of pricing error, such as a missing or invalid product, or missing quantity. Default Options: 0 : None Display Name: Pricing Error |
prioritycode |
Edm.Int32 |
Description: Select the priority so that preferred customers or critical issues are handled quickly. Default Options: 1 : Default Value Display Name: Priority |
processid |
Edm.Guid |
Description: Shows the ID of the process. Display Name: Process |
requestdeliveryby |
Edm.DateTimeOffset |
Description: Enter the delivery date requested by the customer for all products in the order. Display Name: Requested Delivery Date |
salesorderid |
Edm.Guid |
Description: Unique identifier of the order. Display Name: Order |
shippingmethodcode |
Edm.Int32 |
Description: Select a shipping method for deliveries sent to this address. Default Options: 1 : Airborne Display Name: Shipping Method |
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_composite |
Edm.String |
Description: Shows the complete Ship To address. Display Name: Ship To Address Read-only property |
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 : Default Value Display Name: Ship To 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 |
stageid |
Edm.Guid |
Description: Shows the ID of the stage. Display Name: Process Stage |
statecode |
Edm.Int32 |
Description: Shows whether the order is active, submitted, fulfilled, canceled, or invoiced. Only active orders can be edited. Default Options: 0 : Active Display Name: Status |
statuscode |
Edm.Int32 |
Description: Select the order's status. Default Options: 3 : In Progress Display Name: Status Reason |
submitdate |
Edm.DateTimeOffset |
Description: Enter the date when the order was submitted to the fulfillment or shipping center. Display Name: Date Submitted |
submitstatus |
Edm.Int32 |
Description: Type the code for the submitted status in the fulfillment or shipping center system. Display Name: Submitted Status |
submitstatusdescription |
Edm.String |
Description: Type additional details or notes about the order for the fulfillment or shipping center. Display Name: Submitted Status Description |
timezoneruleversionnumber |
Edm.Int32 |
Description: For internal use only. Display Name: Time Zone Rule Version Number |
totalamount |
Edm.Decimal |
Description: Shows the total amount due, calculated as the sum of the products, discounts, freight, and taxes for the order. Display Name: Total Amount |
totalamount_base |
Edm.Decimal |
Description: Shows the Total Amount 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: Total Amount (Base) Read-only property |
totalamountlessfreight |
Edm.Decimal |
Description: Shows the total product amount for the order, minus any discounts. This value is added to freight and tax amounts in the calculation for the total amount due for the order. Display Name: Total Pre-Freight Amount |
totalamountlessfreight_base |
Edm.Decimal |
Description: Shows the Pre-Freight Amount 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: Total Pre-Freight Amount (Base) Read-only property |
totaldiscountamount |
Edm.Decimal |
Description: Shows the total discount amount, based on the discount price and rate entered on the order. Display Name: Total Discount Amount |
totaldiscountamount_base |
Edm.Decimal |
Description: Shows the Total Discount Amount 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: Total Discount Amount (Base) Read-only property |
totallineitemamount |
Edm.Decimal |
Description: Shows the sum of all existing and write-in products included on the order, based on the specified price list and quantities. Display Name: Total Detail Amount |
totallineitemamount_base |
Edm.Decimal |
Description: Shows the Detail Amount field converted to the system's default base currency. The calculation uses the exchange rate specified in the Currencies area. Display Name: Total Detail Amount (Base) Read-only property |
totallineitemdiscountamount |
Edm.Decimal |
Description: Shows the total of the Manual Discount amounts specified on all products included in the order. This value is reflected in the Detail Amount field on the order and is added to any discount amount or rate specified on the order. Display Name: Total Line Item Discount Amount |
totallineitemdiscountamount_base |
Edm.Decimal |
Description: Shows the Total Line Item Discount Amount 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: Total Line Item Discount Amount (Base) Read-only property |
totaltax |
Edm.Decimal |
Description: Shows the Tax amounts specified on all products included in the order, included in the Total Amount due calculation for the order. Display Name: Total Tax |
totaltax_base |
Edm.Decimal |
Description: Shows the Total 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: Total Tax (Base) Read-only property |
traversedpath |
Edm.String |
Description: For internal use only. Display Name: Traversed Path |
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 order. Display Name: Version Number Read-only property |
willcall |
Edm.Boolean |
Description: Select whether the products included in the order 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 Display Name: Ship To |
Single-valued navigation properties
Single-valued navigation properties represent lookup fields where a single entity can be referenced.
| Name | Type | Partner |
|---|---|---|
campaignid |
campaign_orders |
|
createdby |
lk_salesorderbase_createdby |
|
createdonbehalfby |
lk_salesorder_createdonbehalfby |
|
customerid_account |
order_customer_accounts |
|
customerid_contact |
order_customer_contacts |
|
modifiedby |
lk_salesorderbase_modifiedby |
|
modifiedonbehalfby |
lk_salesorder_modifiedonbehalfby |
|
opportunityid |
opportunity_sales_orders |
|
ownerid |
owner_salesorders |
|
owningbusinessunit |
business_unit_orders |
|
owningteam |
team_orders |
|
owninguser |
system_user_orders |
|
pricelevelid |
price_level_orders |
|
quoteid |
quote_orders |
|
transactioncurrencyid |
transactioncurrency_salesorder |
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 |
|---|---|---|
contactorders_association |
contactorders_association |
|
order_details |
salesorderid |
|
order_invoices |
salesorderid |
|
salesorder_activity_parties |
partyid_salesorder |
|
SalesOrder_ActivityPointers |
regardingobjectid_salesorder |
|
SalesOrder_Annotation |
objectid_salesorder |
|
SalesOrder_Appointments |
regardingobjectid_salesorder_appointment |
|
SalesOrder_AsyncOperations |
regardingobjectid_salesorder |
|
SalesOrder_BulkDeleteFailures |
regardingobjectid_salesorder |
|
salesorder_connections1 |
record1id_salesorder |
|
salesorder_connections2 |
record2id_salesorder |
|
SalesOrder_Emails |
regardingobjectid_salesorder_email |
|
SalesOrder_Faxes |
regardingobjectid_salesorder_fax |
|
SalesOrder_Letters |
regardingobjectid_salesorder_letter |
|
SalesOrder_OrderClose |
salesorderid |
|
SalesOrder_Phonecalls |
regardingobjectid_salesorder_phonecall |
|
SalesOrder_RecurringAppointmentMasters |
regardingobjectid_salesorder_recurringappointmentmaster |
|
SalesOrder_ServiceAppointments |
regardingobjectid_salesorder_serviceappointment |
|
SalesOrder_SocialActivities |
regardingobjectid_salesorder_socialactivity |
|
SalesOrder_Tasks |
regardingobjectid_salesorder_task |
Operations bound to salesorder
The following operations are bound to the salesorder entity type.
| Name | Bound to |
|---|---|
Collection |
|
Entity |
|
Entity |
Operations using the salesorder entity type.
The following operations use the salesorder entity type in a parameter or return type.
| Name | How used | Description |
|---|---|---|
ReturnType |
Converts a quote to a sales order. |
|
entityset Parameter |
Fulfills a sales order. |
|
entity Parameter |
Retrieves the products from an opportunity and copy them to the sales order. |
|
entity Parameter |
Locks the total price of products and services that are specified in the sales order (order). |
関連項目
他のリソース
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 CRM 2016 and Microsoft Dynamics CRM Online
Send comments about this topic to Microsoft.
© 2015 Microsoft. All rights reserved.