Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Delete Forecast Billing Schedules

deleteForecastedBillingSchedules API deletes forecast billing information of the provided Quote/Proposal or Order IDs. It deletes records from Forecast Billing Schedules, Forecast Billing Summaries, Forecast Billing Options, and Forecast Line Item Options.

API

Signature

deleteForecastedBillingSchedules

static Id deleteForecastedBillingSchedules(Set objectIds, Boolean asyncOperationRequired)

This is useful when you want to clean up forecast data before regenerating it or after actual billing schedules are created.
Note: Only IDs of the same type (either all Proposal IDs or all Order IDs) should be passed in the set.

Request

Field

Type

Required?

Description

objectIDs

Set

Yes

Set of proposal IDs or orders IDs.

Ensure that the set of IDs contain either proposal IDs or Order IDs. It cannot contain a mix of both IDs.

asyncOperationRequired

Boolean

Yes

Set it to true if you want a batch job to be submitted to perform the deletion in an asynchronous mode. If you set it to true, the forecast data is deleted in a synchronous mode.

Response

Field

Type

Description

ID

ID

If you have set asyncOperationRequired as true in the request parameter, the API returns the ID of the submitted batch job.

If you have set asyncOperationRequired as false in the request parameter, the API returns null.

Sample Code - Request

Id deleteForecastedBillingSchedules  =  
    Apttus_Billing.ForecastBillingService.deleteForecastedBillingSchedules(new Set<Id>{'a0YDc000002fENHMA2'}, false); //ID ProposalId 
System.debug('--deleteForecastedBillingSchedules--'+deleteForecastedBillingSchedules);

Sample Code - Response

|--deleteForecastedBillingSchedules--null