CRMContractDetail.Cancel Method
The Cancel method sets the state of a contract detail to Canceled. If the contract line has expired, you cannot cancel it. Also, you can cancel the contract line item only if its parent contract is in either the Active or Invoiced state.
Syntax
[Visual Basic .NET]
Public Sub Cancel(
ByVal Caller As CUserAuth,
ByVal ContractDetailId As String,
ByVal Status As Integer
)
[C#]
public void Cancel(
CUserAuth Caller,
string ContractDetailId,
int Status
);
[C++]
public: void Cancel(
CUserAuth* Caller,
String* ContractDetailId,
long Status
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvWriteContract privilege and access rights on the object to be modified. See CUserAuth.
ContractDetailId
Specifies the ID of the contract detail to be canceled.
Status
Specifies the new status code for the contract detail. You can use this parameter to specify application status. See Remarks.
Return Value
No return value.
Remarks
Note The Status parameter corresponds to Status Reason in the Microsoft CRM application. If you pass -1 for this parameter, the platform sets the status to the appropriate value for the Microsoft CRM application. You can use the RetrieveStatus method to retrieve the status codes used in the application.
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#]
// strServerName should be set with the name of the platform Web server
string strServerName = "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://" + strServerName + "/" + 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";
// CRMContractDetail proxy object
Microsoft.Crm.Platform.Proxy.CRMContractDetail contractdetail = new Microsoft.Crm.Platform.Proxy.CRMContractDetail();
contractdetail.Credentials = System.Net.CredentialCache.DefaultCredentials;
contractdetail.Url = strDir + "CRMContractDetail.srf";
string strErrorMsg;
string strContractDetailId= "{506D234F-CF08-40CD-8059-CC0DF6377A19}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Cancel the contract detail
contractdetail.Cancel (userAuth, strContractDetailId, -1);
}
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