Change the Status of Billing Schedule Records
When the status of a BSR is changed from Pending Billing to Invoiced, the Total Invoiced Amount field on the Billing Header shows the cumulative rolled-up amounts of all the BSRs in Invoiced status. The Pending Invoiced Amount field on the BH contains the total contract value less the invoiced amount.
Suppose the order line item for a standalone product has the following details:
|
Order No. |
Order Line No. |
Product |
Billing Frequency |
Start Date |
End Date |
Quantity |
List price |
Net Price |
|---|---|---|---|---|---|---|---|---|
|
O-1 |
OLI-1 |
Service |
Half-yearly |
01 Jan 2024 |
31 Dec 2024 |
1 |
USD 1,200.00 |
USD 1,200.00 |
When Billing is initiated, the resulting BH will contain the Price Type as Evergreen instead of Recurring. The billing header shows:
|
Billing header ID |
Order No. |
Current Order Line |
Product |
Status |
Billing Frequency |
Billing Rule |
Start Date |
End Date |
Quantity |
Net Unit Price |
Total Invoiced Amount |
Pending Invoiced Amount |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
BH-1 |
O-1 |
OLI-1 |
Service |
Active |
Half-yearly |
Bill In Advance |
01 Jan 2024 |
31 Dec 2024 |
1 |
USD 1,200.00 |
USD 0.00 |
USD 1,200.00 |
Two BSRs are generated in pending billing status.
(BSD is not shown here to keep the example simple. It is assumed that the BSD is approved and the fee amount is rolled up to the BSR.)
|
Billing Schedule Record No |
Billing header ID |
Period Start Date |
Period End Date |
Actual Fee Amount |
Ready for Invoice Date |
Status |
|---|---|---|---|---|---|---|
|
BSR-1 |
BH-1 |
01 Jan 2024 |
30 Jun 2024 |
USD 600.00 |
01 Jan 2024 |
Pending Billing |
|
BSR-2 |
BH-1 |
01 Jul 2024 |
31 Dec 2024 |
USD 600.00 |
01 Jul 2024 |
Pending Billing |
You called the Update Invoice API to change the status of BSR-1. The status of BSR-1 is changed to "Invoiced".
|
Billing Schedule Record No |
Billing header ID |
Period Start Date |
Period End Date |
Actual Fee Amount |
Ready for Invoice Date |
Status |
|---|---|---|---|---|---|---|
|
BSR-1 |
BH-1 |
01 Jan 2024 |
30 Jun 2024 |
USD 600.00 |
01 Jan 2024 |
Invoiced |
|
BSR-2 |
BH-1 |
01 Jul 2024 |
31 Dec 2024 |
USD 600.00 |
01 Jul 2024 |
Pending Billing |
The following fields on BH are updated:
|
BH Total Invoiced Amount |
BH Pending Invoiced Amount |
|---|---|
|
USD 600.00 |
USD 600.00 |
Hence, the Total Invoiced Amount field on the BH is updated with the cumulative rolled-up amounts of all the BSRs in Invoiced status. The Pending Invoiced Amount field on the BH contains the total contract value less the invoiced amount.
