charging
Service Operations (Technical Names)
This process component provides the following service operations:
- chargeableItemCharge
- chargeableItemChargeMass
- chargeableItemChargeBundle
- chargeableItemCheckCharge
- chargeableItemCheckChargeMass
You use this information when preparing the implementation phase of your project. During the developments, use the WSDL provided by a running SAP CC Core Server system at the appropriate endpoint over HTTP. Use the technical name of this process component (charging) to determine the relevant endpoint URL.
Note
Consult the functional specification of each service operation for more information about the business context and use, the error handling, and the prerequisites.
Legend
-
The XML elements are ordered and required by default.
Each element is described on a line by its:
- Name
- Type (or base type)
- Use: Optional (*), required (default), prohibited
- Default value
- Occurrence: Unique (default), multiple
- Nillable attribute
- Restricted enumeration
-
The attributes are prefixed using the @ character.
Each attribute is described on a line by its:
- Name
- Type (or base type)
- Use: Optional (*) (default), required, prohibited
- Default value
- Restricted enumeration
Important Note (*)
This SAP product documentation is based on the XML Schema handled by SAP CC. It does not show the conditional elements or attributes at business level. However conditional constraints may exist on certain elements or attributes that are tagged as optional. Refer to the annotations or comments that precise the final business use.
Message Types
This section details all the message types defined by this process component (Web service). Consult the specifications of both the request and response that correspond to your service operation.
Message Type: chargeableItemChargeRequest
Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.
Structure
The chargeableItemChargeRequest message type is structured as follows:
-
context (ChargeableItemChargeContext, optional)
-
senderInfo (SenderContext, optional)
- jobId (Integer22, optional)
-
chargingOutputContext (ChargingOutputContext, optional)
- chargeableItemExported (boolean, optional, default: "true")
- itemImmediatelyLoaded (boolean, optional, default: "false")
-
chargingResultContext (ChargingResultContext, optional)
- chargingProcessInfoReturned (boolean, optional, default: "false")
- chargingContractInfoReturned (boolean, optional, default: "false")
- chargeableItemInfoReturned (boolean, optional, default: "false")
- accountOperationReturned (boolean, optional, default: "false")
- accountInfoReturned (boolean, optional, default: "false")
- chargedItemReturned (boolean, optional, default: "false")
- notificationReturned (boolean, optional, default: "false")
-
chargingResultOnErrorContext (ChargingResultOnErrorContext, optional)
- notificationReturned (boolean, optional, default: "false")
-
senderInfo (SenderContext, optional)
-
chargeableItem (ChargeableItem)
- name (NotEmptyString256)
-
uid (StringUniqueIdentifier, optional)
- @type (NotEmptyString256)
- userTechnicalId (NotEmptyString256)
- serviceId (NotEmptyString256)
- consumptionDate (Date)
- userProperties (ChargeableItemUserProperties)
Message Type: chargeableItemChargeResponse
Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.
Structure
The chargeableItemChargeResponse message type is structured as follows:
- status (ResponseStatus, {return | error})
- message (string, optional)
-
result (ChargingResult, optional)
-
chargingProcessInfo (ChargingProcessInfo, optional)
-
chargedItemSetUniqueId (IntegerUniqueIdentifier)
- @type (NotEmptyString256)
- eventProcessingDate (Date)
-
chargedItemSetUniqueId (IntegerUniqueIdentifier)
-
chargingContractInfo (ChargingContractInfo, optional)
- subscriberAccountId (NotEmptyString256)
- chargingContractId (NotEmptyString256)
- chargingContractItemId (String256)
-
chargeableItemInfo (ChargeableItemInfo, optional)
-
uid (StringUniqueIdentifier)
- @type (NotEmptyString256)
-
uid (StringUniqueIdentifier)
-
accountOperation
...
(AccountOperation, optional, multiple)
- type (AccountOperationType, {debit | credit})
-
amount (Amount, optional)
- @currencyCode (CurrencyCode)
-
netAmount (Amount, optional)
- @currencyCode (CurrencyCode)
-
taxAmount (Amount, optional)
- @currencyCode (CurrencyCode)
-
mainAccountReference (AccountReference, optional)
- type (AccountReferenceType, {external | prepaid})
- id (String256)
-
amountAssignment
...
(AmountAssignment, optional, multiple)
-
amount (Amount)
- @currencyCode (CurrencyCode)
-
accountReference (AccountReference)
- type (AccountReferenceType, {external | prepaid})
- id (String256)
- chargedItemKey (int, optional)
-
amount (Amount)
- key (int)
- dependentAccountOperationKey (int, optional)
- externalAccountInfo ... (ExternalAccountInfo, optional, multiple)
-
prepaidAccountInfo
...
(PrepaidAccountInfo, optional, multiple)
- id (String256)
-
balance (Amount)
- @currencyCode (CurrencyCode)
-
stateSchedule (StateSchedule)
-
item
...
(StateScheduleItem, optional, multiple)
- stateCode (StateScheduleItemCode, {blocked | locked | closed})
- fromDate (Date)
-
item
...
(StateScheduleItem, optional, multiple)
- chargedItem ... (ChargedItem, optional, multiple)
- notification ... (Notification, optional, multiple)
-
chargingProcessInfo (ChargingProcessInfo, optional)
-
error (ChargingFailure, optional)
- category (FailureCategory, {illegalState | invalid | invalidConfiguration | prerequisiteMissing | temporaryIllegalSystemState | illegalSystemState})
- message (string, optional)
-
cause (FailureCause, optional)Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
- module (string)
- code (int)
- message (string)
-
causedBy
...
(FailureCause, optional, multiple)
- module (string)
- code (int)
- message (string)
- reason (ChargingFailureReason, optional, {outOfValidityPeriod | notAuthorized | accountBlocked | accountLocked | accountClosed | cannotChargeAccount})
-
chargeableItem (ChargeableItem)
- name (NotEmptyString256)
-
uid (StringUniqueIdentifier, optional)
- @type (NotEmptyString256)
- userTechnicalId (NotEmptyString256)
- serviceId (NotEmptyString256)
- consumptionDate (Date)
- userProperties (ChargeableItemUserProperties)
Message Type: chargeableItemChargeMassRequest
Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.
Structure
The chargeableItemChargeMassRequest message type is structured as follows:
-
context (ChargeableItemChargeContext, optional)
-
senderInfo (SenderContext, optional)
- jobId (Integer22, optional)
-
chargingOutputContext (ChargingOutputContext, optional)
- chargeableItemExported (boolean, optional, default: "true")
- itemImmediatelyLoaded (boolean, optional, default: "false")
-
chargingResultContext (ChargingResultContext, optional)
- chargingProcessInfoReturned (boolean, optional, default: "false")
- chargingContractInfoReturned (boolean, optional, default: "false")
- chargeableItemInfoReturned (boolean, optional, default: "false")
- accountOperationReturned (boolean, optional, default: "false")
- accountInfoReturned (boolean, optional, default: "false")
- chargedItemReturned (boolean, optional, default: "false")
- notificationReturned (boolean, optional, default: "false")
-
chargingResultOnErrorContext (ChargingResultOnErrorContext, optional)
- notificationReturned (boolean, optional, default: "false")
-
senderInfo (SenderContext, optional)
-
chargeableItemChargeRequest
...
(ChargeableItemChargeRequest, optional, multiple (max: 1000))
-
context (ChargeableItemChargeContext, optional)
-
senderInfo (SenderContext, optional)
- jobId (Integer22, optional)
-
chargingOutputContext (ChargingOutputContext, optional)
- chargeableItemExported (boolean, optional, default: "true")
- itemImmediatelyLoaded (boolean, optional, default: "false")
-
chargingResultContext (ChargingResultContext, optional)
- chargingProcessInfoReturned (boolean, optional, default: "false")
- chargingContractInfoReturned (boolean, optional, default: "false")
- chargeableItemInfoReturned (boolean, optional, default: "false")
- accountOperationReturned (boolean, optional, default: "false")
- accountInfoReturned (boolean, optional, default: "false")
- chargedItemReturned (boolean, optional, default: "false")
- notificationReturned (boolean, optional, default: "false")
-
chargingResultOnErrorContext (ChargingResultOnErrorContext, optional)
- notificationReturned (boolean, optional, default: "false")
-
senderInfo (SenderContext, optional)
-
chargeableItem (ChargeableItem)
- name (NotEmptyString256)
-
uid (StringUniqueIdentifier, optional)
- @type (NotEmptyString256)
- userTechnicalId (NotEmptyString256)
- serviceId (NotEmptyString256)
- consumptionDate (Date)
- userProperties (ChargeableItemUserProperties)
-
context (ChargeableItemChargeContext, optional)
Message Type: chargeableItemChargeMassResponse
Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.
Structure
The chargeableItemChargeMassResponse message type is structured as follows:
- status (ResponseStatus, {return | error})
- message (string, optional)
-
error (Failure, optional)
- category (FailureCategory, {illegalState | invalid | invalidConfiguration | prerequisiteMissing | temporaryIllegalSystemState | illegalSystemState})
- message (string, optional)
-
cause (FailureCause, optional)Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
- module (string)
- code (int)
- message (string)
-
causedBy
...
(FailureCause, optional, multiple)
- module (string)
- code (int)
- message (string)
-
chargeableItemChargeResponse
...
(ChargeableItemChargeResponse, optional, multiple)
- status (ResponseStatus, {return | error})
- message (string, optional)
-
result (ChargingResult, optional)
-
chargingProcessInfo (ChargingProcessInfo, optional)
-
chargedItemSetUniqueId (IntegerUniqueIdentifier)
- @type (NotEmptyString256)
- eventProcessingDate (Date)
-
chargedItemSetUniqueId (IntegerUniqueIdentifier)
-
chargingContractInfo (ChargingContractInfo, optional)
- subscriberAccountId (NotEmptyString256)
- chargingContractId (NotEmptyString256)
- chargingContractItemId (String256)
-
chargeableItemInfo (ChargeableItemInfo, optional)
-
uid (StringUniqueIdentifier)
- @type (NotEmptyString256)
-
uid (StringUniqueIdentifier)
-
accountOperation
...
(AccountOperation, optional, multiple)
- type (AccountOperationType, {debit | credit})
-
amount (Amount, optional)
- @currencyCode (CurrencyCode)
-
netAmount (Amount, optional)
- @currencyCode (CurrencyCode)
-
taxAmount (Amount, optional)
- @currencyCode (CurrencyCode)
-
mainAccountReference (AccountReference, optional)
- type (AccountReferenceType, {external | prepaid})
- id (String256)
-
amountAssignment
...
(AmountAssignment, optional, multiple)
-
amount (Amount)
- @currencyCode (CurrencyCode)
-
accountReference (AccountReference)
- type (AccountReferenceType, {external | prepaid})
- id (String256)
- chargedItemKey (int, optional)
-
amount (Amount)
- key (int)
- dependentAccountOperationKey (int, optional)
- externalAccountInfo ... (ExternalAccountInfo, optional, multiple)
-
prepaidAccountInfo
...
(PrepaidAccountInfo, optional, multiple)
- id (String256)
-
balance (Amount)
- @currencyCode (CurrencyCode)
-
stateSchedule (StateSchedule)
-
item
...
(StateScheduleItem, optional, multiple)
- stateCode (StateScheduleItemCode, {blocked | locked | closed})
- fromDate (Date)
-
item
...
(StateScheduleItem, optional, multiple)
- chargedItem ... (ChargedItem, optional, multiple)
- notification ... (Notification, optional, multiple)
-
chargingProcessInfo (ChargingProcessInfo, optional)
-
error (ChargingFailure, optional)
- category (FailureCategory, {illegalState | invalid | invalidConfiguration | prerequisiteMissing | temporaryIllegalSystemState | illegalSystemState})
- message (string, optional)
-
cause (FailureCause, optional)Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
- module (string)
- code (int)
- message (string)
-
causedBy
...
(FailureCause, optional, multiple)
- module (string)
- code (int)
- message (string)
- reason (ChargingFailureReason, optional, {outOfValidityPeriod | notAuthorized | accountBlocked | accountLocked | accountClosed | cannotChargeAccount})
-
chargeableItem (ChargeableItem)
- name (NotEmptyString256)
-
uid (StringUniqueIdentifier, optional)
- @type (NotEmptyString256)
- userTechnicalId (NotEmptyString256)
- serviceId (NotEmptyString256)
- consumptionDate (Date)
- userProperties (ChargeableItemUserProperties)
Message Type: chargeableItemChargeBundleRequest
Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.
Structure
The chargeableItemChargeBundleRequest message type is structured as follows:
-
context (ChargeableItemChargeContext, optional)
-
senderInfo (SenderContext, optional)
- jobId (Integer22, optional)
-
chargingOutputContext (ChargingOutputContext, optional)
- chargeableItemExported (boolean, optional, default: "true")
- itemImmediatelyLoaded (boolean, optional, default: "false")
-
chargingResultContext (ChargingResultContext, optional)
- chargingProcessInfoReturned (boolean, optional, default: "false")
- chargingContractInfoReturned (boolean, optional, default: "false")
- chargeableItemInfoReturned (boolean, optional, default: "false")
- accountOperationReturned (boolean, optional, default: "false")
- accountInfoReturned (boolean, optional, default: "false")
- chargedItemReturned (boolean, optional, default: "false")
- notificationReturned (boolean, optional, default: "false")
-
chargingResultOnErrorContext (ChargingResultOnErrorContext, optional)
- notificationReturned (boolean, optional, default: "false")
-
senderInfo (SenderContext, optional)
-
chargeableItemChargeRequest
...
(ChargeableItemChargeRequest, optional, multiple (max: 1000))
-
context (ChargeableItemChargeContext, optional)
-
senderInfo (SenderContext, optional)
- jobId (Integer22, optional)
-
chargingOutputContext (ChargingOutputContext, optional)
- chargeableItemExported (boolean, optional, default: "true")
- itemImmediatelyLoaded (boolean, optional, default: "false")
-
chargingResultContext (ChargingResultContext, optional)
- chargingProcessInfoReturned (boolean, optional, default: "false")
- chargingContractInfoReturned (boolean, optional, default: "false")
- chargeableItemInfoReturned (boolean, optional, default: "false")
- accountOperationReturned (boolean, optional, default: "false")
- accountInfoReturned (boolean, optional, default: "false")
- chargedItemReturned (boolean, optional, default: "false")
- notificationReturned (boolean, optional, default: "false")
-
chargingResultOnErrorContext (ChargingResultOnErrorContext, optional)
- notificationReturned (boolean, optional, default: "false")
-
senderInfo (SenderContext, optional)
-
chargeableItem (ChargeableItem)
- name (NotEmptyString256)
-
uid (StringUniqueIdentifier, optional)
- @type (NotEmptyString256)
- userTechnicalId (NotEmptyString256)
- serviceId (NotEmptyString256)
- consumptionDate (Date)
- userProperties (ChargeableItemUserProperties)
-
context (ChargeableItemChargeContext, optional)
Message Type: chargeableItemChargeBundleResponse
Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.
Structure
The chargeableItemChargeBundleResponse message type is structured as follows:
- status (ResponseStatus, {return | error})
- message (string, optional)
-
error (Failure, optional)
- category (FailureCategory, {illegalState | invalid | invalidConfiguration | prerequisiteMissing | temporaryIllegalSystemState | illegalSystemState})
- message (string, optional)
-
cause (FailureCause, optional)Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
- module (string)
- code (int)
- message (string)
-
causedBy
...
(FailureCause, optional, multiple)
- module (string)
- code (int)
- message (string)
-
chargeableItemChargeResponse
...
(ChargeableItemChargeResponse, optional, multiple)
- status (ResponseStatus, {return | error})
- message (string, optional)
-
result (ChargingResult, optional)
-
chargingProcessInfo (ChargingProcessInfo, optional)
-
chargedItemSetUniqueId (IntegerUniqueIdentifier)
- @type (NotEmptyString256)
- eventProcessingDate (Date)
-
chargedItemSetUniqueId (IntegerUniqueIdentifier)
-
chargingContractInfo (ChargingContractInfo, optional)
- subscriberAccountId (NotEmptyString256)
- chargingContractId (NotEmptyString256)
- chargingContractItemId (String256)
-
chargeableItemInfo (ChargeableItemInfo, optional)
-
uid (StringUniqueIdentifier)
- @type (NotEmptyString256)
-
uid (StringUniqueIdentifier)
-
accountOperation
...
(AccountOperation, optional, multiple)
- type (AccountOperationType, {debit | credit})
-
amount (Amount, optional)
- @currencyCode (CurrencyCode)
-
netAmount (Amount, optional)
- @currencyCode (CurrencyCode)
-
taxAmount (Amount, optional)
- @currencyCode (CurrencyCode)
-
mainAccountReference (AccountReference, optional)
- type (AccountReferenceType, {external | prepaid})
- id (String256)
-
amountAssignment
...
(AmountAssignment, optional, multiple)
-
amount (Amount)
- @currencyCode (CurrencyCode)
-
accountReference (AccountReference)
- type (AccountReferenceType, {external | prepaid})
- id (String256)
- chargedItemKey (int, optional)
-
amount (Amount)
- key (int)
- dependentAccountOperationKey (int, optional)
- externalAccountInfo ... (ExternalAccountInfo, optional, multiple)
-
prepaidAccountInfo
...
(PrepaidAccountInfo, optional, multiple)
- id (String256)
-
balance (Amount)
- @currencyCode (CurrencyCode)
-
stateSchedule (StateSchedule)
-
item
...
(StateScheduleItem, optional, multiple)
- stateCode (StateScheduleItemCode, {blocked | locked | closed})
- fromDate (Date)
-
item
...
(StateScheduleItem, optional, multiple)
- chargedItem ... (ChargedItem, optional, multiple)
- notification ... (Notification, optional, multiple)
-
chargingProcessInfo (ChargingProcessInfo, optional)
-
error (ChargingFailure, optional)
- category (FailureCategory, {illegalState | invalid | invalidConfiguration | prerequisiteMissing | temporaryIllegalSystemState | illegalSystemState})
- message (string, optional)
-
cause (FailureCause, optional)Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
- module (string)
- code (int)
- message (string)
-
causedBy
...
(FailureCause, optional, multiple)
- module (string)
- code (int)
- message (string)
- reason (ChargingFailureReason, optional, {outOfValidityPeriod | notAuthorized | accountBlocked | accountLocked | accountClosed | cannotChargeAccount})
-
chargeableItem (ChargeableItem)
- name (NotEmptyString256)
-
uid (StringUniqueIdentifier, optional)
- @type (NotEmptyString256)
- userTechnicalId (NotEmptyString256)
- serviceId (NotEmptyString256)
- consumptionDate (Date)
- userProperties (ChargeableItemUserProperties)
Message Type: chargeableItemCheckChargeRequest
Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.
Structure
The chargeableItemCheckChargeRequest message type is structured as follows:
-
context (ChargeableItemChargeContext, optional)
-
senderInfo (SenderContext, optional)
- jobId (Integer22, optional)
-
chargingOutputContext (ChargingOutputContext, optional)
- chargeableItemExported (boolean, optional, default: "true")
- itemImmediatelyLoaded (boolean, optional, default: "false")
-
chargingResultContext (ChargingResultContext, optional)
- chargingProcessInfoReturned (boolean, optional, default: "false")
- chargingContractInfoReturned (boolean, optional, default: "false")
- chargeableItemInfoReturned (boolean, optional, default: "false")
- accountOperationReturned (boolean, optional, default: "false")
- accountInfoReturned (boolean, optional, default: "false")
- chargedItemReturned (boolean, optional, default: "false")
- notificationReturned (boolean, optional, default: "false")
-
chargingResultOnErrorContext (ChargingResultOnErrorContext, optional)
- notificationReturned (boolean, optional, default: "false")
-
senderInfo (SenderContext, optional)
-
chargeableItem (ChargeableItem)
- name (NotEmptyString256)
-
uid (StringUniqueIdentifier, optional)
- @type (NotEmptyString256)
- userTechnicalId (NotEmptyString256)
- serviceId (NotEmptyString256)
- consumptionDate (Date)
- userProperties (ChargeableItemUserProperties)
Message Type: chargeableItemCheckChargeResponse
Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.
Structure
The chargeableItemCheckChargeResponse message type is structured as follows:
- status (ResponseStatus, {return | error})
- message (string, optional)
-
result (ChargingResult, optional)
-
chargingProcessInfo (ChargingProcessInfo, optional)
-
chargedItemSetUniqueId (IntegerUniqueIdentifier)
- @type (NotEmptyString256)
- eventProcessingDate (Date)
-
chargedItemSetUniqueId (IntegerUniqueIdentifier)
-
chargingContractInfo (ChargingContractInfo, optional)
- subscriberAccountId (NotEmptyString256)
- chargingContractId (NotEmptyString256)
- chargingContractItemId (String256)
-
chargeableItemInfo (ChargeableItemInfo, optional)
-
uid (StringUniqueIdentifier)
- @type (NotEmptyString256)
-
uid (StringUniqueIdentifier)
-
accountOperation
...
(AccountOperation, optional, multiple)
- type (AccountOperationType, {debit | credit})
-
amount (Amount, optional)
- @currencyCode (CurrencyCode)
-
netAmount (Amount, optional)
- @currencyCode (CurrencyCode)
-
taxAmount (Amount, optional)
- @currencyCode (CurrencyCode)
-
mainAccountReference (AccountReference, optional)
- type (AccountReferenceType, {external | prepaid})
- id (String256)
-
amountAssignment
...
(AmountAssignment, optional, multiple)
-
amount (Amount)
- @currencyCode (CurrencyCode)
-
accountReference (AccountReference)
- type (AccountReferenceType, {external | prepaid})
- id (String256)
- chargedItemKey (int, optional)
-
amount (Amount)
- key (int)
- dependentAccountOperationKey (int, optional)
- externalAccountInfo ... (ExternalAccountInfo, optional, multiple)
-
prepaidAccountInfo
...
(PrepaidAccountInfo, optional, multiple)
- id (String256)
-
balance (Amount)
- @currencyCode (CurrencyCode)
-
stateSchedule (StateSchedule)
-
item
...
(StateScheduleItem, optional, multiple)
- stateCode (StateScheduleItemCode, {blocked | locked | closed})
- fromDate (Date)
-
item
...
(StateScheduleItem, optional, multiple)
- chargedItem ... (ChargedItem, optional, multiple)
- notification ... (Notification, optional, multiple)
-
chargingProcessInfo (ChargingProcessInfo, optional)
-
error (ChargingFailure, optional)
- category (FailureCategory, {illegalState | invalid | invalidConfiguration | prerequisiteMissing | temporaryIllegalSystemState | illegalSystemState})
- message (string, optional)
-
cause (FailureCause, optional)Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
- module (string)
- code (int)
- message (string)
-
causedBy
...
(FailureCause, optional, multiple)
- module (string)
- code (int)
- message (string)
- reason (ChargingFailureReason, optional, {outOfValidityPeriod | notAuthorized | accountBlocked | accountLocked | accountClosed | cannotChargeAccount})
-
chargeableItem (ChargeableItem)
- name (NotEmptyString256)
-
uid (StringUniqueIdentifier, optional)
- @type (NotEmptyString256)
- userTechnicalId (NotEmptyString256)
- serviceId (NotEmptyString256)
- consumptionDate (Date)
- userProperties (ChargeableItemUserProperties)
Message Type: chargeableItemCheckChargeMassRequest
Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.
Structure
The chargeableItemCheckChargeMassRequest message type is structured as follows:
-
context (ChargeableItemChargeContext, optional)
-
senderInfo (SenderContext, optional)
- jobId (Integer22, optional)
-
chargingOutputContext (ChargingOutputContext, optional)
- chargeableItemExported (boolean, optional, default: "true")
- itemImmediatelyLoaded (boolean, optional, default: "false")
-
chargingResultContext (ChargingResultContext, optional)
- chargingProcessInfoReturned (boolean, optional, default: "false")
- chargingContractInfoReturned (boolean, optional, default: "false")
- chargeableItemInfoReturned (boolean, optional, default: "false")
- accountOperationReturned (boolean, optional, default: "false")
- accountInfoReturned (boolean, optional, default: "false")
- chargedItemReturned (boolean, optional, default: "false")
- notificationReturned (boolean, optional, default: "false")
-
chargingResultOnErrorContext (ChargingResultOnErrorContext, optional)
- notificationReturned (boolean, optional, default: "false")
-
senderInfo (SenderContext, optional)
-
chargeableItemCheckChargeRequest
...
(ChargeableItemCheckChargeRequest, optional, multiple (max: 1000))
-
context (ChargeableItemChargeContext, optional)
-
senderInfo (SenderContext, optional)
- jobId (Integer22, optional)
-
chargingOutputContext (ChargingOutputContext, optional)
- chargeableItemExported (boolean, optional, default: "true")
- itemImmediatelyLoaded (boolean, optional, default: "false")
-
chargingResultContext (ChargingResultContext, optional)
- chargingProcessInfoReturned (boolean, optional, default: "false")
- chargingContractInfoReturned (boolean, optional, default: "false")
- chargeableItemInfoReturned (boolean, optional, default: "false")
- accountOperationReturned (boolean, optional, default: "false")
- accountInfoReturned (boolean, optional, default: "false")
- chargedItemReturned (boolean, optional, default: "false")
- notificationReturned (boolean, optional, default: "false")
-
chargingResultOnErrorContext (ChargingResultOnErrorContext, optional)
- notificationReturned (boolean, optional, default: "false")
-
senderInfo (SenderContext, optional)
-
chargeableItem (ChargeableItem)
- name (NotEmptyString256)
-
uid (StringUniqueIdentifier, optional)
- @type (NotEmptyString256)
- userTechnicalId (NotEmptyString256)
- serviceId (NotEmptyString256)
- consumptionDate (Date)
- userProperties (ChargeableItemUserProperties)
-
context (ChargeableItemChargeContext, optional)
Message Type: chargeableItemCheckChargeMassResponse
Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.
Structure
The chargeableItemCheckChargeMassResponse message type is structured as follows:
- status (ResponseStatus, {return | error})
- message (string, optional)
-
error (Failure, optional)
- category (FailureCategory, {illegalState | invalid | invalidConfiguration | prerequisiteMissing | temporaryIllegalSystemState | illegalSystemState})
- message (string, optional)
-
cause (FailureCause, optional)Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
- module (string)
- code (int)
- message (string)
-
causedBy
...
(FailureCause, optional, multiple)
- module (string)
- code (int)
- message (string)
-
chargeableItemCheckChargeResponse
...
(ChargeableItemCheckChargeResponse, optional, multiple)
- status (ResponseStatus, {return | error})
- message (string, optional)
-
result (ChargingResult, optional)
-
chargingProcessInfo (ChargingProcessInfo, optional)
-
chargedItemSetUniqueId (IntegerUniqueIdentifier)
- @type (NotEmptyString256)
- eventProcessingDate (Date)
-
chargedItemSetUniqueId (IntegerUniqueIdentifier)
-
chargingContractInfo (ChargingContractInfo, optional)
- subscriberAccountId (NotEmptyString256)
- chargingContractId (NotEmptyString256)
- chargingContractItemId (String256)
-
chargeableItemInfo (ChargeableItemInfo, optional)
-
uid (StringUniqueIdentifier)
- @type (NotEmptyString256)
-
uid (StringUniqueIdentifier)
-
accountOperation
...
(AccountOperation, optional, multiple)
- type (AccountOperationType, {debit | credit})
-
amount (Amount, optional)
- @currencyCode (CurrencyCode)
-
netAmount (Amount, optional)
- @currencyCode (CurrencyCode)
-
taxAmount (Amount, optional)
- @currencyCode (CurrencyCode)
-
mainAccountReference (AccountReference, optional)
- type (AccountReferenceType, {external | prepaid})
- id (String256)
-
amountAssignment
...
(AmountAssignment, optional, multiple)
-
amount (Amount)
- @currencyCode (CurrencyCode)
-
accountReference (AccountReference)
- type (AccountReferenceType, {external | prepaid})
- id (String256)
- chargedItemKey (int, optional)
-
amount (Amount)
- key (int)
- dependentAccountOperationKey (int, optional)
- externalAccountInfo ... (ExternalAccountInfo, optional, multiple)
-
prepaidAccountInfo
...
(PrepaidAccountInfo, optional, multiple)
- id (String256)
-
balance (Amount)
- @currencyCode (CurrencyCode)
-
stateSchedule (StateSchedule)
-
item
...
(StateScheduleItem, optional, multiple)
- stateCode (StateScheduleItemCode, {blocked | locked | closed})
- fromDate (Date)
-
item
...
(StateScheduleItem, optional, multiple)
- chargedItem ... (ChargedItem, optional, multiple)
- notification ... (Notification, optional, multiple)
-
chargingProcessInfo (ChargingProcessInfo, optional)
-
error (ChargingFailure, optional)
- category (FailureCategory, {illegalState | invalid | invalidConfiguration | prerequisiteMissing | temporaryIllegalSystemState | illegalSystemState})
- message (string, optional)
-
cause (FailureCause, optional)Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
- module (string)
- code (int)
- message (string)
-
causedBy
...
(FailureCause, optional, multiple)
- module (string)
- code (int)
- message (string)
- reason (ChargingFailureReason, optional, {outOfValidityPeriod | notAuthorized | accountBlocked | accountLocked | accountClosed | cannotChargeAccount})
-
chargeableItem (ChargeableItem)
- name (NotEmptyString256)
-
uid (StringUniqueIdentifier, optional)
- @type (NotEmptyString256)
- userTechnicalId (NotEmptyString256)
- serviceId (NotEmptyString256)
- consumptionDate (Date)
- userProperties (ChargeableItemUserProperties)
SearchOrderType
Syntax
This is a restriction of the String256 type.
The possible values are:
- asc
- desc
- noOrder