CRMInvoice.UpdateAndRetrieve Method
The UpdateAndRetrieve method updates an invoice and then retrieves it.
Syntax
[Visual Basic .NET]
Public Function UpdateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal InvoiceId As String,
ByVal InInvoiceXml As String
) As String
[C#]
public string UpdateAndRetrieve(
CUserAuth Caller,
string InvoiceId,
string InInvoiceXml
);
[C++]
public: String* UpdateAndRetrieve(
CUserAuth* Caller,
String* InvoiceId,
String* InInvoiceXml
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvWriteInvoice and prvReadInvoice privileges and access rights on the object to be updated. See CUserAuth.
InvoiceId
Specifies the ID of the invoice to be updated.
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 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 dDirectory 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 strInvoiceId = "{A9920C07-EE2A-3434-A7EC-9J9D240CF535}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the XML string to update the invoice
string strInvoiceXml = "<invoice>";
strInvoiceXml += "<name>invoice updated</name>";
strInvoiceXml += "</invoice>";
// Update the invoice, and then retrieve it
string strResultXml = invoice.UpdateAndRetrieve(userAuth, strInvoiceId, 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