SAP Multichannel Foundation for Utilities and Public Sector

PDF download from SAP Help Portal:

http://help.sap.com

Created on April 20, 2015

The documentation may have changed since you downloaded the PDF. You can always find the latest information on SAP Help Portal.

Note

This PDF document contains the selected topic and its subtopics (max. 150) in the selected structure. Subtopics from other structures are not included.
The selected structure has more than 150 subtopics. This download contains only the first 150 subtopics. You can manually download the missing subtopics.

© 2015 SAP SE or an SAP affiliate company. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose
without the express permission of SAP SE. The information contained herein may be changed without prior notice. Some software products marketed by SAP SE
and its distributors contain proprietary software components of other software vendors. National product specifications may vary. These materials are provided by
SAP SE and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be
liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express
warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. SAP and other
SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP SE in Germany and other
countries. Please see www.sap.com/corporate-en/legal/copyright/index.epx#trademark for additional trademark information and notices.

Table of content

PUBLIC Page 1 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Table of content
1 SAP Multichannel Foundation for Utilities and Public Sector
1.1 What's New in SAP Multichannel Foundation for Utilities and Publ
1.2 Customizing for Interaction Records
1.2.1 Maintaining Activity Categories for Transaction Types
1.2.2 Defining Reason Codes for Interaction Records
1.2.3 Mapping Multilevel Categories to Activity Reason Codes
1.2.4 Maintaining Types of Note Texts
1.3 Customizing for Business Process Settings in SAP CRM
1.3.1 Business Process: Manage Contract
1.3.2 Business Process: Create Interaction Record
1.3.3 Business Process: Search Interaction Records
1.3.4 Business Process: Search Products
1.3.5 Business Process: Add Attachment
1.3.6 Business Process: Configure Co-Browsing
1.4 Customizing for Business Process Settings in SAP ERP
1.4.1 Business Process: Get Communication Channel Used by Customer
1.4.2 Business Process: Configure Co-Browsing
1.4.3 Business Process: Manage Communication Preferences
1.4.4 Business Process: Record a Customer Interaction
1.4.5 Business Process: Get Real-Time Consumption from EDM Profile Val
1.4.6 Business Process: Start a New Service (Move-In)
1.4.7 Business Process: End a Service (Move-Out)
1.4.8 Business Process: Transfer a Service (Move-In & Move-Out)
1.4.9 Business Process: Report an Outage
1.4.10 Business Process: Create a Payment Plan
1.4.11 Business Process: Create a Service Request (Service Notification
1.5 Configuring Products in the Product Workbench
1.6 Configuring Invoices, Invoice PDFs, and Contract Account Balance
1.7 Configuring Payments
1.8 Configuring Communication Preferences
1.8.1 Customizing for Communication Preferences
1.9 Move-In, Move-Out and Move-In/Out in Standalone ERP Scenario
1.10 Billed Consumption and Period Type
1.11 Paying Bills Without Logging In
1.12 OData Entities in SAP Multichannel Foundation for Utilities and
1.12.1 Entities for OData Service Model in SAP ERP
1.12.1.1 Account
1.12.1.2 AccountAddress
1.12.1.3 AccountAddressDependentEmail
1.12.1.4 AccountAddressDependentFax
1.12.1.5 AccountAddressDependentMobilePhone
1.12.1.6 AccountAddressDependentPhone
1.12.1.7 AccountAddressIndependentEmail
1.12.1.8 AccountAddressIndependentFax
1.12.1.9 AccountAddressIndependentMobilePhone
1.12.1.10 AccountAddressIndependentPhone
1.12.1.11 AccountAddressUsage
1.12.1.12 AccountAlert
1.12.1.13 AccountBalance
1.12.1.14 AccountContact
1.12.1.15 AccountSex
1.12.1.16 AccountTitle
1.12.1.17 AccountType
1.12.1.18 AddressType
1.12.1.19 Attachment
1.12.1.20 Bank
1.12.1.21 BankAccount
1.12.1.22 BudgetBillingCycle
1.12.1.23 BudgetBillingPlan
1.12.1.24 CommunicationCategory

PUBLIC Page 2 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 1.12.1.25 CommunicationMethod
1.12.1.26 CommunicationPreference
1.12.1.27 ConsumptionPeriodType
1.12.1.28 ContactAction
1.12.1.29 ContactAdditionalInfo
1.12.1.30 ContactClass
1.12.1.31 ContactPriority
1.12.1.32 ContactType
1.12.1.33 Contract
1.12.1.34 ContractAccount
1.12.1.35 ContractAccountBalance
1.12.1.36 ContractConsumptionValue
1.12.1.37 Country
1.12.1.38 Device
1.12.1.39 Division
1.12.1.40 FutureMeterReading
1.12.1.41 Installation
1.12.1.42 Invoice
1.12.1.43 InvoicePDF
1.12.1.44 MeterReadingCategory
1.12.1.45 MeterReadingNote
1.12.1.46 MeterReadingReason
1.12.1.47 MeterReadingResult
1.12.1.48 MeterReadingStatus
1.12.1.49 Outage
1.12.1.50 ParkedDocument
1.12.1.51 ParkedDocumentInstallation
1.12.1.52 PaymentCard
1.12.1.53 PaymentCardType
1.12.1.54 PaymentDocument
1.12.1.55 PaymentDocumentItem
1.12.1.56 PaymentMethod
1.12.1.57 PaymentPlan
1.12.1.58 PaymentStatus
1.12.1.59 Premise
1.12.1.60 PremiseType
1.12.1.61 Product
1.12.1.62 ProfileHeader
1.12.1.63 ProfileType
1.12.1.64 ProfileValue
1.12.1.65 ProfileValuesFile
1.12.1.66 ProfileValueType
1.12.1.67 Region
1.12.1.68 RegisterToRead
1.12.1.69 RegisterType
1.12.1.70 ServiceNotification
1.12.1.71 ServiceNotificationType
1.12.1.72 ServiceOrder
1.12.1.73 ServiceOrderType
1.12.1.74 ServicePriority
1.12.1.75 ServiceProvider
1.12.1.76 GetAllowedCommunicationMethods
1.12.1.77 GetPremisesForAccount
1.12.1.78 GetPremisesByAddress
1.12.1.79 RequestChange
1.12.1.80 SimulatePaymentPlan
1.12.2 Entities for OData Service Model in SAP CRM
1.12.2.1 Account
1.12.2.2 AccountAddress
1.12.2.3 AccountAddressDependentEmail
1.12.2.4 AccountAddressDependentFax
1.12.2.5 AccountAddressDependentMobilePhone

PUBLIC Page 3 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 1.12.2.6 AccountAddressDependentPhone
1.12.2.7 AccountAddressIndependentEmail
1.12.2.8 AccountAddressIndependentFax
1.12.2.9 AccountAddressIndependentMobilePhone
1.12.2.10 AccountAddressIndependentPhone
1.12.2.11 AccountAddressUsage
1.12.2.12 AccountSex
1.12.2.13 AccountTitle
1.12.2.14 AccountType
1.12.2.15 AddressType
1.12.2.16 Attachment
1.12.2.17 Bank
1.12.2.18 BankAccount
1.12.2.19 BusinessAgreement
1.12.2.20 Channel
1.12.2.21 CommunicationChannel
1.12.2.22 CommunicationPermission
1.12.2.23 CommunicationPermissionStatus
1.12.2.24 ContractItem
1.12.2.25 ContractItemTimeSlice
1.12.2.26 Country
1.12.2.27 Division
1.12.2.28 DocumentStatus
1.12.2.29 InteractionRecord
1.12.2.30 InteractionRecordCategory
1.12.2.31 InteractionRecordReason
1.12.2.32 PaymentCard
1.12.2.33 PaymentCardType

PUBLIC Page 4 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 1 SAP Multichannel Foundation for Utilities and Public Sector

SAP Multichannel Foundation for Utilities and Public Sector is a customer-facing solution based on SAP NetWeaver Gateway. It allows utility companies to
interact with their customers through different communication channels, for example, the Web (online self-services), mobile, and social networks. SAP
Multichannel Foundation for Utilities and Public Sector provides a set of standardized and reusable OData services that are used by end-user applications to
access data and processes from SAP Business Suite for Utilities and Public Sector.
The standard services consist of self-service scenarios that enable customers to securely access and manage key account information and perform important
activities online, like bill payment, entering meter readings, creating inquiries, and sending requests to a utility company.
A Web application template for customer self-services is also included with the solution.

Note
The UIs delivered with SAP Multichannel Foundation for Utilities and Public Sector serve as templates, which provide a set of standard features that need to
be tailored to your specific requirements for productive use.

More Information
For information on what Web browsers are supported by SAP Multichannel Foundation for Utilities and Public Sector, see

https://help.sap.com/saphelp_nw74/helpdata/en/91/f079dc6f4d1014b6dd926db0e91070/content.htm

1.1 What's New in SAP Multichannel Foundation for Utilities and

Public Sector

The SAP Multichannel Foundation for Utilities and Public Sector solution has been created as an Add-On for SAP Gateway, SAP CRM and SAP ERP. The
solution now includes a responsive Web design (SP03 onwards) that can be easily used on a desktop, a tablet, or on a mobile phone.

Note
The UIs delivered with SAP Multichannel Foundation for Utilities and Public Sector serve as templates, which provide a set of standard features that need to
be tailored to your specific requirements for productive use.

The following release notes have been created for SAP Multichannel Foundation for Utilities and Public Sector:
Utilities Multichannel: Managing Online Accounts
Utilities Multichannel: Managing Customer Details
Utilities Multichannel: Managing Utility Contracts
Utilities Multichannel: Managing Meter Reading Data
Utilities Multichannel: Viewing Bills and Consumption
Utilities Multichannel: Managing Budget Billing Plans
Utilities Multichannel: Managing Payments
Utilities Multichannel: Communicating with the Utility Company
Utilities Multichannel: Managing Outages
Utilities Multichannel: Agent Co-Browsing

Note
For a list of supported Web browsers, see the information available here:

https://help.sap.com/saphelp_nw74/helpdata/en/91/f079dc6f4d1014b6dd926db0e91070/content.htm

1.2 Customizing for Interaction Records

Activities
In order to use the Interaction Record functionality in the SAP Multichannel Foundation for Utilities solution, you can maintain the following Customizing:
Maintaining Activity Categories for Transaction Types
Defining Reason Codes for Interaction Records
Mapping Multilevel Categories to Activity Reason Codes
Maintaining Types of Note Texts

1.2.1 Maintaining Activity Categories for Transaction Types

In order to define categories for transaction types and activities, you must first perform some Customizing activities.

PUBLIC Page 5 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Procedure
1. Define the activity category.
On the SAP Easy Access screen for Customer Relationship Management, choose Transactions Settings for Activities Maintain Categories, Goals, and
Priorities Maintain Categories ; define the activity category.
2. Assign the activity category to a transaction type.
On the SAP Easy Access screen for Customer Relationship Management, choose Transactions Settings for Activities Maintain Categories, Goals, and
Priorities Assign Categories to Transaction Types ; assign the category to a transaction type.

1.2.2 Defining Reason Codes for Interaction Records

To be able to assign a reason code when creating an interaction record, you must first define the reason code in Customizing.

Procedure
1. Check the subject profile used for interaction record.
On the SAP Easy Access screen for Customer Relationship Management, choose Transactions Basic Settings Define Transaction Types and select
Interaction Record (standard IR type 0010) activity reason as subject profile; the subject profile is defined under the Customizing Header folder.
2. Use subject profile for interaction record.
On the SAP Easy Access screen, for Customer Relationship Management, choose Transactions Settings for Activities Define Activity Reasons
Define Subject Profiles . Select Activity Reason as the subject profile (ACT000001) used for interaction records and then select Code Groups from the
navigation panel on the left; the Catalog and CodeGrpProfile fields for the subject profile Activity Reason (ACT000001) are A1 and A0000001 respectively.
3. Define reason codes for activity reasons.
On the SAP Easy Access screen, for Customer Relationship Management, choose Transactions Settings for Activities Define Activity Reasons
Define Code Group Profiles .

1.2.3 Mapping Multilevel Categories to Activity Reason Codes

If your business practices require you to use multilevel categories for your business activities, you must first map your categories to the relevant activity reason
codes in the back end SAP CRM system.

Procedure
1. Log on to the CRM WebUI using the IC_MANAGER business role.
2. Choose Categorization Schemas under the Search block and then choose Business Activity. For this example, you can choose Application ID.
3. Select the schema with status Active; the schema is displayed.

Note
The subject profile must match the one used for the transaction 0010.

4. Map a category to an Activity Reason Code by selecting it from Category Hierarchy; the mapped activity reason code is displayed in the General Data
assignment block.

More Information
Defining Reason Codes for Interaction Records

1.2.4 Maintaining Types of Note Texts

To be able to set the types of note texts that you want your customer to see, you must set up the relevant Customizing. For example, you may set up the
Customizing so your customer is not able to see internal memos but have access to customer notes.

Procedure
1. On the SAP Easy Access screen for Customer Relationship Management, choose Transactions Basic Settings Define Transaction Types and
check the value for interaction records by double-clicking; the default value of the Text Det. Procedure field is ACT00001.
2. On the SAP Easy Access screen for Customer Relationship Management, choose Basic Functions Text Management Define Text Determination
Procedure , select the text object CRM_ORDERH and choose the Procedure node on the navigation panel on the left.
3. Select the Text Determination Procedure used for interaction record (found from the first step): ACT00001
4. Choose the Definition of Procedure folder from the navigation panel on the left and maintain the text types used for the interaction records.

1.3 Customizing for Business Process Settings in SAP CRM

PUBLIC Page 6 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 The Maintain Business Process Settings Customizing activity is designed to control the behavior of OData entities in SAP Multichannel Foundation for Utilities and
Public Sector, without changing the default Business Add-In (BAdI) implementation in the Enhancement Spot CRM_UMC_ODATA.

You can modify the attribute values in the delivered Customizing for business process settings. If you want to create your own business processes or attributes,
you must enhance the default BAdI implementation.
The following business processes are delivered with SAP Multichannel Foundation for Utilities and Public Sector:

Process ID Business Process Description

1 Manage Contract

3 Create Interaction Record

4 Search Interaction Records

5 Search Products

6 Add Attachment

7 Configure co-browsing

Note
You must not remove any delivered business processes listed above since they are in use in the delivered OData entities.

Structure
Each parameter for a business process contains the following fields:

Field Description

Entity Name Key field

OData entity name for entity specific parameter value
If left empty, it becomes the default parameter for all entities.

Parameter Name Key field

Parameter ID
Field is case sensitive

Sequence Key field

Sequence number
Used when the parameter is a table

Parameter Value Parameter value

1.3.1 Business Process: Manage Contract

The parameters that have been delivered with SAP Multichannel Foundation for Utilities and Public Sector for managing contracts and quotations are listed in the
following table:

Entity Name Parameter Name Sequence Parameter Value

ChannelIDForMobile 1 MSA

ChannelIDForVoice 1 EXS

ChannelIDForWeb 1 ISA

InitialMaxHit 1 800

ProcessProfileName 1 UMC_B2C

All parameters are applied for both ContractItem and QuotationItem entities. The parameters with the prefix ChannelID are used for the channel that is
used to access the ContractItem or QuotationItem entities.
The parameter InitialMaxHit defines the maximum number of hits for the contract item and quotation item search. The parameter ProcessProfileName
specifies the profile name of the Process Framework.

1.3.2 Business Process: Create Interaction Record

The parameters that have been delivered with SAP Multichannel Foundation for Utilities and Public Sector for creating interaction records are listed in the following
table:

Entity Name Parameter Name Sequence Parameter Value

Active 1 X

NoteTextType 1 A002

Priority 1 5

ProcessType 1 0010

Status 1 E0003

PUBLIC Page 7 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 InteractionRecord ChannelIDForMobile 1 MSA

InteractionRecord ChannelIDForVoice 1 EXS

InteractionRecord ChannelIDForWeb 1 ISA

InteractionRecord Active 1 X

InteractionRecord Status 1 E0001

All defaults parameters are applied to an interaction record created by either the InteractionRecord entity or from the back end system directly by other
entities.
By default, the status of an interaction record is E0003 (Closed), if it is created directly from the back end system. If an interaction record is created by the
InteractionRecord entity, the status is E0001 (Open).

The parameter Active is used to control whether the creation of an interaction record is executed. By default, interaction records are created by all entities. If you
want to skip the creation of interaction record directly from certain entities, you must add new entries with the empty parameter value for those entities to switch off
the creation of interaction records.
In order to avoid accidentally switching off the Create_entity operation from the InteractionRecord entity, you must explicitly switch on the parameter
Active for the InteractionRecord entity in the Customizing delivered with SAP Multichannel Foundation for Utilities and Public Sector.

The parameter ProcessType defines the SAP CRM process type used in creating an interaction record. By default, the parameter value 0010 (CRM Interaction
Record) is used.
The parameter NoteTextType specifies the note text type used in creating an interaction record. By default, the parameter value A002 (Note) is used.

Parameters with the prefix ChannelID are used to represent the channel that is used in the creation of the interaction record by the InteractionRecord
entity.

1.3.3 Business Process: Search Interaction Records

The parameters that have been delivered with SAP Multichannel Foundation for Utilities and Public Sector for searching interaction records are listed in the
following table:

Entity Name Parameter Name Sequence Parameter Value

MaxHits 1 100

ProcessType 1 0010

By default, the system returns up to 100 interaction records with the operation Get_EntitySet for the InteractionRecord entity.

1.3.4 Business Process: Search Products

The parameter that has been delivered with SAP Multichannel Foundation for Utilities and Public Sector for searching for products is listed in the following table:

Entity Name Parameter SEQNO Parameter Value

MaxHits 1 100

By default, the system returns up to ten SAP IS-U products in the SAP CRM product search.

1.3.5 Business Process: Add Attachment

The parameter that has been delivered with SAP Multichannel Foundation for Utilities and Public Sector for adding an attachment is listed in the following table:

Entity Name Parameter Name Sequence Parameter Value

InteractionRecord ObjectType 1 BUS2000126

1.4.2 Business Process: Configure Co-Browsing

The UserGroup parameter can be used to configure a user group for the agent as the user. The responsive Web application validates if the user is the agent. By
default, this feature is delivered inactive.
The parameters that have been delivered with SAP Multichannel Foundation for Utilities and Public Sector for configuring co-browsing are listed in the following
table:

Entity Name Parameter Name Sequence Parameter Value

UserGroup 1 UMC_AGENT

Active 1

1.4 Customizing for Business Process Settings in SAP ERP

PUBLIC Page 8 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 1.4 Customizing for Business Process Settings in SAP ERP

The Maintain Business Process Settings Customizing activity is designed to control the behavior of OData entities in SAP Multichannel Foundation for Utilities and
Public Sector, without changing the default Business Add-In (BAdI) implementation in the Enhancement Spot ISU_UMC_ODATA.

You can modify the attribute values in the delivered Customizing for business process settings. If you want to create your own business processes or attributes,
you must create Customizing for a new process and use this Customizing in the code.
The following business processes are delivered with SAP Multichannel Foundation for Utilities and Public Sector:

Process ID Business Process Description

1 Record a Customer Interaction

2 Manage Communication Preferences

3 Start a New Service (Move In)

4 End a Service (Move Out)

5 Transfer a Service (Move In & Move Out)

6 Create a Service Request (Service Notification)

7 Report an Outage

8 Create a Payment Plan

9 Get Communication Channel Used by Customer

10 Configure Co-Browsing

11 Get real time consumption from EDM profile values

Note
You must not remove any delivered business processes listed above since they are in use in the delivered OData entities. The recommendation is to either
modify the Customizing activities that are delivered for existing business processes or create new business processes.

Structure
Each parameter for a business process contains the following fields:

Field Description

Entity Name Key field

OData entity name for entity specific parameter value
If left empty, it becomes the default parameter for all entities.

Parameter Name Key field

Parameter ID
Field is case sensitive

Sequence Key field

Sequence number
Used when the parameter is a table

Parameter Value Parameter value

1.4.1 Business Process: Get Communication Channel Used by

Customer

The business partner channel can be configured in the Define Customer Contact Types Customizing activity. If you want configure attribute values, you can find
the Customizing entry under Financial Accounting Contract Accounts Receivable and Payable Basic Functions Customer Contacts Additional Information
Define Customer Contact Types .
The parameters that have been delivered with SAP Multichannel Foundation for Utilities and Public Sector to get the communication channel are listed in the
following table:

Entity Name Parameter Name Sequence Parameter Value

Default 1 005

Mobile 1 005

Mozilla 1 005

Voice 1 005

1.4.2 Business Process: Configure Co-Browsing

PUBLIC Page 9 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 The UserGroup parameter can be used to configure a user group for the agent as the user. The responsive Web application validates if the user is the agent. By
default, this feature is delivered inactive.
The parameters that have been delivered with SAP Multichannel Foundation for Utilities and Public Sector for configuring co-browsing are listed in the following
table:

Entity Name Parameter Name Sequence Parameter Value

UserGroup 1 UMC_AGENT

Active 1

1.4.3 Business Process: Manage Communication Preferences

The Manage Communication Preference business process is used to configure the communication preference settings in SAP Multichannel Foundation for Utilities
and Public Sector. The OData entity CommunicationCategory defines all communication preferences categories that are used in this solution.

The special “virtual” communication preferences category UMCB, is used by the SAP IS-U invoicing documents, since SAP IS-U invoicing does not use the
correspondence variants. The supported communication methods for each communication preferences category are defined in the OData entity
CommunicationMethod. The OData entity CommunicationPreference is used to define the property name and value pairs to configure the class
attributes of the API class CL_ISU_UMC_API_CORRESPONDENCE.

The parameters that have been delivered with SAP Multichannel Foundation for Utilities and Public Sector for managing communication preferences are listed in
the following table:

Entity Name Parameter Name Sequence Parameter Value

CommunicationCategory Category 1 UMCB

CommunicationCategory Category 2 UMC1

CommunicationCategory ProcessType 3 UMC2

CommunicationCategory PaperlessType 1 X

CommunicationCategory PaperlessType 2

CommunicationCategory PaperlessType 3

CommunicationMethod UMC1 1 SMS

CommunicationMethod UMC1 2 MAIL

CommunicationMethod UMC1 3 STND

CommunicationMethod UMC1 4 NONE

CommunicationMethod UMC2 1 SMS

CommunicationMethod UMC2 2 MAIL

CommunicationMethod UMC2 3 NONE

CommunicationMethod UMCB 1 STND

CommunicationMethod UMCB 2 NONE

CommunicationPreference Property 1 MV_DISPATCH_TYPE_NONE

CommunicationPreference Property 2 MV_VARIANT_PREFIX

CommunicationPreference Property 3 MV_ALL_CONTRACT_ACCOUNTS

CommunicationPreference Property 4 MV_PAPER_SENDCONTROL

CommunicationPreference Property 5 MV_PAPERLESS_SENDCONTROL

CommunicationPreference Value 1 NONE

CommunicationPreference Value 2 UM

CommunicationPreference Value 3 X

CommunicationPreference Value 4 STND

CommunicationPreference Value 5 NONE

1.4.4 Business Process: Record a Customer Interaction

With the standard delivery of SAP Multichannel Foundation for Utilities and Public Sector, a new business partner contact can be created in the system when an
OData entity is changed.
The settings below determine:
Whether a new business partner contact needs to be created. This is controlled by the parameter value “X” for parameter “Active”.
Activity (Action) type of the created business partner contact.
Class of the created business partner contact
You can find the available contact activities within Contact Classes under Financial Accounting Contract Accounts Receivable and Payable Basic Functions
Customer Contacts Define Customer Contact Classes/Actions .

PUBLIC Page 10 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 The parameters that have been delivered with SAP Multichannel Foundation for Utilities and Public Sector for recording customer interaction are listed in the
following table:

Entity Name Parameter SEQNO Parameter Value

Account Active 1 X

Account Activity 1 0001

Account Class 1 0006

AccountAddress Active 1 X

AccountAddress Activity 1 0002

AccountAddress Class 1 0006

AccountAddressDependentEmail Active 1 X

AccountAddressDependentEmail Activity 1 0002

AccountAddressDependentEmail Class 1 0006

AccountAddressDependentFax Active 1 X

AccountAddressDependentFax Activity 1 0002

AccountAddressDependentFax Class 1 0006

AccountAddressDependentMobilePh Active 1 X
one

AccountAddressDependentMobilePh Activity 1 0002

one

AccountAddressDependentMobilePh Class 1 0006

one

AccountAddressDependentPhone Active 1 X

AccountAddressDependentPhone Activity 1 0002

AccountAddressDependentPhone Class 1 0006

AccountAddressIndependentEmail Active 1 X

AccountAddressIndependentEmail Activity 1 0002

AccountAddressIndependentEmail Class 1 0006

AccountAddressIndependentFax Active 1 X

AccountAddressIndependentFax Activity 1 0002

AccountAddressIndependentFax Class 1 0006

AccountAddressIndependentMobile Active 1 X
Phone

AccountAddressIndependentMobile Activity 1 0002

Phone

AccountAddressIndependentMobile Class 1 0006

Phone

AccountAddressIndependentPhone Active 1 X

AccountAddressIndependentPhone Activity 1 0002

AccountAddressIndependentPhone Class 1 0006

BankAccount Active 1 X

BankAccount Activity 1 0001

BankAccount Class 1 0006

BudgetBillingPlan Active 1 X

BudgetBillingPlan Activity 1 0001

BudgetBillingPlan Class 1 0005

CommunicationPreference Active 1 X

CommunicationPreference Activity 1 0002

CommunicationPreference Class 1 0006

ContractAccount Active 1 X

ContractAccount Activity 1 0001

ContractAccount Class 1 0006

MeterReadingResult Active 1 X

MeterReadingResult Activity 1 0001

MeterReadingResult Class 1 0013

ParkedDocument Active 1 X

PUBLIC Page 11 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 ParkedDocument MoveInActivity 1 0001

ParkedDocument MoveinClass 1 0026

ParkedDocument MoveOutActivity 1 0003

ParkedDocument MoveOutClass 1 0026

ParkedDocument MoveInOutActivity 1 0002

ParkedDocument MoveInOutClass 1 0026

PaymentCard Active 1 X

PaymentCard Activity 1 0001

PaymentCard Class 1 0006

PaymentDocument Active 1 X

PaymentDocument Activity 1 0001

PaymentDocument Class 1 0005

ServiceNotification Active 1 X

ServiceNotification Activity 1 0001

ServiceNotification Class 1 0010

1.4.5 Business Process: Get Real-Time Consumption from EDM

Profile Values

SAP Energy Data Management (SAP EDM) is a module in SAP for Utilities Industry Solution to manage the energy data of a utility company. Based on this data,
a utility company can retrieve real-time interval consumption and make real-time pricing and settlement.
SAP Multichannel Foundation for Utilities and Public Sector provides a set of OData entities that help you to retrieve the interval consumption from SAP EDM
Profile Values.
The parameters that have been delivered with this implementation to get real-time consumption data from SAP EDM profile values are listed in the following table:

Entity Name Parameter Name Sequence Parameter Value

ProfileValue ValueStatus_Error 1 IU014

ProfileValue ValueStatus_Forecast 1 IU020

ProfileValue ValueStatus_Historical 1 IU012

ProfileValue ValueStatus_Historical 2 IU013

ProfileValue ValueStatus_Historical 3 IU015

ProfileValue ValueStatus_Historical 4 IU016

ProfileValue ValueStatus_Missing 1 IU011

ProfileValue ValueStatus_Missing 2 IU010

You can find the parameter value for Customizing under SAP Utilities Energy Data Management Profile Management Display Function Define System
Status Display for Profile Values .

1.4.6 Business Process: Start a New Service (Move-In)

For the move-in, move-out as well as the move-in and move-out processes, the parking variant can be defined in the Customizing entries.
The parameter that has been delivered with SAP Multichannel Foundation for Utilities and Public Sector to start a new service is listed in the following table:

Entity Name Parameter SEQNO Parameter Value

ParkedDocument Variant 1 0001

You can find the Customizing activity for the parking variant under SAP Utilities Customer Service Process Execution Move-In/Out Accelerated Entry
Define Preentry Variants

1.4.7 Business Process: End a Service (Move-Out)

For the move-in, move-out as well as the move-in and move-out processes, the parking variant can be defined in the Customizing entries.
The parameter that has been delivered with SAP Multichannel Foundation for Utilities and Public Sector to end a service is listed in the following table:

Entity Name Parameter Name Sequence Parameter Value

ParkedDocument Variant 1 0001

Business Process: Transfer a Service (Move-In & Move-Out)

PUBLIC Page 12 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Business Process: Transfer a Service (Move-In & Move-Out)

For move-in, move-out as well as the move-in and move-out processes, the parking variant can be defined in the Customizing entries.
The parameter that has been delivered with SAP Multichannel Foundation for Utilities and Public Sector to transfer a service is listed in the following table:

Entity Name Parameter SEQNO Parameter Value

ParkedDocument Variant 1 0001

1.4.9 Business Process: Report an Outage

When changing outage class, activity and direction, the outage that is created from the Web application, (represented by business partner contact) is modified
based on the Customizing.
The parameters that have been delivered with SAP Multichannel Foundation for Utilities and Public Sector for reporting an outage are listed in the following table:

Entity Name Parameter Name Sequence Parameter Value

Outage Activity 1 0001

Outage AdditionalInfo 1

Outage AdditionalInfoForService 1

Outage Class 1 0017

Outage Direction 1 1

Outage ObjectRole 1 IDOCOUTPREM

Outage OffSetDays 1 30

Outage PremiseKey 1 PREMISES

Outage ServicePartner 1

When changing the ObjectRole or PremiseKey parameters, the BOR object representing a premise linked to outage can be changed as well.

The AdditionalInfo parameter corresponds to partner contact additional information and is used for the reported outage category.

The AdditionalInfoForService parameter corresponds to partner contact additional information and is used for broadcast outage category.
You can find the Customizing activity for contact additional information under Financial Accounting Contract Accounts Receivable and Payable Basic
Functions Customer Contacts Define Customer-Contact Class/Actions .
The ServicePartner parameter corresponds to a service partner for the outage broadcast by the utility company.

1.4.10 Business Process: Create a Payment Plan

With the standard delivery of SAP Multichannel Foundation for Utilities and Public Sector, a new payment plan can be created and its type can be changed in
Customizing. The payment plan type value can be found in the Customizing under SAP Utilities Invoicing Budget Billing Plan Payment Plan Define
Payment Plan Categories (AMB/BBP) .
The parameters that have been delivered with SAP Multichannel Foundation for Utilities and Public Sector for creating a payment plan are listed in the following
table:

Entity Name Parameter Name Sequence Parameter Value

PaymentPlan PaymentPlanType 1 0001

1.4.11 Business Process: Create a Service Request (Service

Notification)

You can define the service notification code in the Define Notification Code Customizing activity to control the creation of service notifications. You can find the
Customizing activity under SAP Utilities Work Management Processing Notifications Define Notification Code .
The parameter that has been delivered with SAP Multichannel Foundation for Utilities and Public Sector for creating a service request is listed in the following
table:

Entity Name Parameter Name Sequence Parameter Value

ParkedDocument Variant 1 0001

1.5 Configuring Products in the Product Workbench

To enable a customer to see and sign up for a utility product even when they are not logged on to their account, you can configure the list of utility products in the

PUBLIC Page 13 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Product Workbench in the SAP CRM system. Additionally, the customer is also able to search for these products by using specific filters.

Procedure
1. In the Product Workbench (transaction COMMPR01 ), create a new product of type Service and then choose the correct utility product category.
2. Enter a unique product name and description for the Service field.
3. In the Set Types field, choose the Product Proposal for Utilities and enter the following information:
Division (mandatory), for example, 01 for Electricity, 02 for Gas, 03 for Water
Other fields as needed
4. On the Documents tab page, create a document with the name IconPath and description IconPath.
5. Choose Start Editor and enter a path for the icon, for example, img/history_grey_48.png .

Note
If you do not specify a path for the icon, the system chooses the default path.

6. In the Set Types field on the SAP Basic Data tab page, choose the Texts option and then choose Basic Texts for Text Category; enter the long text for your
product.
7. Under Additional Set Types, choose the Set Types field and select the IS-U pricing extension option if you need to specify the product pricing information.

Result
You have successfully set up the list of products for the customer to choose from.

1.6 Configuring Invoices, Invoice PDFs, and Contract Account

Balances for OData Consumption

Procedure

Invoices
You can use the Biller Direct functionality to retrieve invoices from the SAP ERP system. This allows customers to see invoices detailing their energy
consumption. The API behind this retrieval is GEN_EBPP_GET_DATA. This API retrieves lists of invoices generically for various industries and SAP
components.
For this API to work, you must maintain the following Customizing:
1. You must start an interval for number range object EBPP_EVENT using transaction SNRO.
2. You must maintain basic Customizing using the Settings for Customer Portal in the Internet activity under SAP Utilities Customer Service SAP
Multichannel Foundation for Utilities Biller Direct .
3. In transaction FQEVENTS for event 1231(Biller Direct: Group Items for Display), the following IS-U function module has to be activated:
ISU_GET_ITEMS_1231.
The ISU_GET_ITEMS_1231 API performs the calculation of remaining amounts and compares the amounts in the IS-U invoice document and the FI-CA
posted documents for customer payments.
There is additional information describing the Biller Direct functionality in the Configuration of SAP Biller Direct for FI-CA documentation. It can be found in the

SAP Library at http://help.sap.com/erp2005_ehp_04/helpdata/en/2c/1f34f19abb324bbb2e6683f9bb4f9e/frameset.htm .

Invoice PDFs
You can use the Biller Direct API GEN_EBPP_GET_INVOICE_DETAIL in the SAP ERP system to retrieve an invoice PDF. This API performs generic retrievals
of invoice PDFs for various industries and components.
In this API, BAdI FIS_INVOICEDETAIL is used. This BAdI has several SAP-delivered implementations. One of them is specifically for IS-U:
ISU_INVOICEDETAIL.
This implementation searches the archive for invoices and tries to retrieve invoice PDFs using ISU_GET_INVOICES_PDF_RAW. If this implementation doesn’t
satisfy the business requirements, a new BAdI implementation can be created. For testing purposes, when there is no archive for invoices, you can create a
BAdI implementation where the ISU_GET_PDF_FILE API can be used to retrieve a simulated PDF document. This can only be used for testing since PDF
simulation is time-consuming and shouldn’t be used in a production environment.

Contract Account Balances

The contract account balance is calculated based on Biller Direct API GEN_EBPP_GET_DATA in the SAP ERP system. The balance is retrieved from the
returning structure E_CREDITS.
Since displayed invoices, balances, and PDF files can be customer-specific, OData entity implementations can easily be enhanced following the extensibility
guidelines for SAP Multichannel Foundation for Utilities.

1.7 Configuring Payments

In order to configure payment specifications, you must execute a number of Customizing activities. You can use the SAP Biller Direct for FI-CA function to pay
bills (invoices), which includes making one time payments and future-dated payment from the SAP ERP system. This enables you to settle open receivables
such as invoices detailing their energy consumption by credit card or bank transfer in part, or in full.

PUBLIC Page 14 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Activities

Payment Specification and One Time Payment

You use the GEN_EBPP_PUT_DATA API to make payments from the SAP Biller Direct for FI-CA function. This API supports two modes of payment: standard
mode and balance mode.
For standard mode, this API creates a payment specification for a list of generic open invoices that can be used across various industries; for balance mode, the
same API creates a payment specification for the standing balance in customer contract accounts. The payment amount entered is distributed across open bills
during the clearing control; invoices are then processed further in the same way as in the standard mode. To be able to use all of the functions of SAP Biller
Direct, you have to make the following Customizing settings for Contract Accounts Receivable and Payable (FI-CA).
For this API to work, you must maintain the following Customizing:
Basic Settings
These settings from FI-CA are essential for you to be able to display bills on the front end and to process payments initiated in SAP FI-CA.

For more information, see http://help.sap.com/erp under Basic Settings for Configuration of SAP Biller Direct for FI-CA.
Processing Payments and Credits
In order to allow making and clearing of partial payments, overpayments and credits, you have to make additional system settings specified under
Processing Payments and Credits.

For more information, see http://help.sap.com/erp under Basic Settings Processing Payments and Credits for Configuration of SAP Biller Direct
for FI-CA.
Payments by Payment Card
In order to allow payment using payment cards, you have to make additional system settings specified under Payments by Payment Card.

For more information, see http://help.sap.com/erp for Payments by Payment Card under Configuration of SAP Biller Direct for FI-CA.
You can customize the payment card authorization check using the Customizing activity Settings for Customer Portal in the Internet under SAP Utilities
Customer Service SAP Multichannel Foundation for Utilities Biller Direct ; you have to provide your function module for the field Authorization, which
meets your requirements. Otherwise no authorization checks are applied by default. SAP provides a simulation function CCARD_AUTH_SIMULATION as an
example.
Automatic notification after payment is created for customer using either e-mail or SMS is offered by the SAP Biller Direct in FI-CA function. BAdI
Confirmation E-Mail for Payment of Open Bills (ES_FIN_EBPP_MAIL_PUT_DATA) is provided to you for configuring the standard, automatic e-mail that the
system sends to the customer to confirm that the payments they have made for open bills have been entered in the system.
At the end of each successful creation of a payment, a customer contact for the current business partner is created within the implementation. Meanwhile,
SAP Biller Direct for FI-CA also provides a BAdI Create Customer Contacts (ES_FIN_EBPP_CONTACT), which is used in the Utilities Industry (IS-U)
component for creating contacts for E-Service processes and can be found under SAP Utilities Customer Service Utility Customer E-Services (UCES)
E-Mail Configuration , but we recommend you do not use the SAP Biller Direct for FI-CA BAdI.
For balance mode, the FI-CA functions within the FI-CA EVENT 0110 can be enhanced according to specific customer requirement. The FI-CA Event 0110
assigns an available amount to open invoices and then the selected invoices are cleared or partially cleared on the basis of this assignment.
For more information, see the documentation for the sample function module FKK_SAMPLE_0110.

Future-Dated Payment
Future-dated payment refers to a payment created for a future date for an invoice that is also due in the future. In order to make this feature work through SAP Biller
Direct FI-CA, the GEN_EBPP_PUT_DATA API payment specification must be used. The FI-CA functions within the FI-CA EVENT 1249 can be enhanced
according to specific customer requirement. The FI-CA EVENT 1249 checks whether the invoices specified for the payment can be included together in a
payment specification even if the due dates of the invoices are different.
For more information, see the documentation for the sample function module FKK_SAMPLE_1249.

More Information
For more information describing the SAP Biller Direct in FI-CA function in theConfiguration of SAP Biller Direct for FI-CA documentation can be found on the SAP

Help Portal at http://help.sap.com/erp under SAP Contract Accounts Receivable and Payable (FI-CA).

For more information describing payments in SAP FI-CA, see the SAP Help Portal at http://help.sap.com/erp under Contract Accounts Receivable and
Payable Payments .

1.8 Configuring Communication Preferences

The Communication Preferences function is implemented based on the SAP FI-CA Correspondence and Dispatch control function. While this is on the SAP ERP
system, the “Hot Offers” field uses marketing permissions in SAP CRM.
The combinations of communication preferences are defined as “correspondence variants” and stored in the contract account.
Communication preferences are grouped by communication preferences category. Each communication preferences category could contain one or multiple
correspondence types. The Correspondence role in the standard Correspondence Customizing is used as Communication Preference Category in SAP
Multichannel Foundation for Utilities. The correspondence variants group all correspondence types in the communication preferences categories for controlling
dispatch of send methods and periodic correspondence.

Activities
Since the invoicing function in the SAP IS-U system uses the SAP FI-CA dispatch control without using the correspondence variants, the special “virtual”
communication preferences category, UMCB, that only contains paper and paperless options are used for invoicing in the SAP IS-U system. The virtual

PUBLIC Page 15 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 communication preference category UMCB, is predefined in the API for SAP Multichannel Foundation for Utilities and not maintained in the Correspondence Role
Customizing activity. You can remove it by modifying the BAdI implementation.
For more information on how to modify the BAdI implementation, see Customizing for Communication Preferences.

1.8.1 Customizing for Communication Preferences

Procedure
In order to carry out the Customizing for communication preferences, you must do the following:
1. Step 1: Define Correspondence Types
2. Step 2: Define Communication Preferences Category (Correspondence Roles)
3. Step 3: Define Allowed Send Methods
4. Step 4: Define Correspondence Types for the Communication Preference Category and Address Determination
5. Step 5: Define Correspondence Variants
6. Step 6: Activate BC Set for the Customizing

Step 1: Define Correspondence Types

Correspondence types used in the Communication Preferences feature in SAP Multichannel Foundation for Utilities, must be maintained in Customizing under
SAP Reference IMG Cross-Application Components General Application Functions Correspondence Define Correspondence Types .
This Customizing is cross-client and the following three correspondence types are used in the delivered Customizing for communication preferences:
0019 – Payment Notice
0031 – Notification of Invoices, Credit Memos
UMCO – Outage Notification
0019 and 0031 are standard correspondence types for SAP FI-CA. The UMCO is the new correspondence type for SAP Multichannel Foundation for Utilities and
should be used for demo purposes only.

Step 2: Define Communication Preferences Category (Correspondence Roles)

Communication Preferences Category is based on the Correspondence roles. To define the Communication Preferences Category, you need to do the following:
1. Create a new Correspondence role as the Communication Preferences Category in Customizing under SAP Reference IMG Cross-Application
Components General Application Functions Correspondence Define Correspondence Roles .
In the standard delivery for Customizing in SAP Multichannel Foundation for Utilities, the following Correspondence roles are defined as the communication
preferences categories:
UMC1 – Bill and Payment Notifications
UMC2 – Outage Notifications
Since invoicing in the SAP IS-U system does not use correspondence variants, the special virtual communication preferences category is used for the
invoicing documents in the SAP IS-U system. This virtual communication preferences category UMCB is not necessarily defined in the Correspondence
role Customizing activity. It must be added to the BAdI method GET_COMM_PREFERENCE_CATEGORY as outlined in the next step.
2. In the BAdI ISU_UMC_BUSINESS_SETTINGS under the Enhancement Spot ISU_UMC_ODATA, you must implement the method
IF_ISU_UMC_SETTING_BADI~GET_COMM_PREFERENCE_CATEGORY to return all related Correspondence roles as communication preferences
categories for the SAP Multichannel Foundation for Utilities application. In the standard BAdI implementation, three communication preferences categories
are returned:
UMCB – Go Green, go paperless
UMC1 – Bill and Payment Notifications
UMC2 – Outage Notifications

Step 3: Define Allowed Send Methods

You must define send methods for each communication preferences category by doing the following:
1. All sending options are maintained in Customizing under SAP Reference IMG Cross-Application Components General Application Functions Print
Workbench Define Shipping Control .

Note
You must ensure that the allowed send method has been already defined in the Customizing mentioned above.

2. The allowed send methods for each communication preferences category are defined by the BAdI method
IF_ISU_UMC_SETTING_BADI~GET_ALLOWED_DISPATCH_LIST in the BAdI ISU_UMC_BUSINESS_SETTINGS. In the standard BAdI implementation,
the following allowed send methods for the three delivered communication preferences categories are returned:
UMCB – (Go Green, go paperless)
STND – Mail (Paper)
NONE – Not Sent (Paperless)
UMC1 – Bill and Payment Notifications)
SMS – SMS
MAIL – Email
STND – Mail
NONE – Not to send
UMC2 – (Outage Notifications)
SMS – SMS
MAIL – Email
NONE – Not to send

PUBLIC Page 16 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Step 4: Define Correspondence Types for Communication Preference Category and Address Determination
The Correspondence Types for each Communication Preference Category need to be maintained in Customizing under SAP Reference IMG Cross-Application
Components General Application Functions Correspondence Configure Address Determination .
In the standard Customizing that is delivered with SAP Multichannel Foundation for Utilities, the following entries are maintained:

Corr. Type CorresRole Addr. Type

0019 UMC1 XXDEFAULT

0031 UMC1 XXDEFAULT

UMCO UMC2 XXDEFAULT

In the standard SAP FI-CA Correspondence feature, a correspondence type could be assigned to multiple Correspondence roles. However, in the Communication
Preferences feature delivered with SAP Multichannel Foundation for Utilities, the correspondence type can only be assigned to one Correspondence role specific
to the SAP Multichannel Foundation for Utilities application. Otherwise, the system returns a system error with code E043(ISU_UMC_ODATA).

Step 5: Define Correspondence Variants

The standard delivered communication preferences Customizing is illustrated in the following diagram:

Communication Preferences

Since there are 4 allowed send methods and 3 allowed send methods for two communication categories in SAP Multichannel Foundation for Utilities, a total of 12
combinations are available for the CommunicationPreference object like it is represented in the following table:

Combinations UMC1 UMC2

Bill & Payment Notification Outage Notification

1 Email Email

2 Email Not to send

3 Email SMS

4 Not to send Email

5 Not to send Not to send

6 Not to send SMS

7 SMS Email

8 SMS Not to send

9 SMS SMS

10 Mail Email

11 Mail Not to send

12 Mail SMS

Since the invoicing function in the SAP IS-U system uses the SAP FI-CA dispatch control without using the correspondence variants, the communication
preferences category UMCB related to the invoicing document is not included in the combinations.
To model those combinations of communication categories and send methods, the following 12 correspondence variants must be maintained in Customizing under
SAP Reference IMG Cross-Application Components General Application Functions Correspondence Configure Correspondence Variants .

Variant Correspondence Name CTyp Periods DispContrl

UM00 UM00-MAIL/MAIL 0019 Immediately MAIL

0031 Immediately MAIL
UMCO Immediately MAIL

UM01 UM01-MAIL/NONE 0019 Immediately MAIL

0031 Immediately MAIL
UMCO Immediately NONE

UM02 UM02-MAIL/SMS 0019 Immediately MAIL

0031 Immediately MAIL
UMCO Immediately SMS

UM03 UM03-NONE/MAIL 0019 Immediately NONE

0031 Immediately NONE
UMCO Immediately MAIL

PUBLIC Page 17 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 UM04 UM04-NONE/NONE 0019 Immediately NONE
0031 Immediately NONE
UMCO Immediately NONE

UM05 UM05-NONE/SMS 0019 Immediately NONE

0031 Immediately NONE
UMCO Immediately SMS

UM06 UM06-SMS/MAIL 0019 Immediately SMS

0031 Immediately SMS
UMCO Immediately MAIL

UM07 UM07-SMS/NONE 0019 Immediately SMS

0031 Immediately SMS
UMCO Immediately NONE

UM08 UM08-SMS/SMS 0019 Immediately SMS

0031 Immediately SMS
UMCO Immediately SMS

UM09 UM09-STND/MAIL 0019 Immediately STND

0031 Immediately STND
UMCO Immediately MAIL

UM0A UM0A-STND/NONE 0019 Immediately STND

0031 Immediately STND
UMCO Immediately NONE

UM0B UM0B-STND/SMS 0019 Immediately STND

0031 Immediately STND
UMCO Immediately SMS

All variant IDs in the combination set must have the same 2 characters as prefix. The prefix is defined in the BAdI implementation method
GET_CORRESPONDENCE_DEFAULT by the property MV_VARIANT_PREFIX. When a new variant combination set used for communication preferences is
created, you must ensure that the prefix is unique and not used by any other variant. The prefix for the standard delivered variant set is “UM”.
An OData Service retrieves only variants with the prefix defined in Customizing. If a variant has the correct prefix, the service returns values of the communication
preferences defined by this variant. If the variant name is different, the user sees that their communication preferences are not maintained.
In order to help the system administrator to set up the correspondence variants correctly, the report ISU_UMC_MAINTAIN_VARIANT has been developed to
generate all variant combinations based on the current Customizing and BAdI implementation.

Step 6: Activate BC Set for the Customizing

You have to activate the BC Sets ISU_UMC_CORRESP_DISPATCH_CONTROL and ISU_UMC_CORRESPONDENCE by using transaction SCPR20 . Based on the
delivered example, you can maintain your own Customizing for communication preference categories and generate a new variant using a different variant prefix.

1.9 Move-In, Move-Out and Move-In/Out in Standalone ERP

Scenario

The API method CREATE_PARKEDDOCUMENT within the class CL_ISU_UMC_API_PARKEDDOCUMENT has been used to create a new parked document
provided by the feature Accelerated Move-In, Move-Out and Move-In/Out Entry (transaction EC70 in SAP ERP).

The current implementation is particularly intended for the standard Move-In, Move-Out and Move-In/Out processes for the same business partner. Very little
information is required to be entered by the user. After the parked document is created, the follow-up process begins, such as the creation of specific Move-In or
Move-Out or Move-In/Out processes in the SAP ERP system.

Prerequisites
The parked document data must be free of errors. If the parked document contains errors, the user has to contact the customer service department of the utility
company to resolve the errors in the parked document, and then complete the Move-In, Move-Out or Move-In/Out process.

Features
Based on the API CREATE_PARKEDDOCUMENT, the SAP Multichannel Foundation for Utilities OData Service entity ParkedDocument in SAP ERP requires the
following fields to create a parked document:

Value Description

ParkedDocumentID Parked Document ID (no need for creation)

AccountID Business Partner ID

MoveIn Complex type MasterDataKey for Move-In

MoveOut Complex type MasterDataKey for Move-Out

The fields in the complex type MasterDataKey are as follows:

Value Description

PUBLIC Page 18 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 ContractAccountID Contract Account ID

PremiseID Premise ID

Date The date for Move-In, Move-Out or Move-In/Out

Additionally, a table for the ParkedDocumentInstallation OData Service entity in SAP ERP is also required with the following fields to create a parked
document:

Value Description

ParkedDocumentID Parked Document ID (no need for creation)

InstallationID Installation ID

DivisionID Division ID

ProductID SAP CRM Product ID (Template for Creating Contract)

ServiceProviderID Service Provider ID

Activities
You must maintain the following configuration settings:
IS-U: Permitted Contract Model for Parking Customizing activity
In the TECAMIOVARAS table (transaction SM30 ), enter the contract models that are relevant for the accelerated move-in, move-out and move-in/out entry.
Here, you must also determine for which divisions a contract model is valid. The contract model is used to determine the master data template for creating a
contract.
Parking Variants Customizing activity
Maintain the view cluster VC_TECAMIOVAR (transaction SM34 ) to define parking variants. After creating the variants, allocate parking variants to the user
groups by maintaining the TECAMIOVARU table (transaction M30 ).
Master Data Templates
To use the accelerated move-in, move-out and move-in/out entry, at least two master data templates must be defined under the following categories:
Master data template category CRMNEWCONTRACT
Master data template category BPARTNER

More Information

For more information, see the Increased Efficiency SAP IS-U/CCS - New Developments on the SAP Service Marketplace at http://service.sap.com/utilities
under SAP for Utilities - Product Information SAP ERP for Utilities (IS-U) General Cookbooks & Guidelines .

1.10 Billed Consumption and Period Type

You use the API method GET_BILLED_CONSUMPTION within the class CL_ISU_UMC_API_GET_BILLED_CONS to retrieve the billed consumption. This API
returns the raw billed consumption for the given contract or the installation.
The class CL_ISU_UMC_API_GET_BILLED_CONS is based on the default BAdI implementation CL_DEF_IM_ISU_BILLED_CONSUMPT of the BAdI definition
ISU_PROVIDE_BILLED_CONSUMPT.

Features

Billed Consumption
Based on the API, the SAP Multichannel Foundation for Utilities OData Service entity ContractConsumptionValues in SAP ERP, returns the billed
consumption records with the following fields:

Value Description

Contract ID Utilities Contract ID

PeriodTypeID Period Type ID

StartDate Start date of the billing period

EndDate End date of the billing period

BilledAmount Contract monetary amount billed

Currency Currency for BilledAmount

ConsumptionValue Billed utilities consumption amount

ConsumptionUnit Utilities consumption unit of measurement

BillingPeriodYear Invoice Year

BillingPeriodMonth Invoice Month

MeterReadingCategoryID Meter Reading Category ID

PUBLIC Page 19 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Besides the standard fields listed above, the back end system API of the OData service also retrieves additional fields as defined in the DDIC structure
ISUS_UMC_CONSUMPTION as listed in the following table:

Value Description

MR_TYPE Meter reading type

REGISTER Register

BILLING_DOC_ID Number of a billing document

MR_DOCUMENT Meter reading document ID

MR_BILLED Billed meter reading

MR_PREVIOUS Previous meter reading

If the consumption values from multiple registers for the same period are billed together, the billed consumption and billed net values are aggregated. In this case,
all fields related to meter reading are empty since the record reflects the aggregated value based on the meter reading values from the different registers.
When the billing cycle is not yearly, but the PeriodTypeID = 'Y' (yearly), the billed consumption values and net values are aggregated by the invoice year.

Period Type
All validated period types are defined in the DDIC Domain ISU_UMC_PERIOD_TYPE as listed in the following table:

Value Description

BC Billing Cycle

Y Yearly

M Monthly

W Weekly

D Daily

2W Bi-Weekly

2M Bi-Monthly

HM Half-Monthly

HY Half-Yearly

Currently, the standard SAP Multichannel Foundation for Utilities OData Service entity PeriodType only supports BC (Billing Cycle) and Y (yearly). If you need
to support a period type other than that of the types billing cycle and yearly, the method GET_PERIOD_TYPE_LIST in the API class
CL_ISU_UMC_API_CONSUMPTION needs to be overwritten.

1.11 Paying Bills Without Logging In

This function allows a user to pay their bill without logging on to the utility company's portal as a registered user.

Prerequisites
In order to enable the user to make an anonymous payment, the following information must be provided:
Business Agreement ID (SAP CRM) or Contract Account ID (SAP ERP)
Detailed payment card information
E-mail address for payment confirmation

Activities
You use the same SAP Biller Direct for FI-CA API (GEN_EBPP_PUT_DATA) to make one time payments for a given business agreement (CRM) or contract
account (ERP) by balance mode through a payment card.

More Information
For more information on how to configure anonymous bill payments, see Configuring Payments.
For more information on the SAP Biller Direct in FI-CA function in the Configuration of SAP Biller Direct for FI-CA, see the SAP Help Portal at

http://help.sap.com/erp under SAP Contract Accounts Receivable and Payable (FI-CA).

For more information on payments in SAP FI-CA, see the SAP Help Portal at http://help.sap.com/erp under Contract Accounts Receivable and Payable
Payments .

1.12 OData Entities in SAP Multichannel Foundation for Utilities

and Public Sector

PUBLIC Page 20 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 OData (Open Data Protocol) is a standardized Web protocol for querying and updating data from different systems. It provides a way to unlock the data and free it
from boundaries that exist in applications today. OData builds on core protocols like HTTP and commonly accepted methodologies like REST. The result is a
uniform way to expose full-featured APIs.
CRUD operations (create, read, update, and delete) are mapped to POST, GET, PUT, or DELETE HTTP requests where the specifics of the command are in the
URL.
The semantics of HTTP operations are as follows:
GET: Get a collection of entities or a single entity.
POST: Create a new entity from an entry document.
PUT: Update an existing entity with an entry document.
DELETE: Remove an entity.
SAP Multichannel Foundation for Utilities provides a foundation with lightweight OData entities which are easily consumed. These are exposed using POST, GET,
PUT, and DELETE requests with a straightforward extensibility approach. Services need to wrap existing IS-U business processes on SAP ERP as well as SAP
CRM for Utilities. It is easy to create new services and use any UI approach to build web self-service applications as well as mobile applications.

More Information
Entities for OData Service Model in SAP CRM
Entities for OData Service Model in SAP ERP

1.12.1 Entities for OData Service Model in SAP ERP

This chapter lists all OData entities and function imports used in the SAP OData Service Model for SAP Multichannel Foundation for Utilities and Public Sector in
the SAP ERP system.

Note
You can easily extend the fields of the entities listed below. For more information, see the section on Application Operations in the Administrator's Guide for
SAP Multichannel Foundation for Utilities and Public Sector.

OData Entities
Account
AccountAddress
AccountAddressDependentEmail
AccountAddressDependentFax
AccountAddressDependentMobilePhone
AccountAddressDependentPhone
AccountAddressIndependentEmail
AccountAddressIndependentFax
AccountAddressIndependentMobilePhone
AccountAddressIndependentPhone
AccountAddressUsage
AccountAlert
AccountBalance
AccountContact
AccountSex
AccountTitle
AccountType
AddressType
Attachment
Bank
BankAccount
BudgetBillingCycle
BudgetBillingPlan
CommunicationCategory
CommunicationMethod
CommunicationPreference
ConsumptionPeriodType
ContactAction
ContactAdditionalInfo
ContactClass
ContactPriority

PUBLIC Page 21 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 ContactType
Contract
ContractAccount
ContractAccountBalance
ContractConsumptionValue
Country
Device
Division
FutureMeterReading
Installation
Invoice
InvoicePDF
Language
MeterReadingCategory
MeterReadingNote
MeterReadingReason
MeterReadingResult
MeterReadingStatus
Outage
ParkedDocument
ParkedDocumentInstallation
PaymentCard
PaymentCardType
PaymentDocument
PaymentDocumentItem
PaymentMethod
PaymentPlan
PaymentStatus
Premise
PremiseType
Product
ProfileHeader
ProfileType
ProfileValue
ProfileValuesFile
ProfileValueType
Region
RegisterToRead
RegisterType
ServiceNotification
ServiceOrder
ServicePriority
ServiceOrderType
ServiceProvider
ServiceNotificationType

OData Function Imports

GetAllowedCommunicationMethods
GetPremisesForAccount
GetPremisesByAddress
RequestChange
SimulatePaymentPlan

1.12.2.1 Account

An entity used to represent an account. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_ACCOUNT. A customer contact is created
for a PUT operation in the back end system.

Properties

PUBLIC Page 22 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 The OData Entity Account has the following properties:

AccountTypeID
AccountID
AccountTitleID
FirstName
LastName
MiddleName
SecondName
Sex
Name1
Name2
Name3
Name4
GroupName1
GroupName2
FullName

Possible Operations
The following operations are possible when using the Account Entity:

GET
PUT

Navigation Properties
It is possible to navigate from the Account Entity to the following Entities:
AccountContacts
AccountType
AccountAlerts
StandardAccountAddress
CommunicationPreferences
ServiceNotifications
ContractAccounts
AccountAddresses
PaymentCards
ServiceOrders
AccountAddressIndependentEmails
AccountAddressIndependentMobilePhones
AccountAddressIndependentPhones
AccountAddressIndependentFaxes
PaymentDocuments
Invoices
BankAccounts
AccountSex
AccountTitle

Filters
There are no filters implemented for this Entity.

1.12.2.2 AccountAddress

An entity used to represent an address associated with a given account (business partner). The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_ADDRESS. A customer contact is created for a PUT operation in the back end system.

Properties
The OData Entity AccountAddress has the following properties:

AccountID
AddressID
AddressInfo

Possible Operations
The following operations are possible when using the AccountAddress Entity:
GET
POST

Navigation Properties
It is possible to navigate from the AccountAddress Entity to the following Entities:

PUBLIC Page 23 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 AccountAddressDependentFaxes
AccountAddressDependentMobilePhones
AccountAddressUsages
AccountAddressDependentPhones
AccountAddressDependentEmails

Filters
There are no filters implemented for this Entity.

1.12.2.3 AccountAddressDependentEmail

An entity used to represent an address-dependent e-mail. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_ADDRDEPEMAIL. A
customer contact is created for a PUT, POST, or DELETE operation in the back end system.

Properties
The OData Entity AccountAddressDependentEmail has the following properties:

AccountID
AddressID
SequenceNo
Email
HomeFlag
StandardFlag

Possible Operations
The following operations are possible when using the AccountAddressDependentEmail Entity:

GET
PUT
POST
DELETE

Navigation Properties
There are no navigation properties for the AccountAddressDependentEmail Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.4 AccountAddressDependentFax

An entity used to represent an address-dependent fax number. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_ADDRDEPFAX. A
customer contact is created for a PUT, POST, or DELETE operation in the back end system.

Properties
The OData Entity AccountAddressDependentFax has the following properties:

AccountID
AddressID
SequenceNo
FaxNo
HomeFlag
StandardFlag
Extension
CompleteFaxNo
CountryID

Possible Operations
The following operations are possible when using the AccountAddressDependentFax Entity:

GET
PUT
POST
DELETE

Navigation Properties
There are no navigation properties for the AccountAddressDependentFax Entity.

PUBLIC Page 24 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Filters
There are no filters implemented for this Entity.

1.12.2.5 AccountAddressDependentMobilePhone

An entity used to represent an address-dependent mobile phone number. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_ADDRDEPMOBILE. A customer contact is created for a PUT, POST, or DELETE operation in the back end system.

Properties
The OData Entity AccountAddressDependentMobilePhone has the following properties:
AccountID
AddressID
SequenceNo
PhoneNo
HomeFlag
StandardFlag
Extension
CompletePhoneNo
CountryID
DefaultFlag
PhoneType

Possible Operations
The following operations are possible when using the AccountAddressDependentMobilePhone Entity:

GET
PUT
POST
DELETE

Navigation Properties
There are no navigation properties for the AccountAddressDependentMobilePhone Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.6 AccountAddressDependentPhone

An entity used to represent an address-dependent phone number. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_ADDRDEPPHONE. A customer contact is created for a PUT, POST, or DELETE operation in the back end system.

Properties
The OData Entity AccountAddressDependentPhone has the following properties:

AccountID
AddressID
SequenceNo
PhoneNo
HomeFlag
StandardFlag
Extension
CompletePhoneNo
CountryID
PhoneType

Possible Operations
The following operations are possible when using the AccountAddressDependentPhone Entity:

GET
PUT
POST
DELETE

Navigation Properties

PUBLIC Page 25 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 There are no navigation properties for the AccountAddressDependentPhone Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.7 AccountAddressIndependentEmail

An entity used to represent an address-independent e-mail. The Business Add-In (BAdI) implementation for this Entity is CL_CRM_IU_UMC_ODATA_INDEMAIL.
A customer contact is created for a PUT, POST, or DELETE operation in the back end system.

Properties
The OData Entity AccountAddressIndependentEmail has the following properties:

AccountID
SequenceNo
Email
HomeFlag
StandardFlag

Possible Operations
The following operations are possible when using the AccountAddressIndependentEmail Entity:

GET
PUT
POST
DELETE

Navigation Properties
There are no navigation properties for the AccountAddressIndependentEmail Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.8 AccountAddressIndependentFax

An entity used to represent an address-independent fax number. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_ADDRINDFAX.
A customer contact is created for a PUT, POST, or DELETE operation in the back end system.

Properties
The OData Entity AccountAddressIndependentFax has the following properties:

AccountID
SequenceNo
FaxNo
HomeFlag
StandardFlag
Extension
CompleteFaxNo
CountryID

Possible Operations
The following operations are possible when using the AccountAddressIndependentFax Entity:

GET
PUT
POST
DELETE

Navigation Properties
There are no navigation properties for the AccountAddressIndependentFax Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.9 AccountAddressIndependentMobilePhone
PUBLIC Page 26 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 1.12.2.9 AccountAddressIndependentMobilePhone

An entity used to represent an address-independent mobile phone number. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_ADDRINDMOBILE. A customer contact is created for a PUT, POST, or DELETE operation in the back end system.

Properties
The OData Entity AccountAddressIndependentMobilePhone has the following properties:

AccountID
SequenceNo
PhoneNo
HomeFlag
StandardFlag
Extension
CompletePhoneNo
DefaultFlag
CountryID
PhoneType

Possible Operations
The following operations are possible when using the AccountAddressIndependentMobilePhone Entity:

GET
PUT
POST
DELETE

Navigation Properties
There are no navigation properties for the AccountAddressIndependentMobilePhone Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.10 AccountAddressIndependentPhone

An entity used to represent an address-independent phone number. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_ADDRINDPHONE. A customer contact is created for a PUT, POST, or DELETE operation in the back end system.

Properties
The OData Entity AccountAddressIndependentPhone has the following properties:

AccountID
SequenceNo
PhoneNo
HomeFlag
StandardFlag
Extension
CompletePhoneNo
CountryID
PhoneType

Possible Operations
The following operations are possible when using the AccountAddressIndependentPhone Entity:

GET
PUT
POST
DELETE

Navigation Properties
There are no navigation properties for the AccountAddressIndependentPhone Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.11 AccountAddressUsage
PUBLIC Page 27 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 1.12.2.11 AccountAddressUsage

An entity used to represent how an account address is used. This entity is linked to the AddressType Entity. Examples of address usage are standard address,
billing address, and communication address. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_ADDRUSAGE.

Properties
The OData Entity AccountAddressUsage has the following properties:

AccountID
AddressID
AddressTypeID

Possible Operations
A GET operation is possible when using the AccountAddressUsage Entity.

Navigation Properties
It is possible to navigate from the AccountAddressUsage Entity to the AddressType Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.12 AccountAlert

An entity used to represent an alert notification for an account, for example, an overdue bill payment. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_ACCOUNTALERT.

Properties
The OData Entity AccountAlert has the following properties:

AccountID
AlertID
AlertTypeID
AlertSeverityID
Subject
Message

Possible Operations
A GET operation is possible when using the AccountAlert Entity.

Navigation Properties
There are no navigation properties for the AccountAlert Entity.

Filters
The AccountAlert Entity can be filtered on the following Entities:

AlertTypeID
AlertSeverityID

1.12.1.13 AccountBalance

An entity used to represent account balance. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_ACCOUNTBALANCE.

Properties
The OData Entity ISU_UMC_ODATA_ACCOUNTBALANCE has the following properties:

AccountID
CurrentBalance
TotalAmount
NetAmount
OpenCollectable
OpenDebits
OpenCredits
Currency

PUBLIC Page 28 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Possible Operations
A GET operation is possible when using the AccountBalance Entity.

Navigation Properties
There are no navigation properties for the AccountBalance Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.14 AccountContact

An entity used to represent a contact for an account. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_ACCOUNTCONTACT. A
customer contact is created for a POST operation in the back end system.

Properties
The OData Entity AccountContact has the following properties:

AccountContactID
AccountID
ContactClassID
ContactActionID
ContactPriorityID
ContactDate
Note
ContactTypeID

Possible Operations
A GET operation is possible when using the AccountContact Entity.

Navigation Properties
It is possible to navigate from the AccountContact Entity to the following Entities:

ContactClass
ContactAction
ContactPriority

Filters
There are no filters implemented for this Entity.

1.12.2.12 AccountSex

An entity used to represent the gender of the account holder. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_ACCOUNTSEX.

Properties
The OData Entity AccountSex has the following properties:

Sex
Description

Possible Operations
A GET operation is possible when using the AccountSex Entity.

Navigation Properties
There are no navigation properties for the AccountSex Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.13 AccountTitle

PUBLIC Page 29 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 An entity used to represent the title of an account holder. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_ACCOUNTTITLE.

Properties
The OData Entity AccountTitle has the following properties:

TitleID
AccountTypeID
Description

Possible Operations
A GET operation is possible when using the AccountTitle Entity.

Navigation Properties
It is possible to navigate from the AccountTitle Entity to the AccountType Entity.

Filters
The AccountTitle Entity can be filtered on the AccountTypeID Entity.

1.12.2.14 AccountType

An entity used to represent a type of account. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_ACCOUNTTYPE.

Properties
The OData Entity AccountType has the following properties:

AccountTypeID
Description

Possible Operations
A GET operation is possible when using the AccountType Entity.

Navigation Properties
There are no navigation properties for the AccountType Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.15 AddressType

An entity used to represent types of addresses that are used to identify the usage for the address. Examples of address types are standard address, billing
address and communication address. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_ADDRTYPE.

Properties
The OData Entity AddressType has the following properties:

AddressTypeID
Description

Possible Operations
A GET operation is possible when using the AddressType Entity.

Navigation Properties
There are no navigation properties for the AddressType Entity.

Filters
The AddressType Entity can be filtered on the following Entities:

AddressTypeID
Description

1.12.2.16 Attachment

PUBLIC Page 30 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 An entity used to represent an attachment. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_ATTACHMENT. An Attachment
document is created for a Post operation in the back end system, and linked to an associated business object, either Outage or ServiceNotification.

Properties
The OData Entity Attachment has the following properties:

AttachmentID
EntityID
EntityName
Description
MimeType
MediaResource
FileName

Possible Operations
The following operations are possible when using the Attachment Entity:

GET
POST

Navigation Properties
There are no navigation properties for the Attachment Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.17 Bank

An entity used to represent a bank. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_BANK.

Properties
The OData Entity Bank has the following properties:

CountryID
BankID
Name
City
SWIFTCode

Possible Operations
A GET operation is possible when using the Bank Entity.

Navigation Properties
There are no navigation properties for the Bank Entity.

Filters
The Bank Entity can be filtered on the CountryID Entity.

1.12.2.18 BankAccount

An entity used to represent a bank account. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_BANKACCOUNT. A customer contact
is created for a PUT, POST, or DELETE operation in the back end system.

Properties
The OData Entity BankAccount has the following properties:

CountryID
AccountID
BankAccountID
BankID
BankAccountNo
AccountHolder
BankAccountName
IBAN

PUBLIC Page 31 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Possible Operations
The following operations are possible when using the BankAccount Entity:

GET
PUT
POST
DELETE

Navigation Properties
It is possible to navigate from the BankAccount Entity to the Bank Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.22 BudgetBillingCycle

An entity used to access a budget billing cycle object. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_BUDGETBILLINGCYC.

Properties
The OData Entity BudgetBillingCycle has the following properties:

BudgetBillingCycleID
Description

Possible Operations
A GET operation is possible when using the BudgetBillingCycle Entity.

Navigation Properties
There are no navigation properties for the BudgetBillingCycle Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.23 BudgetBillingPlan

An entity used to represent a budget billing plan for Europe. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_BUDGETBILLINGPL. A customer contact is created for a PUT operation in the back end system.

Properties
The OData Entity BudgetBillingPlan has the following properties:

ContractID
BudgetBillingPlanID
BudgetBillingCycleID
Amount
StartDate
EndDate
Currency
ChangeFromDate
UpperLimitAmount
LowerLimitAmount

Possible Operations
The following operations are possible when using the BudgetBillingPlan Entity:

GET
PUT

Navigation Properties
It is possible to navigate from the BudgetBillingPlan Entity to the BudgetBillingCycle Entity.

Filters

PUBLIC Page 32 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 There are no filters implemented for this Entity.

1.12.1.24 CommunicationCategory

An entity used to represent the description of a communication category. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_COMMCATEGORY.

Properties
The OData Entity CommunicationCategory has the following properties:

CommunicationCategoryID
Description

Possible Operations
A GET operation is possible when using the CommunicationCategory Entity.

Navigation Properties
There are no navigation properties for the CommunicationCategory Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.25 CommunicationMethod

An entity used to represent the description of a communication method. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_COMMMETHOD.

Properties
The OData Entity CommunicationMethod has the following properties:

CommunicationMethodID
Description

Possible Operations
A GET operation is possible when using the CommunicationMethod Entity.

Navigation Properties
There are no navigation properties for the CommunicationMethod Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.26 CommunicationPreference

An entity used to represent a user's preferred method of communication. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_COMMPREFERENCE.

Properties
The OData Entity CommunicationPreference has the following properties:

ContractAccountID
CommunicationCategoryID
CommunicationMethodID
AccountID
AddressID

Possible Operations
A GET operation is possible when using the CommunicationPreference Entity.

Navigation Properties
It is possible to navigate from the CommunicationPreference Entity to the following Entities:

PUBLIC Page 33 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 AccountAddress
CommunicationCategory
CommunicationMethod
DependentAccountCommPreferences
DependentContractAccountCommPreferences

Filters
There are no filters implemented for this Entity.

1.12.1.27 ConsumptionPeriodType

An entity used to represent an interval between consumption values, for example, monthly, bi-monthly, and yearly. By default, there are two intervals supported –
default billing period which this Utility company is using, and “yearly” consumption. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_PERIODTYPE.

Properties
The OData Entity ConsumptionPeriodType has the following properties:

ConsumptionPeriodTypeID
Description

Possible Operations
A GET operation is possible when using the ConsumptionPeriodType Entity.

Navigation Properties
There are no navigation properties for the ConsumptionPeriodType Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.28 ContactAction

An entity used to represent contact action, which is a part of the categorization of an account contact. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_CONTACTACTION.

Properties
The OData Entity ContactAction has the following properties:
ContactClassID
ContactActionID
Description

Possible Operations
A GET operation is possible when using the ContactAction Entity.

Navigation Properties
It is possible to navigate from the ContactAction Entity to the ContactClass Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.29 ContactAdditionalInfo

An entity used to represent the description for additional information for a customer. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_ADDITIONALINFO.

Properties
The OData Entity ContactAdditionalInfo has the following properties:

ContactAdditionalInfoID
Description

PUBLIC Page 34 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Possible Operations
A GET operation is possible when using the ContactAdditionalInfo Entity.

Navigation Properties
There are no navigation properties for the ContactAdditionalInfo Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.30 ContactClass

An entity used to represent contact class, which is a part of the categorization of an account contact. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_CONTACTCLASS.

Properties
The OData Entity ContactClass has the following properties:

ContactClassID
Description

Possible Operations
A GET operation is possible when using the ContactClass Entity.

Navigation Properties
There are no navigation properties for the ContactClass Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.31 ContactPriority

An entity used to represent priority for an account contact. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_CONTACTPRIORITY.

Properties
The OData Entity ContactPriority has the following properties:

ContactPriorityID
Description

Possible Operations
A GET operation is possible when using the ContactPriority Entity.

Navigation Properties
There are no navigation properties for the ContactPriority Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.32 ContactType

An entity used to represent a channel for an account contact or outage. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_CONTACTTYPE. A customer contact is created for a PUT, POST, or DELETE operation in the back end system.

Properties
The OData Entity ContactType has the following properties:

ContactTypeID
Description

PUBLIC Page 35 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Possible Operations
A GET operation is possible when using the ContactType Entity.

Navigation Properties
There are no navigation properties for the ContactType Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.33 Contract

An entity used to represent a contract in the SAP IS-U system. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_CONTRACT.

Properties
The OData Entity Contract has the following properties:

ContractID
Description
ContractAccountID
DivisionID
PremiseID
MoveInDate
MoveOutDate
ProcessingStatus

Possible Operations
A GET operation is possible when using the Contract Entity.

Navigation Properties
It is possible to navigate from the Contract Entity to the following Entities:

ActivePaymentPlan
ContractConsumptionValues
Premise
Devices
ActiveBudgetBillingPlan
Division
ContractAccount

Filters
The Contract Entity can be filtered on the MoveInDate Entity.

1.12.1.34 ContractAccount

An entity used to represent a contract account. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_CONTRACTACCOUNT. A customer
contact is created for a PUT operation in the back end system.

Properties
The OData Entity ContractAccount has the following properties:

ContractAccountID
AccountID
Description
BudgetBillingProcedure
IncomingPaymentMethodID
OutgoingPaymentMethodID1
OutgoingPaymentMethodID2
OutgoingPaymentMethodID3
OutgoingPaymentMethodID4
OutgoingPaymentMethodID5
IncomingPaymentBankAccountID
OutgoingPaymentBankAccountID
IncomingPaymentPaymentCardID
OutgoingPaymentPaymentCardID
AccountAddressID
BillToAccountID

PUBLIC Page 36 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 BillToAccountAddressID
CountryID

Possible Operations
The following operations are possible when using the ContractAccount Entity:
GET
PUT

Navigation Properties
It is possible to navigate from the ContractAccount Entity to the following Entities:

Invoices
ContractAccountBalance
Contracts
BillToAccountAddress
OutgoingPaymentMethod1
IncomingPaymentMethod
OutgoingPaymentMethod3
OutgoingPaymentMethod5
IncomingBankAccount
BillToAccount
AccountAddress
Country
CommunicationPreferences
IncomingPaymentCard
OutgoingPaymentMethod4
OutgoingBankAccount
OutgoingPaymentCard
OutgoingPaymentMethod2

Filters
There are no filters implemented for this Entity.

1.12.1.35 ContractAccountBalance

An entity used to represent a contract account balance in the SAP IS-U system. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_CONTRACCBAL.

Properties
The OData Entity ContractAccountBalance has the following properties:

ContractAccountID
CurrentBalance
TotalAmount
NetAmount
OpenCollectable
OpenDebits
OpenCredits
Currency

Possible Operations
A GET operation is possible when using the ContractAccountBalance Entity.

Navigation Properties
There are no navigation properties for the ContractAccountBalance Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.36 ContractConsumptionValue

An entity used to represent the total consumption value for a contract. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_CONSUMPTION.

PUBLIC Page 37 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 The OData Entity ContractConsumptionValue has the following properties:

ContractID
ConsumptionPeriodTypeID
StartDate
EndDate
BilledAmount
Currency
ConsumptionValue
ConsumptionUnit
BillingPeriodYear
BillingPeriodMonth
MeterReadingCategoryID

Possible Operations
A GET operation is possible when using the ContractConsumptionValue Entity.

Navigation Properties
It is possible to navigate from the ContractConsumptionValue Entity to the following Entities:

ConsumptionPeriodType
MeterReadingCategory

Filters
There are no filters implemented for this Entity.

1.12.2.26 Country

An entity used to represent a country. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_COUNTRY.

Properties
The OData Entity Country has the following properties:

CountryID
Name

Possible Operations
A GET operation is possible when using the Country Entity.

Navigation Properties
It is possible to navigate from the Country Entity to the following Entities:

PaymentMethods
Regions

Filters
The Country Entity can be filtered on the following Entities:

CountryID
Name

1.12.1.38 Device

An entity used to represent a device. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_DEVICE.

Properties
The OData Entity Device has the following properties:

DeviceID
ContractID
DivisionID
SerialNumber

Possible Operations
A GET operation is possible when using the Device Entity.

PUBLIC Page 38 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Navigation Properties
It is possible to navigate from the Device Entity to the following Entities:

FutureMeterReadings
Division
Contract
MeterReadingResults
RegistersToRead

Filters
There are no filters implemented for this Entity.

1.12.2.27 Division

An entity used to represent a division. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_DIVISION.

Properties
The OData Entity Division has the following properties:

DivisionID
Description

Possible Operations
A GET operation is possible when using the Division Entity.

Navigation Properties
There are no navigation properties for the Division Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.40 FutureMeterReading

An entity used to represent a meter reading scheduled for a future date. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_FUTUREREADING.

Properties
The OData Entity FutureMeterReading has the following properties:

DeviceID
MeterReadingReasonID
MeterReadingCategoryID
MeterReadingDate
SerialNumber

Possible Operations
A GET operation is possible when using the FutureMeterReading Entity.

Navigation Properties
It is possible to navigate from the FutureMeterReading Entity to the following Entities:

MeterReadingCategory
Device
MeterReadingReason

Filters
There are no filters implemented for this Entity.

1.12.1.41 Installation

An entity used to manage an installation. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_INSTALLATION.

PUBLIC Page 39 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Properties
The OData Entity Installation has the following properties:

InstallationID
DivisionID
PremiseID

Possible Operations
A GET operation is possible when using the Installation Entity.

Navigation Properties
It is possible to navigate from the Installation Entity to the Division Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.42 Invoice

An entity used to represent an invoicing document. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_INVOICE.

Properties
The OData Entity Invoice has the following properties:

InvoiceID
AccountID
ContractAccountID
AmountDue
Currency
DueDate
InvoiceDate
AmountPaid
AmountRemaining
InvoiceDescription
InvoiceStatusID

Possible Operations
A GET operation is possible when using the Invoice Entity.

Navigation Properties
It is possible to navigate from the Invoice Entity to the following Entities:

ContractAccount
InvoicePDF

Filters
The Invoice Entity can be filtered on the following Entities:

InvoiceDate
InvoiceStatusID

1.12.1.43 InvoicePDF

An entity used to represent a PDF document associated with an invoicing document. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_INVOICEPDF.

Properties
The OData Entity InvoicePDF has the following properties:

InvoiceID
MimeType
MediaResource

Possible Operations
A GET operation is possible when using the InvoicePDF Entity.

PUBLIC Page 40 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Navigation Properties
There are no navigation properties for the InvoicePDF Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.44 MeterReadingCategory

An entity used to represent the description of a meter reading category. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_READINGCATEGORY.

Properties
The OData Entity MeterReadingCategory has the following properties:

MeterReadingCategoryID
Description

Possible Operations
A GET operation is possible when using the MeterReadingCategory Entity.

Navigation Properties
There are no navigation properties for the MeterReadingCategory Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.45 MeterReadingNote

An entity used to represent a note of a meter reader. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_READINGNOTE.

Properties
The OData Entity MeterReadingNote has the following properties:

MeterReadingNoteID
Description

Possible Operations
A GET operation is possible when using the MeterReadingNote Entity.

Navigation Properties
There are no navigation properties for the MeterReadingNote Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.46 MeterReadingReason

An entity used to represent the description of a meter reading reason. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_READINGREASON.

Properties
The OData Entity MeterReadingReason has the following properties:

MeterReadingReasonID
Description

Possible Operations
A GET operation is possible when using the MeterReadingReason Entity.

PUBLIC Page 41 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Navigation Properties
There are no navigation properties for the MeterReadingReason Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.47 MeterReadingResult

An entity used to represent historic meter reading results as well as to upload new meter reading results. The Business Add-In (BAdI) implementation for this
Entity is ISU_UMC_ODATA_MRRESULT. A customer contact is created for a POST operation in the back end system.

Properties
The OData Entity MeterReadingResult has the following properties:
MeterReadingResultID
DeviceID
RegisterID
ReadingResult
ReadingDateTime
ReadingUnit
MeterReadingNoteID
Consumption
MeterReadingReasonID
MeterReadingCategoryID
MeterReadingStatusID
SerialNumber
MultipleMeterReadingReasonsFlag

Possible Operations
The following operations are possible when using the MeterReadingResult Entity:

GET
POST

Navigation Properties
It is possible to navigate from the MeterReadingResult Entity to the following Entities:

MeterReadingReason
MeterReadingReasons
MeterReadingNote
MeterReadingCategory
Device
DependentMeterReadingResults
MeterReadingStatus

Filters
There are no filters implemented for this Entity.

1.12.1.48 MeterReadingStatus

An entity used to represent the description of a meter reading status. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_READINGSTATUS.

Properties
The OData Entity MeterReadingStatus has the following properties:

MeterReadingStatusID
Description

Possible Operations
A GET operation is possible when using the MeterReadingStatus Entity.

Navigation Properties
There are no navigation properties for the MeterReadingStatus Entity.

PUBLIC Page 42 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Filters
There are no filters implemented for this Entity.

1.12.1.49 Outage

An entity used to represent an outage. This Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_OUTAGE. A customer contact is created for
a POST operation in the back end system.

Properties
The OData Entity Outage has the following properties:

OutageID
ContactPriorityID
Note
ContactTypeID
DateTime
ContactAdditionalInfoID
PremiseID
IncomingFlag

Possible Operations
The following operations are possible when using the Outage Entity:

GET
POST

Navigation Properties
It is possible to navigate from the Outage Entity to the following Entities:

Premise
ContactType
ContactPriority
ContactAdditionalInfo

Filters
The Entity can be filtered on the DateTime Entity.

1.12.1.50 ParkedDocument

An entity used to manage a parked document. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_PARKEDDOCUMENT. A customer
contact is created for a POST operation in the back end system.

Properties
The OData Entity ParkedDocument has the following properties:

ParkedDocumentID
AccountID
MoveIn
MoveOut

Possible Operations
A POST operation is possible when using the ParkedDocument Entity.

Navigation Properties
It is possible to navigate from the ParkedDocument Entity to the following Entities:

MoveOutInstallations
MoveInInstallations

Filters
There are no filters implemented for this Entity.

1.12.1.51 ParkedDocumentInstallation

PUBLIC Page 43 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 An entity used to manage a parked document installation. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_PARKEDDOCINSTALL.

Properties
The OData Entity ParkedDocumentInstallation has the following properties:

ParkedDocumentID
InstallationID
DivisionID
ProductID
ServiceProviderID

Possible Operations
No operations are possible when using the ParkedDocumentInstallation Entity.

Navigation Properties
There are no navigation properties for the ParkedDocumentInstallation Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.32 PaymentCard

An entity used to represent a payment card in the SAP IS-U account. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_PCARD. A
customer contact is created for a PUT, POST, or DELETE operation in the back end system.

Properties
The OData Entity PaymentCard has the following properties:

AccountID
PaymentCardID
PaymentCardTypeID
CardNumber
StandardFlag
Description
ValidFrom
ValidTo
Cardholder
Issuer
IssueDate

Possible Operations
The following operations are possible when using the PaymentCard Entity:

GET
PUT
POST
DELETE

Navigation Properties
It is possible to navigate from the PaymentCard Entity to the PaymentCardType Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.33 PaymentCardType

An entity used to read payment card types. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_PCARDTYPE.

Properties
The OData Entity PaymentCardType has the following properties:

PaymentCardTypeID
Description

PUBLIC Page 44 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Possible Operations
A GET operation is possible when using the PaymentCardType Entity.

Navigation Properties
There are no navigation properties for the PaymentCardType Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.54 PaymentDocument

An entity used to manage payments at the invoice level in the SAP IS-U system. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_PAYMENTDOCUMENT. A customer contact is created for a POST, or DELETE operation in the back end system.

Properties
The OData Entity PaymentDocument has the following properties:

PaymentDocumentID
AccountID
PaymentMethodDescription
ExecutionDate
Amount
Currency
PaymentStatusID
BankAccountID
PaymentCardID
CVC
PaymentCardTypeID
CardNumber
ValidFrom
ValidTo
Cardholder

Possible Operations
The following operations are possible when using the PaymentDocument Entity:
GET
POST
DELETE

Navigation Properties
It is possible to navigate from the PaymentDocument Entity to the following Entities:

PaymentDocumentStatus
PaymentDocumentItems

Filters
The PaymentDocument Entity can be filtered on the following Entities:

ExecutionDate
PaymentStatusID

1.12.1.55 PaymentDocumentItem

An entity used to manage a payment at the invoice level in the SAP IS-U system. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_PAYMENTDOCITEM. A customer contact is created for a PUT, POST, or DELETE operation in the back end system.

Properties
The OData Entity PaymentDocumentItem has the following properties:

PaymentDocumentID
InvoiceID
ExecutionDate
Amount
Currency

PUBLIC Page 45 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Possible Operations
A GET operation is possible when using the PaymentDocumentItem Entity.

Navigation Properties
There are no navigation properties for the PaymentDocumentItem Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.56 PaymentMethod

An entity used to retrieve a payment method. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_PAYMETHOD.

Properties
The OData Entity PaymentMethod has the following properties:

CountryID
PaymentMethodID
Description

Possible Operations
A GET operation is possible when using the PaymentMethod Entity.

Navigation Properties
There are no navigation properties for the PaymentMethod Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.57 PaymentPlan

An entity used to represent a payment plan. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_PAYMENTPLAN. A customer contact
is created for a POST, DELETE and EXECUTEoperation in the back end system.

Properties
The OData Entity PaymentPlan has the following properties:

ContractID
PaymentPlanID
PaymentPlanCycleID
Amount
BalanceForwardAmount
Currency
StartingMonth
Year
AlternativeStartingMonth

Possible Operations
The following operations are possible when using the PaymentPlan Entity:

GET
EXECUTE
POST
DELETE

Navigation Properties
It is possible to navigate from the PaymentPlan Entity to the BudgetBillingCycle Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.58 PaymentStatus
PUBLIC Page 46 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 An entity used to indicate the clearing status of a payment (PaymentDocument). The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_PAYMENTSTATUS. A customer contact is created for a PUT, POST, or DELETE operation in the back end system.

Properties
The OData Entity PaymentStatus has the following properties:
PaymentStatusID
Description

Possible Operations
A GET operation is possible when using the PaymentStatus Entity.

Navigation Properties
There are no navigation properties for the PaymentStatus Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.59 Premise

An entity used to represent a premise. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_PREMISE. A customer contact is created
for an EXECUTE ACTION operation in the back end system.

Properties
The OData Entity Premise has the following properties:

PremiseID
PremiseTypeID
AddressInfo

Possible Operations
A GET operation is possible when using the Premise Entity.

Navigation Properties
It is possible to navigate from the Premise Entity to the following Entities:

PremiseType
Installations

Filters
There are no filters implemented for this Entity.

1.12.1.60 PremiseType

An entity used to represent a premise type. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_PREM_TYPE.

Properties
The OData Entity PremiseType has the following properties:

PremiseTypeID
Description

Possible Operations
A GET operation is possible when using the PremiseType Entity.

Navigation Properties
There are no navigation properties for the PremiseType Entity.

Filters
There are no filters implemented for this Entity.

PUBLIC Page 47 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 1.12.1.61 Product

An entity used to represent a product. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_PRODUCT.

Properties
The OData Entity Product has the following properties:
ProductID
Description
LongText
IconURL
DivisionID
PremiseTypeID
PersonsMin
PersonsMax
ConsumptionMin
ConsumptionMax

Possible Operations
A GET operation is possible when using the Product Entity.

Navigation Properties
It is possible to navigate from the Product Entity to the following Entities:
UtilitiesProductPrices
PremiseType
Division

Filters
The Product Entity can be filtered on the following Entities:
ProductID
DivisionID
PremiseTypeID
PersonsMin
PersonsMax
ConsumptionMin
ConsumptionMax

1.12.1.62 ProfileHeader

An entity used to represent a profile header. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_PROFHEADER.

Properties
The OData Entity ProfileHeader has the following properties:
ProfileHeaderID
DeviceID
DivisionID
RegisterID
Interval
ProfileTypeID
UnitOfMeasure
Currency
Datefrom
Timefrom
Dateto
Timeto
TimeZone

Possible Operations
A GET operation is possible when using the ProfileHeader Entity.

Navigation Properties
It is possible to navigate from the ProfileHeader Entity to the following Entities:
ProfileType

PUBLIC Page 48 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 ProfileValues

Filters
There are no filters implemented for this Entity.

1.12.1.63 ProfileType

An entity used to represent a profile type. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_PROFTYPE.

Properties
The OData Entity ProfileType has the following properties:
ProfileTypeID
Description

Possible Operations
A GET operation is possible when using the ProfileType Entity.

Navigation Properties
There are no navigation properties for the ProfileType Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.64 ProfileValue

An entity used to represent a profile value. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_PROFVALUE.

Properties
The OData Entity ProfileValue has the following properties:

ProfileHeaderID
Timestamp
OutputInterval
ContractID
DeviceID
RegisterID
ProfileTypeID
ProfileValueTypeID
UnitOfMeasure
Currency
TimeZone
Value

Possible Operations
A GET operation is possible when using the ProfileValue Entity.

Navigation Properties
It is possible to navigate from the ProfileValue Entity to the following Entities:

ProfileType
ProfileValueType

Filters
The ProfileValue Entity can be filtered on the following Entities:
ProfileHeaderID
Timestamp
OutputInterval
ContractID
DeviceID
RegisterID
ProfileTypeID
UnitOfMeasure
Currency

PUBLIC Page 49 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 1.12.1.65 ProfileValuesFile

An entity used to represent a file of profile values. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_PROFVALUEFILE.

Properties
The OData Entity ProfileValuesFile has the following properties:
ProfileValuesFileID
MimeType
MediaResource
Timestamp
OutputInterval
ContractID
DeviceID
RegisterID
ProfileHeaderID
ProfileTypeID

Possible Operations
A GET operation is possible when using the ProfileValuesFile Entity.

Navigation Properties
There are no navigations implemented for the ProfileValuesFile Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.66 ProfileValueType

An entity used to represent a profile value type. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_PROFVALUETYPE.

Properties
The OData Entity ProfileValueType has the following properties:
ProfileValueTypeID
Description

Possible Operations
A GET operation is possible when using the ProfileValueType Entity.

Navigation Properties
There are no navigation properties for the ProfileValueType Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.67 Region

An entity used to represent a region. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_REGION.

Properties
The OData Entity Region has the following properties:

CountryID
RegionID
Name

Possible Operations
A GET operation is possible when using the Region Entity.

PUBLIC Page 50 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Navigation Properties
There are no navigation properties for the Region Entity.

Filters
The Region Entity can be filtered on the following Entities:
CountryID
RegionID
Name

1.12.1.68 RegisterToRead

An entity used to represent all registers of a device in the SAP IS-U system that are ready for meter reading. The Business Add-In (BAdI) implementation for this
Entity is ISU_UMC_ODATA_REGISTERTOREAD. A customer contact is created for a PUT, POST, or DELETE operation in the back end system.

Properties
The OData Entity RegisterToRead has the following properties:
DeviceID
RegisterID
RegisterTypeID
ReadingUnit
IntegerPlaces
DecimalPlaces
NoMeterReadingOrderFlag
PreviousMeterReadingResult
PreviousMeterReadingDate
PreviousMeterReadingReasonID
PreviousMeterReadingCategoryID
SerialNumber

Possible Operations
A GET operation is possible when using the RegisterToRead Entity.

Navigation Properties
It is possible to navigate from the RegisterToRead Entity to the following Entities:
Device
MeterReadingReason
MeterReadingCategory
RegisterType

Filters
The RegisterToRead Entity can be filtered on the following Entities:

PreviousMeterReadingResult
PreviousMeterReadingDate

1.12.1.69 RegisterType

An entity used to represent the description of a type of register in the SAP IS-U system. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_REGISTERTYPE.

Properties
The OData Entity RegisterType has the following properties:
RegisterTypeID
Description

Possible Operations
A GET operation is possible when using the RegisterType Entity.

Navigation Properties
There are no navigation properties for the RegisterType Entity.

PUBLIC Page 51 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Filters
There are no filters implemented for this Entity.

1.12.1.70 ServiceNotification

An entity used to represent a service notification. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_SERVICENOTIF. A customer
contact is created for a POST operation in the back end system.

Properties
The OData Entity ServiceNotification has the following properties:
ServiceNotificationID
DeviceID
MalfunctionStartDate
MalfunctionEndDate
ServicePriorityID
ServiceNotificationTypeID
Description
Note
SystemStatus
ServiceOrderID
ChangedOn
Status
Active
CreatedBy
AccountID

Possible Operations
The following operations are possible when using the ServiceNotification Entity:

GET
POST

Navigation Properties
It is possible to navigate from the ServiceNotification Entity to the following Entities:
ServiceNotificationType
ServiceOrder
ServicePriority

Filters
The ServiceNotification Entity can be filtered on the Active Entity.

1.12.1.71 ServiceNotificationType

An entity used to represent a type of service notification. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_SERVICENOTIFTYPE.

Properties
The OData Entity ServiceNotificationType has the following properties:
ServiceNotificationTypeID
Description

Possible Operations
A GET operation is possible when using the ServiceNotificationType Entity.

Navigation Properties
There are no navigation properties for the ServiceNotificationType Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.72 ServiceOrder

PUBLIC Page 52 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 An entity used to represent a service order. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_SERVICEORDER.

Properties
The OData Entity ServiceOrder has the following properties:

ServiceOrderID
ServiceOrderTypeID
StartDate
EndDate
ServicePriorityID
Description
Note
SystemStatus
ServiceNotificationID
DeviceID
Status
AccountID

Possible Operations
A GET operation is possible when using the ServiceOrder Entity.

Navigation Properties
It is possible to navigate from the ServiceOrder Entity to the following Entities:

ServiceNotification
ServicePriority
ServiceOrderType

Filters
There are no filters implemented for this Entity.

1.12.1.73 ServiceOrderType

An entity used to represent the type of service order. The Business Add-In (BAdI) implementation for this Entity is ISU_UMC_ODATA_SERVICEORDERTYPE.

Properties
The OData Entity ServiceOrderType has the following properties:

ServiceOrderTypeID
Description

Possible Operations
A GET operation is possible when using the ServiceOrderType Entity.

Navigation Properties
There are no navigation properties for the ServiceOrderType Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.74 ServicePriority

An entity used to represent the priority for a service order or service notification. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_SERVICEPRIORITY.

Properties
The OData Entity ServicePriority has the following properties:
ServicePriorityID
Description

Possible Operations
A GET operation is possible when using the ServicePriority Entity.

PUBLIC Page 53 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Navigation Properties
There are no navigation properties for the ServicePriority Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.75 ServiceProvider

An entity used to represent a service provider object in the SAP IS-U system. The Business Add-In (BAdI) implementation for this Entity is
ISU_UMC_ODATA_SERVICEPROVD.

Properties
The OData Entity ServiceProvider has the following properties:
ServiceProviderID
ServiceTypeID
Name
CompanyCode
ExternalID
OwnSystemFlag
DivisionID
ServiceCategoryID
ServiceTypeDescription

Possible Operations
A GET operation is possible when using the ServiceProvider Entity.

Navigation Properties
There are no navigation properties for the ServiceProvider Entity.

Filters
There are no filters implemented for this Entity.

1.12.1.76 GetAllowedCommunicationMethods

A function import used to get allowed communication methods for a communication category. The Business Add-In (BAdI) implementation for this function import is
ISU_UMC_ODATA_COMMMETHOD.

Function Import Parameters

The function import GetAllowedCommunicationMethods requires the CommunicationCategoryID input parameter.

Possible Operations
A POST operation is possible when using the ChangeProduct function import.

1.12.1.77 GetPremisesForAccount

A function import used to find all premises associated with a specific account ID provided in the import parameter. The Business Add-In (BAdI) implementation for
this function import is ISU_UMC_ODATA_PREMISE. A Premise Entity is returned at the end of the operation.

Function Import Parameters

The function import GetPremisesForAccount requires the AccountID input parameter.

Possible Operations
A GET operation is possible when using the GetPremisesForAccountAddresses function import.

1.12.1.78 GetPremisesByAddress

A function import used to get premises by the search criteria provided in the input parameters. The Business Add-In (BAdI) implementation for this function import
is ISU_UMC_ODATA_PREMISE.

PUBLIC Page 54 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Function Import Parameters
The function import GetPremisesByAddress requires the following input parameters:

City
CountryID
HouseNo
PostalCode
Region
RoomNo
Street

Possible Operations
A GET operation is possible when using the GetPremisesByAddress function import.

1.12.1.79 RequestChange

A function import used to request a change of master data, which cannot be changed directly using other OData services for security reasons, for example,
changing the first and last names of a customer. Execution of this function import triggers the creation of an account contact and creation of a Workflow. An agent
can approve this request in the Workflow or reject it.
The Business Add-In (BAdI) implementation for this function import is ISU_UMC_ODATA_ACCOUNTCONTACT. An AccountContact Entity is returned at the end
of the operation.

Function Import Parameters

The function import RequestChange requires the following input parameters:

AccountContactID
Attribute1Name
Attribute1Value
Attribute2Name
Attribute2Value

Possible Operations
A POST operation is possible when using the RequestChange function import.

1.12.1.80 SimulatePaymentPlan

A function import used to provide the possibility to simulate payment plan information without creating an actual payment plan. Based on the obtained information,
an end user can decide whether to opt in to the payment plan. The Business Add-In (BAdI) implementation for this function import is
ISU_UMC_ODATA_CONTRACT.

Function Import Parameters

The function import SimulatePaymentPlan requires the following input parameters:
ContractID
StartingMonth
Year

Possible Operations
A GET operation is possible when using the SimulatePaymentPlan function import.

1.12.2 Entities for OData Service Model in SAP CRM

This chapter lists all OData entities and function imports used in the SAP OData Service Model for SAP Multichannel Foundation for Utilities and Public Sector in
the SAP CRM system.

Note
You can easily extend the fields of the OData entities listed below. For more information, see the section on Application Operations in the Administrator’s
Guide for SAP Multichannel Foundation for Utilities and Public Sector.

OData Entities
Account
AccountAddress
AccountAddressDependentEmail

PUBLIC Page 55 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 AccountAddressDependentFax
AccountAddressDependentMobilePhone
AccountAddressDependentPhone
AccountAddressIndependentEmail
AccountAddressIndependentFax
AccountAddressIndependentMobilePhone
AccountAddressIndependentPhone
AccountAddressUsage
AccountSex
AccountTitle
AccountType
AddressType
Attachment
Bank
BankAccount
BusinessAgreement
Channel
CommunicationChannel
CommunicationPermission
CommunicationPermissionStatus
ContractItem
ContractItemTimeSlice
Country
Division
DocumentStatus
InteractionRecord
InteractionRecordCategory
InteractionRecordReason
PaymentCard
PaymentCardType
PaymentMethod
PointOfDelivery
Premise
PremiseType
Product
QuotationItem
Region
UtilitiesProductPrice

OData Function Imports

ChangeProduct
CheckMoveOut
GetPointOfDeliveriesByAddress
GetPremisesByAddress
GetPremisesForAccountAddresses
MoveOut
RequestChange

1.12.2.1 Account

An entity used to represent a business partner. The Business Add-In (BAdI) implementation for this Entity is CRM_IU_UMC_ODATA_ACCOUNT. An interaction
record is created for a PUT operation in the back end system.

Properties
The OData Entity Account has the following properties:

AccountID
AccountTitleID
FirstName
LastName

PUBLIC Page 56 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 MiddleName
SecondName
AccountTypeID
Sex
Name1
Name2
Name3
Name4
GroupName1
GroupName2
FullName

Possible Operations
The following operations are possible when using the Account Entity:

GET
PUT

Navigation Properties
It is possible to navigate from the Account Entity to the following Entities:

AccountType
AccountAddressIndependentFaxes
CommunicationPermissions
AccountAddressIndependentPhones
InteractionRecords
AccountTitle
BusinessAgreements
BankAccounts
AccountSex
AccountAddressIndependentMobilePhones
PaymentCards
AccountAddresses
StandardAccountAddress
AccountAddressIndependentEmails
ContractItems

Filters
There are no filters implemented for this Entity.

1.12.2.2 AccountAddress

An entity used to represent an address associated with a given account (business partner). The Business Add-In (BAdI) implementation for this Entity is
CRM_IU_UMC_ODATA_ADDRESS. An interaction record is created for a PUT operation in the back end system.

Properties
The OData Entity AccountAddress has the following properties:

AccountID
AddressID
AddressInfo

Possible Operations
The following operations are possible when using the AccountAddress Entity:
GET
POST

Navigation Properties
It is possible to navigate from the AccountAddress Entity to the following Entities:

AccountAddressDependentFaxes
AccountAddressDependentMobilePhones
AccountAddressUsages
AccountAddressDependentPhones
AccountAddressDependentEmails

Filters
There are no filters implemented for this Entity.

PUBLIC Page 57 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 1.12.2.3 AccountAddressDependentEmail

An entity used to represent an address-dependent e-mail. The Business Add-In (BAdI) implementation for this Entity is CRM_IU_UMC_ODATA_ADDRDEPEMAIL.
An interaction record is created for a PUT, POST, or DELETE operation in the back end system.

Properties
The OData Entity AccountAddressDependentEmail has the following properties:
AccountID
SequenceNo
Email
HomeFlag
StandardFlag

Possible Operations
The following operations are possible when using the AccountAddressDependentEmail Entity:
GET
PUT
POST
DELETE

Navigation Properties
There are no navigation properties for the AccountAddressDependentEmail Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.4 AccountAddressDependentFax

An entity used to represent an address-dependent fax number. The Business Add-In (BAdI) implementation for this Entity is
CRM_IU_UMC_ODATA_ADDRDEPFAX. An interaction record is created for a PUT, POST, or DELETE operation in the back end system.

Properties
The OData Entity AccountAddressDependentFax has the following properties:

AccountID
AddressID
SequenceNo
FaxNo
HomeFlag
StandardFlag
Extension
CompleteFaxNo
CountryID

Possible Operations
The following operations are possible when using the AccountAddressDependentFax Entity:
GET
PUT
POST
DELETE

Navigation Properties
There are no navigation properties for the AccountAddressDependentFax Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.5 AccountAddressDependentMobilePhone

An entity used to represent an address-dependent mobile phone number. The Business Add-In (BAdI) implementation for this Entity is
CRM_IU_UMC_ODATA_ADDRDEPMOBILE. An interaction record is created for a PUT, POST, or DELETE operation in the back end system.

PUBLIC Page 58 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Properties
The OData Entity AccountAddressDependentMobilePhone has the following properties:

AccountID
AddressID
SequenceNo
PhoneNo
HomeFlag
StandardFlag
Extension
CompletePhoneNo
CountryID
DefaultFlag
PhoneType

Possible Operations
The following operations are possible when using the AccountAddressDependentMobilePhone Entity:
GET
PUT
POST
DELETE

Navigation Properties
There are no navigation properties for the AccountAddressDependentMobilePhone Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.6 AccountAddressDependentPhone

An entity used to represent an address-dependent phone number. The Business Add-In (BAdI) implementation for this Entity is
CRM_IU_UMC_ODATA_ADDRDEPPHONE. An interaction record is created for a PUT, POST, or DELETE operation in the back end system.

Properties
The OData Entity AccountAddressDependentPhone has the following properties:

PhoneType
AccountID
AddressID
SequenceNo
PhoneNo
HomeFlag
StandardFlag
Extension
CompletePhoneNo
CountryID

Possible Operations
The following operations are possible when using the AccountAddressDependentPhone Entity:

GET
PUT
POST
DELETE

Navigation Properties
There are no navigation properties for the AccountAddressDependentPhone Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.7 AccountAddressIndependentEmail

An entity used to represent a address-independent e-mail. The Business Add-In (BAdI) implementation for this Entity is CRM_IU_UMC_ODATA_INDEMAIL. An
interaction record is created for a PUT, POST, or DELETE operation in the back end system.

PUBLIC Page 59 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Properties
The OData Entity AccountAddressIndependentEmail has the following properties:

AccountID
SequenceNo
Email
HomeFlag
StandardFlag

Possible Operations
The following operations are possible when using the AccountAddressIndependentEmail Entity:

GET
PUT
POST
DELETE

Navigation Properties
There are no navigation properties for the AccountAddressIndependentEmail Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.8 AccountAddressIndependentFax

An entity used to represent an address-independent fax number. The Business Add-In (BAdI) implementation for this Entity is
CRM_IU_UMC_ODATA_ADDRINDFAX. An interaction record is created for a PUT, POST, or DELETE operation in the back end system.

Properties
The OData Entity AccountAddressIndependentFax has the following properties:
AccountID
SequenceNo
FaxNo
HomeFlag
StandardFlag
Extension
CompleteFaxNo

Possible Operations
The following operations are possible when using the AccountAddressIndependentFax Entity:
GET
PUT
POST
DELETE

Navigation Properties
There are no navigation properties for the AccountAddressIndependentFax Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.9 AccountAddressIndependentMobilePhone

An entity used to represent an address-independent mobile phone number. The Business Add-In (BAdI) implementation for this Entity is
CRM_IU_UMC_ODATA_ADDRINDMOBILE. An interaction record is created for a PUT, POST, or DELETE operation in the back end system.

Properties
The OData Entity AccountAddressIndependentMobilePhone has the following properties:
AccountID
SequenceNo
PhoneNo
HomeFlag

PUBLIC Page 60 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 StandardFlag
Extension
CompletePhoneNo
DefaultFlag
CountryID
PhoneType

Possible Operations
The following operations are possible when using the AccountAddressIndependentMobilePhone Entity:

GET
PUT
POST
DELETE

Navigation Properties
There are no navigation properties for the AccountAddressIndependentMobilePhone Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.10 AccountAddressIndependentPhone

An entity used to represent an address-independent phone number. The Business Add-In (BAdI) implementation for this Entity is
CRM_IU_UMC_ODATA_ADDRINDPHONE. An interaction record is created for a PUT, POST, or DELETE operation in the back end system.

Properties
The OData Entity AccountAddressIndependentPhone has the following properties:

AccountID
SequenceNo
PhoneNo
HomeFlag
StandardFlag
Extension
CompletePhoneNo
CountryID
PhoneType

Possible Operations
The following operations are possible when using the AccountAddressIndependentPhone Entity:

GET
PUT
POST
DELETE

Navigation Properties
There are no navigation properties for the AccountAddressIndependentPhone Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.11 AccountAddressUsage

An entity used to represent how an account address is used. This entity is linked to the AddressType Entity. Examples of address usage are standard address,
billing Address, communication address. The Business Add-In (BAdI) implementation for this Entity is CRM_IU_UMC_ODATA_ADDRUSAGE.

Properties
The OData Entity AccountAddressUsage has the following properties:

AccountID
AddressID
AddressTypeID

PUBLIC Page 61 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Possible Operations
A GET operation is possible when using the AccountAddressUsage Entity.

Navigation Properties
It is possible to navigate from the AccountAddressUsage Entity to the AddressType Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.12 AccountSex

An entity used to represent the gender of the account holder. The Business Add-In (BAdI) implementation for this Entity is CRM_IU_UMC_ODATA_ACCOUNTSEX.

Properties
The OData Entity AccountSex has the following properties:

Sex
Description

Possible Operations
A GET operation is possible when using the AccountSex Entity.

Navigation Properties
It is possible to navigate from the AccountSex Entity to the Account Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.13 AccountTitle

An entity used to represent the title of an account holder. The Business Add-In (BAdI) implementation for this Entity is CRM_IU_UMC_ODATA_ACCOUNTTITLE.

Properties
The OData Entity AccountTitle has the following properties:
TitleID
AccountTypeID
Description

Possible Operations
A GET operation is possible when using the AccountTitle Entity.

Navigation Properties
It is possible to navigate from the AccountTitle Entity to the AccountType Entity.

Filters
The AccountTitle Entity can be filtered on the AccountTypeID Entity.

1.12.2.14 AccountType

An entity used to represent the type of account. The Business Add-In (BAdI) implementation for this Entity is CRM_IU_UMC_ODATA_ACCOUNTTYPE.

Properties
The OData Entity AccountType has the following properties:

AccountTypeID
Description

Possible Operations

PUBLIC Page 62 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 A GET operation is possible when using the AccountType Entity.

Navigation Properties
There are no navigation properties for the AccountType Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.15 AddressType

An entity used to represent types of addresses used to identify the usage for the address. Examples of address types are standard address, billing address and
communication address. The Business Add-In (BAdI) implementation for this Entity is CRM_IU_UMC_ODATA_ADDRTYPE.

Properties
The OData Entity AddressType has the following properties:

AddressTypeID
Description

Possible Operations
A GET operation is possible when using the AddressType Entity.

Navigation Properties
There are no navigation properties for the AddressType Entity.

Filters
The AddressType Entity can be filtered on the following Entities:
AddressTypeID
Description

1.12.2.16 Attachment

An entity used to represent an attachment. The Business Add-In (BAdI) implementation for this Entity is CRM_IU_UMC_ODATA_ATTACHMENT.

Properties
The OData Entity Attachment has the following properties:

AttachmentID
EntityID
EntityName
MimeType
MediaResource
FileName
Description

Possible Operations
A GET operation is possible when using the Attachment Entity.

Navigation Properties
There are no navigation properties for the Attachment Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.17 Bank

An entity used to represent a bank. The Business Add-In (BAdI) implementation for this Entity is CRM_IU_UMC_ODATA_BANK.

Properties
The OData Entity Bank has the following properties:

PUBLIC Page 63 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 CountryID
BankID
Name
City
SWIFTCode

Possible Operations
A GET operation is possible when using the Bank Entity.

Navigation Properties
There are no navigation properties for the Bank Entity.

Filters
The Bank Entity can be filtered on the CountryID Entity.

1.12.2.18 BankAccount

An entity used to represent a bank account. The Business Add-In (BAdI) implementation for this Entity is CRM_IU_UMC_ODATA_BANKACCOUNT. An interaction
record is created for a PUT, POST, or DELETE operation in the back end system.

Properties
The OData Entity BankAccount has the following properties:
CountryID
AccountID
BankAccountID
BankID
BankAccountNo
AccountHolder
BankAccountName
IBAN

Possible Operations
The following operations are possible when using the BankAccount Entity:

GET
PUT
POST
DELETE

Navigation Properties
It is possible to navigate from the BankAccount Entity to the Bank Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.19 BusinessAgreement

An entity used to represent a business agreement for a given business partner. The Business Add-In (BAdI) implementation for this Entity is
CRM_IU_UMC_ODATA_BUAG. An interaction record is created for a PUT and POST operation in the back end system.

Properties
The OData Entity BusinessAgreement has the following properties:
BusinessAgreementID
AccountID
Description
BillToAccountID
IncomingPaymentMethodID
OutgoingPaymentMethodID1
OutgoingPaymentMethodID2
OutgoingPaymentMethodID3
OutgoingPaymentMethodID4
OutgoingPaymentMethodID5
IncomingPaymentBankAccountID

PUBLIC Page 64 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 OutgoingPaymentBankAccountID
IncomingPaymentPaymentCardID
OutgoingPaymentPaymentCardID
AccountAddressID
BillToAccountAddressID
CountryID

Possible Operations
The following operations are possible when using the BusinessAgreement Entity:
GET
PUT
POST

Navigation Properties
It is possible to navigate from the BusinessAgreement Entity to the following Entities:
BillToAccount
ContractItems
IncomingPaymentMethod
OutgoingPaymentMethod5
OutgoingBankAccount
OutgoingPaymentMethod3
Country
IncomingBankAccount
OutgoingPaymentMethod4
OutgoingPaymentMethod2
IncomingPaymentCard
OutgoingPaymentCard
BillToAccountAddress
OutgoingPaymentMethod1

Filters
There are no filters implemented for this Entity.

1.12.2.20 Channel

An entity used to represent a channel, for example, Internet, telephone, and so on, used to consume OData Services. The Business Add-In (BAdI)
implementation for this Entity is CRM_IU_UMC_ODATA_CHANNEL.

Properties
The OData Entity Channel has the following properties:
ChannelID
Description

Possible Operations
A GET operation is possible when using the Channel Entity.

Navigation Properties
It is possible to navigate from the Channel Entity to the InteractionRecords Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.21 CommunicationChannel

An entity used to represent all available communication channels. The Business Add-In (BAdI) implementation for this Entity is
CRM_IU_UMC_ODATA_COMMCHANNEL.

Properties
The OData Entity CommunicationChannel has the following properties:

CommunicationChannelID
Description

PUBLIC Page 65 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Possible Operations
A GET operation is possible when using the CommunicationChannel Entity.

Navigation Properties
There are no navigation properties for the CommunicationChannel Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.22 CommunicationPermission

An entity used to represent communication permission for a user. The Business Add-In (BAdI) implementation for this Entity is CRM_IU_UMC_ODATA_COMMPERM.
An interaction record is created for a POST and DELETE operation in the back end system.

Properties
The OData Entity CommunicationPermission has the following properties:
CommunicationPermissionGUID
CommunicationChannelID
CommunicationPermissionStatusID
AccountID
CommunicationDetail
ValidFrom

Possible Operations
The following operations are possible when using the CommunicationPermission Entity:

GET
POST
DELETE

Navigation Properties
It is possible to navigate from the CommunicationPermission Entity to the following Entities:

CommunicationChannel
CommunicationPermissionStatus

Filters
There are no filters implemented for this Entity.

1.12.2.23 CommunicationPermissionStatus

An entity used to represent all available communication permission statuses from Customizing. The Business Add-In (BAdI) implementation for this Entity is
CRM_IU_UMC_ODATA_COMMPERMSTAT.

Properties
The OData Entity CommunicationPermissionStatus has the following properties:

CommunicationPermissionStatusID
Description

Possible Operations
A GET operation is possible when using the CommunicationPermissionStatus Entity.

Navigation Properties
There are no navigation properties for the CommunicationPermissionStatus Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.24 ContractItem

PUBLIC Page 66 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 An entity used to represent a service contract. The Business Add-In (BAdI) implementation for this Entity is CRM_IU_UMC_ODATA_CNTRITEM. An interaction
record is created for a POST operation in the back end system.

Properties
The OData Entity ContractItem has the following properties:

ContractID
Description
ContractItemGUID
ContractHeaderGUID
ContractStartDate
ContractEndDate
AccountID
BusinessAgreementID
ProductID
DivisionID
PointOfDeliveryGUID
PremiseID
FormerServiceProviderID
NewServiceProviderID
Distributor
SwitchServiceFlag
MeterNumber
Distributor
SwitchServiceFlag
MeterNumber

Possible Operations
The following operations are possible when using the ContractItem Entity:
GET
POST

Navigation Properties
It is possible to navigate from the ContractItem Entity to the following Entities:

Division
BusinessAgreement
Product
Premise
ContractItemTimeSlices

Filters
The ContractItem Entity can be filtered on the ContractStartDate Entity.

1.12.2.25 ContractItemTimeSlice

A service contract, in its life span, could have several time slices (time periods) when the service product changes. This entity is used to represent those time
slices of a service contract.

Properties
The OData Entity ContractItemTimeSlice has the following properties:

ContractID
Description
ContractItemTimeSliceGUID
StartDate
EndDate
ProductID
DocumentStatusID

Possible Operations
A GET operation is possible when using the ContractItemTimeSlice Entity.

Navigation Properties
It is possible to navigate from the ContractItemTimeSlice Entity to the following Entities:
DocumentStatus
ContractItem

PUBLIC Page 67 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Product

Filters
The ContractItemTimeSlice Entity can be filtered on the StartDate Entity.

1.12.2.26 Country

An entity used to represent a country. The Business Add-In (BAdI) implementation for this Entity is CRM_IU_UMC_ODATA_COUNTRY.

Properties
The OData Entity Country has the following properties:
CountryID
Name

Possible Operations
A GET operation is possible when using the Country Entity.

Navigation Properties
It is possible to navigate from the Country Entity to the following Entities:

PaymentMethods
Regions

Filters
The Country Entity can be filtered on the following Entities:
CountryID
Name

1.12.2.27 Division

An entity used to represent a division. The Business Add-In (BAdI) implementation for this Entity is CRM_IU_UMC_ODATA_DIVISION.

Properties
The OData Entity Division has the following properties:
DivisionID
Description

Possible Operations
A GET operation is possible when using the Division Entity.

Navigation Properties
There are no navigation properties for the Division Entity.

Filters
The Division Entity can be filtered on the following Entities:

DivisionID
Description

1.12.2.28 DocumentStatus

An entity used to represent an interaction-related document status. The Business Add-In (BAdI) implementation for this Entity is
CRM_IU_UMC_ODATA_DOC_STATUS.

Properties
The OData Entity DocumentStatus has the following properties:
DocumentStatusID
Description
InternalID
ProfileID

PUBLIC Page 68 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Priority

Possible Operations
A GET operation is possible when using the DocumentStatus Entity.

Navigation Properties
There are no navigation properties for the DocumentStatus Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.29 InteractionRecord

An entity used to represent an interaction record for a given business partner. The Business Add-In (BAdI) implementation for this Entity is
CRM_IU_UMC_ODATA_IR. An interaction record is created for a POST operation in the back end system.

Properties
The OData Entity InteractionRecord has the following properties:

InteractionRecordID
AccountID
Description
PremiseID
BusinessAgreementID
Priority
InteractionRecordReasonID
Reason
InteractionRecordCategory1
InteractionRecordCategory2
InteractionRecordCategory1GUID
InteractionRecordCategory2GUID
ChannelID
Note
DateFrom
IncomingFlag
DocumentStatusID

Possible Operations
The following operations are possible when using the InteractionRecord Entity:

GET
POST

Navigation Properties
It is possible to navigate from the InteractionRecord Entity to the following Entities:

InteractionRecordReason
InteractionRecordCategoryLevel1
InteractionRecordCategoryLevel2
DocumentStatus
Channel

Filters
The InteractionRecord Entity can be filtered on the following Entities:

InteractionRecordReasonID
DateFrom
DocumentStatusID

1.12.2.30 InteractionRecordCategory

An entity used to represent an interaction record category. The Business Add-In (BAdI) implementation for this Entity is CRM_IU_UMC_ODATA_IREC_CAT.

Properties
The OData Entity InteractionRecordCategory has the following properties:

InteractionRecordCategoryGUID

PUBLIC Page 69 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 Description
InteractionRecordCategoryParentGUID

Possible Operations
A GET operation is possible when using the InteractionRecordCategory Entity.

Navigation Properties
It is possible to navigate from the InteractionRecordCategory Entity to the InteractionRecordSubCategories Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.31 InteractionRecordReason

An entity used to represent the reason for an interaction. The Business Add-In (BAdI) implementation for this Entity is CRM_IU_UMC_ODATA_IR_REASON.

Properties
The OData Entity InteractionRecordReason has the following properties:

InteractionRecordReasonID
Description

Possible Operations
A GET operation is possible when using the InteractionRecordReason Entity.

Navigation Properties
There are no navigation properties for the InteractionRecordReason Entity.

Filters
There are no filters implemented for this Entity.

1.12.2.32 PaymentCard

An entity used to represent a payment card. The Business Add-In (BAdI) implementation for this Entity is CRM_IU_UMC_ODATA_PCARD. An interaction record is
created for a PUT, or POST operation in the back end system.

Properties
The OData Entity PaymentCard has the following properties:

AccountID
PaymentCardID
PaymentCardTypeID
CardNumber
StandardFlag
Description
ValidFrom
ValidTo
Cardholder
Issuer
IssueDate

Possible Operations
The following operations are possible when using the PaymentCard Entity:
GET
PUT
POST

Navigation Properties
It is possible to navigate from the PaymentCard Entity to the PaymentCardType Entity.

Filters

PUBLIC Page 70 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.
 There are no filters implemented for this Entity.

1.12.2.33 PaymentCardType

An entity used to read payment card types. The Business Add-In (BAdI) implementation for this Entity is CRM_IU_UMC_ODATA_PCARDTYPE.

Properties
The OData Entity PaymentCardType has the following properties:
PaymentCardTypeID
Description

Possible Operations
A GET operation is possible when using the PaymentCardType Entity.

Navigation Properties
There are no navigation properties for the PaymentCardType Entity.

Filters
There are no filters implemented for this Entity.

PUBLIC Page 71 of 71
© 2014 SAP SE or an SAP affiliate company. All rights reserved.