refilling
Service Operations (Technical Names)
This process component provides the following service operations:
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 (refilling) 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: prepaidAccountRefillRequest
Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.
Structure
The prepaidAccountRefillRequest message type is structured as follows:
- refillUid (String256)
- subscriberAccountId (String256)
- prepaidAccountId (String256)
- date (Date, optional)
-
amount (Amount)
- @currencyCode (CurrencyCode)
-
refillItem (RefillItem)
- usageId (String256)
-
property
...
(Property, optional, multiple)
- @type (PropertyType, required, {string | number | date})
- @value (String256)
- @name (String256, required)
Message Type: prepaidAccountRefillResponse
Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.
Structure
The prepaidAccountRefillResponse message type is structured as follows:
- status (ResponseStatus, {return | error | inProgress})
-
message (string, optional)Additional message to describe the error or report a warning, in case of success.
-
error (Failure, optional)
- category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
- 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)
Message Type: prepaidAccountFindFromUserTechnicalIdentifierRequest
Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.
Message Type: prepaidAccountFindFromUserTechnicalIdentifierResponse
Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.
Structure
The prepaidAccountFindFromUserTechnicalIdentifierResponse message type is structured as follows:
- status (ResponseStatus, {return | error | inProgress})
-
message (string, optional)Additional message to describe the error or report a warning, in case of success.
-
error (Failure, optional)
- category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
- 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)
-
totalCount (int, optional)The number of remaining objects in the set after the current page found by the SAP CC system. This includes the number of objects in the current set.
-
lastUniqueId (String256, optional)The reference of the last element in case of pagination. Set up the fromUniqueId element in the next search operation request with this reference value.
-
prepaidAccountFindFromUserTechnicalIdentifierResultItem
...
(PrepaidAccountFindFromUserTechnicalIdentifierResponseItem, optional, multiple)
- userTechnicalIdentifier (String256)
- serviceIdentifier (String256)
- date (Date)
-
prepaidAccount (PrepaidAccount)
- id (String256)
- subscriberAccountId (String256)
- description (String2000, optional)
- currencyCode (CurrencyCode)
-
emptyLimit (Decimal, optional, default: "0")Conditional. If not specified, the empty limit of the prepaid account is set to 0.
-
balance (Decimal, optional)The balance of the prepaid account is only readable. Do not specify a balance amount for the create or change operation requests.
- currentState (PrepaidAccountState, optional, {active | blocked | locked | closed})
-
stateSchedule (StateSchedule)
-
item
...
(StateScheduleItem, optional, multiple)
- stateCode (PrepaidAccountStateSchedule, {blocked | locked | closed})
- fromDate (Date)
-
item
...
(StateScheduleItem, optional, multiple)
- amountAlert ... (AmountAlert, optional, multiple)
-
stateChangeAlert
...
(StateChangeAlert, optional, multiple)
- alertCode (String256)
- dayCount (int, optional, default: "0")
- toStateCode (PrepaidAccountState, {active | blocked | locked | closed})
Simple Types
The message types use the following simple types:
- PropertyType
- ResponseStatus
- FailureCategory
- SearchOrderType
- SearchFilterType
- Decimal
- Long
- Integer
- Integer22
- PositiveDecimal
- CurrencyCode
- String256
- NotEmptyString256
- String2000
- Date
- CountryCode
- Empty
- TableScope
- PrepaidAccountStateSchedule
- PrepaidAccountState
- AccountTaxationMode
- VATBusinessCategory
- EZTaxString
- EZTaxCustomerType
- EZTaxIncorporatedCode
- EZTaxClientResale
PropertyType
Syntax
This is a restriction of the String256 type.
The possible values are:
- string
- number
- date
ResponseStatus
Syntax
This is a restriction of the String256 type.
The possible values are:
- return
- error
- inProgress
FailureCategory
Syntax
This is a restriction of the String256 type.
The possible values are:
- alreadyExists
- doesNotExist
- invalid
- prerequisiteMissing
- incompatibleConfiguration
- illegalState
- temporaryIllegalState
SearchOrderType
Syntax
This is a restriction of the String256 type.
The possible values are:
- asc
- desc
- noOrder
PrepaidAccountStateSchedule
Syntax
This is a restriction of the String256 type.
The possible values are:
- blocked
- locked
- closed
PrepaidAccountState
Syntax
This is a restriction of the String256 type.
The possible values are:
- active
- blocked
- locked
- closed
AccountTaxationMode
Syntax
This is a restriction of the String256 type.
The possible values are:
- vendorSubjectToPay
- buyerSubjectToPay
- buyerExempted
- noTax
VATBusinessCategory
Syntax
This is a restriction of the String256 type.
The possible values are:
- B2B
- B2C
EZTaxCustomerType
Syntax
This is a restriction of the String256 type.
The possible values are:
- business
- industrial
- residentialCustomer
- seniorCitizen
EZTaxIncorporatedCode
Syntax
This is a restriction of the String256 type.
The possible values are:
- inside
- outside
EZTaxClientResale
Syntax
This is a restriction of the String256 type.
The possible values are:
- resale
- sale