Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Show Page Sections

Managing the Approval Status of Adjustment Billing Schedule Details

Adjustment Billing Schedule Detail (BSD) are always created in Draft status. You can change the status to Pending Approval, Approved, Rejected, and Canceled.The change in the status of an adjustment BSD affects the roll-up amount of its parent Billing Schedule Record (BSR). For example, when the status of an adjustment BSD changes from Draft to Approved, its fee amount is rolled up to its parent 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:
Existing StatusDestination StatusEffect
DraftPending ApprovalStatus update only
Draft or Pending ApprovalApproved
  • Status update
  • Update in parent BSR Fee Amount with the Adjustment Amount
Draft or Pending ApprovalRejectedStatus update only
DraftCanceledStatus update only
ApprovedCanceled
  • Status update
  • Update in parent BSR Fee Amount less the Adjustment Amount

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.

To Change the Status of Adjustment BSDs

  • The Billing Header is in Active status.
  • The parent BSR is in Pending Billing status.
  • The adjustment BSDs' category is Adjustment.
  1. Call the Billing Management API, https://<URL_of_the_Instance>/api/billing/v1/schedules/adjustments/update-approval-stage.
  2. Enter the values in the payload.
    • BillingScheduleDetailId: ID of the BSD whose status needs to be changed.
    • ApprovalStage: Enter the desired approval stage.
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 from Approved to Canceled. The effect on the BSR fee amount is illustrated below.

BSD status changed from Draft to Approved:

BSD IDBSR IDBSR StatusBH StatusCategoryBSD Existing StatusBSD Changed StatusBSD FeeBSR Fee Post BSD Status Change

BSD-1.a

BSR-2

Pending Billing

Active

Adjustment

Draft

Approved

USD 50.00

USD 500.00

BSD status changed from Approved to Canceled:

BSD IDBSR IDBSR StatusBH StatusCategoryBSD Existing StatusBSD Changed StatusBSD FeeBSR Fee Post BSD Status Change

BSD-1.a

BSR-2

Pending Billing

Active

Adjustment

Approved

Canceled

USD 50.00

USD 450.00