This API creates one or more contracts (agreements) from a single quote by filtering the quote line items you want to include. Pass filter parameters along with the Quote ID to generate a contract containing only the matching line items. The quote or proposal must be associated with a price list.

You can use this API when you have a consolidated quote that includes products or services for multiple customers and you need to create separate contractual agreements for each customer. You can call the API multiple times on the same quote using different filter parameters to create multiple contracts, where each contract contains only the relevant subset of line items and maintains a relationship to the source quote.

Your original quote remains unchanged. Quote line items are not modified or deleted. Changes made to quote line items after contract creation are not synchronized to existing contract line items.

API

Parameters

Request Data Object: Apttus_QPComply.QPComplyWebService.CreateAgreementRequestDO

Data Object: Apttus_QPComply.QPComplyWebService.PropertyDO

Response Data Object: Apttus_QPComply.QPComplyWebService.CreateAgreementResponseDO

Code Sample

The following sample shows how to create a contract from a quote by filtering specific line items. You can invoke this API multiple times on the same quote with different filter values to generate multiple contracts — one for each customer or filter combination.

/**
 * The below method demonstrates how to create a contract from a quote
 * by filtering specific line items (for example, by customer or account).
 */
public static void createContractFromQuote(String quoteNumber, List<Integer> lineNumbers, Id accountId)
{
    List<Apttus_Proposal__Proposal__c> quote = [SELECT Id FROM
        Apttus_Proposal__Proposal__c WHERE Name = :quoteNumber LIMIT 1];
    if(!quote.isEmpty())
    {
        // Create the request object
        Apttus_QPComply.QPComplyWebService.CreateAgreementRequestDO request =
            new Apttus_QPComply.QPComplyWebService.CreateAgreementRequestDO();
        // Set the source Quote ID
        request.QuoteId = quote.get(0).Id;
        // Specify the line numbers to include in the contract
        request.LineNumbers = lineNumbers;
        // Add filter criteria (for example, filter by Account ID)
        List<Apttus_QPComply.QPComplyWebService.PropertyDO> filters =
            new List<Apttus_QPComply.QPComplyWebService.PropertyDO>();
        filters.add(new Apttus_QPComply.QPComplyWebService.PropertyDO(
            'AccountId', accountId));
        request.FilterCriteria = filters;
        // Execute the createAgreementFromQuote routine
        Apttus_QPComply.QPComplyWebService.CreateAgreementResponseDO response =
            Apttus_QPComply.QPComplyWebService.createAgreementFromQuote(request);
        System.debug('Contract has been successfully created. AgreementId = '
            + response.AgreementId);
    }
}

Integration Details

API Prerequisites:

• The source quote (Proposal) must exist and must be associated with a price list.
• The quote must contain line items that match the filter criteria you provide.
• The standard Quote to Contract data mapping configuration must be in place. All existing field mappings continue to apply to both contract headers and contract line items.
• To receive asynchronous completion notifications, configure the APTS_CPQAsyncNotifyCallbackClass admin property with a class that implements System.Callable.

Behavior:

• Only the quote line items matching your filter and/or line numbers are copied to the contract.
• Line item hierarchy and parent-child relationships are preserved for the filtered items.
• The contract header is populated from the quote header per the existing Quote to Contract mapping rules. Account name updates on the contract header are handled programmatically by Professional Services or the customer.
• The source quote remains unchanged after contract creation.
• Resync is not supported: The line item changes made on the quote after the contract is created are not propagated to existing contract line items.