Technical Details

suacProvisioning

Message Types and Data Types

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

Operation: subscriberAccountRead

The following message types are specified for the subscriberAccountRead operation:

Message Type: subscriberAccountReadRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The subscriberAccountReadRequest message type is structured as follows:

Message Type: subscriberAccountReadResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Implementation Note

This service operation never returns the additionalInfo element.

Structure

The subscriberAccountReadResponse 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)
  • subscriberAccount (SubscriberAccount, optional)

Operation: subscriberAccountReadFully

The following message types are specified for the subscriberAccountReadFully operation:

Message Type: subscriberAccountReadFullyRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The subscriberAccountReadFullyRequest message type is structured as follows:

  • subscriberAccountId (String256)
  • date (Date, optional)
    This date is used by the SAP CC system to compute the current state of the subscriber account. If it is not specified in the operation request, the system considers its current date.

Message Type: subscriberAccountReadFullyResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Implementation Note

This service operation never returns the additionalInfo element.

Structure

The subscriberAccountReadFullyResponse 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)
  • subscriberAccount (SubscriberAccountWithAccounts, optional)
    • id (String256)
    • subscriberId (String256)
    • description (String2000, optional)

    • additionalInfo ... (AdditionalInfo, optional, multiple)
    • externalAccount ... (ExternalAccount, optional, multiple)
    • prepaidAccount ... (PrepaidAccount, optional, multiple)
      • 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)
      • amountAlert ... (AmountAlert, optional, multiple)
      • stateChangeAlert ... (StateChangeAlert, optional, multiple)

Operation: subscriberAccountFind

The following message types are specified for the subscriberAccountFind operation:

Message Type: subscriberAccountFindRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Implementation Note

Available since version 4.0 SP05

Structure

The subscriberAccountFindRequest message type is structured as follows:

  • subscriberAccountSearchFilter (SubscriberAccountSearchFilter)
    Search for every subscriber account that matches all the criteria described in the filter.
    • searchWindow (SearchFilterWindow, optional)
      The settings to enable reference-based pagination of search results in response. Several operation requests are necessary to retrieve the complete results.
      • windowSize (int, optional)
        The maximum number of results expected in the operation response. The SAP CC system returns a subset of the matching result set.
      • fromUniqueId (String256, optional)
        The reference to start pagination from. When omitted in the first search operation request, the beginning of the result set is returned by the SAP CC system. When set in an operation request, it must be equal to the lastUniqueId element in the previous operation response.
    • totalCountRequired (boolean, optional, default: "false")
      Tells the server to indicate the number of unreturned items in the response (the items included in the response itself are not included in the count).
    • id (StringAttributeDescription, optional)
      Use this element to find an account by its name (which is unique across the system).

    • additionalInfo ... (AdditionalAttributeDescription, optional, multiple)
      Each such element instructs the web service to search only subscriber accounts which have the specified value for the given additional information field.
      • name (String256)

        • pattern (String256)
        • stringEnumeration (StringEnumeration)
        • numberEnumeration (NumberEnumeration)
        • dateEnumeration (DateEnumeration)
          • value ... (Date, multiple)
        • numberRange (NumberRange)
          • min (NumberBoundary)
            • @included (boolean, default: "true")
          • max (NumberBoundary)
            • @included (boolean, default: "true")
        • dateRange (DateRange)
          • min (DateBoundary)
            • @included (boolean, default: "true")
          • max (DateBoundary)
            • @included (boolean, default: "true")

Message Type: subscriberAccountFindResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The subscriberAccountFindResponse 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.
  • subscriberAccount ... (SubscriberAccount, optional, multiple)

Operation: subscriberAccountMaintain

The following message types are specified for the subscriberAccountMaintain operation:

Message Type: subscriberAccountMaintainRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The subscriberAccountMaintainRequest message type is structured as follows:

Message Type: subscriberAccountMaintainResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The subscriberAccountMaintainResponse 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)
  • subscriberAccountId (String256, optional)
  • subscriberAccountReference (String256, optional)

Operation: subscriberAccountCancel

The following message types are specified for the subscriberAccountCancel operation:

Message Type: subscriberAccountCancelRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The subscriberAccountCancelRequest message type is structured as follows:

Message Type: subscriberAccountCancelResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The subscriberAccountCancelResponse 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)
  • subscriberAccountId (String256, optional)
  • subscriberAccountReference (String256, optional)

Operation: externalAccountMaintain

The following message types are specified for the externalAccountMaintain operation:

Message Type: externalAccountMaintainRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The externalAccountMaintainRequest message type is structured as follows:

Message Type: externalAccountMaintainResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The externalAccountMaintainResponse 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)
  • externalAccountReference (ExternalAccountReference, optional)
    • subscriberAccountId (String256)
      The name of the subscriber account that contains the targeted external account
    • externalAccountId (String256)
      The name of the targeted external account, within the subscriber account identified by "subscriberAccountId"
    • additionalId (String256, optional)
      This field used to reference an account in an external system. For example, it is used by SAP ERP FICA to store the GPART identifier.

Operation: externalAccountCancel

The following message types are specified for the externalAccountCancel operation:

Message Type: externalAccountCancelRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The externalAccountCancelRequest message type is structured as follows:

  • externalAccountReference (ExternalAccountReference)
    • subscriberAccountId (String256)
      The name of the subscriber account that contains the targeted external account
    • externalAccountId (String256)
      The name of the targeted external account, within the subscriber account identified by "subscriberAccountId"
    • additionalId (String256, optional)
      This field used to reference an account in an external system. For example, it is used by SAP ERP FICA to store the GPART identifier.

Message Type: externalAccountCancelResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The externalAccountCancelResponse 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)
  • externalAccountReference (ExternalAccountReference, optional)
    • subscriberAccountId (String256)
      The name of the subscriber account that contains the targeted external account
    • externalAccountId (String256)
      The name of the targeted external account, within the subscriber account identified by "subscriberAccountId"
    • additionalId (String256, optional)
      This field used to reference an account in an external system. For example, it is used by SAP ERP FICA to store the GPART identifier.

Operation: externalAccountRead

The following message types are specified for the externalAccountRead operation:

Message Type: externalAccountReadRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Implementation Note

Fetches an external account reference (identified by "externalAccountId") within the given subscriber account.

Structure

The externalAccountReadRequest message type is structured as follows:

  • externalAccountReference (ExternalAccountReference)
    • subscriberAccountId (String256)
      The name of the subscriber account that contains the targeted external account
    • externalAccountId (String256)
      The name of the targeted external account, within the subscriber account identified by "subscriberAccountId"
    • additionalId (String256, optional)
      This field used to reference an account in an external system. For example, it is used by SAP ERP FICA to store the GPART identifier.

Message Type: externalAccountReadResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The externalAccountReadResponse 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)
  • externalAccount (ExternalAccount, optional)

Operation: prepaidAccountMaintain

The following message types are specified for the prepaidAccountMaintain operation:

Message Type: prepaidAccountMaintainRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The prepaidAccountMaintainRequest message type is structured as follows:

  • 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)
    • amountAlert ... (AmountAlert, optional, multiple)
    • stateChangeAlert ... (StateChangeAlert, optional, multiple)

Message Type: prepaidAccountMaintainResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The prepaidAccountMaintainResponse 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)
  • prepaidAccountReference (PrepaidAccountReference, optional)

Operation: prepaidAccountCancel

The following message types are specified for the prepaidAccountCancel operation:

Message Type: prepaidAccountCancelRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The prepaidAccountCancelRequest message type is structured as follows:

  • prepaidAccountReference (PrepaidAccountReference)

Message Type: prepaidAccountCancelResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The prepaidAccountCancelResponse 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)
  • prepaidAccountReference (PrepaidAccountReference, optional)

Operation: prepaidAccountRead

The following message types are specified for the prepaidAccountRead operation:

Message Type: prepaidAccountReadRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The prepaidAccountReadRequest message type is structured as follows:

  • prepaidAccountReference (PrepaidAccountReference)
  • date (Date, optional)
    This date is used by the SAP CC system to compute the current state of the prepaid account. If it is not specified in the operation request, the system considers its current date.

Message Type: prepaidAccountReadResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The prepaidAccountReadResponse 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)
  • prepaidAccount (PrepaidAccount, optional)
    • 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)
    • amountAlert ... (AmountAlert, optional, multiple)
    • stateChangeAlert ... (StateChangeAlert, optional, multiple)

Operation: prepaidAccountStateChange

The following message types are specified for the prepaidAccountStateChange operation:

Message Type: prepaidAccountStateChangeRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Implementation Note

Deprecated since version 4.0; Use the service operations available in the process component: Prepaid Account State Management.

Structure

The prepaidAccountStateChangeRequest message type is structured as follows:

  • prepaidAccountReference (PrepaidAccountReference)
  • stateCode (PrepaidAccountState, {active | blocked | locked | closed})
  • fromDate (Date, optional)
    If the fromDate is not specifiedd, the SAP CC system removes the specified state change from the state schedule currently set.

Message Type: prepaidAccountStateChangeResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The prepaidAccountStateChangeResponse 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)
  • prepaidAccountReference (PrepaidAccountReference, optional)

Operation: subscriberAccountMaintainMass

The following message types are specified for the subscriberAccountMaintainMass operation:

Message Type: subscriberAccountMaintainMassRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The subscriberAccountMaintainMassRequest message type is structured as follows:

  • subscriberAccountMaintainRequest ... (subscriberAccountMaintainRequest, multiple (max: 1000))

Message Type: subscriberAccountMaintainMassResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The subscriberAccountMaintainMassResponse 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)
  • failures (Integer, optional)
    The number of erroneous single operations due to a business error. Check the error stack (category, message, cause).
  • subscriberAccountMaintainResponse ... (subscriberAccountMaintainResponse, multiple (max: 1000))

Operation: subscriberAccountMaintainBundle

The following message types are specified for the subscriberAccountMaintainBundle operation:

Message Type: subscriberAccountMaintainBundleRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The subscriberAccountMaintainBundleRequest message type is structured as follows:

  • subscriberAccountMaintainRequest ... (subscriberAccountMaintainRequest, multiple (max: 1000))

Message Type: subscriberAccountMaintainBundleResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The subscriberAccountMaintainBundleResponse 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)
  • subscriberAccountMaintainResponse ... (subscriberAccountMaintainResponse, multiple (max: 1000))

Operation: prepaidAccountMaintainMass

The following message types are specified for the prepaidAccountMaintainMass operation:

Message Type: prepaidAccountMaintainMassRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The prepaidAccountMaintainMassRequest message type is structured as follows:

  • prepaidAccountMaintainRequest ... (prepaidAccountMaintainRequest, multiple (max: 1000))

Message Type: prepaidAccountMaintainMassResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The prepaidAccountMaintainMassResponse 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)
  • failures (Integer, optional)
    The number of erroneous single operations due to a business error. Check the error stack (category, message, cause).
  • prepaidAccountMaintainResponse ... (prepaidAccountMaintainResponse, multiple (max: 1000))

Operation: prepaidAccountMaintainBundle

The following message types are specified for the prepaidAccountMaintainBundle operation:

Message Type: prepaidAccountMaintainBundleRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The prepaidAccountMaintainBundleRequest message type is structured as follows:

  • prepaidAccountMaintainRequest ... (prepaidAccountMaintainRequest, multiple (max: 1000))

Message Type: prepaidAccountMaintainBundleResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The prepaidAccountMaintainBundleResponse 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)
  • prepaidAccountMaintainResponse ... (prepaidAccountMaintainResponse, multiple (max: 1000))

Operation: externalAccountMaintainMass

The following message types are specified for the externalAccountMaintainMass operation:

Message Type: externalAccountMaintainMassRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The externalAccountMaintainMassRequest message type is structured as follows:

  • externalAccountMaintainRequest ... (externalAccountMaintainRequest, multiple (max: 1000))

Message Type: externalAccountMaintainMassResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The externalAccountMaintainMassResponse 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)
  • failures (Integer, optional)
    The number of erroneous single operations due to a business error. Check the error stack (category, message, cause).
  • externalAccountMaintainResponse ... (externalAccountMaintainResponse, multiple (max: 1000))

Operation: externalAccountMaintainBundle

The following message types are specified for the externalAccountMaintainBundle operation:

Message Type: externalAccountMaintainBundleRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The externalAccountMaintainBundleRequest message type is structured as follows:

  • externalAccountMaintainRequest ... (externalAccountMaintainRequest, multiple (max: 1000))

Message Type: externalAccountMaintainBundleResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The externalAccountMaintainBundleResponse 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)
  • externalAccountMaintainResponse ... (externalAccountMaintainResponse, multiple (max: 1000))

Simple Types

The message types use the following simple types:

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
SearchFilterType

Syntax

This is a restriction of the string type.

The possible values are:

  • boolean
  • number
  • string
  • date
Decimal

Syntax

This is a restriction of the decimal type.

  • maxInclusive: 9999999999999999999999.999999
  • minInclusive: -9999999999999999999999.999999
  • totalDigits: 28
  • fractionDigits: 6
Long

Syntax

This is a restriction of the long type.

  • maxInclusive: 9223372036854775807
  • minInclusive: 0
Integer

Syntax

This is a restriction of the int type.

  • maxInclusive: 2147483647
  • minInclusive: 0
Integer22

Syntax

This is a restriction of the decimal type.

  • totalDigits: 22
  • fractionDigits: 0
PositiveDecimal

Syntax

This is a restriction of the Decimal type.

  • minInclusive: 0
CurrencyCode

Syntax

This is a restriction of the string type.

  • maxLength: 5
String256

Syntax

This is a restriction of the string type.

  • maxLength: 256
NotEmptyString256

Syntax

This is a restriction of the string type.

  • minLength: 1
  • maxLength: 256
String2000

Syntax

This is a restriction of the string type.

  • maxLength: 2000
Date

Syntax

This is a restriction of the dateTime type.

  • pattern: [0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}
CountryCode

Syntax

This is a restriction of the string type.

  • length: 2
Empty

Syntax

This is a restriction of the string type.

  • length: 0
TableScope

Syntax

This is a restriction of the string type.

The possible values are:

  • agreement
  • both
  • catalog
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
EZTaxString

Syntax

This is a restriction of the string type.

  • maxLength: 10
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
Copyright© 2022 SAP SE or an SAP affiliate company. All rights reserved.