Download PDF
Download page Use Case: Cancelation at Period Start When the Impacted Schedule is Not Invoiced.
Use Case: Cancelation at Period Start When the Impacted Schedule is Not Invoiced
When you execute the API for cancellation at the period start date, Billing validates the amount to be canceled. On successful validation, it invokes the cancellation process to execute the cancellation steps on the existing billing header.
Prerequisites
- The cancellation date is not null and is in the range of the OLI's or ALI's start and end date.
- The setting "Superseding the Schedules during Asset Management" is set to Minimize or Always Supersede.
Contact your admin to make this functionality available in your application so that clicking a button calls the billing services API.
At the end of the cancellation process:
Billing schedules records till the cancelation date remain as is.
All billing schedules in the cancellation period with a status of Pending Billing are marked as Canceled. Accompanying BSDs and their Adjustments are also canceled.
- The billing header is marked as Pending Inactivation. It shows the OLI that initiates the cancellation of the service.
- The Billable Amount on the Current Order Line Item field shows the amount to be canceled.
- If any adjustment BSDs are canceled, the Total Adjusted Amount field is updated accordingly. For more information about the fields of the billing header, see Billing Header.
Consider the example,
A new sale is initiated for a service with a TCV of USD 1,200.00. The billing frequency is quarterly. The start date is 01-January-2024 and the end date is 31-December-2024.
You initiated the billing so that the billing header and four BSRs with a fee amount of USD 300.00 each are created. You created three adjustment BSDs with a fee amount of USD 100.00, USD 100.00, and USD 50.00 for the period, starting 01-January-2024, 01-July-2024, and 01-October-2024 respectively. Because of the adjustments, the fee amounts of BSR-1, BSR-3, and BSR-4 are updated to USD 400.00, USD 400.00, and USD 350.00 respectively.
You have invoiced BSR-1 and BSR-2. The billing header shows the following data:
BH ID | Current OLI | Current Order No. | Parent OLI | ALI | Billing Start Date | Billing End Date | TCV | Billable Amount for Current OLI | Total Invoiced Amount | Pending Invoice Amount | Total Adjusted Amount | Total Bill Including Adjustments | Status |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
BH-1 | OLI-1 | O-1 | OLI-1 | ALI-1 | 01-January-2024 | 31-December-2024 | USD 1,200.00 | USD 1,200.00 | USD 600.00 | USD 600.00 | USD 250.00 | USD 1,450.00 | Active |
The data of the four BSRs and BSDs along with the adjustment BSDs are shown in the table:
BSR ID | BSD ID | Record Type | Category | Period Start Date | Period End Date | Actual Fee Amount | Derived Invoice Status | Remarks |
---|---|---|---|---|---|---|---|---|
BSR-1 | BSD-1 | Regular | Fee | 01-January-2024 | 31-March-2024 | USD 300.00 | Invoiced | |
BSD-1.a | Regular | Adjustment | 01-January-2024 | 31-March-2024 | USD 100.00 | Invoiced | Adjustment | |
BSR-2 | BSD-2 | Regular | Fee | 01-April-2024 | 30-June-2024 | USD 300.00 | Invoiced | |
BSR-3 | BSD-3 | Regular | Fee | 01-July-2024 | 30-September-2024 | USD 300.00 | Pending Billing | |
BSD-3.a | Regular | Adjustment | 01-July-2024 | 30-September-2024 | USD 100.00 | Pending Billing | Adjustment | |
BSR-4 | BSD-4 | Regular | Fee | 01-October-2024 | 31-December-2024 | USD 300.00 | Pending Billing | |
BSD-4.a | Regular | Adjustment | 01-October-2024 | 31-December-2024 | USD 50.00 | Pending Billing | Adjustment |
After Cancellation
You canceled the product or service on the period start date so the cancellation goes into effect from 01-July-2024. The Current OLI and Current Order Number fields on the BH are updated to the newly activated OLI which is used to initiate the cancellation process. The End Date field on the BH is updated to the product or service cancellation date. The TCV (Sales) field is updated to show the sum of the Previous TCV (Sales) value and Billable Amount from the Current Order Line. The Billable Amount for Current OLI field shows the amount to be canceled. The Total Invoiced Amount field shows the roll-up of the BSRs in the Invoiced status. The Status field on the BH is updated to Pending Inactivation.
Scenario 1: Setting "Superseding the Schedules during Asset Management" is set to Minimize
.
You have canceled the order so the cancellation goes into effect from 01-July-2024. After cancellation, various fields on the BH are updated as follows:
BH ID | Current OLI | Current Order No. | Parent OLI | ALI | Billing Start Date | Billing End Date | TCV | Billable Amount for Current OLI | Total Invoiced Amount | Pending Invoice Amount | Total Adjusted Amount | Total Bill Including Adjustments | Status |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
BH-1 | OLI-12 | O-11 | OLI-1 | ALI-1 | 01-January-2024 | 30-June-2024 | USD 600.00 | USD ( 600.00) | USD 600.00 | USD 0.00 | USD 100.00 | USD 700.00 | Pending Inactivation |
At the end of the cancellation process, the BSRs, BSDs, and adjustment BSDs before the cancellation date remain in Invoiced status while the BSRs in the cancellation period are marked as canceled. The fee amount of canceled BSRs is USD 0.00 due to the sum of the roll-up amount of the actual BSDs and the counter BSDs.
BSR ID | BH ID | Period Start Date | Period End Date | Fee Amount of BSR | Status | Remarks |
---|---|---|---|---|---|---|
BSR-1 | BH-1 | 01-January-2024 | 31-March-2024 | USD 300.00 | Invoiced | |
BSR-2 | BH-1 | 01-April-2024 | 30-June-2024 | USD 300.00 | Invoiced | |
BSR-3 | BH-1 | 01-July-2024 | 30-September-2024 | USD 0.00 | Canceled | The roll-up amount of the actual and the counter BSD |
BSR-4 | BH-1 | 01-October-2024 | 31-December-2024 | USD 0.00 | Canceled | The roll-up amount of the actual and the counter BSD |
Counter BSDs are created for records that are canceled in pending billing status. These BSDs can be used to offset the revenue forecast from the previous BSDs of the same period.
BSD ID | BSR ID | Record Type | Category | Period Start Date | Period End Date | Fee Amount | Status | Remarks |
---|---|---|---|---|---|---|---|---|
BSD-1 | BSR-1 | Regular | Fee | 01-January-2024 | 31-March-2024 | USD 300.00 | Invoiced | |
BSD-1.a | Regular | Adjustment | 01-January-2024 | 31-March-2024 | USD 100.00 | Invoiced | Adjustment | |
BSD-2 | BSR-2 | Regular | Fee | 01-April-2024 | 30-June-2024 | USD 300.00 | Invoiced | |
BSD-3 | BSR-3 | Regular | Fee | 01-July-2024 | 30-September-2024 | USD 300.00 | Canceled | Since BSD-3 is in Pending status, it has been canceled |
BSD-3.a | Regular | Adjustment | 01-July-2024 | 30-September-2024 | USD 100.00 | Canceled | Since adjustment BSD-3.a is in Pending status, it has been canceled | |
BSD-3.b | Regular | Fee | 01-July-2024 | 30-September-2024 | (USD 300.00) | Canceled | Counter BSD for cancelled BSD-3, can be used as a source to offset the revenue forecast from the previous BSD-3 | |
BSD-4 | BSR-4 | Regular | Fee | 01-October-2024 | 31-December-2024 | USD 300.00 | Canceled | Since BSD-4 is in Pending status, it has been canceled |
BSD-4.a | Regular | Adjustment | 01-October-2024 | 31-December-2024 | USD 50.00 | Canceled | Since adjustment BSD-4.a is in Pending status, it has been canceled | |
BSD-4.b | Regular | Fee | 01-October-2024 | 31-December-2024 | (USD 300.00) | Canceled | Counter BSD for cancelled BSD-4, can be used as a source to offset the revenue forecast from the previous BSD-4 |
Scenario 2: Setting "Superseding the Schedules during Asset Management" is set to Always Supersede
.
You have canceled the order so the cancellation goes into effect from 01-July-2024. After cancellation, various fields on the BH are updated as follows:
BH ID | Current OLI | Current Order No. | Parent OLI | ALI | Billing Start Date | Billing End Date | TCV | Billable Amount for Current OLI | Total Invoiced Amount | Pending Invoice Amount | Total Adjusted Amount | Total Bill Including Adjustments | Status |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
BH-1 | OLI-12 | O-11 | OLI-1 | ALI-1 | 01-January-2024 | 30-June-2024 | USD 600.00 | USD (600.00) | USD 600.00 | USD 0.00 | USD 100.00 | USD 700.00 | Pending Inactivation |
At the end of the cancellation process, the BSRs and BSDs, and adjustment BSDs before the cancellation date remain unchanged. The BSRs, BSDs and adjustment BSDs that are impacted by the cancellation process are in Pending Billing status, so they are canceled.
BSR ID | BSD ID | Record Type | Category | Period Start Date | Period End Date | Actual Fee Amount | Invoice Status | Remarks |
---|---|---|---|---|---|---|---|---|
BSR-1 | BSD-1 | Regular | Fee | 01-January-2024 | 31-March-2024 | USD 300.00 | Invoiced | |
BSD-1.a | Regular | Adjustment | 01-January-2024 | 31-March-2024 | USD 100.00 | Invoiced | Adjustment | |
BSR-2 | BSD-2 | Regular | Fee | 01-April-2024 | 30-June-2024 | USD 300.00 | Invoiced | |
BSR-3 | BSD-3 | Regular | Fee | 01-July-2024 | 30-September-2024 | USD 300.00 | Canceled | Since BSR-3 is in pending billing status, it has been canceled. |
BSD-3.a | Regular | Adjustment | 01-July-2024 | 30-September-2024 | USD 100.00 | Canceled | Since adjustment BSD-3.a is in pending billing status, it has been canceled. | |
BSR-4 | BSD-4 | Regular | Fee | 01-October-2024 | 31-December-2024 | USD 300.00 | Canceled | Since BSR-4 is in pending billing status, it has been canceled. |
BSD-4.a | Regular | Adjustment | 01-October-2024 | 31-December-2024 | USD 50.00 | Canceled | Since adjustment BSD-4.a is in pending billing status, it has been canceled. |