Closing related Quotes on Opportunity lose seems pretty straightforward. But is it really so?
Thought it would be pretty simple until I landed into handling it using code for one of our clients. One of our clients had requested a functionality that can automatically Close all related Quotes when the Opportunity is marked as Lost. Easiest way to do this was through plugin. So, I instantly started writing a plugin to implement this feature.
On Lose, the plugin would fire and would retrieve all the Quotes related to the Opportunity using FetchXml and store as an Entity Collection. For every quote, I tried to set the state of the Quote to canceled using SetStateRequest class. Refer to the code below:
SetStateRequest setStateRequest = new SetStateRequest()
{
EntityMoniker = new EntityReference
{
Id = quote.Id,
LogicalName = "quote",
},
State = new OptionSetValue(3), //Set state to Closed
Status = new OptionSetValue(6) //Set status to Canceled
};
service.Execute(setStateRequest);
}
Well, all above code seemed perfect but alas, this did not work. The code threw an exception when it tried to set the status of the Quote to closed. This happened because closing of Quotes involves an intermediate entity name Quote Close. This Quote Close (schema name: QuoteClose) entity records are generated when a quote is closed.
For closing a Quote, we need to use CloseQuoteRequest class. The code is given below:
private static void CloseQuote(IOrganizationService service, Entity quote)
{
CloseQuoteRequest req = new CloseQuoteRequest();
Entity quoteClose = new Entity("quoteclose");
quoteClose.Attributes.Add("quoteid", new EntityReference("quote", quote.Id));
quoteClose.Attributes.Add("subject", "Opportunity Lost");
req.QuoteClose = quoteClose;
req.RequestName = "CloseQuote";
OptionSetValue optVal = new OptionSetValue();
optVal.Value = 6;
req.Status = optVal;
CloseQuoteResponse resp = (CloseQuoteResponse)service.Execute(req);
}
But there is still a catch here. This code work perfectly for Active Quotes, but since the Quotes in the Draft mode cannot be closed directly, we will have to first activate the Quotes that are in Draft mode then only we can Close them. Quotes can be easily activated using the SetStateRequest class. So, now first we need to check if the current Quote is in Active or Draft mode and then proceed accordingly. If the Quote is in Draft mode we will have to Activate them and then Close them. Below is the code to Activate any Quote:
private static void ActivateQuote(IOrganizationService service, Entity quote)
{
SetStateRequest setStateRequest = new SetStateRequest()
{
EntityMoniker = new EntityReference
{
Id = quote.Id,
LogicalName = "quote",
},
State = new OptionSetValue(1), //Set state to Active
Status = new OptionSetValue(2) //Set status to In Progress
};
service.Execute(setStateRequest);
}
Registering the step:
Message: Lose
Primary Entity: opportunity
Event: Post-operation
Execution Mode: Synchronous
I hope you found this blog helpful as I struggled a lot to implement this easy sounding requirement, so just thought of sharing with you all.