Share via

CRMInvoice.Close Method

  • Article

The Close method sets the state of an invoice to Closed.

Syntax

[Visual Basic .NET]
Public Sub Close(
  ByVal Caller As CUserAuth,
  ByVal InvoiceId As String,
  ByVal Status As Integer
)
[C#]
public void Close(
  CUserAuth  Caller,
  string  InvoiceId,
  int  Status
);
[C++]
public: void Close(
  CUserAuth*  Caller,
  String*  InvoiceId,
  long  Status
);

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must have the prvWriteInvoice privilege and access rights on the object to be closed. See CUserAuth.

InvoiceId

Specifies the ID of the invoice to be closed.

Status

Specifies the status of the invoice. You can use this parameter to specify application status.

Return Value

No return value.

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

// 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();
   
   // Close the invoice
   invoice.Close(userAuth, strInvoiceId, Microsoft.Crm.Platform.Types.INVOICE_STATE.INS_ACTIVE);
}
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.