SalesOrder (order) entity messages and methods

 

Applies To: Dynamics CRM 2013

In Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online, a sales order (order) is a quote that has been accepted. This entity is called order in the Microsoft Dynamics CRM application. The schema name for this entity is SalesOrder. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download.

The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.

Message	Description
AssignRequest	Assigns a sales order to another user or team.
AssociateRequest	Creates a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Associate method. For more information, see Actions on entity records. For a list of default relationships for this entity, refer to the SalesOrder entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
CancelSalesOrderRequest	Cancels a sales order.
CompoundCreateRequest	Deprecated. Creates a sales order and related sales order details. Use CreateRequest.
CompoundUpdateRequest	Deprecated. Updates a sales order and related sales order details. Use UpdateRequest.
ConvertSalesOrderToInvoiceRequest	Converts a sales order to an invoice.
CreateRequest	Creates a sales order. You can also call the IOrganizationService.Create method.
DeleteRequest	Deletes a sales order. You can also call the IOrganizationService.Delete method.
DisassociateRequest	Removes a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Disassociate method. For more information, see Actions on entity records. For a list of default relationships for this entity, refer to the SalesOrder entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
FulfillSalesOrderRequest	Fulfills the sales order.
GenerateSalesOrderFromOpportunityRequest	Generates a sales order from the specified opportunity.
GetQuantityDecimalRequest	Gets the quantity decimal value of a product for the entity specified in the target.
GetSalesOrderProductsFromOpportunityRequest	Retrieves the set of products for a sales order from the specified opportunity.
GrantAccessRequest	Shares a sales order with another security principal (user or team).
InitializeFromRequest	Initializes a new record from an existing record provided that an attribute map is defined for the two entities. For more information, see Customize entity and attribute mappings.
LockSalesOrderPricingRequest	Locks the sales order pricing.
ModifyAccessRequest	Changes the access rights for a sales order previously shared with another security principal (user or team).
RemoveRelatedRequest	Deprecated. Removes the relationship between a sales order and a contact. Use DisassociateRequest or Disassociate instead.
RetrieveDuplicatesRequest	Detects and retrieves duplicate records for the specified record provided that duplicate detection is enabled and there are published duplicate detection rules for the entity. For more information, see Detect duplicate data.
RetrieveRequest	Retrieves a sales order. You can also call the IOrganizationService.Retrieve method.
RetrieveMultipleRequest	Retrieves a collection of sales orders.You can also call the IOrganizationService.RetrieveMultiple method.
RetrievePrincipalAccessRequest	Retrieves the access rights that the specified security principal (user or team) has to a sales order.
RetrieveSharedPrincipalsAndAccessRequest	Retrieves the security principals (users or teams) that have access to a sales order, together with their access rights to the sales order.
RevokeAccessRequest	Removes all access rights to a sales order for the specified security principal (user or team).
RollupRequest	Rolls up or retrieves all the sales orders related to the specified record (account or contact).
SetRelatedRequest	Deprecated. Creates a relationship between a sales order and a contact. Use DisassociateRequest or Disassociate instead.
SetStateRequest	Sets the state of a sales order. If you are using early bound types, use the SalesOrderState enumeration to set the possible states. For a list of the state values, refer to the SalesOrder entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
UnlockSalesOrderPricingRequest	Unlocks the price per unit for the products in the specified sales order (order).
UpdateRequest	Updates a sales order. You can also call the IOrganizationService.Update method.

See Also

Quote, order, and invoice entities
SalesOrder (order) entity privileges
SalesOrderDetail (order product) entity messages and methods