Deleting Forecasting Billing Schedules and Billing Summaries
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 |
|
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. |
Set<Id> setIds = new Set<Id>{'a1o2v000006Jp3dAAC',
'a1o2v000006JowIAAS'}; // Async call Id jobId =
Apttus_Billing.BillingService.deleteForecastedBillingSchedules(setIds,
true);