Forecast Billing Schedules and Billing Summaries
retrieveForecastedBillingSchedulesAndSummaries API is used to generate and display forecast billing schedules and forecast billing summaries for a Quote/Proposal or an order. 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 |
|---|---|
retrieveForecastedBillingSchedulesAndSummaries |
|
The results help sales, finance, and billing teams to preview and communicate expected billing cycles and amounts to customers before actual invoicing happens.
The API works as follows:
- 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.
Note: Forecast billing schedule functionality is not
supported for:
- 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.ForecastedResults retrieveForecastedBillingSchedulesAndSummaries =
Apttus_Billing.ForecastBillingService.retrieveForecastedBillingSchedulesAndSummaries('a0YDc000002fENHMA2', true); //ID ProposalId
System.debug('--retrieveForecastedBillingSchedulesAndSummaries--'+retrieveForecastedBillingSchedulesAndSummaries);Sample Code - Response
retrieveForecastedBillingSchedulesAndSummaries--ForecastedResults:[errorMessage=, forecastedSchedules=(Apttus_Billing__ForecastedBillingSchedule__c:{Apttus_Billing__BillingDayOfMonth__c=1, Apttus_Billing__BillingRule__c=Bill In Advance, Apttus_Billing__BillToAccountId__c=001Dc00000zqVseIAE, Apttus_Billing__Description__c=null, Apttus_Billing__FeeAmount__c=700.00000, Apttus_Billing__HideInvoiceDisplay__c=false, Apttus_Billing__InvoicedScheduleId__c=null, Apttus_Billing__IsSuperseded__c=false, Apttus_Billing__LineItemId__c=a13Dc000003kjm7IAA, Apttus_Billing__LocationId__c=null, Apttus_Billing__PaymentTermId__c=null, Apttus_Billing__PeriodEndDate__c=2026-12-31 00:00:00, Apttus_Billing__PeriodStartDate__c=2026-01-01 00:00:00, Apttus_Billing__ConfigurationId__c=a1IDc000003VOSkMAO, Apttus_Billing__ProposalId__c=a0YDc000002fENHMA2, Apttus_Billing__OrderId__c=null, Apttus_Billing__ReadyForInvoiceDate__c=2026-01-01 00:00:00, Apttus_Billing__ShipToAccountId__c=null, Apttus_Billing__Status__c=Pending Billing, Apttus_Billing__ChargeType__c=Standard Price, Apttus_Billing__PriceType__c=Recurring, Apttus_Billing__IsCreatedFromBillingPlan__c=false, CurrencyIsoCode=USD, Apttus_Billing__ProductName__c=ss_evergreen_product, Id=a6nDc0000005TO0IAM, Apttus_Billing__ForecastedBillingSummaryId__c=a6rDc0000003GtBIAU}, Apttus_Billing__ForecastedBillingSchedule__c:{Apttus_Billing__BillingDayOfMonth__c=1, Apttus_Billing__BillingRule__c=Bill In Advance, Apttus_Billing__BillToAccountId__c=001Dc00000zqVseIAE, Apttus_Billing__Description__c=null, Apttus_Billing__FeeAmount__c=700.00000, Apttus_Billing__HideInvoiceDisplay__c=false, Apttus_Billing__InvoicedScheduleId__c=null, Apttus_Billing__IsSuperseded__c=false, Apttus_Billing__LineItemId__c=a13Dc000003kjm7IAA, Apttus_Billing__LocationId__c=null, Apttus_Billing__PaymentTermId__c=null, Apttus_Billing__PeriodEndDate__c=2027-12-31 00:00:00, Apttus_Billing__PeriodStartDate__c=2027-01-01 00:00:00, Apttus_Billing__ConfigurationId__c=a1IDc000003VOSkMAO, Apttus_Billing__ProposalId__c=a0YDc000002fENHMA2, Apttus_Billing__OrderId__c=null, Apttus_Billing__ReadyForInvoiceDate__c=2027-01-01 00:00:00, Apttus_Billing__ShipToAccountId__c=null, Apttus_Billing__Status__c=Pending Billing, Apttus_Billing__ChargeType__c=Standard Price, Apttus_Billing__PriceType__c=Recurring, Apttus_Billing__IsCreatedFromBillingPlan__c=false, CurrencyIsoCode=USD, Apttus_Billing__ProductName__c=ss_evergreen_product, Id=a6nDc0000005TO1IAM, Apttus_Billing__ForecastedBillingSummaryId__c=a6rDc0000003GtCIAU}, Apttus_Billing__ForecastedBillingSchedule__c:{Apttus_Billing__BillingDayOfMonth__c=1, Apttus_Billing__BillingRule__c=Bill In Advance, Apttus_Billing__BillToAccountId__c=001Dc00000zqVseIAE, Apttus_Billing__Description__c=null, Apttus_Billing__FeeAmount__c=700.00000, Apttus_Billing__HideInvoiceDisplay__c=false, Apttus_Billing__InvoicedScheduleId__c=null, Apttus_Billing__IsSuperseded__c=false, Apttus_Billing__LineItemId__c=a13Dc000003kjm7IAA, Apttus_Billing__LocationId__c=null, Apttus_Billing__PaymentTermId__c=null, Apttus_Billing__PeriodEndDate__c=2028-12-31 00:00:00, Apttus_Billing__PeriodStartDate__c=2028-01-01 00:00:00, Apttus_Billing__ConfigurationId__c=a1IDc000003VOSkMAO, Apttus_Billing__ProposalId__c=a0YDc000002fENHMA2, Apttus_Billing__OrderId__c=null, Apttus_Billing__ReadyForInvoiceDate__c=2028-01-01 00:00:00, Apttus_Billing__ShipToAccountId__c=null, Apttus_Billing__Status__c=Pending Billing, Apttus_Billing__ChargeType__c=Standard Price, Apttus_Billing__PriceType__c=Recurring, Apttus_Billing__IsCreatedFromBillingPlan__c=false, CurrencyIsoCode=USD, Apttus_Billing__ProductName__c=ss_evergreen_product, Id=a6nDc0000005TO2IAM, Apttus_Billing__ForecastedBillingSummaryId__c=a6rDc0000003GtDIAU}, Apttus_Billing__ForecastedBillingSchedule__c:{Apttus_Billing__BillingDayOfMonth__c=1, Apttus_Billing__BillingRule__c=Bill In Advance, Apttus_Billing__BillToAccountId__c=001Dc00000zqVseIAE, Apttus_Billing__Description__c=null, Apttus_Billing__FeeAmount__c=700.00000, Apttus_Billing__HideInvoiceDisplay__c=false, Apttus_Billing__InvoicedScheduleId__c=null, Apttus_Billing__IsSuperseded__c=false, Apttus_Billing__LineItemId__c=a13Dc000003kjm7IAA, Apttus_Billing__LocationId__c=null, Apttus_Billing__PaymentTermId__c=null, Apttus_Billing__PeriodEndDate__c=2029-12-31 00:00:00, Apttus_Billing__PeriodStartDate__c=2029-01-01 00:00:00, Apttus_Billing__ConfigurationId__c=a1IDc000003VOSkMAO, Apttus_Billing__ProposalId__c=a0YDc000002fENHMA2, Apttus_Billing__OrderId__c=null, Apttus_Billing__ReadyForInvoiceDate__c=2029-01-01 00:00:00, Apttus_Billing__ShipToAccountId__c=null, Apttus_Billing__Status__c=Pending Billing, Apttus_Billing__ChargeType__c=Standard Price, Apttus_Billing__PriceType__c=Recurring, Apttus_Billing__IsCreatedFromBillingPlan__c=false, CurrencyIsoCode=USD, Apttus_Billing__ProductName__c=ss_evergreen_product, Id=a6nDc0000005TO3IAM, Apttus_Billing__ForecastedBillingSummaryId__c=a6rDc0000003GtEIAU}), forecastedSummaries=(Apttus_Billing__ForecastedBillingSummary__c:{Apttus_Billing__BillToAccountId__c=001Dc00000zqVseIAE, Apttus_Billing__ConfigurationId__c=a1IDc000003VOSkMAO, Apttus_Billing__DueDate__c=2026-01-01 00:00:00, Apttus_Billing__InvoiceDate__c=2026-01-01 00:00:00, Apttus_Billing__PaymentTermId__c=null, Apttus_Billing__ProposalId__c=a0YDc000002fENHMA2, Apttus_Billing__OrderId__c=null, Apttus_Billing__TotalInvoiceAmount__c=700.00000, Apttus_Billing__TotalOneTimeFeeAmount__c=0.0, Apttus_Billing__TotalRecurringFeeAmount__c=700.00000, Apttus_Billing__TotalUsageFeeAmount__c=0.0, CurrencyIsoCode=USD, Id=a6rDc0000003GtBIAU}, Apttus_Billing__ForecastedBillingSummary__c:{Apttus_Billing__BillToAccountId__c=001Dc00000zqVseIAE, Apttus_Billing__ConfigurationId__c=a1IDc000003VOSkMAO, Apttus_Billing__DueDate__c=2027-01-01 00:00:00, Apttus_Billing__InvoiceDate__c=2027-01-01 00:00:00, Apttus_Billing__PaymentTermId__c=null, Apttus_Billing__ProposalId__c=a0YDc000002fENHMA2, Apttus_Billing__OrderId__c=null, Apttus_Billing__TotalInvoiceAmount__c=700.00000, Apttus_Billing__TotalOneTimeFeeAmount__c=0.0, Apttus_Billing__TotalRecurringFeeAmount__c=700.00000, Apttus_Billing__TotalUsageFeeAmount__c=0.0, CurrencyIsoCode=USD, Id=a6rDc0000003GtCIAU}, Apttus_Billing__ForecastedBillingSummary__c:{Apttus_Billing__BillToAccountId__c=001Dc00000zqVseIAE, Apttus_Billing__ConfigurationId__c=a1IDc000003VOSkMAO, Apttus_Billing__DueDate__c=2028-01-01 00:00:00, Apttus_Billing__InvoiceDate__c=2028-01-01 00:00:00, Apttus_Billing__PaymentTermId__c=null, Apttus_Billing__ProposalId__c=a0YDc000002fENHMA2, Apttus_Billing__OrderId__c=null, Apttus_Billing__TotalInvoiceAmount__c=700.00000, Apttus_Billing__TotalOneTimeFeeAmount__c=0.0, Apttus_Billing__TotalRecurringFeeAmount__c=700.00000, Apttus_Billing__TotalUsageFeeAmount__c=0.0, CurrencyIsoCode=USD, Id=a6rDc0000003GtDIAU}, Apttus_Billing__ForecastedBillingSummary__c:{Apttus_Billing__BillToAccountId__c=001Dc00000zqVseIAE, Apttus_Billing__ConfigurationId__c=a1IDc000003VOSkMAO, Apttus_Billing__DueDate__c=2029-01-01 00:00:00, Apttus_Billing__InvoiceDate__c=2029-01-01 00:00:00, Apttus_Billing__PaymentTermId__c=null, Apttus_Billing__ProposalId__c=a0YDc000002fENHMA2, Apttus_Billing__OrderId__c=null, Apttus_Billing__TotalInvoiceAmount__c=700.00000, Apttus_Billing__TotalOneTimeFeeAmount__c=0.0, Apttus_Billing__TotalRecurringFeeAmount__c=700.00000, Apttus_Billing__TotalUsageFeeAmount__c=0.0, CurrencyIsoCode=USD, Id=a6rDc0000003GtEIAU}), forecastedSummaryBySummaryKey={001Dc00000zqVseIAE1/1/2026USD=Apttus_Billing__ForecastedBillingSummary__c:{Apttus_Billing__BillToAccountId__c=001Dc00000zqVseIAE, Apttus_Billing__ConfigurationId__c=a1IDc000003VOSkMAO, Apttus_Billing__DueDate__c=2026-01-01 00:00:00, Apttus_Billing__InvoiceDate__c=2026-01-01 00:00:00, Apttus_Billing__PaymentTermId__c=null, Apttus_Billing__ProposalId__c=a0YDc000002fENHMA2, Apttus_Billing__OrderId__c=null, Apttus_Billing__TotalInvoiceAmount__c=700.00000, Apttus_Billing__TotalOneTimeFeeAmount__c=0.0, Apttus_Billing__TotalRecurringFeeAmount__c=700.00000, Apttus_Billing__TotalUsageFeeAmount__c=0.0, CurrencyIsoCode=USD, Id=a6rDc0000003GtBIAU}, 001Dc00000zqVseIAE1/1/2027USD=Apttus_Billing__ForecastedBillingSummary__c:{Apttus_Billing__BillToAccountId__c=001Dc00000zqVseIAE, Apttus_Billing__ConfigurationId__c=a1IDc000003VOSkMAO, Apttus_Billing__DueDate__c=2027-01-01 00:00:00, Apttus_Billing__InvoiceDate__c=2027-01-01 00:00:00, Apttus_Billing__PaymentTermId__c=null, Apttus_Billing__ProposalId__c=a0YDc000002fENHMA2, Apttus_Billing__OrderId__c=null, Apttus_Billing__TotalInvoiceAmount__c=700.00000, Apttus_Billing__TotalOneTimeFeeAmount__c=0.0, Apttus_Billing__TotalRecurringFeeAmount__c=700.00000, Apttus_Billing__TotalUsageFeeAmount__c=0.0, CurrencyIsoCode=USD, Id=a6rDc0000003GtCIAU}, 001Dc00000zqVseIAE1/1/2028USD=Apttus_Billing__ForecastedBillingSummary__c:{Apttus_Billing__BillToAccountId__c=001Dc00000zqVseIAE, Apttus_Billing__ConfigurationId__c=a1IDc000003VOSkMAO, Apttus_Billing__DueDate__c=2028-01-01 00:00:00, Apttus_Billing__InvoiceDate__c=2028-01-01 00:00:00, Apttus_Billing__PaymentTermId__c=null, Apttus_Billing__ProposalId__c=a0YDc000002fENHMA2, Apttus_Billing__OrderId__c=null, Apttus_Billing__TotalInvoiceAmount__c=700.00000, Apttus_Billing__TotalOneTimeFeeAmount__c=0.0, Apttus_Billing__TotalRecurringFeeAmount__c=700.00000, Apttus_Billing__TotalUsageFeeAmount__c=0.0, CurrencyIsoCode=USD, Id=a6rDc0000003GtDIAU}, 001Dc00000zqVseIAE1/1/2029USD=Apttus_Billing__ForecastedBillingSummary__c:{Apttus_Billing__BillToAccountId__c=001Dc00000zqVseIAE, Apttus_Billing__ConfigurationId__c=a1IDc000003VOSkMAO, Apttus_Billing__DueDate__c=2029-01-01 00:00:00, Apttus_Billing__InvoiceDate__c=2029-01-01 00:00:00, Apttus_Billing__PaymentTermId__c=null, Apttus_Billing__ProposalId__c=a0YDc000002fENHMA2, Apttus_Billing__OrderId__c=null, Apttus_Billing__TotalInvoiceAmount__c=700.00000, Apttus_Billing__TotalOneTimeFeeAmount__c=0.0, Apttus_Billing__TotalRecurringFeeAmount__c=700.00000, Apttus_Billing__TotalUsageFeeAmount__c=0.0, CurrencyIsoCode=USD, Id=a6rDc0000003GtEIAU}}, invoiceSeparatelyFlagByLocationId={null=}, paymentTermById={null=null}]