ConvertSalesOrderToInvoiceRequest Class

 

Updated: November 29, 2016

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)

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

[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class ConvertSalesOrderToInvoiceRequest : OrganizationRequest

NameDescription
System_CAPS_pubmethodConvertSalesOrderToInvoiceRequest()

Initializes a new instance of the ConvertSalesOrderToInvoiceRequest class.

NameDescription
System_CAPS_pubpropertyColumnSet

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

System_CAPS_pubpropertyExtensionData

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

System_CAPS_pubpropertyItem[String]

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

System_CAPS_pubpropertyParameters

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

System_CAPS_pubpropertyRequestId

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

System_CAPS_pubpropertyRequestName

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

System_CAPS_pubpropertySalesOrderId

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

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

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.

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;

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: