CRMInvoice.GenerateFromOpportunity Method
The GenerateFromOpportunity method generates an invoice from an opportunity.
Syntax
[Visual Basic .NET]
Public Function GenerateFromOpportunity(
ByVal Caller As CUserAuth,
ByVal OpportunityId As String,
ByVal ColumnSetXml As String
) As String
[C#]
public string GenerateFromOpportunity(
CUserAuth Caller,
string OpportunityId,
string ColumnSetXml
);
[C++]
public: String* GenerateFromOpportunity(
CUserAuth* Caller,
String* OpportunityId,
String* ColumnSetXml
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvCreateInvoice and prvReadOpportunity privileges and access rights on the objects. See CUserAuth.
OpportunityId
Specifies the ID of the opportunity to be used as the basis for the new invoice.
ColumnSetXml
Specifies the 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 complete 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
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#]
// strServer should be set with the name of the platform Web server
string strServer = "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://" + strServer + "/" + 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";
// CRMInvoice proxy object
Microsoft.Crm.Platform.Proxy.CRMInvoice invoice = new Microsoft.Crm.Platform.Proxy.CRMInvoice();
invoice.Credentials = System.Net.CredentialCache.DefaultCredentials;
invoice.Url = strDir + "CRMInvoice.srf";
string strErrorMsg;
string strOpportunityId = "{3BDFF384-0E6B-42F8-924E-61A40514E6F6}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>invoicenumber</column>";
strColumnSetXml += "<column>name</column>";
strColumnSetXml += "<column>description</column>";
strColumnSetXml += "</columnset>";
// Generate an invoice from the opportunity
string strInvoiceXml = invoice.GenerateFromOpportunity(userAuth, strOpportunityId, 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