Perform Control Group Run

The PerformControlGroupRun API is used to perform a control billing run for a specified control group in OCS.io.

API Overview

Fields Required for Performing Control Group Run

The following table lists and describes the fields required to perform a control group run through the PerformControlGroupRun API:

Field Description

controlGroup

Control Group for which Control billing will be performed.

billCycleType

Type of the Billing Cycle. Allowed values:

  • PERIODICAL

  • INITIAL

  • ADJUSTMENT

  • FINAL

effectiveDate

Effective Date/Time for which Invoice within Control Group is calculated. If null, Account’s Billing period end date is effective.

scheduledDate

Date/Time when Control group is scheduled to be performed. If null, Control group will be performed immediately.
Detailed API documentation and endpoint specifics are available here.

Request Validations

Perform Control Group Run Example

Use the following request’s body to perform a control group run:

{
  "requestId": "{{$guid}}",
  "controlGroup": "control_group_code",
  "billCycleType": "PERIODICAL",
  "effectiveDate": "2023-09-01T00:00:00Z"
}

The outcome of the API call is as follows:

  • It is validated that the control group with the provided internal code exists.

  • The control billing run is performed as per the provided values.