Service Operations

Find Dependent Charging Contracts

Find Dependent Charging Contracts

Service Operation (WS)

Definition

To find the charging contracts that depend on a specified charging contract or list of charging contracts

Technical Data

Software Product and Version	SAP Convergent Charging 2025
Technical Details	dependentChargingContractFind
Namespace	http://recharging.v2.ws.highdeal.com/
Proxy Instance in SAP CC System	Dispatcher
Service Operation Version	2
Application Area	IS-CC
Direction	inbound
Mode	synchronous
Idempotency	false

Business Context and Use

This service operation is used to search for charging contracts that depend on a charging contract or on a list of charging contracts. The response contains groups of identified charging contracts that can be recharged together. For each group, the system can indicate if all the contracts in this group are rechargeable or not. The system is able to return either all the dependent charging contracts or only the rechargeable charging contracts. The closed charging contracts are not returned in the groups.

A non rechargeable charging contract is a charging contract that uses a shared allowance without belonging to a sharing group or a charging contract with the operational status set to locked.

It is the version 2 of the Web Service (WS) operation. It replaces the former versions.

Two charging contracts depend on one another if:

They belong to the same subscriber account.
They are both linked to the same parent contract, or one of the charging contracts is the parent of the other ones.
They belong to a same sharing group.

Note

To avoid any inconsistency, recharging operations must always include charging contracts which depend on each other and that are not locked or closed.

Important

This is the latest version of this service operation. It replaces the previous versions: version 1 and version 0.

With the version 1, decimal numbers are no longer restricted to the (28,6) precision. For decimal numbers stored in the database, the precision is limited to the precision supported by the database.

With this version 2, the scope of the recharging is extended to support the charging contracts that belong to a sharing group and that use shared allowances.

Rerating Scenario

A correction step precedes the recharging step of the rerating scenario. This step performs corrections when errors leading to the computation of wrong prices are identified. For example, such errors are related to the pricing logic, the properties of chargeable items, and so on.

The recharging step of the rerating scenario consists in sending again chargeable items which were previously charged so that SAP Convergent Charging (SAP CC) computes the correct prices after the correction step.

You can implement the following customizing sequence of operations for the recharging step if you want to provide rerating services in your SAP CC system landscape:

The recharging step may be followed by:

An activation step, in order to trigger again recurring charges which have been undone during the recharging step. See the Activate charging contracts in bulk operation.
A re-invoicing step in the connected billing system such as SAP Convergent Invoicing

Rerating Scenario for Contracts Using Shared Allowances Within a Sharing Group

As of the version 2 of the Recharging web service, the WS operations are enhanced to support the recharging step for charging contracts that use shared allowances within a sharing group. This version provides you with this new scenario of rerating to implement in your SAP CC system landscape.

To be able to rerate all the charging contracts that belong to the same sharing group and that use shared allowances created by the contributor contract, you implement the following operations:

Find the charging contracts belonging to a given sharing group and that must be recharged together as dependent charging contracts
Lock the related charging contracts belonging to the sharing group
Find information on the feasibility of the recharging for charging contracts belonging to the sharing group at a given date/time
Prepare the execution of the recharging process by purging the remaining item files
Find the restoration points for all the related charging contracts belonging to the sharing group
Check the reversibility of the billable items (BITs) related to all the charging contracts to rerate (belonging to the sharing group)
Restore the related charging contracts at a common date/time corresponding to one of their restoration points
Reverse the BITs related to all the charging contracts to rerate (belonging to the sharing group)
Retrieve all consumption items issued from the charging contracts belonging to the sharing group
Recharge all the collected consumption items ordered by ascending dates/times (oldest to newest) to ensure consistency in counter values
Unlock all the related charging contracts belonging to the sharing group

The operations for checking the reversibility of BITs and for reversing BITs are not part of SAP CC Web Services.

Important

Refer to the SAP CC Application Help for more information about the rerating feature, its detailed process, and technical functions/mechanisms. Consult the counter snapshot management (storage, creation, and triggering within a sharing group) feature.

Review the prerequisites, conditions of use, limitations, and recommendations for implementing this rerating scenario for contracts that use shared allowances within a sharing group.

Rerating is not possible for charging contracts using shared allowances outside of any sharing group.

When consumption items to recharge are not ordered by ascending consumption dates/times (oldest to newest), the processing may lead to inconsistencies in counter values.

Features

The WS operation request contains a list of charging contract IDs. For each charging contract ID, the ID of the belonging subscriber account is required.

You specify:

Either a charging contract ID
Or a list of charging contract IDs of charging contracts that may belong to different subscriber accounts

Within sharing groups:

The onlyCandidateToRecharge option set to true (default value) specifies that the response contains only the groups that are rechargeable. Groups containing at least one non rechargeable charging contract are excluded from the response data. When the onlyCandidateToRecharge option is set to false in the request, a group that contains at least one non rechargeable charging contract is returned into the response data but with its candidateToRecharge flag set to false.

Specified charging contracts that belong to a sharing group are used to retrieve dependent charging contracts sharing the same sharing group. Dependent charging contracts are grouped by sharing group in the response.
Outside any sharing group:

Specified charging contracts having no sharing group are returned along with their dependent charging contracts (root contract first and linked contracts following) within their own group.
- When the onlyCandidateToRecharge option is set to true, all contracts (root and linked) of a group must be rechargeable otherwise, the group is not returned in the response.
- When the onlyCandidateToRecharge option is set to false in the request, a group containing at least one non rechargeable charging contract is returned with the candidateToRecharge flag set to false.

The WS operation response includes a list of charging contract groups. Every group contains the identified charging contracts to be recharged together.

Groups are ordered following the order of the charging contracts specified in the request. It means that the first group contains the first charging contract and so on. Inside a group, the first contract is the root charging contract. Other contracts are ordered regarding their increasing OID.

For each group, the following information is available:

Sharing group ID (see sharingGroupId): if present, it indicates that the charging contracts in this group, belong to a sharing group with the given ID. If absent, it indicates that the charging contracts do not belong to any sharing group.
Candidate to recharge (see candidateToRecharge): it indicates if the group can be potentially recharged. It is false if at least one charging contract in the group uses shared allowances without belonging to a sharing group.

Note

The find operation returns charging contract groups without any duplicate charging contracts.

Charging contracts with operational status set to CLOSED are not returned.

Empty groups are not returned.

A group that contains at least one charging contract with an operational status set to LOCKED is set as not rechargeable.

If only one charging contract is specified in the operation request, then the response contains only one charging contract group. This group includes the IDs of the charging contracts that can be recharged together (root and linked charging contracts or charging contracts belonging to the same sharing group).

Authorizations

To know the role that is expected in the user profile of the SAP CC user specified in your request messages, refer to the SAP CC Security Guide of SAP Convergent Charging.

Error Handling

The SAP CC system may return a charging error classified into a category and an error stack detailing the issue and its cause.

Prerequisite Missing	The master data required for the execution of the operation request is missing, or the request is incorrect and does not target the correct master data.	Applicable for this service operation: Next follows a non-exhaustive list of errors linked to the Prerequisite Missing category: The subscriber account specified does not exist The subscriber account specified does not have associated charging contracts The charging contract specified does not exist The charging contract specified does not belong to the subscriber account specified
Invalid	The parameters of the request are not valid. The request must be corrected before sending it again.	Applicable for this service operation: Next follows a non-exhaustive list of errors linked to the Invalid category: No subscriber account identifier was specified in the request
Invalid Configuration	The configuration of the SAP CC system is not valid. It must be corrected before sending the request again.	Applicable for this service operation: Next follows a non-exhaustive list of errors linked to the Invalid Configuration category: The recharging feature is deactivated
Illegal State	The master data used by the operation is not in a valid state. This is usually a normal behavior of the process and should be acknowledged as a failure.	Applicable for this service operation
Temporary Illegal System State	The connected SAP CC system is currently not in an appropriate state to execute the operation request. The request can usually be sent again later without any modification. If the error persists, the system administrators must be informed about it.	Applicable for this service operation
Illegal System State	The operation request failed because of a technical error or an unexpected issue. The system administrators must be informed about this error.	Applicable for this service operation

Troubleshooting

Refer to the SAP CC Error Code Reference for more information about a returned error code and the corrective actions necessary for troubleshooting your implementation project.

Message Types

Consult the structures of the message types related to this service operation of SAP CC:

Prerequisites

Scenario #1:

The relevant subscriber account exists
The relevant charging contracts exist
The relevant charging contracts belong to the subscriber account

Scenario #2:

The relevant subscriber accounts exist
The relevant charging contracts exist
The relevant charging contracts belong to a sharing group to use shared allowances between charging contracts

Integration

There is no specific integration information.

Constraints and Integrity Conditions

There is no specific constraint.

Notes on SAP CC Implementation

You must have installed and configured the SAP CC Core Server system.

Configuration

Consult the SAP CC Configuration and Implementation Guide to know the necessary configuration or Customizing of the SAP CC system.

Before implementing SAP Convergent Charging in your SAP system landscape, you must configure the systems and the data (master data, business data).