Share via


CRMInvoiceDetail.Create Method

The Create method creates an invoice detail.

Syntax

[Visual Basic .NET]
Public Function Create(
  ByVal Caller As CUserAuth,
  ByVal InvoiceDetailXml As String
) As String
[C#]
public string Create(
  CUserAuth  Caller,
  string  InvoiceDetailXml
);
[C++]
public: String* Create(
  CUserAuth*  Caller,
  String*  InvoiceDetailXml
);

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must have the prvCreateInvoice and prvAppendToInvoice privileges and access rights on the invoice to which you want to attach the detail. See CUserAuth.

InvoiceDetailXml

Specifies an XML string containing the invoice detail information. The XML schema is described by invoicedetail.xsd.

Return Value

Returns a String type that specifies the ID of the new invoice detail.

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

// CRMInvoiceDetail proxy object
Microsoft.Crm.Platform.Proxy.CRMInvoiceDetail invoicedetail = new Microsoft.Crm.Platform.Proxy.CRMInvoiceDetail();
invoicedetail.Credentials = System.Net.CredentialCache.DefaultCredentials;
invoicedetail.Url = strDir + "CRMInvoiceDetail.srf";

string strErrorMsg;
string strInvoiceId = "{A9920C07-EE2A-3434-A7EC-9J9D240CF535}";

try
{
   Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Set up the XML string for the invoice detail
   string strInvoiceDetail= "<invoicedetail>";
   strInvoiceDetail += "<description>Invoice description</description>";
   strInvoiceDetail += "<invoiceid>" + strInvoiceId + "</invoiceid>";
   strInvoiceDetail += "</invoicedetail>";

   // Create the invoice detail
   // Note: To make this work, userAuth must have edit privileges on the parent invoice
   string strInvoiceDetailId = invoicedetail.Create(userAuth, strInvoiceDetail);

}
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

© 2005 Microsoft Corporation. All rights reserved.