Services CPQ API Developer Reference

ffscpq.ActionPushToOpportunity

global with sharing class ActionPushToOpportunity

A class that houses the invocable Method for API service PushToOpportunity. Note: Push to Opportunity is used interchangeably with Add to Opportunity in this API.

Methods

pushToOpportunity

global static List<ffscpq.ActionPushToOpportunity.InvocablePushToOpportunityResponse> pushToOpportunity(List<ffscpq.ActionPushToOpportunity.InvocablePushToOpportunityRequest> invocablePushToOpportunityRequests)

A method that adds estimate details to their related opportunities by by creating resource requests and opportunity products.

Input Parameters

Name Type Description
invocablePushToOpportunityRequests List<ffscpq.ActionPushToOpportunity.InvocablePushToOpportunityRequest> The list of InvocablePushToOpportunityRequest objects.

Return Value

This service returns InvocablePushToOpportunityResponse in a list that parallels the input list.

ffscpq.ActionPushToOpportunity.InvocablePushToOpportunityRequest

global with sharing class InvocablePushToOpportunityRequest

The request class to pass multiple parameters to the invocable method.

Properties

Name Type Description
EstimateId Id The ID of the estimate being added to opportunity.
EstimateProductIds List<Id> A list of IDs of the estimate product instances to be added to opportunity.
IncludeRecordsIndependentOfEstimateProducts Boolean If true, records independent of estimate products will be added to opportunity. The default value is true.
AdditionalAggregationFields List<String> [Optional] Additional fields to consolidate estimate role requests by when creating resource requests.
AggregateBySkills Boolean If true, role requests are consolidated by skills. The default value is false.
CreateOpportunityLineItems Boolean If true, opportunity products are created for each estimate product instance. The default value is true.
ProductId Id The ID of the product used to represent records that are independent of estimate products. Required if records independent of estimate product are included.
ProductDate Date The date of the opportunity product used to represent records that are independent of estimate products. Required if records independent of estimate product are included.
ProductDescription String The description of the opportunity product used to represent records that are independent of estimate products.

Methods

InvocablePushToOpportunityRequest

global InvocablePushToOpportunityRequest()

ffscpq.ActionPushToOpportunity.InvocablePushToOpportunityResponse

global with sharing class InvocablePushToOpportunityResponse

The response class for the invocable method.

Properties

Name Type Description
EstimateId Id The ID of the estimate being added to opportunity.
Errors List<ffscpq.PushToOpportunityService.PushToOpportunityError> A list containing errors that occurred while processing the request.
© Copyright 2009–2024 Certinia Inc. All rights reserved. Various trademarks held by their respective owners.