CRMInvoice.RetrieveByObject Method

The RetrieveByObject method retrieves all invoices that are associated with a specific object (account, contact, or opportunity). Only those invoices in the states that you specify are retrieved.

Syntax

[Visual Basic .NET]
Public Function RetrieveByObject(
  ByVal Caller As CUserAuth,
  ByVal Object As CObjectName,
  ByVal StateCodes As Integer(),
  ByVal ColumnSetXml As String
) As String
[C#]
public string RetrieveByObject(
  CUserAuth  Caller,
  CObjectName  Object,
  int[]  StateCodes,
  string  ColumnSetXml
);
[C++]
public: String* RetrieveByObject(
  CUserAuth*  Caller,
  CObjectName*  Object,
  long  StateCodes __gc[],
  String*  ColumnSetXml
);

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must have the prvReadInvoice privilege and access rights on the objects being retrieved. See CUserAuth.

Object

Specifies the object (account, contact, or opportunity) to search for. See CObjectName.

StateCount

Specifies the number of elements in the StateCodes array.

StateCodes

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

ColumnSetXml

Specifies the XML string describing the set of columns to be retrieved. Passing an empty string or null returns all columns (Nothing or "" in VB .NET). 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. This XML string is in the format

<invoices> + invoice1..N + </invoices>

where the XML schema for each invoice is described by invoice.xsd.

Remarks

Unlike the Retrieve method, the XML string returned from this method may contain multiple objects. If no objects are returned the method simply returns an XML document for the object type with no data.

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 = "http://" + 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 strOpportunityId = "{3BDFF384-0E6B-42F8-924E-61A40514E6F6}";

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

   Microsoft.Crm.Platform.Proxy.CObjectName objName = new Microsoft.Crm.Platform.Proxy.CObjectName();
   objName.Id = strOpportunityId;
   objName.Type = Microsoft.Crm.Platform.Proxy.ObjectType.otOpportunity;

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

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

   // Retrieve the invoice by opportunity object
   string strResultsXml = invoice.RetrieveByObject(userAuth, objName, 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 );
}

Requirements

Namespace: Microsoft.Crm.Platform.Proxy

Assembly: Microsoft.Crm.Platform.Proxy.dll

See Also

© 2005 Microsoft Corporation. All rights reserved.