Download PDF
Download page Change Action for Always Superseding.
Change Action for Always Superseding
When you make a request to the Change endpoint, Billing modifies the fields on the activated billing header per the change request or abandons the process.
Prerequisites
- The billing setting, Superseding the Schedules during Asset Management is set to
Always Supersede
. - The current OLI's Delta Price field is populated. It can be 0.00 but not null.
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 amendment process:
- Billing schedule records (BSRs) for periods not impacted by the Change operation remain unchanged.
- Because the Superseding the Schedules during Asset Management billing setting is set to Always Supersede, Billing creates delta billing schedule details (BSDs) and BSRs based on the record's invoice status.
- For un-invoiced records: Billing supersedes the existing BSRs and their BSDs. New BSRs are created for the superseded ones and reflect the updated fee amount to be billed to the customer.
- For invoiced records: Billing creates new BSRs and BSDs for the invoiced records. A period's BSD captures the delta price, which can be either negative or positive.
- On the billing header:
- The values in the Billing Start Date, Billing End Date, Selling Term, Net Unit Price, and Quantity fields are updated to the corresponding values from the Current OLI fields.
- The value in the Billable Amount from the Current Order Line field is updated to the Current OLI's Delta Price field.
- TCV (Sales) is updated to the sum of the previous TCV (Sales) and the value in the Current OLI's Billable Amount field.
The above-mentioned statements can be understood with the help of the example given below.
A new sale is initiated for a service with a TCV (Sales) 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 initiate the billing to create a billing header and four BSRs with a fee amount of USD 300.00 each. There are adjustments of USD 30.00 for BSD-3 and BSD-4.
New Sale
During the new sale, you invoiced BSRs 1 and 2. The billing header looks like a normal BH showing the following data:
BH ID | Current OLI | Parent OLI | ALI | Billing Start Date | Billing End Date | TCV (Sales) | Billable Amount for Current OLI | Total Invoiced Amount | Pending Invoice Amount | Total Adjusted Amount | Total Bill Including Adjustments | Status |
---|---|---|---|---|---|---|---|---|---|---|---|---|
BH-1 | OLI-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 60.00 | USD 1,260.00 | Active |
The data of the four BSRs and 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 | Approval Stage | Remarks |
---|---|---|---|---|---|---|---|---|---|
BSR-1 | BSD-1 | Regular | Fee | 01-January-2024 | 31-March-2024 | USD 300.00 | Invoiced | ||
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 | ||
BSD-3.a | Regular | Adjustment | 01-July-2024 | 30-September-2024 | USD 30.00 | Approved | Adjustment is approved, so the fee amount is rolled up to the BSR-3. | ||
BSR-4 | BSD-4 | Regular | Fee | 01-October-2024 | 31-December-2024 | USD 300.00 | Pending | ||
BSD-4.a | Regular | Adjustment | 01-October-2024 | 31-December-2024 | USD 30.00 | Approved | Adjustment is approved, so the fee amount is rolled up to the BSR-4. |
After Change
Suppose you want to provide a discount of USD 125.00 from the mid-period of BSR-2 through BSR-4 and initiate the change operation which is effective from 16-April-2024. You should send this price change to the existing billing header using a new OLI. When the OLI is activated and is initiated for billing, the billing engine applies the price changes to the header and adjusts the schedules as shown below:
BH ID | Current OLI | Parent OLI | ALI | Billing Start Date | Billing End Date | TCV (Sales) | Billable Amount for Current OLI | Total Invoiced Amount | Pending Invoice Amount | Total Adjusted Amount | Total Bill Including Adjustments | Status |
---|---|---|---|---|---|---|---|---|---|---|---|---|
BH-1 | OLI-110 | OLI-1 | ALI-1 | 16-April-2024 | 31-December-2024 | USD 1,075.00 | (USD 125.00) | USD 600.00 | USD 475.00 | USD 60.00 | USD 1,135.00 | Active |
The BSRs and BSDs after the change operation:
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 | |
BSR-2 | BSD-2 | Regular | Fee | 01-April-2024 | 30-June-2024 | USD 300.00 | Invoiced | Since BSR-2 is invoiced, a new BSR-5 is created for the partial period; to accommodate the effect of the Change operation. |
BSR-3 | BSD-3 | Regular | Fee | 01-July-2024 | 30-September-2024 | USD 300.00 | Superseded | Since BSR-3 is Pending, it is superseded. A new BSR-6 is created with a new fee amount. |
BSD-3.a | Regular | Adjustment | 01-July-2024 | 30-September-2024 | USD 30.00 | Superseded | Adjustment is superseded and a new adjustment 6.a is created | |
BSR-4 | BSD-4 | Regular | Fee | 01-October-2024 | 31-December-2024 | USD 300.00 | Superseded | Since BSR-4 is Pending, it is superseded. A new BSR-7 is created with a new fee amount. |
BSD-4.a | Regular | Adjustment | 01-October-2024 | 31-December-2024 | USD 30.00 | Superseded | Adjustment is superseded and a new adjustment 7.a is created | |
BSR-5 | BSD-5 | Regular | Fee | 16-April-2024 | 30-June-2024 | (USD 25.00) | Pending Billing | New BSR to provide refund against BSR-2, which is invoiced. |
BSR-6 | BSD-6 | Regular | Fee | 01-July-2024 | 30-September-2024 | USD 250.00 | Pending Billing | Since BSR-3 is in Pending status, a new BSR is created to accommodate the effect of the Change operation on the fee amount. |
BSD-6.a | Regular | Adjustment | 01-July-2024 | 30-September-2024 | USD 30.00 | Pending Billing | Adjustment for BSR-3 | |
BSR-7 | BSD-7 | Regular | Fee | 01-October-2024 | 31-December-2024 | USD 250.00 | Pending Billing | Since BSR-4 is in Pending status, a new BSR is created to accommodate the effect of the Change operation on the fee amount. |
BSD-7 | Regular | Adjustment | 01-October-2024 | 31-December-2024 | USD 30.00 | Pending Billing | Adjustment for BSR-4 |