CancelSalesOrderRequest Class
Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online
Contains the data that is needed to cancel a sales order (order).
Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)
Syntax
'Declaration
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class CancelSalesOrderRequest
Inherits OrganizationRequest
[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class CancelSalesOrderRequest : OrganizationRequest
Example
The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.
// Define columns to be retrieved after creating the order
salesOrderColumns = new ColumnSet("salesorderid", "totalamount");
// Convert the quote to a sales order
convertQuoteRequest =
new ConvertQuoteToSalesOrderRequest()
{
QuoteId = _quoteId,
ColumnSet = salesOrderColumns
};
convertQuoteResponse =
(ConvertQuoteToSalesOrderResponse)_serviceProxy.Execute(convertQuoteRequest);
SalesOrder closeSalesOrder = (SalesOrder)convertQuoteResponse.Entity;
_closeSalesOrderId = closeSalesOrder.Id;
CancelSalesOrderRequest cancelRequest = new CancelSalesOrderRequest()
{
OrderClose = new OrderClose()
{
SalesOrderId = closeSalesOrder.ToEntityReference(),
Subject = "Close Sales Order " + DateTime.Now
},
Status = new OptionSetValue(-1)
};
_serviceProxy.Execute(cancelRequest);
Console.WriteLine("Canceled sales order");
Remarks
Message Availability
This message works regardless whether the caller is connected to the server or offline.
Usage
Pass an instance of this class to the Execute method, which returns an instance of the CancelSalesOrderResponse class.
Privileges and Access Rights
To perform this action, the caller must have privileges on the SalesOrder entity. For a complete list of the required privileges, see CancelSalesOrder Privileges.
Inheritance Hierarchy
System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.CancelSalesOrderRequest
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Platforms
Development Platforms
Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)
Target Platforms
Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),
Change History
See Also
Reference
CancelSalesOrderRequest Members
Microsoft.Crm.Sdk.Messages Namespace
CancelSalesOrderResponse
Other Resources
Quote, Order and Invoice Entities
SalesOrder (Order) Entity Messages and Methods
Sample: Process Quotes, Sales Orders and Invoices
CancelSalesOrder Privileges
How Role-Based Security Can Be Used to Control Access to Entities In CRM
How Instance-Based Security Can Be Used to Control Access to Entity Instances (Records) In CRM
Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.