ConvertSalesOrderToInvoiceRequest ConvertSalesOrderToInvoiceRequest ConvertSalesOrderToInvoiceRequest ConvertSalesOrderToInvoiceRequest Class

Definition

Contains the data that is needed to convert a sales order to an invoice.

For the Web API use the ConvertSalesOrderToInvoice Action.

public ref class ConvertSalesOrderToInvoiceRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class ConvertSalesOrderToInvoiceRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type ConvertSalesOrderToInvoiceRequest = class
    inherit OrganizationRequest
Public NotInheritable Class ConvertSalesOrderToInvoiceRequest
Inherits OrganizationRequest
Inheritance
ConvertSalesOrderToInvoiceRequestConvertSalesOrderToInvoiceRequestConvertSalesOrderToInvoiceRequestConvertSalesOrderToInvoiceRequest
Attributes

Examples


      #region Convert SalesOrder to Invoice

// Define columns to be retrieved after creating the invoice
ColumnSet invoiceColumns =
    new ColumnSet("invoiceid", "totalamount");
// Convert the order to an invoice
ConvertSalesOrderToInvoiceRequest convertOrderRequest =
    new ConvertSalesOrderToInvoiceRequest()
    {
        SalesOrderId = _salesOrderId,
        ColumnSet = invoiceColumns
    };
ConvertSalesOrderToInvoiceResponse convertOrderResponse =
    (ConvertSalesOrderToInvoiceResponse)svc.Execute(convertOrderRequest);
Invoice invoice = (Invoice)convertOrderResponse.Entity;
_invoiceId = invoice.Id;

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.

businessmanagement#convertsalesordertoinvoice

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of the ConvertSalesOrderToInvoiceResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the SalesOrder entity and access rights on the specified record in the SalesOrderId property. For a complete list of the required privileges, see ConvertSalesOrderToInvoice message privileges.

Constructors

ConvertSalesOrderToInvoiceRequest() ConvertSalesOrderToInvoiceRequest() ConvertSalesOrderToInvoiceRequest() ConvertSalesOrderToInvoiceRequest()

Initializes a new instance of the ConvertSalesOrderToInvoiceRequest class.

Properties

ColumnSet ColumnSet ColumnSet ColumnSet

Gets or sets the collection of attributes to retrieve from the resulting invoice. Required.

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
ProcessInstanceId ProcessInstanceId ProcessInstanceId ProcessInstanceId
RequestId RequestId RequestId RequestId

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

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
SalesOrderId SalesOrderId SalesOrderId SalesOrderId

Gets or sets the ID of the sales order (order) to convert. Required.

Applies to

See also