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 or ALI'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 or ALI 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 or ALI'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-1OLI-1OLI-1ALI-101-January-202431-December-2024USD 1,200.00USD 1,200.00USD 600.00USD 600.00USD 60.00USD 1,260.00Active

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-1BSD-1RegularFee01-January-202431-March-2024USD 300.00Invoiced

BSR-2BSD-2RegularFee01-April-202430-June-2024USD 300.00Invoiced

BSR-3BSD-3RegularFee01-July-202430-September-2024USD 300.00Pending

BSD-3.aRegularAdjustment01-July-202430-September-2024USD 30.00
ApprovedAdjustment is approved, so the fee amount is rolled up to the BSR-3.
BSR-4BSD-4RegularFee01-October-202431-December-2024USD 300.00Pending 

BSD-4.aRegularAdjustment01-October-202431-December-2024USD 30.00
ApprovedAdjustment is approved, so the fee amount is rolled up to the BSR-4.

After Change

Suppose you want to provide 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-1OLI-110OLI-1ALI-116-April-202431-December-2024USD 1,075.00(USD 125.00)USD 600.00USD 475.00USD 60.00USD 1,135.00Active

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-1BSD-1RegularFee01-January-202431-March-2024USD 300.00Invoiced
BSR-2BSD-2RegularFee01-April-202430-June-2024USD 300.00InvoicedSince BSR-2 is invoiced, a new BSR-5 is created for the partial period; to accommodate the effect of the Change operation.
BSR-3BSD-3RegularFee01-July-202430-September-2024USD 300.00SupersededSince BSR-3 is Pending, it is superseded. A new BSR-6 is created with a new fee amount.
BSD-3.aRegularAdjustment01-July-202430-September-2024USD 30.00SupersededAdjustment is superseded and a new adjustment 6.a is created
BSR-4BSD-4RegularFee01-October-202431-December-2024USD 300.00Superseded Since BSR-4 is Pending, it is superseded. A new BSR-7 is created with a new fee amount.
BSD-4.aRegularAdjustment01-October-202431-December-2024USD 30.00SupersededAdjustment is superseded and a new adjustment 7.a is created
BSR-5BSD-5RegularFee16-April-202430-June-2024(USD 25.00)Pending BillingNew BSR to provide refund against BSR-2, which is invoiced.
BSR-6BSD-6RegularFee01-July-202430-September-2024USD 250.00Pending BillingSince 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.aRegularAdjustment01-July-202430-September-2024USD 30.00Pending BillingAdjustment for BSR-3
BSR-7BSD-7RegularFee01-October-202431-December-2024USD 250.00Pending BillingSince BSR-4 is in Pending status, a new BSR is created to accommodate the effect of the Change operation on the fee amount.
BSD-7RegularAdjustment01-October-202431-December-2024USD 30.00Pending BillingAdjustment for BSR-4