Recharge a single Chargeable Item

Service Operation (WS)

Definition

To recharge a single chargeable item

Technical Data

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

Business Context and Use

This service operation is used to recharge a single chargeable item in the context of recharging operations of chargeable items. Consider the mass operation.

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 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 system landscape:

• Find the charging contracts which must be recharged together
• Lock the related charging contracts
• Find information on the feasibility of the recharging for a charging contract at a given date
• Prepare the execution of the recharging process
• Search the restoration points for the related charging contracts
• Restore the related charging contracts at a date corresponding to one of their restoration points
• Recharge the related chargeable items
• Unlock the related charging contracts

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

Related Service Operations

You can also use the following operations for recharging chargeable items:

• Recharge a set of chargeable items

Features

The behavior of this operation can be configured by modifying its context. The list of possible configurations is the following:

• rechargingContext
  • rechargingLockId: specifies the recharging lock identifier of the recharging operation
• senderInfo
  • jobId: specifies an identifier for the sender of the operation
• chargingOutputContext
  • chargeableItemExported: specifies if chargeable items must be exported in the output of the charging operation
  • itemImmediatelyLoaded: must not be enabled for this service operation (available only for single and bundle operations)
• chargingResultContext
  • chargingProcessInfoReturned: specifies if information about the charging process must be returned in the result
  • chargingContractInfoReturned: specifies if information about the target charging contract must be returned in the result
  • chargeableItemInfoReturned: specifies if information about the chargeable item must be returned in the result
  • accountOperationReturned: specifies if the generated account operations must be returned in the result
  • accountInfoReturned: specifies if information about the impacted accounts must be returned in the result
  • chargedItemReturned: specifies if the generated charged items must be returned in the result
  • notificationReturned: specifies if the generated notifications must be returned in the result
• chargingResultOnErrorContext
  • notificationReturned: when the recharging has been aborted by a No Access component, specifies if the error notification (i.e., the "No access" notification) must be returned in the result.
    Regardless of this setting, user alerts are never returned for a charging operation that has been aborted.

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 .

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.

Reasons

The error may include a reason if the operation request failed because of a business configuration error (system or data). The following reasons are available:

Out of Validity Period	The charging contract is not active at the service consumption date of the chargeable item
Not Authorized	The user technical identifier (UTI) and service identifier (SID) of the chargeable item specified do not correspond to a charging contract
Account Blocked	The target account is blocked in the subscriber account stored in customer master data
Account Locked	The target account is locked
Account Closed	The target account is closed
Cannot Charge Account	The target account cannot be charged (for example because of incompatible currencies)

Categories

Use the following error categories to customize the behavior of your application or system:

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 user technical identifier (UTI) and service identifier (SID) of the chargeable item specified do not correspond to a charging contract
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: The recharging lock ID is missing The chargeable item specified is missing A user property of the chargeable item specified is not valid
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
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: Next follows a non-exhaustive list of errors linked to the Illegal State category: The account to be charged is blocked The corresponding charging contract is not locked by a recharging operation The corresponding charging contract locked by a another recharging 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 :

• chargeableItemRechargeRequest
• chargeableItemRechargeResponse

Prerequisites

• The chargeable item class corresponding to the chargeable item exists
• The user technical identifier and service identifier of the chargeable item exist at the consumption date
• The user properties of the chargeable item are valid
• The relevant charging contract is locked by the recharging operation with the given recharging lock identifier

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).