Share via


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. The caller must have the prvCreateInvoice and prvReadInvoice privileges to perform this action. 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

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.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";

// CRMInvoice proxy object
Microsoft.CRM.Proxy.CRMInvoice invoice = new Microsoft.CRM.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.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.Flags.ObjectType.otAccount.ToString() +"\">";
   strInvoiceXml += strAccountId + "</customerid>";
   strInvoiceXml += "<ownerid type=\"" + Microsoft.CRM.Flags.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.Proxy

Assembly: microsoft.crm.proxy.dll

See Also

© 2003 Microsoft Corporation. All rights reserved.