CRMInvoice.RetrieveByPrincipal Method

The RetrieveByPrincipal method retrieves all invoices that are owned by a security principal (user or team). Only those invoices that are in the states you specify are retrieved.


[Visual Basic .NET]
Public Function RetrieveByPrincipal(
  ByVal Caller As CUserAuth,
  ByVal Principal As CSecurityPrincipal,
  ByVal StateCodes As Integer(),
  ByVal ColumnSetXml As String
) As String
public string RetrieveByPrincipal(
  CUserAuth  Caller,
  CSecurityPrincipal  Principal,
  int[]  StateCodes,
  string  ColumnSetXml
public: String* RetrieveByPrincipal(
  CUserAuth*  Caller,
  CSecurityPrincipal*  Principal,
  long  StateCodes __gc[],
  String*  ColumnSetXml



Specifies the identity of the caller. The caller must have the prvReadInvoice privilege to perform this action. See CUserAuth.


Specifies the security principal for whom invoices are to be retrieved. See CSecurityPrincipal.


Specifies an array of state codes to find. See INVOICE_STATE.


Specifies the XML string describing the set of columns that is to be retrieved. Passing "" or null returns all columns. 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 set of invoices requested. The fields that are returned depend on what fields are specified in the ColumnSetXml parameter. The XML schema is described by invoice.xsd.


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}


// 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;

   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Create a new security principal
   Microsoft.CRM.Proxy.CSecurityPrincipal securityPrincipal = new Microsoft.CRM.Proxy.CSecurityPrincipal();
   securityPrincipal.Id = userAuth.UserId;
   securityPrincipal.Type = Microsoft.CRM.Proxy.SecurityPrincipalType.sptUser;

   // 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>";

   // The array of state codes to find
   int[] arrCodes = new int[] {Microsoft.CRM.Flags.INVOICE_STATE.INS_ACTIVE, Microsoft.CRM.Flags.INVOICE_STATE.INS_CLOSED};

   // Retrieve the invoices for this security principal
   string strResultsXml = invoice.RetrieveByPrincipal (userAuth, securityPrincipal, arrCodes, 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 );


Namespace: Microsoft.CRM.Proxy

Assembly: microsoft.crm.proxy.dll

See Also

© 2003 Microsoft Corporation. All rights reserved.