CancelSalesOrderRequest Class

Definition

public ref class CancelSalesOrderRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest

[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class CancelSalesOrderRequest : Microsoft.Xrm.Sdk.OrganizationRequest

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type CancelSalesOrderRequest = class
    inherit OrganizationRequest

Public NotInheritable Class CancelSalesOrderRequest
Inherits OrganizationRequest

Inheritance

Object

OrganizationRequest

CancelSalesOrderRequest

Attributes

DataContractAttribute

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 instance.

/// <summary>
/// Demonstrates the CancelSalesOrder message
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance</param>
/// <param name="quoteId">The ID of a quote to convert to a sales order</param>
static void CancelSalesOrderExample(IOrganizationService service, Guid quoteId)
{
      // Define columns to be retrieved after creating the order
      var salesOrderColumns = new ColumnSet("salesorderid", "totalamount");

      // Convert the quote to a sales order
      ConvertQuoteToSalesOrderRequest convertQuoteRequest = new()
      {
         QuoteId = quoteId,
         ColumnSet = salesOrderColumns
      };

      var convertQuoteResponse =
         (ConvertQuoteToSalesOrderResponse)service.Execute(convertQuoteRequest);

      Entity closeSalesOrder = convertQuoteResponse.Entity;

      CancelSalesOrderRequest request = new()
      {
         OrderClose = new Entity("orderclose")
         {
            Attributes =
            {
                  {"salesorderid",closeSalesOrder.ToEntityReference() },
                  {"subject","Close Sales Order " + DateTime.Now }
            }
         },
         Status = new OptionSetValue(-1)
      };
      service.Execute(request);
}

Remarks

This message requires Dynamics 365 Sales.

For the Web API use the CancelSalesOrder action.

Usage

Pass an instance of this class to the Execute(OrganizationRequest) 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 table. The privileges required are prvCreateActivity,prvAppendToOrder,prvAppendActivity,and prvWriteOrder.

Constructors

Properties

Applies to

See also

• CancelSalesOrderResponse