CRMInvoice.CreateAndRetrieve Method
The CreateAndRetrieve method creates an invoice and then retrieves it.
Syntax
[Visual Basic .NET]
Public Function CreateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal InInvoiceXml As String
) As String
[C#]
public string CreateAndRetrieve(
CUserAuth Caller,
string InInvoiceXml
);
[C++]
public: String* CreateAndRetrieve(
CUserAuth* Caller,
String* InInvoiceXml
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvCreateInvoice and prvReadInvoice privileges. See CUserAuth.
InInvoiceXml
Specifies the XML string containing the invoice information. The XML schema is described by invoice.xsd.
Return Value
Returns a String type that specifies the XML data containing the complete invoice information. The XML schema is described by invoice.xsd.
Remarks
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 strAccountId = "{3E24E79C-7EC5-4473-95FF-7E46FEBB534B}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the XML string for the invoice
string strInvoiceXml = "<invoice>";
strInvoiceXml += "<name>invoice 1</name>";
strInvoiceXml += "<customerid type=\"" + Microsoft.Crm.Platform.Types.ObjectType.otAccount.ToString() +"\">";
strInvoiceXml += strAccountId + "</customerid>";
strInvoiceXml += "<ownerid type=\"" + Microsoft.Crm.Platform.Types.ObjectType.otSystemUser.ToString() +"\">";
strInvoiceXml += userAuth.UserId + "</ownerid>";
strInvoiceXml += "</invoice>";
// Create and then retrieve the invoice
string strInvoiceXML = invoice.CreateAndRetrieve(userAuth, strInvoiceXml);
}
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