customerDataExportImport

Service Operations (Technical Names)

This process component provides the following service operations:

customerDataExport
customerDataImport

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

Operation: customerDataExport

The following message types are specified for the customerDataExport operation:

customerDataExportRequest
customerDataExportResponse

Message Type: customerDataExportRequest

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

Structure

The customerDataExportRequest message type is structured as follows:

subscriberAccountId (String256, optional)
If this element is set, the subscriber account and its related data are exported. You have to either provide a subscriberAccountId or a at least one rootChargingContractId.
rootChargingContractId ... (String256, optional, multiple)
If this element is set, the content of exported data is restricted to the specified charging contracts (i.e. this does not include the subscriber account and its related accounts). You have to either provide a subscriberAccountId or a at least one rootChargingContractId.
chargingContractOperationalStatusChangedTo (OperationalStatus, optional, {active | locked | closed})
The status of all exported root charging contracts remains unchanged if no operational status is provided. If an operational status is provided, the operational status of each exported root charging contracts is changed.

Message Type: customerDataExportResponse

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

Structure

The customerDataExportResponse message type is structured as follows:

status (ResponseStatus, {return | error | inProgress})
message (string, optional)
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)
customerData (CustomerData, optional)
- subscriberAccount (SubscriberAccount, optional)
  - id (String256)
  - subscriberId (String256)
  - description (String2000, optional)
  - Only one element among the following ones:
    - noTax (Empty)
    - tax (TaxInfo)
      - mode (AccountTaxationMode, {vendorSubjectToPay | buyerSubjectToPay | buyerExempted | noTax})
      - Only one element among the following ones:
        
        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})
  - additionalInfo ... (AdditionalInfo, optional, multiple)
    - name (String256)
    - description (String2000, optional)
    - Only one element among the following ones:
      - string (String2000)
      - date (Date)
      - number (Decimal28_6)
- 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, default: "0")
    Conditional. If not specified, the empty limit of the prepaid account is set to 0.
  - balance (Decimal28_6, 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)
  - amountAlert ... (AmountAlert, optional, multiple)
    - alertCode (String256)
    - amountThreshold (Decimal28_6)
  - stateChangeAlert ... (StateChangeAlert, optional, multiple)
    - alertCode (String256)
    - dayCount (int, optional, default: "0")
    - toStateCode (PrepaidAccountState, {active | blocked | locked | closed})
  - additionalId (String256, optional)
    Field used to reference an account in an external system. For example, it is used by SAP ERP FICA to store the GPART identifier.
  - externalAccountId (String256, optional)
    Field used to reference an account in an external system. For example, it is used by SAP ERP FICA to store the VKONT identifier.
- mappingTable ... (SubscriberMappingTable, optional, multiple)
  - id (String256)
  - mappingTableClassId (String256)
  - subscriberAccountId (String256)
  - additionalInfo ... (AdditionalInfo, optional, multiple)
    - name (String256)
    - description (String2000, optional)
    - Only one element among the following ones:
      - string (String2000)
      - date (Date)
      - number (Decimal28_6)
  - row ... (MappingTableRow, optional, multiple)
    - id (String256)
    - start (Date)
    - end (Date)
    - column ... (MappingTableColumn, multiple)
      - name (String256)
      - Only one element among the following ones:
        
        string (String2000)
        
        currency (String2000)
        
        number (Decimal28_6)
- rangeTable ... (SubscriberRangeTable, optional, multiple)
  - id (String256)
  - description (String2000)
  - rangeTableClassId (String256)
  - subscriberAccountId (String256)
  - additionalInfo ... (AdditionalInfo, optional, multiple)
    - name (String256)
    - description (String2000, optional)
    - Only one element among the following ones:
      - string (String2000)
      - date (Date)
      - number (Decimal28_6)
  - revisions ... (RangeTableRevision, multiple)
    - validityStartDate (Date, optional)
    - validityEndDate (Date, optional)
    - row ... (RangeTableRow, multiple)
      - Only one element among the following ones:
        
        upperBound (PositiveDecimal28_6)
        
        unbounded (no type, nillable)
      - column ... (RangeTableColumn, multiple (max: 15))
        
        name (String256)
        
        Only one element among the following ones:
        
        string (String2000)
        
        number (Decimal28_6)
- chargingContract ... (ChargingContract, optional, multiple)
  - chargingContractId (String256)
  - revision ... (ChargingContractRevision, multiple)
    - date (Date)
      This date is used to merge this revision into the charging contract. This revision will become effective starting from this date.
    - chargingContractRevision (ChargingContractRevision)
      - ...
  - contractState (ChargingContractState, optional)
    - chargingContractId (NotEmptyString256)
    - counter ... (SharedCounterType, optional, multiple)
      - name (NotEmptyString256)
      - value (Decimal28_6)
      - namespace (String256, optional)
    - chargingContractItemState ... (ChargingContractItemState, optional, multiple)
      - chargingContractItemId (NotEmptyString256)
      - counter ... (CounterType, optional, multiple)
        
        name (NotEmptyString256)
        
        value (Decimal28_6)
      - chargeActivationState ... (ChargeActivationState, optional, multiple)
        
        chargeActivationId (NotEmptyString256)
        
        Only one element among the following ones:
        
        neverActivated (ChargeActivationStatus)
        
        active (ChargeActivationStatusWithLastActivationDate)
        
        lastActivationDate (Date)
        
        suspended (ChargeActivationStatusWithLastActivationDate)
        
        lastActivationDate (Date)
        
        counter ... (CounterType, optional, multiple)
        
        name (NotEmptyString256)
        
        value (Decimal28_6)
  - allowance ... (Allowance, optional, multiple)
    - id (String256)
    - allowancePlanId (String256)
    - parent (AllowanceParent, optional)
      - chargingContractItem (AllowanceChargingContractItem)
        
        id (String256)
        
        externalId (String256, optional)
    - status (AllowanceStatus, {inactive | active | expired})
    - validityPeriod (AllowanceValidityPeriod)
      - start (Date, optional)
      - end (Date, optional)
    - currency (String256)
    - accountAssignment (AllowanceAccountAssignment)
      - accountId (String256)
      - type (AllowanceAccountAssignmentType, {postpaid | prepaid})
    - parameter ... (AllowanceParameter, optional, multiple)
      - name (String256)
      - Only one element among the following ones:
        
        string (String2000)
        
        date (Date)
        
        number (Decimal28_6)
    - counter ... (AllowanceCounter, optional, multiple)
      - name (String256)
      - value (Decimal28_6)

Operation: customerDataImport

The following message types are specified for the customerDataImport operation:

customerDataImportRequest
customerDataImportResponse

Message Type: customerDataImportRequest

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

Structure

The customerDataImportRequest message type is structured as follows:

customerData (CustomerData)
- subscriberAccount (SubscriberAccount, optional)
  - id (String256)
  - subscriberId (String256)
  - description (String2000, optional)
  - Only one element among the following ones:
    - noTax (Empty)
    - tax (TaxInfo)
      - mode (AccountTaxationMode, {vendorSubjectToPay | buyerSubjectToPay | buyerExempted | noTax})
      - Only one element among the following ones:
        
        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})
  - additionalInfo ... (AdditionalInfo, optional, multiple)
    - name (String256)
    - description (String2000, optional)
    - Only one element among the following ones:
      - string (String2000)
      - date (Date)
      - number (Decimal28_6)
- 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, default: "0")
    Conditional. If not specified, the empty limit of the prepaid account is set to 0.
  - balance (Decimal28_6, 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)
  - amountAlert ... (AmountAlert, optional, multiple)
    - alertCode (String256)
    - amountThreshold (Decimal28_6)
  - stateChangeAlert ... (StateChangeAlert, optional, multiple)
    - alertCode (String256)
    - dayCount (int, optional, default: "0")
    - toStateCode (PrepaidAccountState, {active | blocked | locked | closed})
  - additionalId (String256, optional)
    Field used to reference an account in an external system. For example, it is used by SAP ERP FICA to store the GPART identifier.
  - externalAccountId (String256, optional)
    Field used to reference an account in an external system. For example, it is used by SAP ERP FICA to store the VKONT identifier.
- mappingTable ... (SubscriberMappingTable, optional, multiple)
  - id (String256)
  - mappingTableClassId (String256)
  - subscriberAccountId (String256)
  - additionalInfo ... (AdditionalInfo, optional, multiple)
    - name (String256)
    - description (String2000, optional)
    - Only one element among the following ones:
      - string (String2000)
      - date (Date)
      - number (Decimal28_6)
  - row ... (MappingTableRow, optional, multiple)
    - id (String256)
    - start (Date)
    - end (Date)
    - column ... (MappingTableColumn, multiple)
      - name (String256)
      - Only one element among the following ones:
        
        string (String2000)
        
        currency (String2000)
        
        number (Decimal28_6)
- rangeTable ... (SubscriberRangeTable, optional, multiple)
  - id (String256)
  - description (String2000)
  - rangeTableClassId (String256)
  - subscriberAccountId (String256)
  - additionalInfo ... (AdditionalInfo, optional, multiple)
    - name (String256)
    - description (String2000, optional)
    - Only one element among the following ones:
      - string (String2000)
      - date (Date)
      - number (Decimal28_6)
  - revisions ... (RangeTableRevision, multiple)
    - validityStartDate (Date, optional)
    - validityEndDate (Date, optional)
    - row ... (RangeTableRow, multiple)
      - Only one element among the following ones:
        
        upperBound (PositiveDecimal28_6)
        
        unbounded (no type, nillable)
      - column ... (RangeTableColumn, multiple (max: 15))
        
        name (String256)
        
        Only one element among the following ones:
        
        string (String2000)
        
        number (Decimal28_6)
- chargingContract ... (ChargingContract, optional, multiple)
  - chargingContractId (String256)
  - revision ... (ChargingContractRevision, multiple)
    - date (Date)
      This date is used to merge this revision into the charging contract. This revision will become effective starting from this date.
    - chargingContractRevision (ChargingContractRevision)
      - ...
  - contractState (ChargingContractState, optional)
    - chargingContractId (NotEmptyString256)
    - counter ... (SharedCounterType, optional, multiple)
      - name (NotEmptyString256)
      - value (Decimal28_6)
      - namespace (String256, optional)
    - chargingContractItemState ... (ChargingContractItemState, optional, multiple)
      - chargingContractItemId (NotEmptyString256)
      - counter ... (CounterType, optional, multiple)
        
        name (NotEmptyString256)
        
        value (Decimal28_6)
      - chargeActivationState ... (ChargeActivationState, optional, multiple)
        
        chargeActivationId (NotEmptyString256)
        
        Only one element among the following ones:
        
        neverActivated (ChargeActivationStatus)
        
        active (ChargeActivationStatusWithLastActivationDate)
        
        lastActivationDate (Date)
        
        suspended (ChargeActivationStatusWithLastActivationDate)
        
        lastActivationDate (Date)
        
        counter ... (CounterType, optional, multiple)
        
        name (NotEmptyString256)
        
        value (Decimal28_6)
  - allowance ... (Allowance, optional, multiple)
    - id (String256)
    - allowancePlanId (String256)
    - parent (AllowanceParent, optional)
      - chargingContractItem (AllowanceChargingContractItem)
        
        id (String256)
        
        externalId (String256, optional)
    - status (AllowanceStatus, {inactive | active | expired})
    - validityPeriod (AllowanceValidityPeriod)
      - start (Date, optional)
      - end (Date, optional)
    - currency (String256)
    - accountAssignment (AllowanceAccountAssignment)
      - accountId (String256)
      - type (AllowanceAccountAssignmentType, {postpaid | prepaid})
    - parameter ... (AllowanceParameter, optional, multiple)
      - name (String256)
      - Only one element among the following ones:
        
        string (String2000)
        
        date (Date)
        
        number (Decimal28_6)
    - counter ... (AllowanceCounter, optional, multiple)
      - name (String256)
      - value (Decimal28_6)
onAlreadyExistingTable (AlreadyExistingDataResolution, default: "rejectImport", {rejectImport | overwrite})
By default this API does not overwrite table already existing in SAP CC and only creates table that does not already exist. If this element is set to overwrite, this API replaces the one already existing.
chargingContractOperationalStatusChangedTo (OperationalStatus, default: "locked", {active | locked | closed})

Message Type: customerDataImportResponse

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

Structure

The customerDataImportResponse message type is structured as follows:

status (ResponseStatus, {return | error | inProgress})
message (string, optional)
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)
importDataResult ... (CustomerDataImportResult, optional, multiple)
- id (String256)
- type (ImportedDataType, {subscriberAccount | externalAccount | prepaidAccount | mappingTable | rangeTable | chargingContract})
- result (ImportResult, {imported | overwritten})

Simple Types

The message types use the following simple types:

ResponseStatus
FailureCategory
SearchOrderType
SearchFilterType
Decimal28_6
Long
Integer
Integer22
PositiveDecimal28_6
CurrencyCode
String256
NotEmptyString256
String2000
Date
CountryCode
Empty
TableScope
OperationalStatus
AlreadyExistingDataResolution
ImportedDataType
ImportResult
PrepaidAccountStateSchedule
PrepaidAccountState
AccountTaxationMode
VATBusinessCategory
EZTaxString
EZTaxCustomerType
EZTaxIncorporatedCode
EZTaxClientResale
AllowanceStatus
AllowanceAccountAssignmentType
RangeBound
LastRange
ComputationMode
RechargingFeasibilityStatus
AccountOperationType
AccountReferenceType
StateScheduleItemCode
ChargingFailureReason

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

Decimal28_6

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

PositiveDecimal28_6

Syntax

This is a restriction of the Decimal28_6 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

OperationalStatus

Syntax

This is a restriction of the String256 type.

The possible values are:

active
locked
closed

AlreadyExistingDataResolution

Syntax

This is a restriction of the String256 type.

The possible values are:

rejectImport
overwrite

ImportedDataType

Syntax

This is a restriction of the String256 type.

The possible values are:

subscriberAccount
externalAccount
prepaidAccount
mappingTable
rangeTable
chargingContract

ImportResult

Syntax

This is a restriction of the String256 type.

The possible values are:

imported
overwritten

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

AllowanceStatus

Syntax

This is a restriction of the String256 type.

The possible values are:

inactive
active
expired

AllowanceAccountAssignmentType

Syntax

This is a restriction of the String256 type.

The possible values are:

postpaid
prepaid

RangeBound

Syntax

This is a restriction of the string type.

The possible values are:

exclusive
inclusive

LastRange

Syntax

This is a restriction of the string type.

The possible values are:

bounded
unbounded

ComputationMode

Syntax

This is a restriction of the string type.

The possible values are:

single
cumulative
rangeSizeCumulative

RechargingFeasibilityStatus

Syntax

This is a restriction of the string type.

The possible values are:

possible
possibleAt
notPossibleUntil
notPossible

AccountOperationType

Syntax

This is a restriction of the string type.

The possible values are:

debit
credit

AccountReferenceType

Syntax

This is a restriction of the string type.

The possible values are:

external
prepaid

StateScheduleItemCode

Syntax

This is a restriction of the string type.

The possible values are:

blocked
locked
closed

ChargingFailureReason

Syntax

This is a restriction of the string type.

The possible values are:

outOfValidityPeriod
notAuthorized
accountBlocked
accountLocked
accountClosed
cannotChargeAccount