Share via


ConvertSalesOrderToInvoiceRequest Class

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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

For the Web API use the ConvertSalesOrderToInvoice Action.

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

Syntax

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

Constructors

Name Description
System_CAPS_pubmethod ConvertSalesOrderToInvoiceRequest()

Initializes a new instance of the ConvertSalesOrderToInvoiceRequest class.

Properties

Name Description
System_CAPS_pubproperty ColumnSet

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

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 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 SalesOrderId

Gets or sets the ID of the sales order (order) to convert. 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

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

Usage

Pass an instance of this class to the Execute 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.

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.


#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)_serviceProxy.Execute(convertOrderRequest);
Invoice invoice = (Invoice)convertOrderResponse.Entity;
_invoiceId = invoice.Id;

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

ConvertSalesOrderToInvoiceResponse
Microsoft.Crm.Sdk.Messages Namespace
Sales entities (lead, opportunity, competitor, quote, order, invoice)
ConvertSalesOrderToInvoice message privileges
Sample: Process quotes, sales orders and invoices
How role-based security can be used to control access to entities in Microsoft Dynamics 365
How record-based security can be used to control access to records in Microsoft Dynamics 365

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright