Dela via


CancelSalesOrderRequest Class

 

Applies To: Dynamics CRM 2015

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)

Inheritance Hierarchy

System.Object
  Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Crm.Sdk.Messages.CancelSalesOrderRequest

Syntax

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class CancelSalesOrderRequest : OrganizationRequest
[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public ref class CancelSalesOrderRequest sealed : OrganizationRequest
[<Sealed>]
[<DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")>]
type CancelSalesOrderRequest = 
    class
        inherit OrganizationRequest
    end
<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class CancelSalesOrderRequest
    Inherits OrganizationRequest

Constructors

Name Description
System_CAPS_pubmethod CancelSalesOrderRequest()

Initializes a new instance of the CancelSalesOrderRequest class.

Properties

Name Description
System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty OrderClose

Gets or sets the close activity that is associated with the sales order (order) that you want to cancel. Required.

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Status

Gets or sets the status of the sales order (order). Required.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

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 message privileges.

Examples

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");

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.

See Also

CancelSalesOrderResponse
Microsoft.Crm.Sdk.Messages Namespace
Quote, order, and invoice entities
SalesOrder (order) entity messages and methods
Sample: Process quotes, sales orders and invoices
CancelSalesOrder message privileges
How role-based security can be used to control access to entities in Microsoft Dynamics CRM
How record-based security can be used to control access to records in Microsoft Dynamics CRM

Return to top

© 2016 Microsoft. All rights reserved. Copyright