SAP DOCUMENTATION
SAP CC 3.0 Web Services | Data Models | Service Endpoints | Safe Operations | Security | System Configuration

suacProvisioning

Message Types and Data Types

Service Operations (Technical Names)

This process component provides the following service operations:

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.

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
    • 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
    • Restricted enumeration

Important Note (*)

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

subscriberAccountRead

Service Operation

Message Types

The following message types are specified for the subscriberAccountRead operation:

subscriberAccountReadRequest

message type

Structure

The subscriberAccountReadRequest message type is structured as follows:

  • subscriberAccountId (String256)

subscriberAccountReadResponse

message type

Structure

The subscriberAccountReadResponse message type is structured as follows:

  • subscriberAccount (SubscriberAccount, optional)
    • id (String256)
    • subscriberId (String256)
    • description (String2000, optional)
      • noTax (Empty)
      • tax (TaxInfo)
        • mode (AccountTaxationMode, {vendorSubjectToPay|buyerSubjectToPay|buyerExempted|noTax})
          • vat (TaxInfoVAT)
            • taxCode (String256)
            • customerCountryCode (CountryCode, optional)
            • businessCategory (VATBusinessCategory, optional, {B2B|B2C})
          • ezTax (TaxInfoEZTax)
            • origination (EZTaxString, optional)
            • termination (EZTaxString, optional)
            • serviceAddress (EZTaxString, optional)
            • customerType (EZTaxCustomerType, optional, {business|industrial|residentialCustomer|seniorCitizen})
            • incorporatedCode (EZTaxIncorporatedCode, optional, {inside|outside})
            • clientResale (EZTaxClientResale, optional, {resale|sale})
  • status (ResponseStatus, {return|error})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists|doesNotExist|invalid|prerequisiteMissing|incompatibleConfiguration|illegalState|temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      • module (string)
      • code (int)
      • message (string)
    • causedBy (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)

subscriberAccountReadFully

Service Operation

Message Types

The following message types are specified for the subscriberAccountReadFully operation:

subscriberAccountReadFullyRequest

message type

Structure

The subscriberAccountReadFullyRequest message type is structured as follows:

  • subscriberAccountId (String256)
  • date (Date, optional)

subscriberAccountReadFullyResponse

message type

Structure

The subscriberAccountReadFullyResponse message type is structured as follows:

  • subscriberAccount (SubscriberAccountWithAccounts, optional)
    • externalAccount (ExternalAccount, optional, multiple)
      • id (String256)
      • subscriberAccountId (String256)
      • description (String2000, optional)
      • additionalId (String256, optional)
      • currencyCode (CurrencyCode, optional)
      • externalSystemCode (String256, optional)
    • prepaidAccount (PrepaidAccount, optional, multiple)
      • id (String256)
      • subscriberAccountId (String256)
      • description (String2000, optional)
      • currencyCode (CurrencyCode)
      • emptyLimit (Decimal28_6, optional)
      • balance (Decimal28_6, optional)
      • currentState (PrepaidAccountState, optional, {active|blocked|locked|closed})
      • stateSchedule (StateSchedule)
        • item (StateScheduleItem, optional, multiple)
          • stateCode (PrepaidAccountStateSchedule, {blocked|locked|closed})
          • fromDate (Date)
      • amountAlert (AmountAlert, optional, multiple)
        • alertCode (String256)
        • amountThreshold (Decimal28_6)
      • stateChangeAlert (StateChangeAlert, optional, multiple)
        • alertCode (String256)
        • dayCount (int, optional)
        • toStateCode (PrepaidAccountState, {active|blocked|locked|closed})
    • id (String256)
    • subscriberId (String256)
    • description (String2000, optional)
      • noTax (Empty)
      • tax (TaxInfo)
        • mode (AccountTaxationMode, {vendorSubjectToPay|buyerSubjectToPay|buyerExempted|noTax})
          • vat (TaxInfoVAT)
            • taxCode (String256)
            • customerCountryCode (CountryCode, optional)
            • businessCategory (VATBusinessCategory, optional, {B2B|B2C})
          • ezTax (TaxInfoEZTax)
            • origination (EZTaxString, optional)
            • termination (EZTaxString, optional)
            • serviceAddress (EZTaxString, optional)
            • customerType (EZTaxCustomerType, optional, {business|industrial|residentialCustomer|seniorCitizen})
            • incorporatedCode (EZTaxIncorporatedCode, optional, {inside|outside})
            • clientResale (EZTaxClientResale, optional, {resale|sale})
  • status (ResponseStatus, {return|error})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists|doesNotExist|invalid|prerequisiteMissing|incompatibleConfiguration|illegalState|temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      • module (string)
      • code (int)
      • message (string)
    • causedBy (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)

subscriberAccountMaintain

Service Operation

Message Types

The following message types are specified for the subscriberAccountMaintain operation:

subscriberAccountMaintainRequest

message type

Structure

The subscriberAccountMaintainRequest message type is structured as follows:

  • subscriberAccount (SubscriberAccount)
    • id (String256)
    • subscriberId (String256)
    • description (String2000, optional)
      • noTax (Empty)
      • tax (TaxInfo)
        • mode (AccountTaxationMode, {vendorSubjectToPay|buyerSubjectToPay|buyerExempted|noTax})
          • vat (TaxInfoVAT)
            • taxCode (String256)
            • customerCountryCode (CountryCode, optional)
            • businessCategory (VATBusinessCategory, optional, {B2B|B2C})
          • ezTax (TaxInfoEZTax)
            • origination (EZTaxString, optional)
            • termination (EZTaxString, optional)
            • serviceAddress (EZTaxString, optional)
            • customerType (EZTaxCustomerType, optional, {business|industrial|residentialCustomer|seniorCitizen})
            • incorporatedCode (EZTaxIncorporatedCode, optional, {inside|outside})
            • clientResale (EZTaxClientResale, optional, {resale|sale})

subscriberAccountMaintainResponse

message type

Structure

The subscriberAccountMaintainResponse message type is structured as follows:

  • subscriberAccountId (String256, optional)
  • subscriberAccountReference (String256, optional)
  • status (ResponseStatus, {return|error})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists|doesNotExist|invalid|prerequisiteMissing|incompatibleConfiguration|illegalState|temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      • module (string)
      • code (int)
      • message (string)
    • causedBy (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)

subscriberAccountCancel

Service Operation

Message Types

The following message types are specified for the subscriberAccountCancel operation:

subscriberAccountCancelRequest

message type

Structure

The subscriberAccountCancelRequest message type is structured as follows:

  • subscriberAccountId (String256)

subscriberAccountCancelResponse

message type

Structure

The subscriberAccountCancelResponse message type is structured as follows:

  • subscriberAccountId (String256, optional)
  • subscriberAccountReference (String256, optional)
  • status (ResponseStatus, {return|error})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists|doesNotExist|invalid|prerequisiteMissing|incompatibleConfiguration|illegalState|temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      • module (string)
      • code (int)
      • message (string)
    • causedBy (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)

externalAccountMaintain

Service Operation

Message Types

The following message types are specified for the externalAccountMaintain operation:

externalAccountMaintainRequest

message type

Structure

The externalAccountMaintainRequest message type is structured as follows:

  • externalAccount (ExternalAccount)
    • id (String256)
    • subscriberAccountId (String256)
    • description (String2000, optional)
    • additionalId (String256, optional)
    • currencyCode (CurrencyCode, optional)
    • externalSystemCode (String256, optional)

externalAccountMaintainResponse

message type

Structure

The externalAccountMaintainResponse message type is structured as follows:

  • externalAccountReference (ExternalAccountReference, optional)
    • subscriberAccountId (String256)
    • externalAccountId (String256)
    • additionalId (String256, optional)
  • status (ResponseStatus, {return|error})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists|doesNotExist|invalid|prerequisiteMissing|incompatibleConfiguration|illegalState|temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      • module (string)
      • code (int)
      • message (string)
    • causedBy (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)

externalAccountCancel

Service Operation

Message Types

The following message types are specified for the externalAccountCancel operation:

externalAccountCancelRequest

message type

Structure

The externalAccountCancelRequest message type is structured as follows:

  • externalAccountReference (ExternalAccountReference)
    • subscriberAccountId (String256)
    • externalAccountId (String256)
    • additionalId (String256, optional)

externalAccountCancelResponse

message type

Structure

The externalAccountCancelResponse message type is structured as follows:

  • externalAccountReference (ExternalAccountReference, optional)
    • subscriberAccountId (String256)
    • externalAccountId (String256)
    • additionalId (String256, optional)
  • status (ResponseStatus, {return|error})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists|doesNotExist|invalid|prerequisiteMissing|incompatibleConfiguration|illegalState|temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      • module (string)
      • code (int)
      • message (string)
    • causedBy (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)

externalAccountRead

Service Operation

Message Types

The following message types are specified for the externalAccountRead operation:

externalAccountReadRequest

message type

Structure

The externalAccountReadRequest message type is structured as follows:

  • externalAccountReference (ExternalAccountReference)
    • subscriberAccountId (String256)
    • externalAccountId (String256)
    • additionalId (String256, optional)

externalAccountReadResponse

message type

Structure

The externalAccountReadResponse message type is structured as follows:

  • externalAccount (ExternalAccount, optional)
    • id (String256)
    • subscriberAccountId (String256)
    • description (String2000, optional)
    • additionalId (String256, optional)
    • currencyCode (CurrencyCode, optional)
    • externalSystemCode (String256, optional)
  • status (ResponseStatus, {return|error})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists|doesNotExist|invalid|prerequisiteMissing|incompatibleConfiguration|illegalState|temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      • module (string)
      • code (int)
      • message (string)
    • causedBy (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)

prepaidAccountMaintain

Service Operation

Message Types

The following message types are specified for the prepaidAccountMaintain operation:

prepaidAccountMaintainRequest

message type

Structure

The prepaidAccountMaintainRequest message type is structured as follows:

  • prepaidAccount (PrepaidAccount)
    • id (String256)
    • subscriberAccountId (String256)
    • description (String2000, optional)
    • currencyCode (CurrencyCode)
    • emptyLimit (Decimal28_6, optional)
    • balance (Decimal28_6, optional)
    • currentState (PrepaidAccountState, optional, {active|blocked|locked|closed})
    • stateSchedule (StateSchedule)
      • item (StateScheduleItem, optional, multiple)
        • stateCode (PrepaidAccountStateSchedule, {blocked|locked|closed})
        • fromDate (Date)
    • amountAlert (AmountAlert, optional, multiple)
      • alertCode (String256)
      • amountThreshold (Decimal28_6)
    • stateChangeAlert (StateChangeAlert, optional, multiple)
      • alertCode (String256)
      • dayCount (int, optional)
      • toStateCode (PrepaidAccountState, {active|blocked|locked|closed})

prepaidAccountMaintainResponse

message type

Structure

The prepaidAccountMaintainResponse message type is structured as follows:

  • prepaidAccountReference (PrepaidAccountReference, optional)
    • subscriberAccountId (String256)
    • prepaidAccountId (String256)
  • status (ResponseStatus, {return|error})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists|doesNotExist|invalid|prerequisiteMissing|incompatibleConfiguration|illegalState|temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      • module (string)
      • code (int)
      • message (string)
    • causedBy (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)

prepaidAccountCancel

Service Operation

Message Types

The following message types are specified for the prepaidAccountCancel operation:

prepaidAccountCancelRequest

message type

Structure

The prepaidAccountCancelRequest message type is structured as follows:

  • prepaidAccountReference (PrepaidAccountReference)
    • subscriberAccountId (String256)
    • prepaidAccountId (String256)

prepaidAccountCancelResponse

message type

Structure

The prepaidAccountCancelResponse message type is structured as follows:

  • prepaidAccountReference (PrepaidAccountReference, optional)
    • subscriberAccountId (String256)
    • prepaidAccountId (String256)
  • status (ResponseStatus, {return|error})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists|doesNotExist|invalid|prerequisiteMissing|incompatibleConfiguration|illegalState|temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      • module (string)
      • code (int)
      • message (string)
    • causedBy (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)

prepaidAccountRead

Service Operation

Message Types

The following message types are specified for the prepaidAccountRead operation:

prepaidAccountReadRequest

message type

Structure

The prepaidAccountReadRequest message type is structured as follows:

  • prepaidAccountReference (PrepaidAccountReference)
    • subscriberAccountId (String256)
    • prepaidAccountId (String256)
  • date (Date, optional)

prepaidAccountReadResponse

message type

Structure

The prepaidAccountReadResponse message type is structured as follows:

  • prepaidAccount (PrepaidAccount, optional)
    • id (String256)
    • subscriberAccountId (String256)
    • description (String2000, optional)
    • currencyCode (CurrencyCode)
    • emptyLimit (Decimal28_6, optional)
    • balance (Decimal28_6, optional)
    • currentState (PrepaidAccountState, optional, {active|blocked|locked|closed})
    • stateSchedule (StateSchedule)
      • item (StateScheduleItem, optional, multiple)
        • stateCode (PrepaidAccountStateSchedule, {blocked|locked|closed})
        • fromDate (Date)
    • amountAlert (AmountAlert, optional, multiple)
      • alertCode (String256)
      • amountThreshold (Decimal28_6)
    • stateChangeAlert (StateChangeAlert, optional, multiple)
      • alertCode (String256)
      • dayCount (int, optional)
      • toStateCode (PrepaidAccountState, {active|blocked|locked|closed})
  • status (ResponseStatus, {return|error})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists|doesNotExist|invalid|prerequisiteMissing|incompatibleConfiguration|illegalState|temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      • module (string)
      • code (int)
      • message (string)
    • causedBy (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)

prepaidAccountStateChange

Service Operation

Message Types

The following message types are specified for the prepaidAccountStateChange operation:

prepaidAccountStateChangeRequest

message type

Structure

The prepaidAccountStateChangeRequest message type is structured as follows:

  • prepaidAccountReference (PrepaidAccountReference)
    • subscriberAccountId (String256)
    • prepaidAccountId (String256)
  • stateCode (PrepaidAccountState, {active|blocked|locked|closed})
  • fromDate (Date, optional)

prepaidAccountStateChangeResponse

message type

Structure

The prepaidAccountStateChangeResponse message type is structured as follows:

  • prepaidAccountReference (PrepaidAccountReference, optional)
    • subscriberAccountId (String256)
    • prepaidAccountId (String256)
  • status (ResponseStatus, {return|error})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists|doesNotExist|invalid|prerequisiteMissing|incompatibleConfiguration|illegalState|temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      • module (string)
      • code (int)
      • message (string)
    • causedBy (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)

subscriberAccountMaintainMass

Service Operation

Message Types

The following message types are specified for the subscriberAccountMaintainMass operation:

subscriberAccountMaintainMassRequest

message type

Structure

The subscriberAccountMaintainMassRequest message type is structured as follows:

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

subscriberAccountMaintainMassResponse

message type

Structure

The subscriberAccountMaintainMassResponse message type is structured as follows:

  • subscriberAccountMaintainResponse (subscriberAccountMaintainResponse, multiple (max: 1000))
  • failures (Integer, optional)
  • status (ResponseStatus, {return|error})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists|doesNotExist|invalid|prerequisiteMissing|incompatibleConfiguration|illegalState|temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      • module (string)
      • code (int)
      • message (string)
    • causedBy (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)

subscriberAccountMaintainBundle

Service Operation

Message Types

The following message types are specified for the subscriberAccountMaintainBundle operation:

subscriberAccountMaintainBundleRequest

message type

Structure

The subscriberAccountMaintainBundleRequest message type is structured as follows:

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

subscriberAccountMaintainBundleResponse

message type

Structure

The subscriberAccountMaintainBundleResponse message type is structured as follows:

  • subscriberAccountMaintainResponse (subscriberAccountMaintainResponse, multiple (max: 1000))
  • status (ResponseStatus, {return|error})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists|doesNotExist|invalid|prerequisiteMissing|incompatibleConfiguration|illegalState|temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      • module (string)
      • code (int)
      • message (string)
    • causedBy (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)

prepaidAccountMaintainMass

Service Operation

Message Types

The following message types are specified for the prepaidAccountMaintainMass operation:

prepaidAccountMaintainMassRequest

message type

Structure

The prepaidAccountMaintainMassRequest message type is structured as follows:

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

prepaidAccountMaintainMassResponse

message type

Structure

The prepaidAccountMaintainMassResponse message type is structured as follows:

  • prepaidAccountMaintainResponse (prepaidAccountMaintainResponse, multiple (max: 1000))
  • failures (Integer, optional)
  • status (ResponseStatus, {return|error})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists|doesNotExist|invalid|prerequisiteMissing|incompatibleConfiguration|illegalState|temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      • module (string)
      • code (int)
      • message (string)
    • causedBy (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)

prepaidAccountMaintainBundle

Service Operation

Message Types

The following message types are specified for the prepaidAccountMaintainBundle operation:

prepaidAccountMaintainBundleRequest

message type

Structure

The prepaidAccountMaintainBundleRequest message type is structured as follows:

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

prepaidAccountMaintainBundleResponse

message type

Structure

The prepaidAccountMaintainBundleResponse message type is structured as follows:

  • prepaidAccountMaintainResponse (prepaidAccountMaintainResponse, multiple (max: 1000))
  • status (ResponseStatus, {return|error})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists|doesNotExist|invalid|prerequisiteMissing|incompatibleConfiguration|illegalState|temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      • module (string)
      • code (int)
      • message (string)
    • causedBy (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)

externalAccountMaintainMass

Service Operation

Message Types

The following message types are specified for the externalAccountMaintainMass operation:

externalAccountMaintainMassRequest

message type

Structure

The externalAccountMaintainMassRequest message type is structured as follows:

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

externalAccountMaintainMassResponse

message type

Structure

The externalAccountMaintainMassResponse message type is structured as follows:

  • externalAccountMaintainResponse (externalAccountMaintainResponse, multiple (max: 1000))
  • failures (Integer, optional)
  • status (ResponseStatus, {return|error})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists|doesNotExist|invalid|prerequisiteMissing|incompatibleConfiguration|illegalState|temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      • module (string)
      • code (int)
      • message (string)
    • causedBy (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)

externalAccountMaintainBundle

Service Operation

Message Types

The following message types are specified for the externalAccountMaintainBundle operation:

externalAccountMaintainBundleRequest

message type

Structure

The externalAccountMaintainBundleRequest message type is structured as follows:

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

externalAccountMaintainBundleResponse

message type

Structure

The externalAccountMaintainBundleResponse message type is structured as follows:

  • externalAccountMaintainResponse (externalAccountMaintainResponse, multiple (max: 1000))
  • status (ResponseStatus, {return|error})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists|doesNotExist|invalid|prerequisiteMissing|incompatibleConfiguration|illegalState|temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      • module (string)
      • code (int)
      • message (string)
    • causedBy (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
Copyright© 2011 SAP AG