Managing the Approval Status of Adjustment Billing Schedule Details

The change in the status of an adjustment billing schedule detail (BSD) affects the roll-up amount of its billing schedule record (BSR). When the status of an adjustment BSD changes from Draft to Approved, its fee amount is rolled up to its BSR, thereby increasing the BSR's fee by an amount equal to the rolled-up amount. If the status of adjustment BSD changes from Approved status to any other status, the BSR's fee amount is reduced by an amount equal to the adjustment BSD's fee amount.

Existing Statuses and Permissible Destination Values

You can manually change the status of the adjustments BSDs from an existing status to certain permissible destination values, defined as follows

• If the existing status of the adjustment BSD is Draft, you can change it to Approved or Rejected status.
• If the existing status of the adjustment BSD is Rejected, you can change it to Approved or Draft status.
• If the adjustment BSD is already Approved, you can change it to Draft status.

Use Case: Changing the Status of Adjustment BSDs

You can change the status of the adjustment BSDs by requesting the status change to an endpoint.

Prerequisites

• The billing header is in Active status.
• The status of the BSR is Pending Billing.
• The category of the adjustment BSD is Adjustment.

To Change the Status of Adjustment BSDs

1. Call the Billing Management API, https://<URL_of_the_Instance>/api/billing/v1/schedules/adjustment.
2. Enter the values in the payload.
   

   [
     {
       "BillingScheduleDetailId": "0a1d0ac4-bf5f-485f-a894-a2e9da4a7446",  // ID of the adjustment BSD
       "ApprovalStage": "Draft" // Destination value of the approval level
     }
   ]

   CODE
   
   The API changes the status of the BSD to the supplied value.
   

For example, you created an adjustment BSD of USD 50.00 in Draft status for a BSR that is in Pending Billing status with a fee of USD 450.00. You changed the status of the BSD manually; from draft to approved, and back to draft. The effect on the BSR fee amount is illustrated below.

BSD status changed from draft to approved:

BSD status changed from approved to draft: