Generate Forecast Options
generateForecastOptions API is used to generate forecasted billing options for a given Proposal (or Order) in Conga Billing. This API accepts the proposal ID or the order ID, and the option to extend the end date with renewal term as input parameters and returns the list of forecast billing schedules and forecast billing summaries.
API | Signature |
|---|---|
generateForecastOptions |
|
It helps you see how billing schedules will be created for the products/services in your proposal, before actual billing is initiated. This is especially useful for sales reps and billing analysts to understand future invoicing and revenue schedules.
If the forecast billing schedules or forecast billing summaries are already generated for the given proposal and no changes are made to the product configurations, the API displays the existing forecast billing schedules. If you perform any asset-based operations or change the product configuration, the generated forecast billing schedules and billing summaries are deleted and new forecast billing schedules and billing summaries are generated to reflect the changes made to the product or the asset.
- Quote/Proposal associated with a billing plan
- Informational line items of bundle and option products
Request | |||
|---|---|---|---|
Field | Type | Required? | Description |
objectID | ID | Yes | The proposal ID or the order ID. |
extendEndDateWithRenewal | Boolean | Yes | If extendEndDateWithRenewal is set to true, then for each proposal line item with Auto-Renew set to True and the Auto Renewal Type set to Fixed. The end date is extended based on the renewal term. |
Response | ||
|---|---|---|
Field | Type | Description |
forecastedSchedules | List | List of forecast billing schedules generated for the given ID. |
forecastedSummaries | List | List of forecast billing summaries generated for the given ID. |
Sample Code - Request
Apttus_Billing.ForecastedBillingOptions generateForecastOptions =
Apttus_Billing.ForecastBillingService.generateForecastOptions('a0YDc000002fENHMA2', true); //ID ProposalId
System.debug('--generateForecastOptions--'+generateForecastOptions);Code Sample - Response
16:43:31.0 (136355741)|USER_DEBUG|[6]|DEBUG|--generateForecastOptions--ForecastedBillingOptions:[forecastForEvergreen=true, forecastForUsage=true, forecastTerms=null, lineItemOptions=(LineItemOptions:[averageLife=null, billingDayOfMonth=1, billingFrequency=Yearly, configId=a1IDc000003VOSkMAO, endDate=2026-12-31 00:00:00, estimatedUsage=null, isDisabled=false, isEvergreenLineItem=false, isNormalLineItem=true, isSelected=true, isUsageLineItem=false, lineItemId=a13Dc000003kjm7IAA, lineItemNumber=LI-0006644605, productName=ss_evergreen_product, renewalTerm=3, sellingTerm=1.00000, startDate=2026-01-01 00:00:00, upliftAfter=null, upliftPerc=null, upliftPercentage=null]), selectedForecastTerm=Current Term]