CRMSalesOrder.SubmitOrConvert Method
The SubmitorConvert method submits a sales order or converts a sales order to an invoice. If Microsoft Business Solutions CRM Integration for Great Plains is installed and enabled, the Submit method is called. Otherwise, the ConvertToInvoice method is called.
Syntax
[Visual Basic .NET]
Public Function SubmitOrConvert(
ByVal Caller As CUserAuth,
ByVal SalesOrderId As String,
ByVal Status As Integer,
ByVal ColumnSetXml As String
) As String
[C#]
public string SubmitOrConvert(
CUserAuth Caller,
string SalesOrderId,
int Status,
string ColumnSetXml
);
[C++]
public: String* SubmitOrConvert(
CUserAuth* Caller,
String* SalesOrderId,
long Status,
String* ColumnSetXml
);
Parameters
Caller
Specifies the identity of the caller. For submit, To perform this action, the caller must have the prvWriteOrder privilege. For convert to invoice, To perform this action, the caller must have the prvReadOrder, prvReadInvoice and prvCreateInvoice privileges. The caller must also have access rights on the objects. See CUserAuth.
SalesOrderId
Specifies the ID of the sales order to be submitted.
Status
Specifies the status of the sales order. You can use this parameter to specify application status. See Remarks.
ColumnSetXml
Specifies an XML string describing the set of columns to be retrieved. Passing an empty string or null returns all columns (Nothing or "" in VB .NET). You can find the valid column names in invoice.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data containing the invoice information. The fields that are returned depend on what fields are specified in the ColumnSetXml parameter. The XML schema is described by invoice.xsd.
Remarks
The Status parameter corresponds to Status Reason in the Microsoft CRM application. If you pass -1 for this parameter, the platform sets the status to the appropriate value for the Microsoft CRM application. You can use the RetrieveStatus method to retrieve the status codes used in the application.
This method always returns a single object so any filter criteria specified in the ColumnSetXml parameter are ignored.
The XML string returned from this method does not contain elements for fields where the value is null or contains empty strings. This improves performance by not sending more XML data than is necessary from the server to the client.
If there is an error, SOAP throws an exception and the error message is reported in System.Web.Services.Protocols.SoapException.Detail.OuterXml.
All IDs passed to the platform are GUIDs wrapped in braces. For example: {6522D89A-A752-4455-A2B0-51494C6957C3}
Example
[C#]
// strServerName should be set with the name of the platform Web server
string strServerName = "myservername";
// virtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string virtualDirectory = "mscrmservices";
string strDir = "https://" + strServerName + "/" + virtualDirectory + "/";
// BizUser proxy object
Microsoft.Crm.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMSalesOrder proxy object
Microsoft.Crm.Platform.Proxy.CRMSalesOrder salesorder = new Microsoft.Crm.Platform.Proxy.CRMSalesOrder ();
salesorder.Credentials = System.Net.CredentialCache.DefaultCredentials;
salesorder.Url = strDir + "CRMSalesOrder.srf";
string strErrorMsg;
string strSalesOrderId = "{37F05EC6-0A39-400E-84D1-CCD9F72F034F}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>name</column>";
strColumnSetXml += "<column>accountid</column>";
strColumnSetXml += "</columnset>";
// Submit the sales order
string strResultXml = salesorder.SubmitOrConvert (userAuth, strSalesOrderId, -1, strColumnSetXml);
}
catch (System.Web.Services.Protocols.SoapException err)
{
// Process the platform error here
strErrorMsg = ("ErrorMessage: " + err.Message + " " + err.Detail.OuterXml + " Source: " + err.Source );
}
catch (Exception err)
{
// Process other errors here
strErrorMsg = ("ErrorMessage: " + err.Message );
}
Requirements
Namespace: Microsoft.Crm.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also