Integration Guide Feature Delivery PROD
Integration Guide Feature Delivery PROD
Integration Guide
© 2023 SAP SE or an SAP affiliate company. All rights reserved.
1 Integration Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Integration Guide
2 PUBLIC Content
Replication of Billing Forecasts to Billing Plans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Transfer of Billing Data to Sales Billing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Transfer of Subscription-Related Data to Finance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Integration with the SAP Fiori Launchpad of SAP S/4HANA Cloud. . . . . . . . . . . . . . . . . . . . . . 287
Integration-Specific Data in SAP Subscription Billing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .292
Monitoring Data Replication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Discontinuing Use of SAP Subscription Billing: Prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . 301
5.2 Subscription Management with Convergent Invoicing (5IK) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
Data Flow Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Master Data Integration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Replication of Subscriptions to Provider Contracts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
Replication of Billing Forecasts to Billing Plans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
Transfer of Billing and Usage Data to Convergent Invoicing. . . . . . . . . . . . . . . . . . . . . . . . . . . .325
Transfer of Data to Revenue Accounting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
Integration with the SAP Fiori Launchpad of SAP S/4HANA Cloud. . . . . . . . . . . . . . . . . . . . . . 334
Integration-Specific Data in SAP Subscription Billing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .339
Monitoring Data Replication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .342
Discontinuing Use of SAP Subscription Billing: Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . 348
Integration Guide
Content PUBLIC 3
11 Integration with SAP Digital Payments Add-On. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
Integration Guide
4 PUBLIC Content
1 Integration Guide
This guide provides detailed information about setting up integration between SAP Subscription Billing and
other solutions and services.
SAP Subscription Billing can be integrated with other SAP and non-SAP software to enable end-to-end
business processes and supporting processes. You can also use APIs and events to integrate with non-SAP
systems and services.
Note
You might require a separate license for the solutions and services with which you want to integrate SAP
Subscription Billing.
Due to the separate release process of each integrated solution, there can be a delay in the availability of
features across integrated production systems.
Integration Guide
Integration Guide PUBLIC 5
2 Integration Using APIs
You can implement a custom integration of your data and services by using the APIs provided with SAP
Subscription Billing.
You can find detailed information about the available APIs in the SAP Subscription Billing API package on the
SAP Business Accelerator Hub.
The API Guide for SAP Subscription Billing also provides you with an overview of the available APIs and with
supplementary information.
Integration Guide
6 PUBLIC Integration Using APIs
3 Integration Using Events
You can use business events published by SAP Subscription Billing to flexibly integrate your systems and
processes. Events are also used in some of the integration scenarios that are predefined by SAP.
Integration Guide
Integration Using Events PUBLIC 7
4 Integration with SAP S/4HANA
You can integrate SAP Subscription Billing with an on-premise SAP S/4HANA system to support end-to-end
processes for your subscription business.
Scenario Description
Subscription Management with Sales Billing - As of SAP S/ This integration enables the transfer of billing and subscrip
4HANA 2021 FPS01 (57Z) [page 42]
tion data from SAP Subscription Billing to SAP S/4HANA for
invoicing in Sales Billing.
Restriction
Subscription Management with Sales Billing - SAP S/4HANA This integration enables the transfer of billing data from SAP
1709 to 2021 (Initial Shipment) [page 9]
Subscription Billing to SAP S/4HANA for invoicing in Sales
Billing.
Subscription Management with Convergent Invoicing (5IK) This integration enables the transfer of billing and subscrip
[page 142]
tion data from SAP Subscription Billing to SAP S/4HANA
Convergent Invoicing, allowing charges from multiple billing
streams to be consolidated into invoices.
Integration Guide
8 PUBLIC Integration with SAP S/4HANA
4.1 Subscription Management with Sales Billing - SAP S/
4HANA 1709 to 2021 (Initial Shipment)
This integration enables you to transfer billing data to SAP S/4HANA Sales for billing and invoicing, and to
forward invoice data to accounting.
Note
The integration as described in this section is supported as of SAP S/HANA 1709 up to and including 2021
(Initial Shipment only). As of SAP S/HANA 2021 FPS01, a new integration is supported (see Subscription
Management with Sales Billing - As of SAP S/4HANA 2021 FPS01 (57Z) [page 42]).
Data Flow
Once billing data is replicated to SAP S/4HANA Sales, billing document requests are created, tax is added, and
tax and other billing-relevant information is merged into a consolidated invoice. Finally, invoice amounts are
posted to accounting.
Customer data in SAP Subscription Billing and business partner data in SAP S/4HANA are kept in sync to
support this process.
Note
You must choose a leading system first to keep data consistent. We recommend that you change data
in the leading system only. Depending on the leading system, you can set up replication in one direction
only. If SAP Subscription Billing is the leading system, set up the replication as described in Replication
of Business Partner Master Data from SAP Subscription Billing to SAP S/4HANA [page 22]; if SAP S/
4HANA is the leading system, then set up the replication as described in Replication of Business Partner
Master Data from SAP S/4HANA to SAP Subscription Billing [page 11].
Integration Guide
Integration with SAP S/4HANA PUBLIC 9
For more information about convergent billing in SAP S/4HANA Sales, see Omnichannel Convergent Billing in
the SAP S/4HANA documentation.
Prerequisites
• SAP BTP has been configured and service keys created to give the integration process access to the SAP
Subscription Billing APIs. This setup is described in the SAP BTP Configuration Guide.
Certain integration scopes are required to integrate with the SAP Subscription Billing solution. For details,
see SAP Subscription Billing API Scopes in the API Guide. The required scopes are listed in the Bills and
Business Partners rows in the table.
• Your SAP Cloud Integration tenant has been provisioned. For details, see Initial Setup in the SAP Cloud
Integration documentation.
• To enable some of the convergent billing use cases, you need to make the necessary settings in
Customizing to set up the correct billing types. For more information, see the configuration information for
scope item 1MC in the Process Navigator in SAP for Me.
External billing document requests, which are required for convergent billing, are supported as of the 1709
release of SAP S/4HANA.
Restrictions
• Custom fields are not replicated from subscriptions to billing document requests.
• For the integration of SAP Subscription Billing with the SAP Data Retention Manager service and SAP
Personal Data Manager service, a legal entity (on which basis the data residence and retention periods
are defined) corresponds to an SAP BTP subaccount. As there can only be one subaccount for an SAP
Subscription Billing tenant, the tenant is restricted to one legal entity. Accordingly, if different markets in
SAP Subscription Billing map to SAP S/4HANA sales areas for which the sales organizations belong to
different legal entities, this cannot be reflected in the data protection functionality for SAP Subscription
Billing. This is also the case for integration with S/4HANA Cloud. While you can restrict the access of
business users in the SAP Subscription Billing user interface based on markets, the SAP Data Retention
Manager service and SAP Personal Data Manager service provide access to all data of all markets. The use
of data protection functionality for SAP Subscription Billing therefore assumes that the data of only one
data controller is being processed within the tenant. For more information, see Deletion of Personal Data
(section Integrated Data) in the Setup and Administration Guide.
Serving as a link between SAP BTP applications and on-premise systems, the Connectivity service runs as an
on-premise agent in secured networks.
Before you can use the Connectivity service to link SAP S/4HANA and SAP BTP, ensure that you have installed
the cloud connector. For more information on installation, see Installation in the SAP Connectivity service
documentation.
Integration Guide
10 PUBLIC Integration with SAP S/4HANA
After installing the cloud connector and starting the cloud connector daemon, you can log on to the daemon
and perform required configurations to make your cloud connector operational. For more information, see
Initial Configuration in the SAP Connectivity service documentation.
In addition, specify the SAP S/4HANA web service that can be accessed by integration flows using HTTP. For
more information, see Configure Access Control (HTTP) in the SAP Connectivity service documentation.
Procedure
This section describes how to replicate business partner master data, including relationship information, from
SAP S/4HANA to SAP Subscription Billing using SAP Cloud Integration.
Note
Only the following data can be replicated from SAP S/4HANA to SAP Subscription Billing:
• Customer and contact with one of the following business partner roles:
• FLCU01 (Customer)
• FLCU00 (Customer (Financial Accounting))
• BUP001 (Contact)
• Additional business partner roles configured in integration flow BP from SAP S4HANA to SAP
Subscription Billing
• Customer-contact relationships of a business partner (customer) of the category Organization
Integration Guide
Integration with SAP S/4HANA PUBLIC 11
There are two ways for triggering replication:
• Automatic Trigger: Changes are directly transferred to a target system when a business partner is created
or updated.
• Manual Trigger: via the DRFOUT transaction.
This transaction can be executed with the following options:
• Initialization: The system processes all data of the selected outbound implementations that are
required for a replication model.
• Changes: The program analyzes all data that was changed since the last change or since an
initialization was last performed.
• Manual: You can select and transfer individual data records by choosing the Manual Replication Filter
Criteria push button. If manual filter criteria is available, the Manual Replication Filter Criteria Available
check-box is selected.
Restrictions
• If a business partner has both Customer and Contact roles, the business partner is replicated to SAP
Subscription Billing as a customer only.
• If a business partner does not have the Contact role, and the business partner is used as a contact in
the customer-contact relationship, the customer-contact relationship is not replicated to SAP Subscription
Billing.
• If a business partner has both Customer and Contact roles, and the business partner is used as contact in
the customer-contact relationship, the customer-contact relationship is not replicated to SAP Subscription
Billing.
To configure the asynchronous replication of business partner master data, including relationship information,
from SAP S/4HANA to SAP Subscription Billing, proceed with the instructions for the SAP Cloud Integration
settings and SAP S/4HANA settings described in the following sections.
Configuration Overview
Integration Guide
12 PUBLIC Integration with SAP S/4HANA
As shown in the flowchart above, the configuration consists of the following steps:
Integration Guide
Integration with SAP S/4HANA PUBLIC 13
4.1.2.1 SAP Cloud Integration Settings
To enable business partner master data replication from SAP S/4HANA to SAP Subscription Billing, you need
to configure integration in the SAP Cloud Integration web application. You launch this application by accessing
the URL provided by SAP, and then enter your credentials to log on.
Procedure
1. Add SAP Subscription Billing credentials to the SAP Cloud Integration security material.
1. In the navigation panel, choose Monitor, and access the Security Material screen in the section Manage
Security.
2. Choose Add OAuth2 Credentials .
3. Specify the following fields in the Add OAuth2 Credential dialog box.
For information about getting the client ID and client secret, see SAP BTP Configuration Guide (section
about creating a service key).
4. Choose Deploy.
2. Add SAP S/4HANA credentials to the SAP Cloud Integration security material.
1. Access the Security Material screen, as described in the previous step and choose Add User
Credentials .
2. Enter a name for the credential, and enter a user (with password) that has authorization to access the
SAP S/4HANA back-end system.
3. Choose Deploy.
3. Configure the integration flow BP from SAP S4HANA to SAP Subscription Billing.
1. In the navigation panel, choose Discover, find the package SAP Subscription Billing Integration with
SAP S/4HANA - Sales Billing, and choose Copy to copy all the integration flows to the workspace.
2. In the navigation panel, choose Design, navigate to the package, and on the ARTIFACTS tab, choose
Actions Configure for the integration flow BP from SAP S4HANA to SAP Subscription Billing.
Integration Guide
14 PUBLIC Integration with SAP S/4HANA
3. Set up the following on the Sender tab:
Address /S4/SB/ReplicateBP Note that this address is used to set up the outbound
service URL connection on the SAP S/4HANA side (see
step 10 in SOA Manager Settings [page 19]).
Authorization Select the appropriate au The following methods are supported:
thorization method. • User Role
This is the default method for the sender system.
With this method, the sender system should send
a message through the user name and password.
The user needs to have access to trigger the inte
gration flow.
Caution
• Client Certificate
With this method, you need to upload the SAP S/
4HANA client certificate. You do this by choosing
the Select button that appears when you select
Client Certificate as the authorization method. For
information about getting the certificate, see Get
the SAP S/4HANA Client Certificate [page 41].
Receiver S4_Confirmation
Integration Guide
Integration with SAP S/4HANA PUBLIC 15
Field Name Value Comments
Authentication Basic
Receiver SubscriptionBilling
For example:
eu10.revenue.cloud.sap/a
pi
If you want to extend the capabilities of standard integration content, configure the following. For
details on integration flow extension, see Integration Flow Extension.
Receiver PostExit
Address /S4/SB/
CustomerExtensionProcess
Integration Guide
16 PUBLIC Integration with SAP S/4HANA
5. Set up the following under All Parameters (open the More tab and choose All Parameters for the Type
field):
4. Configure the integration flow Relationship from SAP S4HANA to SAP Subscription Billing.
1. On the ARTIFACTS tab, choose Actions Configure for the integration flow.
2. Set up the following on the Sender tab:
Integration Guide
Integration with SAP S/4HANA PUBLIC 17
Field Name Value Comments
Authorization Select the appropriate authorization The same comments and further in
method. formation apply as in step 3 above.
3. Set up the following under All Parameters (open the More tab and choose All Parameters for the Type
field):
5. Deploy the integration flows on the ARTIFACTS tab, by choosing Actions Deploy .
After the deployment, an integration flow changes its status to Started and is visible under Monitor
Manage Integration Content .
Related Information
For more information, see the following topic in the SAP Cloud Integration documentation:
Integration Guide
18 PUBLIC Integration with SAP S/4HANA
4.1.2.2 SOA Manager Settings
Make configurations in SAP S/4HANA to set up the business partner master data replication, including
relationships, from SAP S/4HANA to SAP Subscription Billing .
Make configurations in the SOA Manager for SAP S/4HANA as described below. The SOA Manager is used to
administer and configure service providers and consumer proxies for a local system.
Note
This URL can be directly copied from the SAP Cloud Integration tenant where your integration flow
BP from S4 to SB is deployed. After the successful deployment of the integration flow on SAP Cloud
Integration, go to the Operations View, choose Manage Integration Content, select the corresponding
integration flow and find the complete URL under Endpoints.
Field Value
RM Protocol SAP RM
Integration Guide
Integration with SAP S/4HANA PUBLIC 19
Field Value
In SAP S/4HANA, define the target system and data for the replication.
Integration Guide
20 PUBLIC Integration with SAP S/4HANA
6. Under Assign Outbound Parameter, select the outbound parameter PACK_SIZE_BULK and add the
number for Outbound Parameter Value. Save your changes.
3. Activate the replication model.
Choose Data Replication Define Custom Settings for Data Replication Define Replication Model
<your replication model> Active .
4. Add the trigger for the web service call.
1. Open transaction SPRO. Choose SAP Reference IMG Cross-Application Components SAP
Business Partner Data Distribution Activate Function Modules .
2. Select the MDG_BS_BP_OUTBOUND_DRF function module and select Call. Save your changes.
5. Check the activation.
1. Open transaction SM30.
2. Enter BSSOAV_WS_ACTIVE in Table/View and choose Maintain.
3. If the BSSOAV_WS_ACTIVE entry doesn't appear as active, choose New Entries and select Active. Save
your changes.
If the region code list in SAP S/4HANA does not match the region code list in SAP Subscription Billing, you can
use value mapping to map the SAP S/4HANA region code values with the SAP Subscription Billing region code
values.
Note
In SAP Subscription Billing, the region code list follows ISO 3166-2 standard.
1. Start the transaction SPRO. Choose SAP Reference IMG Cross-Application Components Processes
and Tools for Enterprise Applications Master Data Governance Central Governance General Settings
Value Mapping Assign Code Lists to Elements and Systems .
2. Choose New Entries and fill out the following data:
Field Value
Type structure
Integration Guide
Integration with SAP S/4HANA PUBLIC 21
Field Value
List ID MDG_FND_REGION_CODE
List Version ID Starts at 01, and add version for every new entry.
Field Value
List ID MDG_FND_REGION_CODE
7. Select the entry and open the Define Value Mapping view, and map the value, for example, map SAP
S/4HANA code 010 to SAP Subscription Billing 11 for Beijing.
8. Save your changes.
This section describes how to replicate business partner master data, including relationship information, from
SAP Subscription Billing to SAP S/4HANA using SAP Cloud Integration.
You can replicate business partner master data, including relationship information, from SAP Subscription
Billing to SAP S/4HANA using the following integration flows:
Integration Guide
22 PUBLIC Integration with SAP S/4HANA
Note
The deletion of a business partner relationship in SAP Subscription Billing is not replicated to SAP S/
4HANA. The deletion of a business partner relationship in SAP S/4HANA, is replicated to SAP Subscription
Billing, however.
In SAP Subscription Billing every customer has only one address. However, SAP S/4HANA allows multiple
addresses for business partners. If you replicate customers from SAP Subscription Billing to SAP S/
4HANA, all original, non-default addresses in SAP S/4HANA will be deleted and the default address will be
overwritten by the default address from SAP Subscription Billing.
Restrictions
SAP S/4HANA has a stricter restriction on the maximum length of certain fields of a customer. You need to
set the length of the following fields in SAP Subscription Billing within the maximum length defined by SAP
S/4HANA. Otherwise, the customer will not be replicated due to a data validation error on SAP S/4HANA side.
House Number 10
Street 60
City 40
When the master data is replicated using the Customer from SAP Subscription Billing to SAP S4HANA or
Contact from SAP Subscription Billing to SAP S4HANA integration flows, the SAP S4HANA system sends a
confirmation back to SAP Subscription Billing by using the integration flow BP Confirmation from SAP S4HANA
to SAP Subscription Billing.
Integration Guide
Integration with SAP S/4HANA PUBLIC 23
Prerequisite
To replicate master data, configure and deploy the integration flow BP Confirmation from SAP S4HANA to SAP
Subscription Billing before you start the configuration of the dependent integration flows Customer from SAP
Subscription Billing to SAP S4HANA and Contact from SAP Subscription Billing to SAP S4HANA.
When the relationship is replicated using the Relationship from SAP Subscription Billing to SAP S4HANA
integration flow, the SAP S4HANA system sends a confirmation back to SAP Subscription Billing by using the
integration flow Relationship Confirmation from SAP S4HANA to SAP Subscription Billing.
Prerequisites
To replicate relationship data, configure and deploy the integration flow Relationship Confirmation from SAP
S4HANA to SAP Subscription Billing before you start the configuration of the dependent integration flow
Relationship from SAP Subscription Billing to SAP S4HANA.
Configuration Overview
As shown in the flowchart above, the configuration consists of the following steps:
1. SAP Cloud Integration fetches customer/contact/relationship data from SAP Subscription Billing.
• SAP Cloud Integration configuration
• SAP Subscription Billing Client ID
• SAP Subscription Billing Client Secret
• SAP Subscription Billing API Authorization Server
• SAP Subscription Billing API Path
Integration Guide
24 PUBLIC Integration with SAP S/4HANA
2. SAP Cloud Integration sends customer/contact/relationship data to SAP S/4HANA via SAP Cloud
Connector.
• SAP Cloud Connector
• Setup
• Virtual Address
• Local Address
• SAP Cloud Integration configuration
• Virtual Address
• SAP S/4HANA Client
• User Credential to access SAP S/4HANA
• SAP S/4HANA configuration
• SOA Manager for confirmation
3. SAP S/4HANA sends confirmation to SAP Cloud Integration.
• SAP S/4HANA configuration to send out:
• SOA Manager
• SAP Application Interface
• Region Code Value Mapping (If needed)
• SAP Cloud Integration configuration to receive:
• SAP Cloud Integration exposes an API for SAP S/4HANA to call
• Authorization (user/certificate) for the API exposed by SAP Cloud Integration
To enable business partner master data replication from SAP Subscription Billing to SAP S/4HANA, you need
to configure integration in the SAP Cloud Integration web application. You launch this application by accessing
the URL provided by SAP, and then enter your credentials to log on.
Note
If you have already deployed user credentials on your tenant (see steps 1 and 2 of SAP Cloud Integration
Settings [page 14] (direction SAP S/4HANA to SAP Subscription Billing), you can skip steps 1 and 2 below.
Procedure
1. Add SAP Subscription Billing credentials to the SAP Cloud Integration security material.
1. In the navigation panel, choose Monitor, and access the Security Material screen in the section Manage
Security.
2. Choose Add OAuth2 Credentials .
3. Specify the following fields in the Add OAuth2 Credential dialog box.
Integration Guide
Integration with SAP S/4HANA PUBLIC 25
Name Credential name
For information about getting the client ID and client secret, see SAP BTP Configuration Guide (section
about creating a service key).
4. Choose Deploy.
2. Add SAP S/4HANA credentials to the SAP Cloud Integration Security Material.
1. Access the Security Material screen, as described in the previous step and choose Add User
Credentials .
2. Enter a name for the credential, and enter a user (with password) that has authorization to access the
SAP S/4HANA back-end system.
3. Choose Deploy.
3. Configure the integration flow Customer from SAP Subscription Billing to SAP S4HANA.
1. On the Discover tab, find the package SAP Subscription Billing Integration with SAP S/4HANA - Sales
Billing and copy all the integration flows to the workspace.
2. In the navigation panel, choose Design, navigate to the package, and on the ARTIFACTS tab, choose
Actions Configure for the integration flow Customer from SAP Subscription Billing to SAP
S4HANA.
3. On the Timer tab, define the execution schedule and frequency of the integration flow.
After the integration flow is started, it collects changed and new customer data and sends it to the SAP
S/4HANA system.
If you choose the option Run Once, the integration flow is executed once and must be manually
triggered again. This option can be used for testing purposes.
4. Set up the following on the Receiver tab:
Receiver S4
Integration Guide
26 PUBLIC Integration with SAP S/4HANA
Field Name Value Comments
Authentication Basic
Receiver SubscriptionBilling
For example:
eu10.revenue.cloud.sap/a
pi
5. Set up the following in All Parameters (open the More tab and choose All Parameters for the Type field):
Tax_Classification Default value is 1. This value is used for the tax clas
sification field when creating a cus
tomer.
Subscription_Billing_System_ID Enter the SAP Subscription Billing You can define the value on your
system identifier. own.
Integration Guide
Integration with SAP S/4HANA PUBLIC 27
Field Name Value Comments
4. Configure the integration flow Contact from SAP Subscription Billing to SAP S4HANA.
1. On the ARTIFACTS tab, choose Actions Configure for the integration flow.
2. Repeat the steps 3.c. and 3.d. above.
3. Set up the following on the Parameters tab:
Subscription_Billing_System_ID Enter the SAP Subscription Billing This is the business system config-
system identifier. ured in step 1.b. of Data Replication
Framework Settings [page 20].
Integration Guide
28 PUBLIC Integration with SAP S/4HANA
Field Name Value Comments
5. Configure the integration flow BP Confirmation from SAP S4HANA to SAP Subscription Billing.
1. On the ARTIFACTS tab, choose Actions Configure for the integration flow.
2. Set up the following on the Sender tab:
Integration Guide
Integration with SAP S/4HANA PUBLIC 29
Field Name Value Comments
Authorization Select the appropriate authorization The following methods are sup
method. ported:
• User Role
This is the default method for
the sender system. With this
method, the sender system
sends a message through the
user name and password. The
user needs to have access to
trigger the integration flow.
Caution
• Client Certificate
With this method, you need to
upload the SAP S/4HANA cli
ent certificate. You do this by
choosing the Select button that
appears when you select Client
Certificate as the authorization
method. For information about
getting the certificate, see Get
the SAP S/4HANA Client Certif
icate [page 41].
Receiver SubscriptionBilling
Integration Guide
30 PUBLIC Integration with SAP S/4HANA
Field Name Value Comments
3. Set up the following in All Parameters (open the More tab and choose All Parameters for the Type field):
6. Configure the integration flow Relationship from SAP Subscription Billing to SAP S4HANA.
1. On the ARTIFACTS tab, choose Actions Configure for the integration flow.
2. Define the execution schedule and frequency of the integration flow on the Timer tab.
After the integration flow is started, it collects changed and new business partner relationship data and
sends it to the SAP S/4HANA system.
If you choose the option Run Once, the integration flow is executed once and must be manually
triggered again. This option can be used for testing purposes.
3. Set up the following on the Receiver tab:
Receiver S4
Integration Guide
Integration with SAP S/4HANA PUBLIC 31
Field Name Value Comments
Authentication Basic
Receiver SubscriptionBilling
4. Set up the following in All Parameters (open the More tab and choose All Parameters for the Type field):
Subscription_Billing_System_ID Enter the SAP Subscription Billing This is the business system config-
system identifier. ured in step 1.b. of Data Replication
Framework Settings [page 20].
Integration Guide
32 PUBLIC Integration with SAP S/4HANA
Field Name Value Comments
7. Configure the integration flow Relationship Confirmation from SAP S4HANA to SAP Subscription Billing.
1. On the ARTIFACTS tab, choose Actions Configure for the integration flow.
2. Repeat steps 5.b. to 5.c. above except the Address field. This address is used to set up the outbound
service URL connection on the SAP S/4HANA side in step 14 of SOA Manager Settings [page 34].
8. Configure the value mapping project.
You define the relationship between the market ID in SAP Subscription Billing and the company code,
reconciliation account, tax category and payment methods (respectively) in SAP S/4HANA.
Note
As a prerequisite, the relationship between markets and SAP S/4HANA sales areas must have been
defined in Business Configuration in SAP Subscription Billing. In the Manage Business Configuration
app, you do this on the Markets screen.
1. On the Design tab, navigate to the package and choose Value Mapping between SAP Subscription
Billing and SAP S4HANA under ARTIFACTS.
2. Choose Actions Configure .
3. Choose Add to define the relationship between each identifier.
The following are examples of the value mapping:
A1 1710
A1 E
Integration Guide
Integration with SAP S/4HANA PUBLIC 33
Market ID (SAP Subscription Billing) Reconciliation Account (SAP S/4HANA)
A1 121000
A1 UTXJ
9. Deploy the integration flows on the ARTIFACTS tab, by choosing Actions Deploy .
After the deployment, an integration flow changes its status to Started and is visible under Monitor
Manage Integration Content .
Related Information
For more information, see the following topic in the SAP Cloud Integration documentation:
Make configurations in SAP S/4HANA to set up the business partner master data replication from SAP
Subscription Billing to SAP S/4HANA.
Make configurations in SOA Manager for SAP Subscription Billing as described below. The SOA Manager is
used to administer and configure service providers and consumer proxies for a local system.
Integration Guide
34 PUBLIC Integration with SAP S/4HANA
• For Certificate based authentication:
Choose the X.509 Client Certificate option.
Choose the value help on the SSL Client PSE of transaction STRUST field.
Choose the PSE in which the Client certificate issued by CA supported by SAP Cloud Integration is
stored.
9. Choose Next.
10. Enter the SAP Cloud Integration operation server node URL in the URL field and append it with /cxf
and the Address endpoint as configured in the Sender tab of your integration flow. It should look like:
<https://XXXXXXX-iflmap.sap.hana.ondemand.com:443/cxf/S4/SB/BPConfirm>
Note
This URL can be directly copied from the SAP Cloud Integration tenant where your integration flow
BP Confirmation from S4 to SB is deployed. After the successful deployment of the integration flow
on SAP Cloud Integration, go to the Operations View, choose Manage Integration Content, select the
corresponding integration flow and find the complete URL under Endpoints.
Field Value
RM Protocol SAP RM
Integration Guide
Integration with SAP S/4HANA PUBLIC 35
4.1.3.3 Region Code Value Mapping Settings
If the region code list in SAP Subscription Billing does not match the region code list in SAP S/4HANA , you can
use value mapping to map the SAP Subscription Billing region code values with the SAP S/4HANA region code
values.
For detailed instruction, see Region Code Value Mapping Settings [page 21].
This section describes how to replicate billing documents from SAP Subscription Billing to SAP S/4HANA by
using SAP Cloud Integration.
You can replicate billing documents from SAP Subscription Billing to SAP S/4HANA by using the integration
flow Bill from SAP Subscription Billing to SAP S4HANA.
Prerequisites
• We recommend that the integration flows for replication of business partner data are configured, deployed,
and run at least once before you start the configuration and deployment of the dependent integration flow
Bill from SAP Subscription Billing to SAP S4HANA.
This is described in the sections Replication of Business Partner Master Data from SAP S/4HANA to SAP
Subscription Billing [page 11] and Replication of Business Partner Master Data from SAP Subscription
Billing to SAP S/4HANA [page 22].
• In SAP Subscription Billing, the price type Net Price or Gross Price can be specified for the market. Make
sure the correct pricing procedure is also configured in SAP S/4HANA system for the corresponding sales
area of the market so that tax can be calculated correctly in SAP S/4HANA. For detailed information about
the price management, see Price Management.
Integration Guide
36 PUBLIC Integration with SAP S/4HANA
As shown in the flowchart above, the configuration consists of the following steps:
1. SAP Cloud Integration fetches bill data from SAP Subscription Billing.
• SAP Cloud Integration configuration
• SAP Subscription Billing Client ID
• SAP Subscription Billing Client Secret
• SAP Subscription Billing API Authorization Server
• SAP Subscription Billing API Path
2. SAP Cloud Integration sends bill data to SAP S/4HANA via SAP Cloud Connector.
• SAP Cloud Connector
• Setup
• Virtual Address
• Local Address
• SAP Cloud Integration configuration
• Virtual Address
• SAP S/4HANA Client
• User Credential to access SAP S/4HANA
• SAP S/4HANA configuration
• SOA Manager for confirmation
To enable billing data replication from SAP Subscription Billing to SAP S/4HANA, you need to configure
integration in the SAP Cloud Integration web application. You launch this application by accessing the URL
provided by SAP, and then enter your credentials to log on.
Procedure
1. Configure the integration flow Bill from SAP Subscription Billing to SAP S4HANA.
1. In the navigation panel, choose Design, navigate to the package SAP Subscription Billing Integration
with SAP S/4HANA - Sales Billing, and on the ARTIFACTS tab, choose Actions Configure for the
integration flow.
2. On the Timer tab, define the execution schedule and frequency of the integration flow Bill from SAP
Subscription Billing to SAP S4HANA.
After the integration flow is started, it collects the transferable billing documents and sends them to
the SAP S/4HANA system.
If you choose the option Run Once, the integration flow is executed once and must be manually
triggered again. This option can be used for testing purposes.
Integration Guide
Integration with SAP S/4HANA PUBLIC 37
3. Set up the following on the Receiver tab:
Receiver S4
Authentication Basic
Receiver SubscriptionBilling
For example:
eu10.revenue.cloud.sap/a
pi
If you want to extend the capabilities of standard integration content, configure the following. For
details on integration flow extension, see Integration Flow Extension.
Integration Guide
38 PUBLIC Integration with SAP S/4HANA
Field Name Value Comments
Receiver PostExit
Address /SB/S4/EBDR_PostExit
4. Set up the following on the All Parameters drop-down list (Click the More tab and choose All
Parameters for the Type field):
Subscription_Billing_System_ID Enter the SAP Subscription Billing You can define the value on your
system identifier. own.
Integration Guide
Integration with SAP S/4HANA PUBLIC 39
Field Name Value Comments
A1 1710
A1 TG0011
3. Deploy the integration flow on the ARTIFACTS tab, by choosing Actions Deploy .
After the deployment, the integration flow changes its status to Started and is visible under Monitor
Manage Integration Content .
Related Information
For more information, see the following topic in the SAP Cloud Integration documentation:
Integration Guide
40 PUBLIC Integration with SAP S/4HANA
4.1.4.2 SOA Manager Settings
Make configurations in SAP S/4HANA to set up the billing data replication from SAP Subscription Billing to
SAP S/4HANA.
Make configurations in SOA Manager for SAP Subscription Billing as described below. The SOA Manager is
used to administer and configure service providers and consumer proxies for a local system.
Procedure
The Subject field under Certificate has the same value as the Subject field under Own Certificate.
5. Choose Export Certificate.
6. Choose File path and save the certificate with file extension *.cer .
Procedure
In the section Calling function LCR_GET_OWN_BUSINESS_SYSTEM, the value of id is your SAP S/4HANA
business system ID.
Integration Guide
Integration with SAP S/4HANA PUBLIC 41
4.1.7 Monitoring
Every time an error occurs during the run-time of an integration flow, the system creates an error log. You can
use these logs to analyze the errors. All the logs are saved in your SAP Cloud Integration tenant. To retrieve an
error log, follow the steps below.
1. Open your SAP Cloud Integration tenant on the SAP Cloud Integration web page.
2. Choose Monitor All Integration Flows (Failed Messages) .
3. Change the time range to see older messages.
4. Select a message from the list.
• Choose the integration flow name to open it.
• Choose the message status Failed to open a window with all the logs belonging to this error.
5. Select a log.
6. Download the log to have a local copy of it.
This integration enables the transfer of billing and subscription data from SAP Subscription Billing to SAP
S/4HANA for invoicing in Sales Billing, with subsequent financial processes.
As of SAP S/4HANA 2022, this integration is enabled by the SAP Best Practices scope item 57Z.
Note
The integration as described in this section is supported as of SAP S/4HANA 2021 FPS01 and replaces the
previous integration described in the section Subscription Management with Sales Billing - SAP S/4HANA
1709 to 2021 (Initial Shipment) [page 9].
Business Process
1. Creation of subscriptions in SAP Subscription Billing from upstream systems, via APIs.
2. Management of subscriptions in SAP Subscription Billing.
3. Collection of usage records and automated rating of usage, recurring, and one-time charges in SAP
Subscription Billing.
4. Transfer of billing data from SAP Subscription Billing to SAP S/4HANA Sales Billing, resulting in the
creation of billing document requests.
Billing clerks can process the billing document requests to create customer invoices.
Integration Guide
42 PUBLIC Integration with SAP S/4HANA
Financial Processes
Accounting-relevant data in billing document requests is forwarded from invoices in Sales Billing to SAP
S/4HANA Finance. To provide further information for finance processes, a provider contract is created
automatically in SAP S/4HANA for each subscription in SAP Subscription Billing.The provider contract
contains the contract data of the subscription, such as the billable charges. For more information, see
Replication of Subscriptions to Provider Contracts [page 48].
Supported financial processes include receivables management, and margin and revenue analysis on
subscription level.
Restriction
Integrated Data
You can find a graphical overview of data replication in Data Replication Overview [page 45].
• Business partners in SAP S/4HANA or SAP Master Data Integration are replicated as customers in SAP
Subscription Billing.
• Products and rate elements in SAP Subscription Billing are replicated as products in SAP S/4HANA.
• Subscriptions in SAP Subscription Billing are replicated as provider contracts in SAP S/4HANA.
• Billing data in SAP Subscription Billing is replicated as subscription billing document requests (request
type SBDR) in SAP S/4HANA.
Setup
• As of SAP S/4HANA 2022: Follow the instructions for the scope item 57Z (Subscription Management with
Sales Billing version for SAP S/4HANA). You can access this information in the Process Navigator in
SAP for Me or by using this link: Setup Instructions .
• For SAP S/4HANA 2021 (FPS01 and above): Follow the instructions in the current guide, in the section
Setup Instructions for SAP S/4HANA 2021 (FPS01 and Above) [page 63].
Integration Guide
Integration with SAP S/4HANA PUBLIC 43
Restrictions
• Newly released integration functionality is not necessarily supported immediately by all SAP S/4HANA
releases for which integration is enabled. Functionality that has a dependency with an SAP S/4HANA
release and functionality that's not yet supported by the integration is listed below:
Supported (with dependency to SAP S/4HANA release)
Functionality Supported As Of
Time zone mapping: All time zones in SAP Subscription SAP S/4HANA 2022
Billing mapped to time zones in SAP S/4HANA
• A maximum of 25,000 subscriptions per hour can be created/changed and replicated to SAP S/4HANA.
If you want to migrate data or run any other process that result in mass changes to subscriptions, please
contact SAP beforehand by creating an incident on the component CEC-SAL-SB. In addition, the general
technical constraints of the SAP Event Mesh default plan apply.
• For the integration of SAP Subscription Billing with the SAP Data Retention Manager service and SAP
Personal Data Manager service, a legal entity (on which basis the data residence and retention periods
are defined) corresponds to an SAP BTP subaccount. As there can only be one subaccount for an SAP
Subscription Billing tenant, the tenant is restricted to one legal entity. Accordingly, if different markets in
SAP Subscription Billing map to SAP S/4HANA sales areas for which the sales organizations belong to
different legal entities, this cannot be reflected in the data protection functionality for SAP Subscription
Billing. This is also the case for integration with S/4HANA Cloud. While you can restrict the access of
business users in the SAP Subscription Billing user interface based on markets, the SAP Data Retention
Manager service and SAP Personal Data Manager service provide access to all data of all markets. The use
of data protection functionality for SAP Subscription Billing therefore assumes that the data of only one
data controller is being processed within the tenant. For more information, see Deletion of Personal Data
(section Integrated Data) in the Setup and Administration Guide.
• Some functional restrictions apply regarding subscriptions that have been replicated to provider contracts
in SAP S/4HANA. See Replication of Subscriptions to Provider Contracts [page 48].
You require a separate license for SAP Event Mesh, which is used to enable the replication of subscription data.
If you want to use this integration, you cannot use the following services and applications with SAP
Subscription Billing:
• SAP digital payments add-on: Payments are managed in Accounts Receivable (FI-AR).
• SAP Contract Accounts Receivable and Payable (FI-CA): Payments are managed in Accounts Receivable
(FI-AR).
Integration Guide
44 PUBLIC Integration with SAP S/4HANA
4.2.1 Data Replication Overview
Overview of data replication between the applications and services that are part of the integration
Subscription Management with Sales Billing (57Z) with SAP S/4HANA:
To ensure consistency of data between the applications, business partner data must be replicated from SAP
S/4HANA to SAP Subscription Billing
Business partners in SAP S/4HANA are created as customers in SAP Subscription Billing.
• SAP Master Data Integration service (this is the recommended replication method).
For details, see SAP Master Data Integration: Business Partner Data Replication [page 358].
Caution
To integrate SAP Master Data Integration with an SAP S/4HANA on-premise system, the SAP
Master Data Integration instance must be created with the s4hana-onpremise service plan. s4hana-
onpremise is only visible as a service plan option if the service instance is created in a CPEA-enabled
account (Cloud Platform Enterprise Agreement) or has an explicit entitlement in the SAP BTP cockpit
which may require an additional license. For more information, see Connecting Clients in the SAP
Master Data Integration documentation.
Integration Guide
Integration with SAP S/4HANA PUBLIC 45
• SAP Cloud Integration with predefined integration content.
Required Data
Only business partners with one or more of the following roles are replicated from SAP S/4HANA to SAP
Subscription Billing as customers:
Currently, the customer number in SAP Subscription Billing must be identical to the business partner number
in SAP S/4HANA.
You must specify sales areas for the business partners in SAP S/4HANA or SAP Master Data Integration. The
sales areas maps to markets in SAP Subscription Billing.
Partner Functions
The partner information is passed on from subscriptions to billing data in SAP Subscription Billing. The payer
and bill-to party are included in the bill header, the ship-to party is included in the bill items.
Integration Guide
46 PUBLIC Integration with SAP S/4HANA
Provider Contract Subscription Billing
Subscription Provider Contract Item Billing Plan Document Request
To ensure consistency of data between the applications, products and rate elements must be replicated
from SAP Subscription Billing to SAP S/4HANA Cloud or SAP S/4HANA (both referred to below as "SAP
S/4HANA").
Both products and rate elements from SAP Subscription Billing are created as products in SAP S/4HANA.
Replication takes place via SAP Cloud Integration, using predefined integration content.
Required Data
• The description length in SAP S/4HANA cannot exceed 40 characters and longer descriptions will be
truncated accordingly.
• For rate element replication, the unit of the rate element in SAP Subscription Billing must exist as a
commercial unit in SAP S/4HANA.
product.code productInternalID
M industrySectorCode
SBPD productTypecode
product.names description
EA baseMeasureUnitCode
Integration Guide
Integration with SAP S/4HANA PUBLIC 47
Field Mapping for Rate Elements
ratePlanElement.id productInternalID
M industrySectorCode
SBRE productTypecode
ratePlanElement.labels description
ratePlanElement.unit baseMeasureUnitCode
To provide the required information for accounting processes, subscriptions in SAP Subscription Billing are
replicated to provider contracts in SAP S/4HANA via SAP Event Mesh.
A provider contract comprises all agreements regarding the provision and billing of services required for the
processing of subscriptions in the SAP S/4HANA system.
Context
The provider contract represents the subscription contract in the SAP S/4HANA system.
Replication Process
SAP Subscription Billing sends a business event with the entire subscription data via SAP Event Mesh to SAP
S/4HANA every time that you create or change a subscription. This event triggers the creation or update of the
provider contract depending on the sent data and the event type.
You can also learn more about supported events in the API Guide:
Integration Guide
48 PUBLIC Integration with SAP S/4HANA
• Business Events
• Subscription Events
Restriction
A maximum of 25,000 subscriptions per hour can be created/changed and replicated to SAP S/4HANA.
If you want to migrate data or run any other process that result in mass changes to subscriptions, please
contact SAP beforehand by creating an incident on the component CEC-SAL-SB.
Note
With the Subscriptions API, you can backdate subscription parameters for the Sales Billing
scenario. To learn more, see Update Subscription Parameters in the API Guide.
Integration Guide
Integration with SAP S/4HANA PUBLIC 49
Subscription and Item Provider Contract and Item
Product New items are created. They start on the effective date of
the subscription snapshot.
• Product sold
• Product
The items for the previous product and product sold end on
the day before the new item starts.
Field Mapping
Header
The replication generates a provider contract with the same ID as the subscription. The header fields are
mapped as follows:
• The company code of the provider contract is derived from the sales area, which is the combination of
an organization, a distribution channel and a division. You can see the sales area in the provider contract
items. The sales area is mapped with the market from SAP Subscription Billing.
• The duration of the provider contract matches the duration of the subscription. The expiration date defines
the end of the subscription. If the subscription has no expiration date, the provider contract ends on
9999-12-31.
• Pending subscriptions aren't replicated to SAP S/4HANA. All other subscriptions are replicated and the
status of the subscription is mapped with the status Active of the provider contract.
• The subscription uses either a subscription-specific time zone, which is provided upon creation, or the
time zone of the market. The subscription time zone is mapped to the local time zone of the provider
contract. All contract-related dates, except for the create and change dates, are displayed in the local time
zone.
Note
For SAP S/4HANA 2021, not all time zones in SAP Subscription Billing are mapped to time zones in
SAP S/4HANA. You can only use markets with the following mapped time zones:
Etc/GMT UTC
Europe/London GMTUK
Europe/Berlin CET
Europe/Helsinki EET
Europe/Moscow RUS03
Integration Guide
50 PUBLIC Integration with SAP S/4HANA
SAP Subscription Billing SAP S/4HANA
Europe/Samara RUS04
Asia/Yekaterinburg RUS05
Asia/Omsk RUS06
Asia/Novosibirsk RUS07
Asia/Yakutsk RUS09
Asia/Tokyo JAPAN
Asia/Kolkata INDIA
Asia/Shanghai UTC+8
Australia/Perth AUSWA
Australia/Adelaide AUSSA
Australia/Sydney AUSNSW
Pacific/Bougainville RUS11
Pacific/Wake RUS12
Pacific/Honolulu HAW
Atlantic/Azores AZOREN
Atlantic/Stanley FLKLND
America/New_York EST
America/Mexico_City CST
America/Chicago CST
America/Denver MST
America/Phoenix MSTNO
America/Los_Angeles PST
America/Anchorage ALA
America/Fortaleza BRZLEA
America/Manaus BRZLWE
America/Rio_Branco BRZLAN
Integration Guide
Integration with SAP S/4HANA PUBLIC 51
Subscription Provider Contract
Status: Status:
Items
The replication generates one provider contract item per charge from the subscription item. The provider
contract item shows the following products:
• The product sold, which represents the subscription product. The product sold is mapped with the product
from SAP Subscription Billing. If a subscription item has multiple charges, multiple provider contract items
share the same product sold.
• The product, which represents an individual charge for which the subscriber pays. The product is mapped
with the rate element of the charge from the rate plan in SAP Subscription Billing. The product is unique
per item.
Example
A subscription has two items, one for the main product and one for an add-on product. Each subscription
item has three charges. In the provider contract, this structure is replicated into six provider contract items.
Three items are assigned to the main product of the first subscription item, and three items, to the add-on
product from the second subscription item.
Integration Guide
52 PUBLIC Integration with SAP S/4HANA
Other fields of the provider contract item are mapped with the subscription as follows:
• The end of duration is populated based on the expected term end of the subscription.
If the subscription doesn't have an expected term, or if the expected term end is later than the expiration
date, then the end of duration of the item is populated based on the expiration date of the subscription.
• The customer reference and date are mapped with the customer purchase reference and date of the
subscription. In SAP S/4HANA, you can use the customer reference to split the billing document, and you
can also include both the reference number and date on the printed invoice.
• Sales organization
• Distribution channel
• Division
• Company code
• Profit center
• Segment
Integration Guide
Integration with SAP S/4HANA PUBLIC 53
Subscription Subscription Item Provider Contract Item
Expiration date
In the S/4HANA system, use event 0540 to map custom references to the custom fields of the provider
contract item or to the table that contains external references in the provider contract header.
For more information, see the documentation of the FKK_SAMPLE_0540 sample function module.
To enable the replication of subscriptions from SAP Subscription Billing to provider contracts in SAP S/4HANA,
the subscriptions must have certain data.
Prerequisites
• You've defined the required settings for markets and subscription profiles in Business Configuration.
These settings are described in the scope item setup instructions.
• You've created products of subscription type Commercial in the Manage Products app.
Note
Details
Integration Guide
54 PUBLIC Integration with SAP S/4HANA
Subscription Data Requirement
Subscription profile Assign a subscription profile for which replication of subscriptions to provider contracts is
activated.
Recommendation
Product Assign a product of subscription type Commercial. This subscription type ensures that the
provider contract items are billed and printed on the invoice.
Duration (subscription Specify the duration of the subscription via the subscription terms. If your subscriptions are
terms)
open-ended, use the expected term to indicate the projected duration. You can predefine
the terms via the product or define specific terms for individual subscriptions.
The following term end dates are used to set the end of duration of the provider contract
items:
When the subscriptions are created, they appear on the Manage Subscriptions app. In the subscription header
you see the reference to the replicated provider contract, under General Info Processing Data . In this tab
you can also see the integration settings of the assigned subscription profile.
Integration Guide
Integration with SAP S/4HANA PUBLIC 55
4.2.4 Transfer of Billing Data to Sales Billing
Preparatory billing data in SAP Subscription Billing is transferred to SAP S/4HANA Cloud or SAP S/4HANA
(both referred to below as "SAP S/4HANA") where it is used in subsequent billing, invoicing, and financial
processes.
Transfer to Sales Billing takes place via SAP Cloud Integration, using predefined integration content.
• Billing data stored in bills is transferred to SAP S/4HANA, resulting in the creation of subscription billing
document requests in Sales Billing. These are external billing document requests (BDRs) of the type SBDR.
• The IDs of the BDRs are transferred back to SAP Subscription Billing. In the Manage Billing Data app of SAP
Subscription Billing, the successor document ID and successor system are displayed for the replicated bills
on the Transfer tab.
The replication is done by the asynchronous inbound service SUBSCRIPTIONBDRREQUEST_IN using SOAP
messages.
Each item in a bill has one or more charges or credits. These are mapped as follows in Sales Billing:
Field Mapping
In the standard integration flow, the fields are mapped as follows in the service
SUBSCRIPTIONBDRREQUEST_IN:
CreationDateTime Date and time (timestamp) when the message was created
Integration Guide
56 PUBLIC Integration with SAP S/4HANA
Node 3: Action Control (ActionControl)
AllItemsOfBllbleDocAreProcessableChk 1
Value
Example: 001000
Example: 001001
SalesDocumentType SBD
BillingDocumentRequestType SBDR
Integration Guide
Integration with SAP S/4HANA PUBLIC 57
Value
externalObjectRefer
ences[externalIdTyp
eCode=sap.sb.custom
er-purchase-
reference.id].exter
nalId
HigherLevelItem The
ReferenceDocumentItem
of the main item.
Integration Guide
58 PUBLIC Integration with SAP S/4HANA
Value
externalObjectRefer
ences[externalIdTyp
eCode=sap.s4.soluti
on-order-
management.order.id
].externalId
externalObjectRefer
ences[externalIdTyp
eCode=sap.s4.soluti
on-order-
management.order.it
em.id].externalId
externalObjectRefer
ences[externalIdTyp
eCode=sap.s4.provid
er-
contract.item.id].e
xternalId
externalObjectRefer
ences[externalIdTyp
eCode=
sap.s4.pricing-
procedure.id].exter
nalId
Integration Guide
Integration with SAP S/4HANA PUBLIC 59
Value
ConditionQuantity 1
Note
Integration Guide
60 PUBLIC Integration with SAP S/4HANA
Value
Note
If bill items have different general data, for example different customer purchase orders, they are split into
different BDRs in SAP S/4HANA. For more information, see the Sales Billing documentation:
SAP S/4HANA
Example
A bill has 2 bill items, each with 3 charges. In the subscription billing document request, this bill is replicated
into 8 billing document items. For each bill item there is a main item with the subscription product and 3
subitems with corresponding rate elements for each charge.
Bill
R-RECURRING USD 20 20
Integration Guide
Integration with SAP S/4HANA PUBLIC 61
Higher-Level Billing Quan Item Net
Item Item ID Product Item Category Item tity Amount
If you implement Subscription Management with Sales Billing, data related to SAP S/4HANA is available in SAP
Subscription Billing.
Customers
The IDs of business partners replicated from SAP S/4HANA or SAP Master Data Integration are stored as
external object references.
Subscriptions
• Related documents: In the subscription you see the reference to the replicated provider contract.
• Subscription settings: In the assigned subscription profile you see the prefix of the subscription ID, which
is the same for the provider contract ID.
Bills
In addition to the standard set of data that is required for billing and invoicing, bills for this integration contain
the following specific references:
• Provider contract: Included in the bill item, originates in the subscription item.
This attribute is available via the Bills API (subset billItems.externalObjectReferences).
• Successor document: Included in the transfer data of relevant bills. This is the subscription billing
document request (SBDR) in SAP S/4HANA.
Integration Guide
62 PUBLIC Integration with SAP S/4HANA
4.2.6 Setup Instructions for SAP S/4HANA 2021 (FPS01 and
Above)
This section provides instructions for setting up integration between SAP Subscription Billing and SAP S/
4HANA 2021 (FPS01 and above) Sales Billing.
To set up the integration as of SAP S/4HANA 2022, follow the instructions provided for the scope item 57Z
(Subscription Management with Sales Billing, version for SAP S/4HANA). You can access this information in the
Process Navigator in SAP for Me or by using this link: Setup Instructions .
4.2.6.1 Preparation
System Details
SAP S/4HANA Accessible via SAP Fiori Launchpad. Your system adminis
trator provides you with the URL to access the various apps
assigned to your role.
SAP Subscription Billing Accessible via URL. Your system administrator provides you
with the URL to access the application.
SAP Cloud Integration Accessible via URL. Your system administrator provides you
with the URL to access the application.
4.2.6.1.2 Prerequisites
• Your SAP Cloud Integration tenant has been provisioned. For details, see Initial Setup in the SAP Cloud
Integration documentation.
• SAP Business Technology Platform (SAP BTP) has been configured and service keys created to give the
integration process access to the SAP Subscription Billing APIs. This setup is described in the SAP BTP
Configuration Guide.
• If you are not already using Billing and Revenue Innovation Management in SAP S/4HANA and switches
FICA and CONV_INV are currently inactive, you must activate the following business functions:
• FICAC_CORE
• FICAC_CI
Note
These business functions enable the basic provider contract and billing plan functionality that is
required for this integration but do not allow you to use the full functionality of Billing and Revenue
Innovation Management.
Integration Guide
Integration with SAP S/4HANA PUBLIC 63
• Certain integration scopes are required to integrate with the SAP Subscription Billing solution. For details,
see SAP Subscription Billing API Scopes in the API Guide. The required view scopes (with the suffix _view)
are listed in the table rows Bills, Business Partners, Products, and Rate Plans.
Market units in SAP Subscription Billing must be mapped to the SAP S/4HANA organizational units.
Procedure
2 Navigate to Markets Under Master Data and The Markets view is displayed. At least one mar
Configuration, open the Manage ket unit for the
Business Configuration app and US or Germany
choose Markets. must have been
defined. If that is
not the case,
contact your
system adminis
trator.
Integration Guide
64 PUBLIC Integration with SAP S/4HANA
Step # Step Name Instruction Expected Result Comments
3 Maintain Market Click on Create and enter the fol The market is created and has For Germany,
map the sales
Unit Mapping lowing Market Details: been mapped to SAP S/4HANA
organization
organizational units.
Market A1 1010.
ID: A1
Name: US East
Currency: USD
Distribution Channel: 10
Division: 00
Choose Save.
Choose Create.
Market E1
ID: E1
Currency: EUR
Company Name: DE
House Number: 10
Street: Bahnhofstrasse
Integration Guide
Integration with SAP S/4HANA PUBLIC 65
Step # Step Name Instruction Expected Result Comments
City: Walldorf
Distribution Channel: 10
Division: 00
Choose Save.
Units for pricing and billing must be defined in SAP Subscription Billing.
Procedure
3 Create Units of Meas Click Create and define the Units of measure
ure are created.
following units of measure:
Description: Each
Unit Code: EA
Description: Gigabyte
Unit Code: GB
Integration Guide
66 PUBLIC Integration with SAP S/4HANA
4.2.6.2.3 Make ID/Number Range Settings for Products
and Rate Elements
To map only relevant product information between SAP S/4HANA and SAP Subscription Billing, maintain the
following number range integration settings in SAP Subscription Billing.
Procedure
2 Navigate to Integra Under Master Data and The Integration Settings view is
tion Settings Configuration, open the Manage displayed.
Business Configuration app and
choose Integration Settings.
3 Maintain Master Under Master Data, make the fol Number range settings are main
Data Settings lowing settings: tained.
Product
From Number: P
To Number: PZZZZZ
Rate Element
From Number: R
To Number: RZZZZZ
Integration Guide
Integration with SAP S/4HANA PUBLIC 67
4.2.6.2.4 Activate Language-Dependent Texts for Products
and Rate Elements
To ensure correct mapping of products and rate elements, language-dependent names and descriptions must
be activated.
2 Navigate to Lan Under Master Data and The Language Settings view is dis
guage Settings Configuration, open the Manage played.
Business Configuration app and
choose Language Settings.
To replicate subscriptions to provider contracts, define the following subscription profile settings in SAP
Subscription Billing.
Procedure
2 Navigate to Sub Under Master Data and The Subscription Settings view is
scription Settings Configuration, open the Manage displayed.
Business Configuration app and
choose Subscription Settings.
Integration Guide
68 PUBLIC Integration with SAP S/4HANA
Step # Step Name Instruction Expected Result Comments
3 Maintain Subscrip Choose Create and define a sub Subscription settings are defined
tion Profiles Set scription profile as follows: in a subscription profile.
tings
ID: DEFAULT
Replicate Subscriptions to
Provider Contracts: Selected
Choose Save.
As part of the setup, to enable replication of subscription data between SAP Subscription Billing and SAP
S/4HANA, you must activate outbound events.
Procedure
2 Navigate to Integra Under Master Data and The Integration Settings view is
tion Settings Configuration, open the Manage displayed.
Business Configuration app and
choose Integration Settings.
3 Activate Events Under SAP Event Mesh, switch on Events are activated.
Activate Outbound Events.
Integration Guide
Integration with SAP S/4HANA PUBLIC 69
4.2.6.2.7 Enable Navigation to SAP S/4HANA
After you have completed the integration setup, you can enable navigation from the SAP Subscription Billing
user interface to SAP S/4HANA.
Procedure
2 Navigate to Integra Under Master Data and The Integration Settings view is
tion Settings Configuration, open the Manage displayed.
Business Configuration app and
choose Integration Settings.
Purpose
In this activity, you create rate elements in SAP Subscription Billing. The rate IDs must correspond with the
relevant SAP S/4HANA products of type SBRE.
Integration Guide
70 PUBLIC Integration with SAP S/4HANA
Rate ID Rate Type Description
Procedure
Test Step Number Test Step Name Instruction Expected Result Comments
2 Navigate to Rate Ele Under Master Data and The Rate Elements
ments Configuration, open view is displayed.
the Manage Business
Configuration app and
choose Rate Elements.
ID: R-ONETIME
Label: One-Time
Activation Fee
One-Time Type:
Initial Fee
Description: Enter
a description, for
exampleOne-Time
Activation Fee
Active: Selected
Choose Save.
Integration Guide
Integration with SAP S/4HANA PUBLIC 71
Test Step Number Test Step Name Instruction Expected Result Comments
ID: R-SEATS
Label: Seat-Based
Monthly Fee
Data Source:
Subscription
Description: Enter a
description, for ex
ampleSeat-Based
Monthly Fee
Active: Selected
Choose Save.
Integration Guide
72 PUBLIC Integration with SAP S/4HANA
Test Step Number Test Step Name Instruction Expected Result Comments
ID: R-TRAFFIC
Unit: Each(EA)
Label: Traffic-
Based Usage Fee
Type of Technical
Resource ID: Cloud
Storage Space
ID
Description: Upload/
Download
Traffic in GB (or
another description of
your choice)
Active: Selected
Choose Save.
Purpose
In this activity you create a rate plan template in SAP Subscription Billing.
Integration Guide
Integration with SAP S/4HANA PUBLIC 73
Procedure
Test
Step # Test Step Name Instruction Expected Result Comments
2 Navigate to Rate Under Pricing, open the Manage The available rate plan templates
Plan Templates Rate Plan Templates app. are displayed.
3 Create Template for Choose Create Without The basic data for the template is
Seat-Based Rate Pricing Scheme, and enter the fol defined.
Plan lowing data under General Info:
Description: Seat-Based
Plan Template
Choose Add.
Integration Guide
74 PUBLIC Integration with SAP S/4HANA
Test
Step # Test Step Name Instruction Expected Result Comments
Percentage Pricing.
Ratio: 100
-Block Pricing .
Rate Element:R-TRAFFIC
Choose Save.
Integration Guide
Integration with SAP S/4HANA PUBLIC 75
4.2.6.3.3 Create a Product
Purpose
Note
The ID of the product in SAP Subscription Billing must correspond to the relevant product ID in SAP
S/4HANA.
Procedure
Product: P-CLOUD_STORAGE
Test
Step # Test Step Name Instruction Expected Result Comments
2 Navigate to Prod Under Master Data and The available products are dis
ucts Configuration, open the Manage played.
Products app.
3 Maintain General Choose Create, then enter the fol General information has been
Product Information lowing data on the General Info maintained.
tab:
Integration Guide
76 PUBLIC Integration with SAP S/4HANA
Test
Step # Test Step Name Instruction Expected Result Comments
4 Maintain Rate Plan On the Rate Plans tab, The product’s rate plan has been
for Product choose Create Without maintained.
Pricing Scheme .
5 Maintain Subscrip On the Subscription Terms tab, Subscription terms are main
tion Terms enter the following: tained.
6 Create Product On the Create Rate Plan view, The product P-CLOUD_STORAGE
choose Create. is created.
In this activity, you create two business partners with supported business partner roles. For general information
about business partner replication, see Replication of Business Partners [page 45].
Integration Guide
Integration with SAP S/4HANA PUBLIC 77
Step # Step Name Instruction Expected Results Comments
Grouping: External
alpha-numeric
numbering
Title: Company
Name: Domestic US
Customer 1
Street/House Number:
Augusta Ave SE 200
Augusta Ave SE 200
Postal Code/City:
30315-1402 Atlanta
Country/Reg: US
Region: GA
Timezone: EST
Transportation Zone:
0000000001
Integration Guide
78 PUBLIC Integration with SAP S/4HANA
Step # Step Name Instruction Expected Results Comments
Language: English
Mail: [email protected]
Legal Form:01
Industry: 91
ID: 0001
Ctry: US
Choose Save.
12 Verify Details Verify all the details such as: The business partner is
saved with the Customer
Address tab
role.
Communication tab
Identification tab
Choose Save.
Integration Guide
Integration with SAP S/4HANA PUBLIC 79
Step # Step Name Instruction Expected Results Comments
15 Verify Details Verify all the details such as: The business partner is
saved with the Customer
Address tab
(Fin.Accounting) role.
Communication tab
Identification tab
Choose Save.
This section describes how to set up the replication of business partner master data from SAP S/4HANA to
SAP Subscription Billing using SAP Cloud Integration.
Business partners in SAP S/4HANA are created as customers in SAP Subscription Billing.
• SAP Master Data Integration service (this is the recommended replication method).
Note
If you use this replication option, you don't need to complete the configuration steps described in the
current guide section. Instead, refer to the following documentation to set up integration between SAP
Subscription Billing and SAP Master Data Integration: SAP Master Data Integration: Business Partner
Data Replication [page 358]
Caution
To integrate SAP Master Data Integration with an SAP S/4HANA on-premise system, the SAP
Master Data Integration instance must be created with the s4hana-onpremise service plan. s4hana-
onpremise is only visible as a service plan option if the service instance is created in a CPEA-enabled
account (Cloud Platform Enterprise Agreement) or has an explicit entitlement in the SAP BTP cockpit
which may require an additional license. For more information, see Connecting Clients in the SAP
Master Data Integration documentation.
Integration Guide
80 PUBLIC Integration with SAP S/4HANA
Only business partners with one or more of the following roles are replicated from SAP S/4HANA to SAP
Subscription Billing as customers:
• Automatic Trigger: Changes are directly transferred to a target system when a business partner is created
or updated.
• Manual Trigger: via the transaction DRFOUT.
This transaction can be executed with the following options:
• Initialization: The system processes all data of the selected outbound implementations that are
required for a replication model.
• Changes: The program analyzes all data that was changed since the last change or since an
initialization was last performed.
• Manual: You can select and transfer individual data records by choosing the Manual Replication Filter
Criteria push button. If manual filter criteria is available, the Manual Replication Filter Criteria Available
check-box is selected.
The SOA Manager is used to administer and configure service providers and consumer proxies for a local
system.
Make settings to enable replication of business partners from SAP S/4HANA to SAP Subscription Billing:
Integration Guide
Integration with SAP S/4HANA PUBLIC 81
5. Enter the logical port name, for example, LP_SUB_BP.
In this example, SUB is the system that you are connecting to.
6. Select the Set Log.port Default checkbox.
7. Choose Next.
8. Maintain the Authentication details as follows and ensure the port is active:
Field Entry
9. Choose Next.
10. Enter the SAP Cloud Integration operation server node URL in the URL field and append it with /cxf and
the address endpoint as configured in the Sender tab of your integration flow.
Example: https://XXXXXX-iflmap.sap.eu2.hana.ondemand.com/cxf/S4/SB/bpReplicate
Note
You can find this URL in the SAP Cloud Integration tenant where you deploy the integration
flow Replicate Business Partners to SAP Subscription Billing (described in this guide under
Configuration of SAP Cloud Integration Configure and Deploy Integration Flow for Business Partner
Replication ). After the successful deployment of the integration flow on SAP Cloud Integration, go to
the Operations View, choose Manage Integration Content, select the corresponding integration flow and
find the complete URL under Endpoints.
Field Value
RM Protocol SAP RM
Integration Guide
82 PUBLIC Integration with SAP S/4HANA
4.2.6.5.1.2 Define Logical System
You need to create a logical system that represents SAP S/4HANA in the SAP Subscription Billing application.
Logical systems are defined as cross-client systems.
4. Choose Save.
5. Choose Ok to confirm the pop-up and save the details in the transport request.
This step might be already done if you used the direct business partner integration before.
3. Choose Save.
1. Access the transaction DRFIMG and navigate as follows: Define Custom Settings for Data Replication
Define Technical Settings Define Technical Systems for Business Systems .
The screen Change View "Define Business Systems": Overview is displayed.
Integration Guide
Integration with SAP S/4HANA PUBLIC 83
2. Under Defined Business Systems, choose New Entries and enter the following values:
Note
3. Select the newly created business system and double click Define Bus. Systems, BOs.
4. Choose New Entries and enter:
5. Choose the newly created BO Type and double click Define Bus. Systems, Bos, Communication Channel:
6. The screen Define Bus. Systems, BOs, Communication Channel is displayed.
7. Choose New Entries and enter:
Replication Not Defined <Not selected> Not Defined Not Defined <empty>
via Services
8. Choose Save.
1. Access the transaction DRFIMG and navigate as follows: Define Custom Settings for Data Replication
Define Replication Models .
The screen Change View: "Define Replication Model":Overview is displayed.
2. Choose New Entries and enter:
3. Choose Save.
4. Select the newly created replication model and double-click Assign Outbound Implementation in the left
navigation.
Integration Guide
84 PUBLIC Integration with SAP S/4HANA
5. Choose New Entries, and enter:
Outbound Communication
Implementation Description Sequence Channel Filter Time
6. Select the newly created outbound implementation and double-click Assign Target Systems for Repl.
Model/Outb.Impl. in the left navigation.
7. Choose New Entries, and enter:
Business System
SUBS4HANA
8. Choose the newly created business system and double-click Assign Outbound Parameter in the left
navigation.
9. Choose New Entries and enter:
Note
The Outbound Parameter Value for PACK_SIZE_BULK can be set as the most efficient package size,
which differs from system to system.
Integration Guide
Integration with SAP S/4HANA PUBLIC 85
4.2.6.5.2 Replication of Products and Rate Elements from
SAP Subscription Billing to SAP S/4HANA
This section describes how to set up the replication of products and rate elements from SAP Subscription
Billing to SAP S/4HANA.
The SOA Manager is used to administer and configure service providers and consumer proxies for a local
system.
Make settings to enable replication of products and rate elements from SAP Subscription Billing to SAP S/
4HANA and creation of products in SAP S/4HANA:
Note
Select the object and choose Show Details. Make a note of the Access URL: You will need it when you deploy
the integration flow (described in this guide under Configuration of SAP Cloud Integration Configure
and Deploy Integration Flow for Product Replication ). .
The SOA Manager is used to administer and configure service providers and consumer proxies for a local
system.
Make settings to enable confirmation from SAP S/4HANA to SAP Subscription Billing that products and rate
elements were successfully transferred and products were created in SAP S/4HANA:
Integration Guide
86 PUBLIC Integration with SAP S/4HANA
3. Search for the following object name:
Field Entry
9. Choose Next.
10. Enter the SAP Cloud Integration operation server node URL in the URL field and append it with /cxf and
the address endpoint as configured in the Sender tab of your integration flow.
Example: https://XXXXXX-iflmap.sap.eu2.hana.ondemand.com/cxf/
S4HCE_ProductConfirmation
Note
You can find this URL in the SAP Cloud Integration tenant where you deploy the integration flow
Confirm Product replication in SAP S4HANA Cloud (described in this guide under Configuration
of SAP Cloud Integration Configure and Deploy Integration Flow for Confirmation of Product
Replication ). After the successful deployment of the integration flow on SAP Cloud Integration, go to
the Operations View, choose Manage Integration Content, select the corresponding integration flow and
find the complete URL under Endpoints.
Field Value
RM Protocol SAP RM
Integration Guide
Integration with SAP S/4HANA PUBLIC 87
13. Choose Finish.
This section describes how to set up the replication of billing data from SAP Subscription Billing to SAP
S/4HANA.
The SOA Manager is used to administer and configure service providers and consumer proxies for a local
system.
Make settings to enable replication of bills from SAP Subscription Billing to SAP S/4HANA as billing document
requests:
Bills transferred from SAP Subscription Billing create billing document requests in SAP S/4HANA.
4. For SUBSCRIPTIONBDRREQUEST_IN, select User Name/Password (Basic) and X.509 Client Certificate.
5. Choose Save.
Note
Select the object and choose Show Details. Make a note of the Access URL: You will need for the step
Configure and Deploy Integration Flow for Billing Data Replication [page 131].
Integration Guide
88 PUBLIC Integration with SAP S/4HANA
4.2.6.5.3.2 SOA Manager Settings for Confirmation of Billing
Data Replication
The SOA Manager is used to administer and configure service providers and consumer proxies for a local
system.
Make settings to enable confirmation from SAP S/4HANA to SAP Subscription Billing that billing data was
successfully transferred and billing documents requests were created in SAP S/4HANA:
SubscriptionBDRConfirmation_Out SubscriptionBDRConfirmation_Out
Field Entry
9. Choose Next.
10. Enter the SAP Cloud Integration operation server node URL in the URL field and append it with /cxf and
the address endpoint as configured in the Sender tab of your integration flow.
Example: https://XXXXXX-iflmap.sap.eu2.hana.ondemand.com/cxf/S4/SB/bdrConfirm
Note
You can find this URL in the SAP Cloud Integration tenant where you deploy the integration
flow Confirm Billing Document Request Creation to SAP Subscription Billing (described in this
guide under Configuration of SAP Cloud Integration Configure and Deploy Integration Flow for
Confirmation of Billing Document Request Creation ). After the successful deployment of the
integration flow on SAP Cloud Integration, go to the Operations View, choose Manage Integration
Content, select the corresponding integration flow and find the complete URL under Endpoints.
Integration Guide
Integration with SAP S/4HANA PUBLIC 89
12. Choose Next and enter the following data under Messaging:
Field Value
RM Protocol SAP RM
To provide the required information for accounting processes, subscriptions in SAP Subscription Billing are
replicated to provider contracts in SAP S/4HANA via SAP Event Mesh.
Note
A provider contract comprises all agreements regarding the provision and billing of services required for the
processing of subscriptions in the SAP S/4HANA system.
Context
Integration Guide
90 PUBLIC Integration with SAP S/4HANA
Replication Process
SAP Subscription Billing sends an event with the entire subscription data to SAP S/4HANA every time that you
create or change a subscription. This event triggers the creation or update of the provider contract depending
on the sent data and the event type.
You can also learn more about supported events in the API Guide:
• Business Events
• Subscription Events
Restriction
A maximum of 25,000 subscriptions per hour can be created/changed and replicated to SAP S/4HANA.
If you want to migrate data or run any other process that result in mass changes to subscriptions, please
contact SAP beforehand by creating an incident on the component CEC-SAL-SB.
To enable a seamless replication process, the subscriptions in SAP Subscription Billing are subject to the
following restrictions:
Field Mapping
Header
The replication generates a provider contract with the same ID as the subscription. The header fields are
mapped as follows:
• The company code of the provider contract is derived from the sales area, which is the combination of
an organization, a distribution channel and a division. You can see the sales area in the provider contract
items. The sales area is mapped with the market from SAP Subscription Billing.
• The duration of the provider contract matches the duration of the subscription. The expiration date defines
the end of the subscription. If the subscription has no expiration date, the provider contract ends on
9999-12-31.
• The subscription uses either a subscription-specific time zone, which is provided upon creation, or the
time zone of the market. The subscription time zone is mapped to the local time zone of the provider
contract. All contract-related dates, except for the create and change dates, are displayed in the local time
zone.
Integration Guide
Integration with SAP S/4HANA PUBLIC 91
Restriction
Not all time zones in SAP Subscription Billing are mapped to time zones in SAP S/4HANA. You can only
use markets with mapped time zones.
Etc/GMT UTC
Europe/London GMTUK
Europe/Berlin CET
Europe/Helsinki EET
Europe/Moscow RUS03
Europe/Samara RUS04
Asia/Yekaterinburg RUS05
Asia/Omsk RUS06
Asia/Novosibirsk RUS07
Asia/Yakutsk RUS09
Asia/Tokyo JAPAN
Asia/Kolkata INDIA
Asia/Shanghai UTC+8
Australia/Perth AUSWA
Australia/Adelaide AUSSA
Australia/Sydney AUSNSW
Pacific/Bougainville RUS11
Pacific/Wake RUS12
Pacific/Honolulu HAW
Atlantic/Azores AZOREN
Atlantic/Stanley FLKLND
America/New_York EST
America/Mexico_City CST
America/Chicago CST
America/Denver MST
America/Phoenix MSTNO
America/Los_Angeles PST
America/Anchorage ALA
America/Fortaleza BRZLEA
America/Manaus BRZLWE
Integration Guide
92 PUBLIC Integration with SAP S/4HANA
SAP Subscription Billing SAP S/4HANA
America/Rio_Branco BRZLAN
• Pending subscriptions are not replicated to SAP S/4HANA. All other subscriptions are replicated and the
status of the subscription is mapped with the status Active of the provider contract.
Status: Status:
Items
The replication generates one provider contract item per charge from the subscription item. The provider
contract item shows the following products:
• The product sold, which represents the subscription product. The product sold is mapped with the product
from SAP Subscription Billing. If a subscription item has multiple charges, multiple provider contract items
share the same product sold.
• The product, which represents an individual charge for which the subscriber pays. The product is mapped
with the rate element of the charge from the rate plan in SAP Subscription Billing. The product is unique
per item.
Example
A subscription has two items, one for the main product and one for an add-on product. Each subscription
item has three charges. In the provider contract, this structure is replicated into six provider contract items.
Three items are assigned to the main product of the first subscription item, and three items, to the add-on
product from the second subscription item.
Integration Guide
Integration with SAP S/4HANA PUBLIC 93
Other fields of the provider contract item are mapped with the subscription as follows:
• The end of duration is populated based on the expected term end of the subscription.
If the subscription doesn't have an expected term, or if the expected term end is later than the expiration
date, then the end of duration of the item is populated based on the expiration date of the subscription.
• The customer reference and date are mapped with the customer purchase reference and date of the
subscription. In SAP S/4HANA, you can use the customer reference to split the billing document, and you
can also include both the reference number and date on the printed invoice.
• Sales organization
• Distribution channel
• Division
• Company code
• Profit center
• Segment
Integration Guide
94 PUBLIC Integration with SAP S/4HANA
Subscription Subscription Item Provider Contract Item
Expiration date
If you're not yet using SAP Event Mesh, you need to complete some initial steps in the SAP BTP cockpit. The
following steps are described in detail in SAP BTP Configuration Guide for Subscription Billing.
In the Business Configuration for SAP Subscription Billing, activate sending of outbound events:
Create a queue for subscription events and subscribe to the queue to enable SAP S/4HANA to consume the
events.
Integration Guide
Integration with SAP S/4HANA PUBLIC 95
Prerequisites
Access to the SAP Event Mesh application, where you perform these tasks, must be enabled. The required
steps to do this are described in theSAP BTP Configuration Guide for SAP Subscription Billing (section
Administer queues via Event Mesh Management UI).
Procedure
This section describes how to configure Enterprise Event Enablement in the ABAP Platform.
Enterprise Event Enablement is a technical component on SAP S/4HANA. It enables the exchange of events
across different platforms for seamless event-driven communication. Events from SAP S/4HANA can be sent
to SAP Event Mesh only, where they can be used by any recipient.
Prerequisite
For more information about roles and authorization objects in the Enterprise Event Enablement framework, see
Authorization Objects and Roles in the SAP S/4HANA documentation.
Integration Guide
96 PUBLIC Integration with SAP S/4HANA
Configuration
In order to successfully exchange events between SAP Event Mesh and an SAP S/4HANA on-premise-system,
an upright connection is required. This connection is maintained by the Enterprise Event Enablement
framework during channel creation.
Note
A channel represents a single connection to a service instance of the SAP Event Mesh.
The maintenance of a channel requires a SM59 transaction destination and an OAuth 2.0 configuration on the
SAP S/4HANA system. Both must be configured according to the service key of the corresponding SAP Event
Mesh instance.
Inbound Scenario
Once a channel has been created, you can decide which topics to maintain on the channel. This, and the
configuration of subscriptions, is required to consume an event to the corresponding SAP Event Mesh instance.
You can create or delete a topic binding and display, assign or delete consumers.
The service key created in SAP Event Mesh contains all information required to establish a connection. This
information is extracted and used to create a destination and an OAuth 2.0 configuration. By using the service
key while creating a channel, the administrator saves manual steps on the SAP S/4HANA system. These
required configurations are created automatically by the Enterprise Event Enablement framework.
Prerequisite
If you want to create, configure and manage channels, you must first create an instance in the SAP Event Mesh.
For more information, see Create an Event Mesh Service Instance in the SAP Event Mesh documentation.
Procedure
Integration Guide
Integration with SAP S/4HANA PUBLIC 97
4. OAuth 2.0 Configuration
4. Enter the service key.
5. Choose Save configuration or press Enter .
Note
• If the destination or the OAuth 2.0 Configuration name is not available, random names will be
generated.
• If there is already a channel you want to use, skip the steps above and proceed with the configuration of
the outbound bindings.
• After saving, you can still change optional parameters.
You must configure inbound event topic bindings for consuming events.
To consume an event to the corresponding SAP Event Mesh instance, you must configure inbound topic
bindings and assign subscriptions.
Once a channel has been created, you can decide which topics to maintain on the channel. This is required to
consume an event to the corresponding SAP Event Mesh instance. You can create or delete a topic binding and
display, assign or delete consumers.
Procedure
Note
If you select an inbound binding from the value help, the corresponding consumer is created
automatically. If you create the inbound topic manually then you need to assign the consumer to
the inbound topic binding (follow the procedure below).
Integration Guide
98 PUBLIC Integration with SAP S/4HANA
4. Choose Save configuration or press Enter .
Create subscriptions for receiving events from the respective SAP Event Mesh queue address.
Procedure
Note
Subscriptions must have a valid subscription address provided by the SAP Event Mesh. Once a
new subscription has been created, the subscription has the status New until the subscription is
acknowledged by the SAP Event Mesh and the status set to Acknowledged. Otherwise, the subscription
gets the status Rejected. Both subscriptions and inbound bindings are required to consume cloud
events.
Note
If the channel you want to configure is in the list but not activated, access the transaction /IWXBE/
CONFIG or navigate as follows in the SAP Customizing Implementation Guide (transaction SPRO): SAP
NetWeaver Enterprise Event Enablement Configuration Administration Channel Connection Settings
Maintain Channels and Parameters
Integration Guide
Integration with SAP S/4HANA PUBLIC 99
4.2.6.7 Configuration in SAP S/4HANA
This section describes the customizing required in SAP S/4HANA to enable the integration.
Note
In addition to configuring SAP S/HANA as described in this section, you must also follow the instructions in
SAP Note 3140665 to provide users with the application to display provider contracts.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Logistics General Material Master Settings for Key Fields Data Relevant to Sales and Distribution
Define Sales Statuses
The screen Change View “Materials: Status in Sales and Distribution”: Overview is displayed.
2. Choose New Entries and enter the following:
St Description
UP Unpublished
3. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Financial Accounting Contract Accounts Receivable and Payable Basic Functions Provider Contract
Define Number Range
The screen Edit Intervals: Provider Contract, Object FKK_VT is displayed.
2. Choose Intervals (button with edit icon).
3. Insert a line and add the following entries:
Number Range No. From No. To Number Number Range Status External
Integration Guide
100 PUBLIC Integration with SAP S/4HANA
5. Choose New Entries and enter the following:
6. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
ABAP Platform Application Server Business Management SAP Business Events Configure Event
Type Linkages
The screen Change View “Event Type Linkages”: Overview is displayed.
2. Choose New Entries and enter the following:
Integration Guide
Integration with SAP S/4HANA PUBLIC 101
Object Object Receiver Receiver Class Interface Method Linkage
Category Type Event Type Call Name Name Name Activated
3. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Service Transactions Basic Settings Define Item Category Group
Integration Guide
102 PUBLIC Integration with SAP S/4HANA
The screen Materials: Item Category Groups in Material Master is displayed.
2. Choose New Entries and enter the following:
Field Value
ItCtGrp SBPD
Field Value
ItCtGrp SBRE
3. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Logistics - General Material Master Basic Settings Material Types Define Attributes of Material
Types
The screen Materials Types”: Overview is displayed.
2. Choose New Entries and enter the following:
For products:
Field Value
General data
User departments
Accounting
Basic data
Sales
Int.purchase orders 0
Integration Guide
Integration with SAP S/4HANA PUBLIC 103
Field Value
Valuation
Quantity/value updating
In no valuation area
In no valuation area
Retail-specific fields
Field Value
General data
User departments
Accounting
Basic data
Sales
Int.purchase orders 0
Valuation
Integration Guide
104 PUBLIC Integration with SAP S/4HANA
Field Value
Quantity/value updating
In no valuation area
In no valuation area
Retail-specific fields
3. Select the material type SBPD and double-click on Quantity/value updating in the navigation.
Update the values for the regions US and DE accordingly.
4. Repeat the previous step for the material type SBRE.
5. Choose Save.
The following condition types are only an example that can be assigned in a pricing procedure. Create those
condition types that are relevant as per the requirements. Adjust the pricing procedure mentioned in next
chapter accordingly with the required condition types.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Sales and Distribution Basic Function Pricing Pricing Control Define Condition Types
2. Choose Set Condition Types for Pricing.
The screen Change View: "Conditions: Condition Types:” Overview is displayed.
3. Choose New Entries and enter the following:
Note
Fields that you see on the screen but that are not listed below are not relevant.
Field Value
Control Data 1
Integration Guide
Integration with SAP S/4HANA PUBLIC 105
Field Value
Amount/Percent X (Selected)
Master Data
Control Data 2
Field Value
Control Data 1
Amount/Percent X (Selected)
Master Data
Control Data 2
Field Value
Control Data 1
Integration Guide
106 PUBLIC Integration with SAP S/4HANA
Field Value
Amount/Percent X (Selected)
Master Data
Control Data 2
4. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Sales and Distribution Basic Functions Pricing Pricing Control Define and Assign Pricing
Procedures
2. Choose Set Document Pricing Procedure.
The screen Change View “Pricing Procedures: Transaction”: Overview is displayed.
3. Choose New Entries and enter the following:
S7 Subscription Billing
4. Choose Save.
Define a pricing procedure with the required condition types and assign it to SAP Subscription Billing.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Sales and Distribution Basic Functions Pricing Pricing Control Define and Assign Pricing
Procedures
2. Choose Set Pricing Procedures.
The screen Change View “Procedures”: Overview is displayed.
Integration Guide
Integration with SAP S/4HANA PUBLIC 107
3. Choose New Entries and enter the following for the US market:
Field Value
4. Select the pricing procedure that you just created, and choose Procedures - Control Data in the navigation.
5. Choose New Entries and enter the following:
Note
Fields that you see on the screen but that are not listed below are not relevant.
Alt.
Calc. Alt.
Condi De Man Re Cndn Cndn Ac
Coun tion scrip From To ual Print Subto quire Amoun Base count
Step ter Type tion Step Step Only Type tal ment t Value Key
Integration Guide
108 PUBLIC Integration with SAP S/4HANA
Alt.
Calc. Alt.
Condi De Man Re Cndn Cndn Ac
Coun tion scrip From To ual Print Subto quire Amoun Base count
Step ter Type tion Step Step Only Type tal ment t Value Key
Integration Guide
Integration with SAP S/4HANA PUBLIC 109
Alt.
Calc. Alt.
Condi De Man Re Cndn Cndn Ac
Coun tion scrip From To ual Print Subto quire Amoun Base count
Step ter Type tion Step Step Only Type tal ment t Value Key
6. Choose Save.
7. Choose New Entries and enter the following for the German market:
Field Value
8. Select the pricing procedure that you created for the German market, and choose Procedures - Control
Data in the navigation.
9. Choose New Entries and enter the following:
Note
Fields that you see on the screen but that are not listed below are not relevant.
Integration Guide
110 PUBLIC Integration with SAP S/4HANA
Alt.
Calc. Alt.
Condi De Man Re Cndn Cndn Ac
Coun tion scrip From To ual Print Subto quire Amoun Base count
Step ter Type tion Step Step Only Type tal ment t Value Key
Integration Guide
Integration with SAP S/4HANA PUBLIC 111
4.2.6.7.9 Define Determination of Pricing Procedure
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Sales and Distribution Basic Functions Pricing Pricing Control Define and Assign Pricing
Procedures
2. Choose Set Pricing Procedure Determination.
The screen Change View “Det. of Pricing Procedures in Sales Docs.”: Overview is displayed.
3. Assign the pricing procedures that you created to the required sales organization and customer pricing
procedures
4. Choose New Entries and enter the following:
5. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Sales and Distribution Billing Billing Documents Define Billing Types for Sales
2. Choose Define Billing Types.
The screen Change View "Billing: Document Types": Overview is displayed.
3. Choose New Entries and enter the following:
Field Value
Number Systems
General Control
Integration Guide
112 PUBLIC Integration with SAP S/4HANA
Field Value
Corr.Doc. w/ ValDat No
Output/partners/texts
4. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Sales and Distribution Sales Sales Documents Sales Document Header Define Sales Document
Types
The screen Change View "Maintain Sales Order Types": Overview is displayed.
2. Choose New Entries and enter the following:
Field Value
SD Document Category C
Number Systems
Transaction flow
Integration Guide
Integration with SAP S/4HANA PUBLIC 113
Field Value
Billing
Order-rel.bill.type F2 (Invoice)
Paymt guarant.proc 01
Checking group 01
3. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Sales and Distribution Basic Functions Pricing Pricing Control Define and Assign Pricing
Procedures
2. Choose Assign Document Pricing Procedures to Order Types.
The screen Change View "Sales Document Types: Document Pricing Procedure": Overview is displayed.
3. Choose New Entries and enter the following:
4. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Sales and Distribution Basic Functions Partner Determination Set Up Partner Determination Set
Up Partner Determination for Sales Document Header Partner Determination Procedure Assignment
2. Choose Set Up Partner Determination for Sales Document Header Partner Determination Procedure
Assignment .
The screen Change View "Partner Determination Procedure Assignment": Overview is displayed.
3. Choose New Entries and enter the following:
Integration Guide
114 PUBLIC Integration with SAP S/4HANA
4. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Sales and Distribution Basic Functions Billing Payment cards Authorization and Settlement
Maintain Checking Groups
2. Choose Assign Checking Groups.
The screen Change View "Assign Checking Groups": Overview is displayed.
3. Choose New Entries and enter the following:
4. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Sales and Distribution Basic Functions Credit Management/Risk Management Receivables Risk
Management Define and Assign Payment Guarantee Schemas
2. Choose Assign Document Schema to Order Types.
The screen Change View "Risk Management: Document Control": Overview is displayed.
3. Choose New Entries and enter the following:
4. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Sales and Distribution Billing Payment cards Maintain Payment Card Plan Types
The screen Change View "Risk Management: Document Control": Overview is displayed.
Integration Guide
Integration with SAP S/4HANA PUBLIC 115
2. Choose New Entries and enter the following:
Sales Doc. Type Description PT (payment Card Plan Type) Payment Card Plan Type
3. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Sales and Distribution Sales Sales Documents Sales Documents Item Define Item Categories
The screen Change View "Maintain Item Categories": Overview is displayed.
2. Choose New Entries and enter the following:
For the subscription charge:
Field Value
Business Data
Billing Relevance B
Pricing X (Selected)
Wght/Vol.Relevant X (Selected)
Transaction Flow
Screen Seq.Grp N
Field Value
Business Data
Item Type B
Billing Relevance C
Transaction Flow
Screen Seq.Grp N
Integration Guide
116 PUBLIC Integration with SAP S/4HANA
Field Value
Field Value
Business Data
Billing Relevance B
Pricing X (Selected)
Wght/Vol.Relevant X (Selected)
Transaction Flow
Screen Seq.Grp N
3. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Sales and Distribution Basic Functions Text Control Define and Assign Text Determination
Procedures
2. Choose Configuration: Texts.
The screen Customizing Text Determination is displayed.
3. For the text object Sales Document, select Item, then choose Change.
The screen Change View "Sales Document Item Txt DetProc Assignmt":Overview is displayed.
4. Choose Text procedure assignment in the navigation.
5. Choose New Entries and enter the following:
6. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Sales and Distribution Basic Functions Partner Determination Set Up Partner Determination
Integration Guide
Integration with SAP S/4HANA PUBLIC 117
2. Choose Set Up Partner Determination for Sales Document Item Partner Determination Procedure
Assignment .
The screen Change View "Partner Determination Procedure Assignment" is displayed.
3. Choose New Entries and enter the following:
4. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Sales and Distribution Billing Billing Documents Maintain Copying Control for Billing Documents
2. Choose Define Copying Control for Sales Document to Billing Document.
The screen Change View "Header": Details is displayed.
3. Choose New Entries and enter the following:
Field Value
Target
Source
Copy
Reference Number A
4. Choose Item.
The screen Change View "Item": Overview is displayed.
5. Choose New Entries and enter the following:
For a subscription charge:
Field Value
Target
Source
Integration Guide
118 PUBLIC Integration with SAP S/4HANA
Field Value
Copy
Billing Quantity A
Pos./Neg.Quantity +
Pricing Type K
Field Value
Target
Source
Copy
Billing Quantity A
Pos./Neg.Quantity +
Pricing Type K
Field Value
Target
Source
Copy
Integration Guide
Integration with SAP S/4HANA PUBLIC 119
Field Value
Billing Quantity A
Pos./Neg.Quantity +
Pricing Type K
6. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Sales and Distribution Billing Billing Documents Maintain Copying Control for Billing Documents
2. Choose Define Copying Control for Billing Document to Billing Document.
The screen Change View "Header": Details is displayed.
3. Choose New Entries and enter the following:
Field Value
Target
Source
Copy
Reference Number A
4. Choose Item.
The screen Change View "Item": Overview is displayed.
5. Choose New Entries and enter the following:
For a subscription charge:
Field Value
Target
Source
Integration Guide
120 PUBLIC Integration with SAP S/4HANA
Field Value
Copy
Billing Quantity A
Pos./Neg.Quantity +
Pricing Type K
Field Value
Target
Source
Copy
Billing Quantity A
Pos./Neg.Quantity +
Pricing Type K
Field Value
Target
Source
Copy
Billing Quantity A
Pos./Neg.Quantity +
Integration Guide
Integration with SAP S/4HANA PUBLIC 121
Field Value
Pricing Type K
6. Choose Save.
To enable replication of data, you need configure integration in SAP Cloud Integration.
Prerequisites
• You have received a SAP Cloud Integration provisioning email from SAP, after which the administrator
needs to create the required users in SAP Cloud Integration. The users require the following roles:
• AuthGroup.IntegrationDeveloper
• AuthGroup.BusinessExpert
• esbmessagestorage.read
• ESBMessaging.send
• To connect to the SAP S/4HANA system, you must install and configure the Cloud Connector that is part
of the SAP Connectivity service. For setup information, see Install and Configure SAP Connectivity service
[page 122].
This section describes the installation and configuration procedures in SAP Connectivity service.
Serving as a link between SAP BTP applications and on-premise systems, the Connectivity service runs as an
on-premise agent in secured networks.
Before you can use the Connectivity service to link SAP S/4HANA and SAP BTP, ensure that you have installed
the cloud connector. For more information on installation, see Installation in the SAP Connectivity service
documentation.
After installing the cloud connector and starting the cloud connector daemon, you can log on to the daemon
and perform required configurations to make your cloud connector operational. For more information, see
Initial Configuration in the SAP Connectivity service documentation.
In addition, specify the SAP S/4HANA web service that can be accessed by integration flows using HTTP. For
more information, see Configure Access Control (HTTP) in the SAP Connectivity service documentation.
Integration Guide
122 PUBLIC Integration with SAP S/4HANA
Procedure
You need to deploy an OAuth2 credentials artifact to be able to connect to SAP Subscription Billing, which
requires OAuth 2.0 authentication.
Procedure
1. Log on to the tenant management node of the SAP Cloud Integration system with the URL https://
<tenant management node URL>/itspaces.
2. In the navigation panel, choose Monitor.
3. Choose Manage Security Security Material .
4. Choose Add OAuth2 Credentials .
5. Specify the following fields in the Add OAuth2 Credentials dialog box.
Integration Guide
Integration with SAP S/4HANA PUBLIC 123
Field Naame Entry Value
For information about getting the client ID and client secret, see the SAP BTP Configuration Guide (setion
about creating a service key).
6. Choose Deploy.
Procedure
1. Log on to the tenant management node of the SAP Cloud Integration system with the URL https://
<tenant management node URL>/itspaces.
2. In the navigation panel, choose Monitor.
3. Go to Manage Security Security Material .
4. Choose Create User Credentials .
5. Enter a name for the credential and enter a user (with password) that has authorization to access the SAP
S/4HANA back-end system.
6. Choose Deploy.
Integration Guide
124 PUBLIC Integration with SAP S/4HANA
4.2.6.8.4 Copy Integration Packages to Customer
Workspace
You need to copy two packages to the customer workspace before configuring the integration flows.
Procedure
1. Log on to your SAP Cloud Integration tenant as an SAP Cloud Integration developer, using the following
URL:
https://<your SAP Cloud Integration tenant URL>/itspaces
2. In the navigation panel, choose Discover.
3. Select All to see all the published integration packages.
4. Search for the integration packages one by one, by entering their names in the Search field:
• SAP Subscription Billing Integration with SAP S/4HANA - Subscription Management with Sales
Billing
• SAP Subscription Billing Integration with SAP S/4HANA Cloud - Product
Note: Although the package name refers to "SAP S/4HANA Cloud", the package is also valid for
integration with the on-premise suite.
5. To copy each integration package from the catalog to your customer workspace, select the package to
open it and choose Copy.
Note
If you use SAP Master Data Integration to integrate business partner data, you don't need this integration
flow. Integration between SAP Subscription Billing and SAP Master Data Integration is described in the SAP
Subscription Billing Integration Guide under Business Partner Data Replication [page 358].
1. Log on to your SAP Cloud Integration tenant as an SAP Cloud Integration developer, using the following
URL:
https://<your SAP Cloud Integration tenant URL>/itspaces
2. In the navigation panel, choose Design.
1. Select the package SAP Subscription Billing Integration with SAP S/4HANA - Subscription
Management with Sales Billing.
2. On the Artifacts tab, select the integration flow Replicate Business Partners to SAP Subscription
Billing and choose Actions Configure .
Integration Guide
Integration with SAP S/4HANA PUBLIC 125
3. On the Sender tab, configure the address and select the appropriate authentication method.
• Address is used to set up the SAP S/4HANA outbound service connection. For example, if the URL
maintained in SOA Manager Settings for Business Partners [page 81] is /cxf/S4/SB/BPReplicate,
the address should be /S4/SB/BPReplicate.
• Select either User Role or Client Certificate authentication.
4. On the Receiver tab, provide the address for the receiver system.
Select SubscriptionBilling as receiver, enter the following parameters:
• Subscription_Billing_API_Home_Path: The API home path mentioned in the SAP BTP Configuration
Guide (section about creating a service key). Example: eu10.revenue.cloud.sap/api
• Credential Name: The credential name created in the step Create OAuth2.0 Credentials for SAP
Subscription Billing [page 123].
• Adapter Type: HTTP
5. Select S4HConfirmIn as receiver, enter the following details:
• Address: You can find the URL for the corresponding configuration object in the SOA Manager (see
SOA Manager Settings for Business Partners [page 81] → Step 14).
• Proxy Type: On-Premise
• Authentication/Credential Name: Choose Basic and enter the credential name created in the step
Create SAP S/4HANA User Credentials in Integration [page 124].
6. If you want to extend the capabilities of standard integration flow, select ExtensionPostExit as receiver and
enter the Address for your custom integration flow.
7. On the More tab, configure the parameters as below:
8. Choose Save.
Integration Guide
126 PUBLIC Integration with SAP S/4HANA
Deploy Integration Flow
1. Log on to your SAP Cloud Integration tenant as an SAP Cloud Integration developer, using the following
URL:
https://<your SAP Cloud Integration tenant URL>/itspaces
2. In the navigation panel, choose Design.
1. Select the package SAP Subscription Billing Integration with SAP S/4HANA Cloud - Product.
Note: Although the package name refers to "SAP S/4HANA Cloud", the package is also valid for
integration with the on-premise suite.
2. On the Artifacts tab, select the integration flow Replicate Products to SAP S/4HANA Cloud and
choose Actions Configure .
3. On the Timer tab, define the execution schedule and frequency of the integration flow.
4. On the Receiver tab, provide the address for the receiver system.
• Select SubscriptionBilling as receiver, enter the following parameters:
• Subscription_Billing_API_Home_Path: The API home path mentioned in the SAP
BTP Configuration Guide ( section about creating a service key). Example:
eu10.revenue.cloud.sap/api
• Adapter Type: HTTP
• Query: The query condition for API calls.
• Credential Name: The credential name created in the step Create OAuth2.0 Credentials for SAP
Subscription Billing [page 123].
5. Select S4HCEConfirmIn as receiver, enter the following details:
• Adapter Type: SOAP
• Address: The URL for the corresponding configuration object in the SOA Manager (see SOA Manager
Settings for Product Replication [page 86]).
Integration Guide
Integration with SAP S/4HANA PUBLIC 127
• Proxy Type: On-Premise
• Authentication/Credential Name: Choose Basic and enter the credential name created in the step
Create SAP S/4HANA User Credentials in Integration [page 124].
6. If you want to extend the capabilities of standard integration flow, select PostExit as receiver and enter
the Address for your custom integration flow.
7. On the More tab, configure the parameters as below:
Product_Type_Code SBPD
8. Choose Save.
1. Log on to your SAP Cloud Integration tenant as an SAP Cloud Integration developer, using the following
URL:
https://<your SAP Cloud Integration tenant URL>/itspaces
2. Select Design from the drop-down menu. You will see all available integration packages for the tenant.
Search for the package SAP Subscription Billing Integration with SAP S/4HANA Cloud - Product.
3. Select the integration package SAP Subscription Billing Integration with SAP S/4HANA Cloud -
Product.
4. Select Artifacts. All artifacts are listed at the bottom of the page.
5. For the integration flow Replicate Products to SAP S4HANA Cloud, select Actions Deploy .
1. Log on to your SAP Cloud Integration tenant as an SAP Cloud Integration developer, using the following
URL:
https://<your SAP Cloud Integration tenant URL>/itspaces
Integration Guide
128 PUBLIC Integration with SAP S/4HANA
2. In the navigation panel, choose Design.
1. Select the package SAP Subscription Billing Integration with SAP S/4HANA - Product.
Note: Although the package name refers to "SAP S/4HANA Cloud", the package is also valid for
integration with the on-premise suite.
2. On the Artifacts tab, select the integration flow Replicate Rate Elements to SAP S4HANA Cloud and
choose Actions Configure .
3. On the Timer tab, define the execution schedule and frequency of the integration flow.
4. On the Receiver tab, provide the address for the receiver system.
• Select the appropriate authentication type (either certificate-based or basic authentication).
• Select SubscriptionBilling as receiver, enter the following parameters:
• Subscription_Billing_API_Home_Path: The API home path mentioned in the SAP
BTP Configuration Guide ( section about creating a service key). Example:
eu10.revenue.cloud.sap/api
• Credential Name: The credential name created in the step Create OAuth2.0 Credentials for SAP
Subscription Billing [page 123].
5. Select S4HCE as receiver, enter the following details:
• Adapter Type: SOAP
• Address: The URL for the corresponding configuration object in the SOA Manager (see SOA Manager
Settings for Product Replication [page 86]).
• Proxy Type: On-Premise
• Authentication/Credential Name: Choose Basic and enter the credential name created in the step
Create SAP S/4HANA User Credentials in Integration [page 124].
6. If you want to extend the capabilities of standard integration flow, select PostExit as receiver and enter
the Address for your custom integration flow.
7. On the More tab, configure the parameters as below:
Product_Type_Code SBRE
8. Choose Save.
1. Note: Although the package name refers to "SAP S/4HANA Cloud", the package is also valid for integration
with the on-premise suite.
2. Select Design from the drop-down menu. You will see all available integration packages for the tenant.
Search for the package SAP Subscription Billing Integration with SAP S/4HANA Cloud – Product.
Integration Guide
Integration with SAP S/4HANA PUBLIC 129
3. Select the integration package SAP Subscription Billing Integration with SAP S/4HANA - Product.
4. Select Artifacts. All artifacts are listed at the bottom of the page.
5. For the integration flow Replicate Rate Elements to SAP S4HANA Cloud, select Actions Deploy .
Procedure
1. Log on to your SAP Cloud Integration tenant as an SAP Cloud Integration developer, using the following
URL:
https://<your SAP Cloud Integration tenant URL>/itspaces
2. Select Design from the drop-down menu. You will see all available integration packages for the tenant.
Search for the package SAP Subscription Billing Integration with SAP S/4HANA Cloud - Product.
Note: Although the package name refers to "SAP S/4HANA Cloud", the package is also valid for integration
with the on-premise suite.
3. Select the integration package SAP Subscription Billing Integration with SAP S/4HANA Cloud -
Product.
4. Select Artifacts. All artifacts are listed at the bottom of the page.
5. For the integration flow Confirm Product Replication in SAP S4HANA Cloud, select Actions
Deploy .
Procedure
You can maintain and deploy the SAP S/4HANA value mapping using the following procedure:
Integration Guide
130 PUBLIC Integration with SAP S/4HANA
4. Select the artifact of type Value Mapping for SAP S4HANA Cloud Product.
5. To configure the value mapping, choose Configure in the Actions column for the artifact.
The value mapping for the language code between SAP Subscription Billing and SAP S/4HANA already
contains all necessary entries.
6. Depending on your Customizing, check and adapt the values for the mappings in the Value
Mappings section.
7. Choose Save.
8. Select Deploy in the Actions menu for Value Mapping for SAP S/4 HANA Cloud Product.
1. Log on to your SAP Cloud Integration tenant as an SAP Cloud Integration developer, using the following
URL:
https://<your SAP Cloud Integration tenant URL>/itspaces
2. In the navigation panel, choose Design.
1. Select the package SAP Subscription Billing Integration with SAP S/4HANA - Subscription
Management with Sales Billing.
2. On the Artifacts tab, select the integration flow Transfer Bills to SAP S4HANA and choose Actions
Configure .
3. On the Timer tab, define the execution schedule and frequency of the integration flow.
4. On the Receiver tab, provide the address for the receiver system.
• Select the appropriate authentication type (either certificate-based or basic authentication).
• Select SubscriptionBilling as receiver, enter the following parameters:
• Subscription_Billing_API_Home_Path: The API home path mentioned in the SAP
BTP Configuration Guide ( section about creating a service key). Example:
eu10.revenue.cloud.sap/api
• Adapter Type: HTTP
• Query: The query condition for API calls.
• Credential Name: The credential name created in the step Create OAuth2.0 Credentials for SAP
Subscription Billing [page 123].
5. Select S4H as receiver, enter the following details:
• Adapter Type: SOAP
• Address: The URL for the corresponding configuration object in the SOA Manager (see SOA Manager
Settings for Billing Data Replication [page 88]).
• Proxy Type: On-Premise
• Authentication/Credential Name: Choose Basic and enter the credential name created in the step
Create SAP S/4HANA User Credentials in Integration [page 124].
Integration Guide
Integration with SAP S/4HANA PUBLIC 131
6. If you want to extend the capabilities of standard integration flow, select ExtensionPostExit as receiver and
enter the Address for your custom integration flow.
7. On the More tab, configure the parameters as below:
8. Choose Save.
1. Log on to your SAP Cloud Integration tenant as an SAP Cloud Integration developer, using the following
URL:
https://<your SAP Cloud Integration tenant URL>/itspaces
2. Select Design from the drop-down menu. You will see all available integration packages for the tenant.
Search for the package SAP Subscription Billing Integration with SAP S/4HANA - Subscription
Management with Sales Billing.
3. Select the integration package SAP Subscription Billing Integration with SAP S/4HANA - Subscription
Management with Sales Billing.
4. Select Artifacts. All artifacts are listed at the bottom of the page.
5. For the integration flow Transfer Bills to SAP S4HANA, select Actions Deploy .
Integration Guide
132 PUBLIC Integration with SAP S/4HANA
4.2.6.8.11 Configure and Deploy Integration Flow for
Confirmation of Billing Document Request
Creation
1. Log on to your SAP Cloud Integration tenant as an SAP Cloud Integration developer, using the following
URL:
https://<your SAP Cloud Integration tenant URL>/itspaces
2. In the navigation panel, choose Design.
1. Select the package SAP Subscription Billing Integration with SAP S/4HANA - Subscription
Management with Sales Billing.
2. On the Artifacts tab, select the integration flow Confirm Billing Document Request Creation SAP
Subscription Billing and choose Actions Configure .
3. On the Sender tab, configure the address and select the appropriate authentication method.
• Address: The URL for the corresponding configuration object in the SOA Manager (see SOA Manager
Settings for Confirmation of Billing Data Replication [page 89]). For example, if the outbound service
path is /cxf/S4/SB/bdrConfirm, the address should be /S4/SB/bdrConfirm.
• Select either User Role or Client Certificate authentication.
4. On the Receiver tab, provide the address for the receiver system.
Select SubscriptionBilling as receiver, enter the following parameters:
• Subscription_Billing_API_Home_Path: The API home path mentioned in the SAP BTP Configuration
Guide ( section about creating a service key). Example: eu10.revenue.cloud.sap/api
• Authentication/Credential Name: Choose Basic and enter the credential name created in the step
Create SAP S/4HANA User Credentials in Integration [page 124].
5. On the More tab, configure the parameters as below:
6. Choose Save.
1. Log on to your SAP Cloud Integration tenant as an SAP Cloud Integration developer, using the following
URL:
https://<your SAP Cloud Integration tenant URL>/itspaces
Integration Guide
Integration with SAP S/4HANA PUBLIC 133
2. Select Design from the drop-down menu. You will see all available integration packages for the tenant.
Search for the package SAP Subscription Billing Integration with SAP S/4HANA - Subscription
Management with Sales Billing.
3. Select the integration package SAP Subscription Billing Integration with SAP S/4HANA - Subscription
Management with Sales Billing.
4. Select Artifacts. All artifacts are listed at the bottom of the page.
5. For the integration flow Confirm Billing Document Request Creation, select Actions Deploy .
Procedure
1. Log on as an SAP Cloud Integration developer on your SAP Cloud Integration tenant (for example, https://
<your SAP Cloud Integration tenant URL>/itspaces).
2. In the navigation panel, choose Design and select the package SAP Subscription Billing Integration with
SAP S/4HANA - Subscription Management with Sales Billing that contains the integration content.
3. An overview of the artifacts available in the selected integration package is shown in the Artifacts tab.
4. Select the artifact of type Value Mapping for SAP S4HANA Sales Billing.
5. To configure the value mapping, choose Configure in the Actions column for the artifact.
In the Value Mappings section, set the value mapping for the Market ID in SAP Subscription Billing and
Plant in SAP S/4HANA.
6. Choose Save.
7. Select Deploy in the Actions menu for Value Mapping for SAP S4HANA Sales Billing.
Purpose
In this activity you enhance the subscription product P-CLOUD_STORAGE in SAP S/4HANA. This product is
created in SAP Subscription Billing and replicated to SAP S/4 HANA.
Integration Guide
134 PUBLIC Integration with SAP S/4HANA
Procedure
Test
Step # Test Step Name Instruction Expected Result Comments
1 Log On Log on to the SAP Fiori Launch The Home page appears.
pad in the role Master Data Spe
cialist - Product Data.
2 Access the SAP Choose the Manage Product The Manage Product Master Data
Fiori app Master Data tile. app appears.
3 Find the Product P- In the search area on the top, Your product is displayed in the re
CLOUD_STORAGE enter the Product: P-CLOUD_ port list.
STORAGE.
Choose Go.
4 Open Product and Choose the product from the re The product should be open and
Maintain Distribu port list, general information is maintained.
tion Chains: General
Product Number: P-
Information
CLOUD_STORAGE
• Base Unit: EA
• Product Type: SBPD (Sub.
Billing Product)
• Description: Cloud
Storage
Note
Integration Guide
Integration with SAP S/4HANA PUBLIC 135
Test
Step # Test Step Name Instruction Expected Result Comments
5 Maintain Distribu On the Product view, in the Grouping terms are maintained For country ver
tion Chains: General Distribution Chains, choose and the product is saved. sion Germany,
Information Create and maintain the following maintain the fol
data: lowing value in
stead of 1710:
Sales Organization: 1710
(Dom. Sales Org US) Sales
Organization:
Distribution Channel: 10
1010 (Dom.
(Direct Sales)
Sales Org
DE)
Integration Guide
136 PUBLIC Integration with SAP S/4HANA
4.2.6.9.2 Enrich Subscription Billing Rate Elements
Purpose
In this activity you enhance the following subscription products in SAP S/4HANA that correspond to rate
elements in SAP Subscription Billing: The products are created in SAP Subscription Billing and replicated to
SAP S/4 HANA.
Procedure
Product: R-ONETIME
Test
Step # Test Step Name Instruction Expected Result Comments
1 Log On Log on to the SAP Fiori Launch The Home page appears.
pad in the role Master Data Spe
cialist - Product Data.
2 Access the SAP Choose the Manage Product The Manage Product Master Data
Fiori app Master Data tile. app appears.
3 Find Product In the search area on the top, en Your product is displayed in the re
ter the Product: R-ONETIME port list.
Choose Go.
Integration Guide
Integration with SAP S/4HANA PUBLIC 137
Test
Step # Test Step Name Instruction Expected Result Comments
4 Open Product and On the Product view, in the The product should be open and For country ver
Maintain Distribu Distribution Chains area, choose general information is maintained. sion Germany,
tion Chains: General Create and maintain the following maintain the fol
Information data: lowing value in
stead of 1710:
Sales Organization: 1710
(Dom. Sales Org US) Sales
Organization:
Distribution Channel: 10
1010 (Dom.
(Direct Sales)
Sales Org
DE)
Note
The other en
Under Description provide
tries are the
the Language and Product
same for both
details for specific region,
countries.
for example, Language:
English and Product:
Subscription Billing
Product.
5 Maintain Distribu Navigate to the Grouping Terms Grouping terms are maintained For country ver
tion Chains: Group area and maintain the following and the product is saved. sion Germany,
ing Terms data: maintain the fol
lowing value in
Account Assignment Group: X9
stead of 1 (Full
(Periodic Service)
Tax):
Tax Classification: 1 (Full
Tax
Tax) Classification: 6
Then choose Apply and then (Full Tax
Create. (Services))
Integration Guide
138 PUBLIC Integration with SAP S/4HANA
Product: R-SEATS
Test
Step # Test Step Name Instruction Expected Result Comments
1 Log On Log on to the SAP Fiori Launch The Home page appears.
pad in the role Master Data Spe
cialist - Product Data.
2 Access the SAP Choose the Manage Product The Manage Product Master Data
Fiori app Master Data tile. app appears.
3 Find Product In the search area on the top, Your product is displayed in the re
port list.
enter the Product: R-SEATS
4 Open Product and On the Product view, in the The product should be open and
For country ver
Maintain Distribu Distribution Chains area, choose general information is maintained.
sion Germany,
tion Chains: General Create and maintain the following
maintain the fol
Information data:
lowing value in
Sales Organization: 1710 stead of 1710:
(Dom. Sales Org US) Sales
Distribution Channel: 10 Organization:
Integration Guide
Integration with SAP S/4HANA PUBLIC 139
Test
Step # Test Step Name Instruction Expected Result Comments
5 Maintain Distribu Navigate to the Grouping Terms Grouping terms are maintained For Country ver
and the product is saved.
tion Chains: Group area and maintain the following sion Germany,
ing Terms data: maintain the fol
lowing value in
Account Assignment Group: X9
stead of 1 (Full
(Periodic Service)
Tax):
Tax Classification: 1 (Full
Tax
Tax) Classification: 6
Then choose Apply . (Full Tax
(Services))
Product: R-TRAFFIC
Test
Step # Test Step Name Instruction Expected Result Comments
1 Log On Log on to the SAP Fiori Launch The Home page appears.
pad in the role Master Data Spe
cialist - Product Data.
2 Access the SAP Choose the Manage Product The Manage Product Master Data
Fiori app Master Data tile. app appears.
3 Find Product In the search area on the top, Your product is displayed in the re
port list.
enter the Product: R-TRAFFIC
Integration Guide
140 PUBLIC Integration with SAP S/4HANA
Test
Step # Test Step Name Instruction Expected Result Comments
4 Open Product and On the Product view, in the The product should be open and
For country ver
Maintain Distribu Distribution Chains area, choose general information is maintained.
sion Germany,
tion Chains: General Create and maintain the following
maintain the fol
Information data:
lowing value in
Sales Organization: 1710 stead of 1710:
(Dom. Sales Org US) Sales
Distribution Channel: 10 Organization:
5 Maintain Distribu Navigate to the Grouping Terms The product is saved. For local version
tion Chains: Group area and maintain the following Germany, main
ing Terms data: tain the following
value instead of 1
Account Assignment Group: X9
(Full Tax):
(Periodic Service)
Tax
Tax Classification: 1 (Full
Classification: 6
Tax)
(Full Tax
Choose Apply and then Save . (Services))
Integration Guide
Integration with SAP S/4HANA PUBLIC 141
4.2.6.10 Error Handling
AIF functionality is needed for error handling in the event handler class CL_FICA_SUBSCRIPTION_HANDLER. If
it is not available, an exception is raised and provider contracts are not be created. The event will get stuck in
the event queue. To avoid this error, AIF Customizing must extracted.
These are the steps that need to be followed for AIF extraction:
This integration enables the transfer of billing and subscription data from SAP Subscription Billing to SAP
S/4HANA Convergent Invoicing, with subsequent financial processes. Convergent invoicing supports the
consolidation of charges from multiple billing streams into invoices.
As of SAP S/4HANA 2022, this integration is enabled by the SAP Best Practices scope item 5IK.
Note
Business Process
1. Creation of subscriptions in SAP Subscription Billing from upstream applications, via APIs.
2. Management of subscriptions in SAP Subscription Billing.
3. Collection of usage records and automated rating of usage, recurring, and one-time charges in SAP
Subscription Billing.
4. Transfer of billing data from SAP Subscription Billing to SAP S/4HANA Convergent Invoicing, resulting in
the creation of billable items.
Customer invoices are created to consolidate charges from multiple sources.
Integration Guide
142 PUBLIC Integration with SAP S/4HANA
Financial Processes
Accounting-relevant billing data in billable items is forwarded from invoices in Convergent Invoicing to SAP
S/4HANA. Supported financial processes include receivables management, revenue accounting and reporting,
and margin and revenue analysis on subscription level.
To provide further information for financial processes, the following objects are created automatically in SAP
S/4HANA:
Integrated Data
You can find a graphical overview of data replication in Data Replication Overview [page 145].
• Business partners in SAP S/4HANA or SAP Master Data Integration are replicated as customers in SAP
Subscription Billing.
• Products and rate elements in SAP Subscription Billing are replicated as products in SAP S/4HANA.
• Subscriptions in SAP Subscription Billing are replicated as provider contracts in SAP S/4HANA.
• Billing forecasts are replicated as billing plans in SAP S/4HANA.
• Billing data in SAP Subscription Billing is replicated as billable items in SAP S/4HANA.
• Usage data in SAP Subscription Billing is replicated as consumption items in SAP S/4HANA.
Setup
• As of SAP S/4HANA 2022: Follow the instructions provided for the scope item 5IK (Subscription
Management with Convergent Invoicing, version for SAP S/4HANA). You can access this information in
the Process Navigator in SAP for Me, or by using this link: Setup Instructions .
• For SAP S/4HANA 2021 (FPS01 and above): Follow the instructions in the current guide, in the section
Setup Instructions for SAP S/4HANA 2021 (FPS01 and Above) [page 169].
The scope items 1NN, 2AR, 2BG, and 2T3 are also required to set up this integration.
Integration Guide
Integration with SAP S/4HANA PUBLIC 143
Restrictions
• Newly released integration functionality is not necessarily supported immediately by all SAP S/4HANA
releases for which integration is enabled. Functionality that has a dependency with an SAP S/4HANA
release and functionality that's not yet supported by the integration is listed below:
Supported (with dependency to SAP S/4HANA release)
Functionality Supported As Of
Time zone mapping: All time zones in SAP Subscription SAP S/4HANA 2022
Billing mapped to time zones in SAP S/4HANA
• A maximum of 25,000 subscriptions per hour can be created/changed and replicated to SAP S/4HANA.
If you want to migrate data or run any other process that result in mass changes to subscriptions, please
contact SAP beforehand by creating an incident on the component CEC-SAL-SB. In addition, the general
technical constraints of the SAP Event Mesh default plan apply.
• A maximum of 100 usage records per charge or credit can be replicated as consumption items in SAP
S/4HANA.
• For the integration of SAP Subscription Billing with the SAP Data Retention Manager service and SAP
Personal Data Manager service, a legal entity (on which basis the data residence and retention periods
are defined) corresponds to an SAP BTP subaccount. As there can only be one subaccount for an SAP
Subscription Billing tenant, the tenant is restricted to one legal entity. Accordingly, if different markets in
SAP Subscription Billing map to SAP S/4HANA sales areas for which the sales organizations belong to
different legal entities, this cannot be reflected in the data protection functionality for SAP Subscription
Billing. This is also the case for integration with S/4HANA Cloud. While you can restrict the access of
business users in the SAP Subscription Billing user interface based on markets, the SAP Data Retention
Manager service and SAP Personal Data Manager service provide access to all data of all markets. The use
of data protection functionality for SAP Subscription Billing therefore assumes that the data of only one
data controller is being processed within the tenant. For more information, see Deletion of Personal Data
(section Integrated Data) in the Setup and Administration Guide.
• Only billing forecasts for subscriptions with the price type "Net" can be replicated to billing plans.
• Some functional restrictions apply regarding subscriptions that have been replicated to provider contracts
in SAP S/4HANA. See Replication of Subscriptions to Provider Contracts [page 149].
You require a separate license for SAP Event Mesh, which is used to enable the replication of subscription and
billing forecast data.
Integration Guide
144 PUBLIC Integration with SAP S/4HANA
If you want to use this integration, you cannot use the following services and applications in SAP Subscription
Billing:
• SAP digital payments add-on: Payments are managed in Contract Accounting (FI-CA).
Overview of data replication between the applications and services that are part of the integration
Subscription Management with Convergent Invoicing (5IK) with SAP S/4HANA:
To ensure consistency of data between the applications, business partner data must be replicated from SAP
S/4HANA to SAP Subscription Billing.
Business partners in SAP S/4HANA are created as customers in SAP Subscription Billing.
• SAP Master Data Integration service (this is the recommended replication method).
For details, see SAP Master Data Integration: Business Partner Data Replication [page 358].
Integration Guide
Integration with SAP S/4HANA PUBLIC 145
Caution
To integrate SAP Master Data Integration with an SAP S/4HANA on-premise system, the SAP
Master Data Integration instance must be created with the s4hana-onpremise service plan. s4hana-
onpremise is only visible as a service plan option if the service instance is created in a CPEA-enabled
account (Cloud Platform Enterprise Agreement) or has an explicit entitlement in the SAP BTP cockpit
which may require an additional license. For more information, see Connecting Clients in the SAP
Master Data Integration documentation.
Required Data
Only business partners with one or more of the following roles are replicated from SAP S/4HANA to SAP
Subscription Billing as customers:
Currently, the customer number in SAP Subscription Billing must be identical to the business partner number
in SAP S/4HANA.
You must specify sales areas for the business partners in SAP S/4HANA or SAP Master Data Integration. The
sales areas maps to markets in SAP Subscription Billing.
Partner Functions
Business partners are transferred and mapped from the subscription and bill in SAP Subscription Billing to
subsequent business documents and transactions in SAP S/4HANA as follows:
Provider Contract
Subscription Provider Contract Item Billing Plan Billable Item
Integration Guide
146 PUBLIC Integration with SAP S/4HANA
Provider Contract
Subscription Provider Contract Item Billing Plan Billable Item
Bill-to party
To ensure consistency of data between the applications, products and rate elements must be replicated
from SAP Subscription Billing to SAP S/4HANA Cloud or SAP S/4HANA (both referred to below as "SAP
S/4HANA").
Both products and rate elements from SAP Subscription Billing are created as products in SAP S/4HANA.
Replication takes place via SAP Cloud Integration, using predefined integration content.
Required Data
• The description length in SAP S/4HANA cannot exceed 40 characters and longer descriptions will be
truncated accordingly.
• For rate element replication, the unit of the rate element in SAP Subscription Billing must exist as a
commercial unit in SAP S/4HANA.
product.code productInternalID
M industrySectorCode
SBPD productTypecode
product.names description
EA baseMeasureUnitCode
Integration Guide
Integration with SAP S/4HANA PUBLIC 147
Field Mapping for Rate Elements
ratePlanElement.id productInternalID
M industrySectorCode
SBRE productTypecode
ratePlanElement.labels description
ratePlanElement.unit baseMeasureUnitCode
To provide the required information for accounting processes and revenue recognition, the subscriptions from
SAP Subscription Billing are replicated to provider contracts in SAP S/4HANA.
Provider Contract
A provider contract comprises all agreements regarding the provision and billing of services required for the
processing of subscriptions in the SAP S/4HANA system.
Note
Context
Integration Guide
148 PUBLIC Integration with SAP S/4HANA
• Definition of the subscription terms, such as cancellation policy, duration, and renewal.
• Calculation of subscription charges via the rating process
• Generation of billing data for the subscriptions, which is transferred to Convergent Invoicing for further
processing and invoicing.
• In SAP S/4HANA, the provider contract contains the contract data of the subscription that is required for
follow-up processes, such as:
• Receivables management
• Revenue accounting
Replication Process
SAP Subscription Billing sends a business event with the entire subscription data via SAP Event Mesh to SAP
S/4HANA every time that you create or change a subscription. This event triggers the creation or update of the
provider contract depending on the sent data and the event type.
You can also learn more about supported events in these articles of the API Guide:
• Business Events
• Subscription Events
Restriction
A maximum of 25,000 subscriptions per hour can be created/changed and replicated to SAP S/4HANA.
If you want to migrate data or run any other process that result in mass changes to subscriptions, please
contact SAP beforehand by creating an incident on the component CEC-SAL-SB.
Integration Guide
Integration with SAP S/4HANA PUBLIC 149
Subscription and Item Provider Contract and Item
Product New items are created. They start on the effective date of
the subscription snapshot.
• Product sold
• Product
The items for the previous product and product sold end on
the day before the new item starts.
Field Mapping
Header
The replication generates a provider contract with the same ID as the subscription. The header fields are
mapped as follows:
• The managing company code of the provider contract is derived from the sales area, which is the
combination of a sales organization, a distribution channel and a division. You can display the sales area in
the provider contract items. The sales area is mapped with the market from SAP Subscription Billing
• The duration of the provider contract matches the duration of the subscription. The expiration date defines
the end of the subscription. If the subscription has no expiration date, the provider contract ends on
9999-12-31.
• Pending subscriptions aren't replicated to SAP S/4HANA. All other subscriptions are replicated, and the
status of the subscription is mapped with the status Active of the provider contract.
• The subscription uses either a subscription-specific time zone, which is provided upon creation, or the
time zone of the market. The subscription time zone is mapped to the local time zone of the provider
contract. All contract-related dates, except for the create and change dates, are displayed in the local time
zone.
Integration Guide
150 PUBLIC Integration with SAP S/4HANA
Note
For SAP S/4HANA 2021, not all time zones in SAP Subscription Billing are mapped to time zones in
SAP S/4HANA. You can only use markets with the following mapped time zones:
Etc/GMT UTC
Europe/London GMTUK
Europe/Berlin CET
Europe/Helsinki EET
Europe/Moscow RUS03
Europe/Samara RUS04
Asia/Yekaterinburg RUS05
Asia/Omsk RUS06
Asia/Novosibirsk RUS07
Asia/Yakutsk RUS09
Asia/Tokyo JAPAN
Asia/Kolkata INDIA
Asia/Shanghai UTC+8
Australia/Perth AUSWA
Australia/Adelaide AUSSA
Australia/Sydney AUSNSW
Pacific/Bougainville RUS11
Pacific/Wake RUS12
Pacific/Honolulu HAW
Atlantic/Azores AZOREN
Atlantic/Stanley FLKLND
America/New_York EST
America/Mexico_City CST
America/Chicago CST
America/Denver MST
America/Phoenix MSTNO
America/Los_Angeles PST
America/Anchorage ALA
America/Fortaleza BRZLEA
America/Manaus BRZLWE
Integration Guide
Integration with SAP S/4HANA PUBLIC 151
SAP Subscription Billing SAP S/4HANA
America/Rio_Branco BRZLAN
Items
The replication generates one provider contract item per charge from the subscription item. The provider
contract item shows the following products:
• The product sold, which represents the subscription product. The product sold is mapped with the product
from SAP Subscription Billing. If a subscription item has multiple charges, multiple provider contract items
share the same product sold.
• The product, which represents an individual charge for which the subscriber pays. The product is mapped
with the rate element of the charge from the rate plan in SAP Subscription Billing. The product is unique
per item.
Example
A subscription has two items, one for the main product and one for an add-on product. Each subscription
item has three charges. In the provider contract, this structure is replicated into six provider contract items.
Three items are assigned to the main product of the first subscription item, and three items, to the add-on
product from the second subscription item.
Integration Guide
152 PUBLIC Integration with SAP S/4HANA
Other fields of the provider contract item are mapped with the subscription and its items as follows:
• The end of duration is populated based on the expected term end of the subscription.
If the subscription doesn't have an expected term, or if the expected term end is later than the expiration
date, then the end of duration of the item is populated based on the expiration date of the subscription.
• The customer reference and date are mapped with the customer purchase reference and date of the
subscription. In SAP S/4HANA, you can use the customer reference to split the billing document, and you
can also include both the reference number and date on the printed invoice.
• The charge type of the item is mapped with the rating type of the charge in SAP Subscription Billing. In
SAP S/4HANA, the rating type is used, along with the sales area, to determine the relevance for revenue
accounting in contract-based revenue recognition.
Integration Guide
Integration with SAP S/4HANA PUBLIC 153
Field Mapping of Items
Subscription Subscription Item Provider Contract Item
• Sales organization
• Distribution channel
• Division
• Company code
• Profit center
• Segment
End of duration
• Expected term end
• Expiration date
Note
• The bill-to party of the subscription isn't mapped to the provider contract item in this integration
scenario.
• If you change the contract account of a subscription item, this change creates a new provider contract
item.
In the S/4HANA system, use event 0540 to map custom references to the custom fields of the provider
contract item or to the table that contains external references in the provider contract header.
For more information, see the documentation of the FKK_SAMPLE_0540 sample function module.
Integration Guide
154 PUBLIC Integration with SAP S/4HANA
4.3.3.1 Required Subscription Data
To enable the replication of subscriptions from SAP Subscription Billing to provider contracts in SAP S/4HANA
or SAP S/4HANA Cloud, the subscriptions must have certain data.
Prerequisites
• You've defined the required settings for markets and subscription profiles in Business Configuration.
These settings are described in the scope item setup instructions.
• You've created products of subscription type Commercial in the Manage Products app.
Note
Details
Subscription profile Assign a subscription profile with replication of subscriptions to provider contracts acti
vated, a billing forecast type assigned, and with the requirement of a contract account
enabled.
Recommendation
Product Assign a product of subscription type Commercial. This subscription type ensures that the
provider contract items are billed and printed on the invoice.
Billing cycle-related data For subscriptions with calendar billing, either use a rate plan that prorates the first billing
cycle (option Prorate First Cycle activated) or ensure that the subscription starts at the
beginning of the relevant calendar period.
This ensures that there are no rating periods outside the subscription validity period, which
would cause errors in data transfer.
Integration Guide
Integration with SAP S/4HANA PUBLIC 155
Subscription Data Requirement
Object references Provide the following object references for accounting in SAP S/4HANA or SAP S/4HANA
Cloud:
• In the subscription header, the revenue accounting reference that is used to determine
or create the revenue contract for the subscription. This reference can be:
• The subscription itself, in which case you don't need to provide any reference.
The revenue accounting reference is automatically generated when you create the
subscription and contains the subscription ID.
• Any other object, for example, an order, in which case you need to provide the
object ID and the reference type EXT.
• In the subscription items, the contract account that is used to manage payment details
for the subscription.
Duration (subscription Specify the duration of the subscription via the subscription terms. If your subscriptions are
terms)
open-ended, use the expected term to indicate the projected duration. You can predefine
the terms via the product or define specific terms for individual subscriptions.
The following term end dates are used to set the end of duration of the provider contract
items:
When the subscriptions are created, they appear on the Manage Subscriptions app. In the subscription header
you see the reference to the replicated provider contract, under General Info Processing Data . In this tab
you can also see the integration settings of the assigned subscription profile.
Integration Guide
156 PUBLIC Integration with SAP S/4HANA
4.3.4 Replication of Billing Forecasts to Billing Plans
To provide the required information for accounting processes and revenue recognition, the billing forecasts
from SAP Subscription Billing are replicated to billing plans in SAP S/4HANA.
Billing Plan
In SAP S/4HANA, a billing plan in Convergent Invoicing defines when and how often an amount is invoiced to a
customer.
Context
Billing forecasts in SAP Subscription Billing provide an estimate of the charges that are expected for
subscription items during a specified period. This simulated outlook on future billing cycles of a subscription
allows users to have a better idea of their upcoming subscription revenue. For more information, see Billing
Forecasts in the Feature Overview.
In SAP S/4HANA, a billing plan represents the billing forecast for a subscription. It contains the forecast data
that is required for revenue accounting.
Note
Billing plans that are created from a subscription in SAP Subscription Billing are not integrated in other
processes of Convergent Invoicing, such as the request of billing plan items for billing.
Replicated billing plans can only have the status Open. Replicated billing plan items can only have the
status Not Yet Requested.
Replication Process
SAP Subscription Billing sends business event with the entire billing forecast data via SAP Event Mesh to SAP
S/4HANA every time that a billing forecast is created or changed. This event triggers the creation or update of
the billing plan depending on the sent data and the event type.
You can also learn more about supported events in these articles of the API Guide:
• Business Events
• Billing Forecast Events
Integration Guide
Integration with SAP S/4HANA PUBLIC 157
Note
To enable a seamless replication process, billing plans that have been replicated from billing forecasts in
SAP Subscription Billing cannot be deleted.
Restriction
Only the billing forecasts for a subscription whose price type is Net can be replicated to billing plans.
Field Mapping
subscriptionDocumentId Contract
subscriptionVersion Version
Billing Plan Category Billing Plan for Provider Contract without request (BIPV1)
Billing Plan Type If Contract Category =Provider Contract: Billing Plan for
Provider Contract (no request) (SBPC1)
Integration Guide
158 PUBLIC Integration with SAP S/4HANA
Billing Forecast Billing Plan Item
forecast-item-monetaryAmount-taxIncluded Gross
subscriptionDocumentId Contract
forecast-item-pricingElements- Amount
conditionValue-amount
forecast-item-pricingElements- Currency
conditionValue-currency
Using the Manage Billing Plans app, you can display billing plans in the SAP S/4HANA system. You can perform
the following tasks:
Integration Guide
Integration with SAP S/4HANA PUBLIC 159
• Search for billing plans, and sort or filter them by different criteria
• Show details and see general information and plan items.
Note
Preparatory billing data and usage data in SAP Subscription Billing is transferred to SAP S/4HANA or SAP
S/4HANA Cloud (both referred to below as "SAP S/4HANA") where it is used in subsequent billing, invoicing,
and financial processes.
Transfer to Convergent Invoicing takes place via SAP Cloud Integration, using predefined integration content.
Billing data stored in bills is transferred to SAP S/4HANA, resulting in the creation of billable items and
consumption items in Convergent Invoicing. Usage data is replicated as consumption items in Convergent
Invoicing. The replication is done by the asynchronous inbound service BillableItemsCreateRequest_In.
Each bill item has one or more charges or credits, and each charge or credit has one or more pricing
elements and associated usage records (which can also have their own items). These are mapped as follows in
Convergent Invoicing:
Restriction
A maximum of 100 usage records per charge or credit can be replicated as consumption items in SAP
S/4HANA.
Billable items and consumption items are linked together by the source transaction ID, which is the bill number
in SAP Subscription Billing.
Field Mapping
In the standard integration flow, the fields are mapped as follows in the service
BillableItemsCreateRequest_In:
CAIsSimulated False
CAReturnLogIsRequested True
Integration Guide
160 PUBLIC Integration with SAP S/4HANA
Additional Parameters for Billable Items Value
Value
BillableItemsBasicCreate
Example: 1-2-1
CASubApplication P
Integration Guide
Integration with SAP S/4HANA PUBLIC 161
Value
BillableItemsTextCreate
CABllbleItmSourceTransType REVCL
Example: 1-2-1
Integration Guide
162 PUBLIC Integration with SAP S/4HANA
Value
Example: ProductCode-
MetricId SubMetricId
SpecificationCode
BillableItemsAdditionalCreate (only applicable if the SAP Subscription Billing bill item’s charge/credit has an original bill
reference)
CABllbleItmSourceTransType REVCL
Example: 1-2-1
Example: 1-2-1
ConsumptionItemsRatedCreate
AdditionalParameters.CACnsmpnItmFieldDrvtnSchema SB01
CASubApplication P
Integration Guide
Integration with SAP S/4HANA PUBLIC 163
Value
Example
A bill has 2 bill items, one item for subscription A item 10 and one item for subscription B item 20. Each bill item
has 3 charges and each charge has 2 pricing elements. A total of 12 billable items will be created for this bill.
Integration Guide
164 PUBLIC Integration with SAP S/4HANA
Some charges have related usage. For each usage record, a consumption item is created.
DRV1 USD -1
Technical re
source ID:
TR00001 /
Quantity 70 /
July 16 - July 30
DRV1 USD -2
Technical re
source ID:
TR00002 /
Quantity 40 /
July 16 - July 30
Billable Items
Integration Guide
Integration with SAP S/4HANA PUBLIC 165
Source Transac Source Transac Billable Item Billable Item
tion ID tion Item ID Provider Contract Amount Quantity Condition Type
Consumption Items
Consumption Quan
Source Transaction ID Access User ID Date From Date To tity
Integration Guide
166 PUBLIC Integration with SAP S/4HANA
4.3.6 Transfer of Data to Revenue Accounting
To provide the required information for revenue accounting, data relating to subscriptions is transferred from
Convergent Invoicing to Revenue Accounting and Reporting.
Data Flow
For revenue accounting, data is required from subscriptions, billing forecasts, and bills in SAP Subscription
Billing. This data includes information about the condition types of pricing elements, estimated or billed
amounts during a specified period, and billable charges.
Convergent Invoicing determines the relevance of provider contract items for revenue accounting, and creates
transfer records as follows to transfer data to Revenue Accounting and Reporting:
• Order items
• For recurring and one-time charges: Created from the billing plan.
• For usage-based charges: Created from the provider contract item.
After the order items are transferred to Revenue Accounting and Reporting, performance obligations are
created in revenue accounting contracts.
• Fulfillment items
Created when billable items are created.
• Invoice items
Created when billable items are invoiced.
Integration Guide
Integration with SAP S/4HANA PUBLIC 167
Display Transfer Records in Convergent Invoicing
You can use the Display Transfer Records app to do the following:
• Search for transfer records using various search criteria such as master data and selection variants.
• Display general information and data for revenue accounting and show details such as billable items and
invoices.
• Determine how performance obligations are fulfilled for the provider contract.
• Calculate the fulfillments for time-based performance obligations based on deferral methods derived as
performance obligation attributes.
Related Information
If you implement integration with Convergent Invoicing, data related to SAP S/4HANA Cloud or SAP S/
4HANAis available in SAP Subscription Billing.
Customers
The IDs of business partners replicated from SAP S/4HANA Cloud/SAP S/4HANA or SAP Master Data
Integration are stored as external object references.
Subscriptions
The following data from SAP S/4HANA Cloud or SAP S/4HANA is available in subscriptions:
• Involved partners: In the subscription you indicate the involved business partners, which are transferred to
the replicated provider contract:
• The payer, which is the business partner of the provider contract.
Integration Guide
168 PUBLIC Integration with SAP S/4HANA
• The ship-to party, which is the service recipient of the provider contract.
• The bill-to party.
• Related documents:
• In the subscription header you see the following:
• The reference to the replicated provider contract
• The reference to the revenue accounting contract (only via the Subscriptions API)
• The customer reference and date for a purchase order.
• In the subscription items you see the reference to the related contract account.
• Subscription settings: In the assigned subscription profile you see the prefix of the subscription ID, which
is the same for the provider contract ID.
Bills
In addition to the standard set of data that is required for billing and invoicing, bills for Convergent Invoicing
contain the following specific references:
• Contract account: Included in the bill header, originating in the subscription item.
• Provider contract: Included in bill item and it's charges/credits, originating in the subscription item.
This attribute is available via the Bills API (subset billItems.externalObjectReferences).
• Partners: The payer and bill-to party are included in the bill header. The ship-to party is included in the bill
items. All the partners originate in the subscription.
• Successor document: This is displayed in the bill header and originates in Convergent Invoicing. The
successor document is a billing document or an invoicing document, depending on how the integration is
configured.
In the Manage Billing Data app, you can see the reference on the Transfer tab. For invoicing documents, you
can also display a PDF if this option is configured.
This section provides instructions for setting up integration between SAP Subscription Billing and SAP S/
4HANA 2021 (FPS01 and above) Convergent Invoicing.
To set up the integration as of SAP S/4HANA 2022, follow the instructions provided for the scope item
5IK (Subscription Management with Convergent Invoicing, version for SAP S/4HANA). You can access this
information in the Process Navigator in SAP for Me or by using this link: Setup Instructions .
Integration Guide
Integration with SAP S/4HANA PUBLIC 169
4.3.8.1 System Access
System Details
SAP S/4HANA Accessible via SAP Fiori Launchpad. Your system adminis
trator provides you with the URL to access the various apps
assigned to your role.
SAP Subscription Billing Accessible via URL. Your system administrator provides you
with the URL to access the application.
SAP Cloud Integration Accessible via URL. Your system administrator provides you
with the URL to access the application.
4.3.8.2 Prerequisites
• Your SAP Cloud Integration tenant has been provisioned. For details, see Initial Setup in the SAP Cloud
Integration documentation.
• SAP Business Technology Platform (SAP BTP) has been configured and service keys created to give the
integration process access to the SAP Subscription Billing APIs. This setup is described in the SAP BTP
Configuration Guide.
• If you are not already using Billing and Revenue Innovation Management in SAP S/4HANA and switches
FICA and CONV_INV are currently inactive, you must activate the following business functions:
• FICAC_CORE
• FICAC_CI
Note
These business functions enable the basic provider contract and billing plan functionality that is
required for this integration but do not allow you to use the full functionality of Billing and Revenue
Innovation Management.
• Certain integration scopes are required to integrate with the SAP Subscription Billing solution. For details,
see SAP Subscription Billing API Scopes in the API Guide. The required view scopes (with the suffix _view)
are listed in the table rows Bills, Business Partners, Products, and Rate Plans.
Integration Guide
170 PUBLIC Integration with SAP S/4HANA
4.3.8.3 Configuration in SAP Subscription Billing
Market units in SAP Subscription Billing must be mapped to the SAP S/4HANA organizational units.
Procedure
2 Navigate to Markets Under Master Data and The Markets view is displayed. At least one mar
Configuration, open the Manage ket unit for the
Business Configuration app and US or Germany
choose Markets. must have been
defined. If that is
not the case,
contact your
system adminis
trator.
Integration Guide
Integration with SAP S/4HANA PUBLIC 171
Step # Step Name Instruction Expected Result Comments
3 Maintain Market Click on Create and enter the fol The market is created and has For Germany,
map the sales
Unit Mapping lowing Market Details: been mapped to SAP S/4HANA
organization
organizational units.
Market A1 1010.
ID: A1
Name: US East
Currency: USD
Distribution Channel: 10
Division: 00
Choose Save.
Choose Create.
Market E1
ID: E1
Currency: EUR
Company Name: DE
House Number: 10
Street: Bahnhofstrasse
Integration Guide
172 PUBLIC Integration with SAP S/4HANA
Step # Step Name Instruction Expected Result Comments
City: Walldorf
Distribution Channel: 10
Division: 00
Choose Save.
Units for pricing and billing must be defined in SAP Subscription Billing.
Procedure
3 Create Units of Meas Click Create and define the Units of measure
ure are created.
following units of measure:
Description: Each
Unit Code: EA
Description: Gigabyte
Unit Code: GB
Integration Guide
Integration with SAP S/4HANA PUBLIC 173
4.3.8.3.3 Make ID/Number Range Settings for Products
and Rate Elements
To map only relevant product information between SAP S/4HANA and SAP Subscription Billing, maintain the
following number range integration settings in SAP Subscription Billing.
Procedure
2 Navigate to Integra Under Master Data and The Integration Settings view is
tion Settings Configuration, open the Manage displayed.
Business Configuration app and
choose Integration Settings.
3 Maintain Master Under Master Data, make the fol Number range settings are main
Data Settings lowing settings: tained.
Product
From Number: P
To Number: PZZZZZ
Rate Element
From Number: R
To Number: RZZZZZ
Integration Guide
174 PUBLIC Integration with SAP S/4HANA
4.3.8.3.4 Activate Language-Dependent Texts for Products
and Rate Elements
To ensure correct mapping of products and rate elements, language-dependent names and descriptions must
be activated.
2 Navigate to Lan Under Master Data and The Language Settings view is dis
guage Settings Configuration, open the Manage played.
Business Configuration app and
choose Language Settings.
To replicate subscriptions to provider contracts, define the following subscription profile settings in SAP
Subscription Billing.
Procedure
2 Navigate to Sub Under Master Data and The Subscription Settings view is
scription Settings Configuration, open the Manage displayed.
Business Configuration app and
choose Subscription Settings.
Integration Guide
Integration with SAP S/4HANA PUBLIC 175
Step # Step Name Instruction Expected Result Comments
3 Maintain Subscrip Choose Create and define a sub Subscription settings are defined
tion Profiles Set scription profile as follows: in a subscription profile.
tings
ID: CI
Name: CI Integration
Replicate Subscriptions to
Provider Contracts: Activated
Choose Save.
As part of the setup, to enable replication of subscription data between SAP Subscription Billing and SAP
S/4HANA, you must activate outbound events.
Procedure
2 Navigate to Integra Under Master Data and The Integration Settings view is
tion Settings Configuration, open the Manage displayed.
Business Configuration app and
choose Integration Settings.
3 Activate Events Under SAP Event Mesh, switch on Events are activated.
Activate Outbound Events.
Integration Guide
176 PUBLIC Integration with SAP S/4HANA
4.3.8.4 Creation of Business Partner Master Data in SAP S/
4HANA
Test Case ID <X.XX> Tester Name Testing Date Enter a test date.
Business Role(s)
Responsibility <State the Service Provider, Customer or Joint Service Pro Duration Enter a duration.
vider and Customer>
In this activity, you create a Business Partner for a new customer in S/4HANA Cloud replication.
Integration Guide
Integration with SAP S/4HANA PUBLIC 177
Step # Step Name Instruction Expected Results Comments
Title:
Name:
Search Terms ½:
Street/House Number:
Postal Code/City:
Country/Reg:
Region:
Timezone:
Tax Juris:
Transportation Zone:
Telephone:
Mail:
Industry: 91
ID : 0001
Ctry: US
Choose Save
Integration Guide
178 PUBLIC Integration with SAP S/4HANA
4.3.8.4.2 Create Customer and Contract Partner Role
In this activity, you extend a business partner with the BP roles FLCU01 (Customer) and MKK (Contract
Partner), and with sales area master data.
6 Open Sales Area Choose Sales and Distribution The Sales Area view is dis
at the top of the view.
played.
Distr.Channel : 10
Division: 00
Delivery Plant:1710
Integration Guide
Integration with SAP S/4HANA PUBLIC 179
Step # Step Name Instruction Expected Results Comments
Delivery Plant:1710
Tax Classification:<1>
In this activity, you create a contract account master data for an FI-CA customer in SAP S/4HANA.
Integration Guide
180 PUBLIC Integration with SAP S/4HANA
Step # Step Name Instruction Expected Results Comments
4 Enter BP details Enter the Business Partner no The Contract account Create:
created in Chapter Maintain General Data view displays.
Business Partner.
Cont.Acct Cat: Y1
Choose Continue.
Company Code:1710
Standard Cocode:1710
Incoming Payments
Inc.Payt Method:E
Outgoing Payments
Outg.Payt Meth.:T
Integration Guide
Integration with SAP S/4HANA PUBLIC 181
4.3.8.5 Creation of Subscription Products in SAP
Subscription Billing
Purpose
In this activity, you create rate elements in SAP Subscription Billing. The rate IDs must correspond with the
relevant SAP S/4HANA products of type SBRE.
Procedure
Test Step Number Test Step Name Instruction Expected Result Comments
2 Navigate to Rate Ele Under Master Data and The Rate Elements
ments Configuration, open view is displayed.
the Manage Business
Configuration app and
choose Rate Elements.
Integration Guide
182 PUBLIC Integration with SAP S/4HANA
Test Step Number Test Step Name Instruction Expected Result Comments
ID: R-ONETIME
Label: One-Time
Activation Fee
One-Time Type:
Initial Fee
Description: Enter
a description, for
exampleOne-Time
Activation Fee
Active: Selected
Choose Save.
ID: R-SEATS
Label: Seat-Based
Monthly Fee
Data Source:
Subscription
Description: Enter a
description, for ex
ampleSeat-Based
Monthly Fee
Active: Selected
Choose Save.
Integration Guide
Integration with SAP S/4HANA PUBLIC 183
Test Step Number Test Step Name Instruction Expected Result Comments
ID: R-TICKETS
Unit: Each(EA)
Label: Ticket-
Based Usage Fee
Type of Technical
Resource ID: Cloud
Storage Space
ID
Description: Upload/
Download
Tickets (or another
description of your
choice)
Active: Selected
Choose Save.
Purpose
In this activity you create a rate plan template in SAP Subscription Billing.
Integration Guide
184 PUBLIC Integration with SAP S/4HANA
Procedure
Test
Step # Test Step Name Instruction Expected Result Comments
2 Navigate to Rate Under Pricing, open the Manage The available rate plan templates
Plan Templates Rate Plan Templates app. are displayed.
3 Create Template for Choose Create Without The basic data for the template is
Seat-Based Rate Pricing Scheme, and enter the fol defined.
Plan lowing data under General Info:
Description: Seat-Based
Plan Template
Choose Add.
Integration Guide
Integration with SAP S/4HANA PUBLIC 185
Test
Step # Test Step Name Instruction Expected Result Comments
Percentage Pricing.
Ratio: 100
-Block Pricing .
Rate Element:R-TICKETS
Choose Save.
Integration Guide
186 PUBLIC Integration with SAP S/4HANA
4.3.8.5.3 Create a Product
Purpose
In this activity you create the products P-CLOUD_COMM and P-CLOUD_SUPPORT in SAP Subscription Billing.
Note
The ID of the products in SAP Subscription Billing must correspond to the relevant product IDs in SAP
S/4HANA.
Procedure
Product: P-CLOUD_COMM
Test
Step # Test Step Name Instruction Expected Result Comments
2 Navigate to Prod Under Master Data and The available products are dis
ucts Configuration, open the Manage played.
Products app.
3 Maintain General Choose Create, then enter the fol General information has been
Product Information lowing data on the General Info maintained.
tab:
Integration Guide
Integration with SAP S/4HANA PUBLIC 187
Test
Step # Test Step Name Instruction Expected Result Comments
4 Maintain Rate Plan On the Rate Plans tab, The product’s rate plan has been
for Product choose Create Without maintained.
Pricing Scheme .
5 Maintain Subscrip On the Subscription Terms tab, Subscription terms are main
tion Terms enter the following: tained.
6 Create Product On the Create Rate Plan view, The product P-CLOUD_COMM is
choose Create. created.
Product: P-CLOUD_SUPPORT
Test
Step # Test Step Name Instruction Expected Result Comments
2 Navigate to Prod Under Master Data and The available products are dis
ucts Configuration, open the Manage played.
Products app.
Integration Guide
188 PUBLIC Integration with SAP S/4HANA
Test
Step # Test Step Name Instruction Expected Result Comments
3 Maintain General Choose Create, then enter the fol General information has been
Product Information lowing data on the General Info maintained.
tab:
4 Maintain Rate Plan On the Rate Plans tab, The product’s rate plan has been
for Product choose Create Without maintained.
Pricing Scheme .
5 Maintain Subscrip On the Subscription Terms tab, Subscription terms are main
tion Terms enter the following: tained.
6 Create Product On the Create Rate Plan view, The product P-CLOUD_SUPPORT
choose Create. is created.
Integration Guide
Integration with SAP S/4HANA PUBLIC 189
4.3.8.6 Data Replication Enablement in SAP S/4HANA
This section describes how to set up the replication of business partner master data from SAP S/4HANA to
SAP Subscription Billing using SAP Cloud Integration.
Business partners in SAP S/4HANA are created as customers in SAP Subscription Billing.
• SAP Master Data Integration service (this is the recommended replication method).
Note
If you use this replication option, you don't need to complete the configuration steps described in the
current guide section. Instead, refer to the following documentation to set up integration between SAP
Subscription Billing and SAP Master Data Integration: SAP Master Data Integration: Business Partner
Data Replication [page 358]
Caution
To integrate SAP Master Data Integration with an SAP S/4HANA on-premise system, the SAP
Master Data Integration instance must be created with the s4hana-onpremise service plan. s4hana-
onpremise is only visible as a service plan option if the service instance is created in a CPEA-enabled
account (Cloud Platform Enterprise Agreement) or has an explicit entitlement in the SAP BTP cockpit
which may require an additional license. For more information, see Connecting Clients in the SAP
Master Data Integration documentation.
Only business partners with one or more of the following roles are replicated from SAP S/4HANA to SAP
Subscription Billing as customers:
Integration Guide
190 PUBLIC Integration with SAP S/4HANA
Options for Triggering Replication
• Automatic Trigger: Changes are directly transferred to a target system when a business partner is created
or updated.
• Manual Trigger: via the transaction DRFOUT.
This transaction can be executed with the following options:
• Initialization: The system processes all data of the selected outbound implementations that are
required for a replication model.
• Changes: The program analyzes all data that was changed since the last change or since an
initialization was last performed.
• Manual: You can select and transfer individual data records by choosing the Manual Replication Filter
Criteria push button. If manual filter criteria is available, the Manual Replication Filter Criteria Available
check-box is selected.
Make settings to enable replication of business partners from SAP S/4HANA to SAP Subscription Billing:
Field Entry
9. Choose Next.
10. Enter the SAP Cloud Integration operation server node URL in the URL field and append it with /cxf and
the address endpoint as configured in the Sender tab of your integration flow.
Integration Guide
Integration with SAP S/4HANA PUBLIC 191
Example: https://XXXXXX-iflmap.sap.eu2.hana.ondemand.com/cxf/S4/SB/bpReplicate
Note
You can find this URL in the SAP Cloud Integration tenant where you deploy the integration
flow Replicate Business Partners to SAP Subscription Billing (described in this guide under
Configuration of SAP Cloud Integration Configure and Deploy Integration Flow for Business Partner
Replication ). After the successful deployment of the integration flow on SAP Cloud Integration, go to
the Operations View, choose Manage Integration Content, select the corresponding integration flow and
find the complete URL under Endpoints.
Field Value
RM Protocol SAP RM
You need to create a logical system that represents SAP S/4HANA in the SAP Subscription Billing application.
Logical systems are defined as cross-client systems.
4. Choose Save.
5. Choose Ok to confirm the pop-up and save the details in the transport request.
Integration Guide
192 PUBLIC Integration with SAP S/4HANA
4.3.8.6.1.3 Activate Function Modules
This step might be already done if you used the direct business partner integration before.
3. Choose Save.
1. Access the transaction DRFIMG and navigate as follows: Define Custom Settings for Data Replication
Define Technical Settings Define Technical Systems for Business Systems .
The screen Change View "Define Business Systems": Overview is displayed.
2. Under Defined Business Systems, choose New Entries and enter the following values:
Note
3. Select the newly created business system and double click Define Bus. Systems, BOs.
4. Choose New Entries and enter:
5. Choose the newly created BO Type and double click Define Bus. Systems, Bos, Communication Channel:
6. The screen Define Bus. Systems, BOs, Communication Channel is displayed.
Integration Guide
Integration with SAP S/4HANA PUBLIC 193
7. Choose New Entries and enter:
Replication Not Defined <Not selected> Not Defined Not Defined <empty>
via Services
8. Choose Save.
1. Access the transaction DRFIMG and navigate as follows: Define Custom Settings for Data Replication
Define Replication Models .
The screen Change View: "Define Replication Model":Overview is displayed.
2. Choose New Entries and enter:
3. Choose Save.
4. Select the newly created replication model and double-click Assign Outbound Implementation in the left
navigation.
5. Choose New Entries, and enter:
Outbound Communication
Implementation Description Sequence Channel Filter Time
6. Select the newly created outbound implementation and double-click Assign Target Systems for Repl.
Model/Outb.Impl. in the left navigation.
7. Choose New Entries, and enter:
Business System
SUBS4HANA
8. Choose the newly created business system and double-click Assign Outbound Parameter in the left
navigation.
9. Choose New Entries and enter:
Integration Guide
194 PUBLIC Integration with SAP S/4HANA
Note
The Outbound Parameter Value for PACK_SIZE_BULK can be set as the most efficient package size,
which differs from system to system.
This section describes how to set up the replication of products and rate elements from SAP Subscription
Billing to SAP S/4HANA.
The SOA Manager is used to administer and configure service providers and consumer proxies for a local
system.
Make settings to enable replication of products and rate elements from SAP Subscription Billing to SAP S/
4HANA and creation of products in SAP S/4HANA:
Integration Guide
Integration with SAP S/4HANA PUBLIC 195
3. On the Configuration tab, search for the following object name:
Note
Select the object and choose Show Details. Make a note of the Access URL: You will need it when you deploy
the integration flow (described in this guide under Configuration of SAP Cloud Integration Configure
and Deploy Integration Flow for Product Replication ). .
The SOA Manager is used to administer and configure service providers and consumer proxies for a local
system.
Make settings to enable confirmation from SAP S/4HANA to SAP Subscription Billing that products and rate
elements were successfully transferred and products were created in SAP S/4HANA:
Field Entry
Integration Guide
196 PUBLIC Integration with SAP S/4HANA
Field Entry
9. Choose Next.
10. Enter the SAP Cloud Integration operation server node URL in the URL field and append it with /cxf and
the address endpoint as configured in the Sender tab of your integration flow.
Example: https://XXXXXX-iflmap.sap.eu2.hana.ondemand.com/cxf/
S4HCE_ProductConfirmation
Note
You can find this URL in the SAP Cloud Integration tenant where you deploy the integration flow
Confirm Product replication in SAP S4HANA Cloud (described in this guide under Configuration
of SAP Cloud Integration Configure and Deploy Integration Flow for Confirmation of Product
Replication ). After the successful deployment of the integration flow on SAP Cloud Integration, go to
the Operations View, choose Manage Integration Content, select the corresponding integration flow and
find the complete URL under Endpoints.
Field Value
RM Protocol SAP RM
This section describes how to set up the replication of billing data from SAP Subscription Billing to SAP
S/4HANA.
Integration Guide
Integration with SAP S/4HANA PUBLIC 197
4.3.8.6.3.1 SOA Manager Settings for Billing Data Replication
The SOA Manager is used to administer and configure service providers and consumer proxies for a local
system.
Make settings to enable replication of bills from SAP Subscription Billing to SAP S/4HANA as billable items:
Bills transferred from SAP Subscription Billing create billing document requests in SAP S/4HANA.
4. For BillableItemsCreateRequest_In, select User Name/Password (Basic) and X.509 Client Certificate.
5. Choose Save.
Note
Select the object and choose Show Details. Make a note of the Access URL: You will need it when you deploy
the integration flow (described in this guide under Configuration of SAP Cloud Integration Configure
and Deploy Integration Flow for Billing Data Replication ).
The SOA Manager is used to administer and configure service providers and consumer proxies for a local
system.
Make settings to enable confirmation from SAP S/4HANA to SAP Subscription Billing that billing data was
successfully transferred and billable items were created in SAP S/4HANA:
BillableItemsCreateConfirmation_Out BillableItemsCreateConfirmation_Out
Integration Guide
198 PUBLIC Integration with SAP S/4HANA
8. Enter the Authentication details as follows and ensure the port is active:
Field Entry
9. Choose Next.
10. Enter the SAP Cloud Integration operation server node URL in the URL field and append it with /cxf and
the address endpoint as configured in the Sender tab of your integration flow.
Example: https://XXXXXX-iflmap.sap.eu2.hana.ondemand.com/cxf/S4/SB/CIConfirm
Note
This URL can be directly copied from the SAP Cloud Integration tenant where your integration
flow Confirm Billable Item Creation to SAP Subscription Billing is deployed. After the successful
deployment of the integration flow on SAP Cloud Integration, go to the Operations View, choose
Manage Integration Content, select the corresponding integration flow and find the complete URL
under Endpoints.
Field Value
RM Protocol SAP RM
Integration Guide
Integration with SAP S/4HANA PUBLIC 199
4.3.8.7 Event Enablement
To provide the required information for accounting processes and revenue recognition, subscriptions and
billing forecasts in SAP Subscription Billing are replicated to provider contracts and billing plans (respectively)
in SAP S/4HANA.
The following topics provide background information to help you understand the replication process and field
mapping:
If you're not yet using SAP Event Mesh, you need to complete some initial steps in the SAP BTP cockpit. The
following steps are described in detail in SAP BTP Configuration Guide for Subscription Billing.
In the Business Configuration for SAP Subscription Billing, activate sending of outbound events:
Integration Guide
200 PUBLIC Integration with SAP S/4HANA
4.3.8.7.1.3 Create a Queue in the Event Mesh Instance
Create a queue for subscription events and subscribe to the queue to enable SAP S/4HANA to consume the
events.
Prerequisites
Access to the SAP Event Mesh application, where you perform these tasks, must be enabled. The required
steps to do this are described in theSAP BTP Configuration Guide for SAP Subscription Billing (section
Administer queues via Event Mesh Management UI).
Procedure
Note
A single queue must be used for both subscription and billing forecast events. If more than one queue is
added, the system will face performance issues and events will be received in the wrong sequence. This is a
critical issue during mass operations and billing forecast events will then end up in AIF.
Integration Guide
Integration with SAP S/4HANA PUBLIC 201
4.3.8.7.2 Enterprise Event Enablement
This section describes how to configure Enterprise Event Enablement in the ABAP Platform.
Enterprise Event Enablement is a technical component on SAP S/4HANA. It enables the exchange of events
across different platforms for seamless event-driven communication. Events from SAP S/4HANA can be sent
to SAP Event Mesh only, where they can be used by any recipient.
Prerequisite
For more information about roles and authorization objects in the Enterprise Event Enablement framework, see
Authorization Objects and Roles in the SAP S/4HANA documentation.
Configuration
In order to successfully exchange events between SAP Event Mesh and an SAP S/4HANA on-premise-system,
an upright connection is required. This connection is maintained by the Enterprise Event Enablement
framework during channel creation.
Note
A channel represents a single connection to a service instance of the SAP Event Mesh.
The maintenance of a channel requires a SM59 transaction destination and an OAuth 2.0 configuration on the
SAP S/4HANA system. Both must be configured according to the service key of the corresponding SAP Event
Mesh instance.
Inbound Scenario
Once a channel has been created, you can decide which topics to maintain on the channel. This, and the
configuration of subscriptions, is required to consume an event to the corresponding SAP Event Mesh instance.
You can create or delete a topic binding and display, assign or delete consumers.
The service key created in SAP Event Mesh contains all information required to establish a connection. This
information is extracted and used to create a destination and an OAuth 2.0 configuration. By using the service
key while creating a channel, the administrator saves manual steps on the SAP S/4HANA system. These
required configurations are created automatically by the Enterprise Event Enablement framework.
Integration Guide
202 PUBLIC Integration with SAP S/4HANA
Prerequisite
If you want to create, configure and manage channels, you must first create an instance in the SAP Event Mesh.
For more information, see Create an Event Mesh Service Instance in the SAP Event Mesh documentation.
Procedure
Note
• If the destination or the OAuth 2.0 Configuration name is not available, random names will be
generated.
• If there is already a channel you want to use, skip the steps above and proceed with the configuration of
the outbound bindings.
• After saving, you can still change optional parameters.
You must configure inbound event topic bindings for consuming events.
To consume an event to the corresponding SAP Event Mesh instance, you must configure inbound topic
bindings and assign subscriptions.
Integration Guide
Integration with SAP S/4HANA PUBLIC 203
4.3.8.7.2.2.1 Maintain Inbound Event Topics
Once a channel has been created, you can decide which topics to maintain on the channel. This is required to
consume an event to the corresponding SAP Event Mesh instance. You can create or delete a topic binding and
display, assign or delete consumers.
Procedure
Note
If you select an inbound binding from the value help, the corresponding consumer is created
automatically. If you create the inbound topic manually then you need to assign the consumer to
the inbound topic binding (follow the procedure below).
Create subscriptions for receiving events from the respective SAP Event Mesh queue address.
Procedure
Integration Guide
204 PUBLIC Integration with SAP S/4HANA
Alternatively, navigate as follows in the SAP Customizing Implementation Guide (transaction SPRO):
ABAP Platform Enterprise Event Enablement Configuration Maintain Subscription
2. Select the channel that you created in the step Create a Channel Using a Service Key [page 97].
3. Press Create new subscription.
4. On the Create Channel Subscription screen, enter the queue name that corresponds to the address of the
queue created in the Event Mesh service.
5. Click Create again to save your entries.
The new subscription will be listed in the Subscriptions table.
Note
Subscriptions must have a valid subscription address provided by the SAP Event Mesh. Once a
new subscription has been created, the subscription has the status New until the subscription is
acknowledged by the SAP Event Mesh and the status set to Acknowledged. Otherwise, the subscription
gets the status Rejected. Both subscriptions and inbound bindings are required to consume cloud
events.
Note
If the channel you want to configure is in the list but not activated, access the transaction /IWXBE/
CONFIG or navigate as follows in the SAP Customizing Implementation Guide (transaction SPRO): SAP
NetWeaver Enterprise Event Enablement Configuration Administration Channel Connection Settings
Maintain Channels and Parameters
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Logistics General Material Master Settings for Key Fields Data Relevant to Sales and Distribution
Define Sales Statuses
The screen Change View “Materials: Status in Sales and Distribution”: Overview is displayed.
2. Choose New Entries and enter the following:
St Description
UP Unpublished
3. Choose Save.
Integration Guide
Integration with SAP S/4HANA PUBLIC 205
4.3.8.8.2 Define Number Range and Configure Sender for
Provider Contracts
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Financial Accounting Contract Accounts Receivable and Payable Basic Functions Provider Contract
Define Number Range
The screen Edit Intervals: Provider Contract, Object FKK_VT is displayed.
2. Choose Intervals (button with edit icon).
3. Insert a line and add the following entries:
Number Range No. From No. To Number Number Range Status External
6. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
ABAP Platform Application Server Business Management SAP Business Events Configure Event
Type Linkages
The screen Change View “Event Type Linkages”: Overview is displayed.
2. Choose New Entries and enter the following:
Integration Guide
206 PUBLIC Integration with SAP S/4HANA
Object Object Receiver Receiver Class Interface Method Linkage
Category Type Event Type Call Name Name Name Activated
Integration Guide
Integration with SAP S/4HANA PUBLIC 207
Object Object Receiver Receiver Class Interface Method Linkage
Category Type Event Type Call Name Name Name Activated
3. Choose Save.
You need to define new item category groups for products and rate plans that are replicated from SAP
Subscription Billing
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Service Transactions Basic Settings Define Item Category Group
The screen Materials: Item Category Groups in Material Master is displayed.
2. Choose New Entries and enter the following:
Field Value
ItCtGrp SBPD
Field Value
ItCtGrp SBRE
3. Choose Save.
Integration Guide
208 PUBLIC Integration with SAP S/4HANA
4.3.8.8.5 Define Attributes of Material Types
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Logistics - General Material Master Basic Settings Material Types Define Attributes of Material
Types
The screen Materials Types”: Overview is displayed.
2. Choose New Entries and enter the following:
For products:
Field Value
General data
User departments
Accounting
Basic data
Sales
Int.purchase orders 0
Valuation
Quantity/value updating
In no valuation area
In no valuation area
Retail-specific fields
Integration Guide
Integration with SAP S/4HANA PUBLIC 209
Field Value
Field Value
General data
User departments
Accounting
Basic data
Sales
Int.purchase orders 0
Valuation
Quantity/value updating
In no valuation area
In no valuation area
Retail-specific fields
3. Select the material type SBPD and double-click on Quantity/value updating in the navigation.
Update the values for the regions US and DE accordingly.
4. Repeat the previous step for the material type SBRE.
5. Choose Save.
Integration Guide
210 PUBLIC Integration with SAP S/4HANA
4.3.8.8.6 Define Condition Types
The following condition types are only an example that can be assigned in a pricing procedure. Create those
condition types that are relevant as per the requirements. Adjust the pricing procedure mentioned in next
chapter accordingly with the required condition types.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Sales and Distribution Basic Function Pricing Pricing Control Define Condition Types
2. Choose Set Condition Types for Pricing.
The screen Change View: "Conditions: Condition Types:” Overview is displayed.
3. Choose New Entries and enter the following:
Note
Fields that you see on the screen but that are not listed below are not relevant.
Field Value
Control Data 1
Amount/Percent X (Selected)
Master Data
Control Data 2
Field Value
Control Data 1
Integration Guide
Integration with SAP S/4HANA PUBLIC 211
Field Value
Amount/Percent X (Selected)
Master Data
Control Data 2
Field Value
Control Data 1
Amount/Percent X (Selected)
Master Data
Control Data 2
4. Choose Save.
Integration Guide
212 PUBLIC Integration with SAP S/4HANA
4.3.8.8.7 Configuration of Billing Plans
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Financial Accounting Contract Accounts Receivable and Payable Convergent Invoicing Enhanced
Functions Billing Plans Define Billing Plan Types
The screen Change View “Billing Plan Type”: Overview is displayed.
2. Choose New Entries and enter the following:
3. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Financial Accounting Contract Accounts Receivable and Payable Convergent Invoicing Enhanced
Functions Billing Plans Assign Item Types to Billing Plan Items
The screen Change View “Assignment of Billing Plan Item Types for Billing Plan Types”: Overview is
displayed.
2. Choose New Entries and enter the following:
3. Choose Save.
Integration Guide
Integration with SAP S/4HANA PUBLIC 213
4.3.8.8.7.3 Define Number Range
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Financial Accounting Contract Accounts Receivable and Payable Convergent Invoicing Enhanced
Functions Billing Plans Maintain Number Ranges for Billing Plans
The screen Edit Intervals: Billing Plan, Object FKKBIX_BIP is displayed.
2. Choose New Entries and enter the following:
S1 020000000000 024999999999 0
3. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Financial Accounting Contract Accounts Receivable and Payable Convergent Invoicing Enhanced
Functions Billing Plans Define Billing Plan Item Types
The screen Change View “Billing Plan Item Type”: Overview is displayed.
2. Choose New Entries and enter the following:
Description of Billing
BPlnItmTyp Plan Item Type Baseline Date Start Date Type Rule Start Date
3. Choose Save.
Integration Guide
214 PUBLIC Integration with SAP S/4HANA
4.3.8.8.8 Configuration of Billable Items in Convergent
Invoicing
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Financial Accounting Contracts Account Receivable and Payable Convergent Invoicing Basic
Functions Billable Items Billable Item Management Define Subprocesses of Billing
The screen Change View “Subprocesses of Billing”: Overview is displayed.
2. Choose New Entries and enter the following:
3. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Financial Accounting Contracts Account Receivable and Payable Convergent Invoicing Basic
Functions Billable Items Billable Item Management Define Field Derivation Schema for Billable
Items
The screen “Field Derivation Schema”: Overview is displayed.
2. Choose New Entries and enter the following:
Integration Guide
Integration with SAP S/4HANA PUBLIC 215
Field Schema Record Type
5. Choose Record Type 'IT Main Items' and choose Maintain Field Value.
6. Choose New Entries.
BITTYPE YONE
POSTREL X
PRINTREL X
SRCTATYPE REVCL
SUBPROCESS SB01
TAX_DATE_TYPE 01
TAX_DET_TYPE 01
BITTYPE YREC
POSTREL X
PRINTREL X
SRCTATYPE REVCL
SUBPROCESS SB01
TAX_DATE_TYPE 01
TAX_DET_TYPE 01
BITTYPE Y001
POSTREL X
PRINTREL X
SRCTATYPE REVCL
Integration Guide
216 PUBLIC Integration with SAP S/4HANA
Field Schema: SB03
SUBPROCESS SB01
TAX_DATE_TYPE 01
TAX_DET_TYPE 01
BITTYPE YCRE
POSTREL X
PRINTREL X
SRCTATYPE REVCL
SUBPROCESS SB01
TAX_DATE_TYPE 01
TAX_DET_TYPE 01
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Financial Accounting Contracts Account Receivable and Payable Convergent Invoicing Billing
Billing Processes Define Billing Processes
The screen Change View “Billing Processes”: Overview is displayed.
2. Choose New Entries and enter the following:
Y001 Billing
3. Choose Save.
4. 1. Choose the Y001 billing process and choose Subprocesses.
2. Choose New Entries and maintain the following:
Integration Guide
Integration with SAP S/4HANA PUBLIC 217
Billing Process: Y001
Name: Billing
3. Choose Save.
Name: Billing
3. Choose Save.
1. Access the transaction FKKBIXBIT_CONF and navigate as follows in the SAP Customizing Implementation
Guide:
Financial Accounting Contracts Account Receivable and Payable Convergent Invoicing Basic
Functions Billable Items Billable Item Classes Maintain Billable Item Classes
2. On the Display Billable Item Classes screen, switch to change mode.
3. On the Maintain Billable Item Classes screen, choose New Class.
4. On the Create a New Billable Item Class screen, enter the following information and Save.
Name ZSAP
5. On the Create Billable Item Class screen, choose Save. If you are asked to enter a package, use the package
name assigned to you.
Integration Guide
218 PUBLIC Integration with SAP S/4HANA
4.3.8.8.8.4.2 Choose Interface Components for Billable Item
Classes
1. On the Maintain Billable Item Classes screen, select the billable item class (CSAP) that you have created
and choose Selected Entries.
2. On the Change Billable Item Class screen, choose Interface.
3. On the Choose Interface Components screen, set the following interface components to active:
Contract Reference
Usage Period
Billing Quantity
Card Payment
Integration Guide
Integration with SAP S/4HANA PUBLIC 219
Billable Item Class Interface Component
Offsetting in Invoicing
Consumption Item ID
Primary Items
Secondary Items
Attachment Items
Data Analysis
Billing Request
FIELDSCHEMA
1. Select the created billable item class CSAP and choose Activate Configuration. If you are asked for a
package, enter the package name assigned to you.
2. Confirm the information dialog boxes.
Integration Guide
220 PUBLIC Integration with SAP S/4HANA
4.3.8.8.8.4.4 Generate Interfaces for Billable Item Classes
1. Access the transaction FKKBIXBIT_CONF and navigate as follows in the SAP Customizing Implementation
Guide:
Financial Accounting Contracts Account Receivable and Payable Convergent Invoicing Basic
Functions Billable Items Billable Item Classes Generate Interfaces for Billable Item Classes .
2. The screen Generate Interfaces for Billable Item Classes is displayed. Select the non-generated class ZSAP
and choose Generate.
3. Confirm the pop up window Generation of Results.
4. Check the generation status of the database views using the transaction FKKBIXBIT_VIEW_GEN.
You must regenerate interfaces for any views with the status Regeneration Required. You must first
regenerate the class-specific views, followed by the common views by selecting the relevant views and
choosing Generate.
1. Access the transaction FKKBIXBIT_DIA_GEN and navigate as follows in the SAP Customizing
Implementation Guide:
Financial Accounting Contracts Account Receivable and Payable Convergent Invoicing Basic
Functions Billable Items Billable Item Classes Generate Maintenance Dialogs for Billable Item
Classes .
2. The screen Generate Maintenance Dialogs for Billable Item Classes is displayed. Enter the billable item class
ZSAP and choose Generate.
3. Choose Yes and confirm the pop up window Generation of Results.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Financial Accounting Contracts Account Receivable and Payable Convergent Invoicing Basic
Functions Billable Items Billable Item Management Assign Subprocesses of Classes
The screen Change View “Assign Subprocesses to Classes”: Overview is displayed.
2. Choose New Entries and enter the following:
3. Choose Save.
Integration Guide
Integration with SAP S/4HANA PUBLIC 221
4.3.8.8.8.6 Assign Item Types of Subprocesses
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Financial Accounting Contracts Account Receivable and Payable Convergent Invoicing Basic
Functions Billable Items Billable Item Management Assign Item Types to Subprocesses
The screen Change View “Assign Item Types to Subprocesses”: Overview is displayed.
2. Choose New Entries and enter the following:
3. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Financial Accounting Contracts Account Receivable and Payable Convergent Invoicing Billing
Billing Processes Define Billing Types for Billing Documents .
The screen Change View: “Billing Types” is displayed.
2. Choose New Entries and enter the following:
3. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Financial Accounting Contracts Account Receivable and Payable Convergent Invoicing Billing
Billing Processes Assign Billing Item Types .
The screen Change View: “Assign Billing Item Types”: Overview is displayed.
Integration Guide
222 PUBLIC Integration with SAP S/4HANA
2. Choose New Entries and enter the following:
3. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Financial Accounting Contracts Account Receivable and Payable Convergent Invoicing Billing
Billing Processes Define Grouping Variants for Billable Items .
The screen Change View “Grouping Variant”: Overview is displayed.
2. Choose New Entries and enter the following:
3. Choose Save.
4. Choose SB01 Assign Grouping Characteristics .
5. Choose New Entries and enter the following:
6. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Financial Accounting Contracts Account Receivable and Payable Convergent Invoicing Billing
Billing Processes Define Aggregation for Billable Items
Integration Guide
Integration with SAP S/4HANA PUBLIC 223
The screen Change View “Grouping Variant”: Overview is displayed.
2. Choose New Entries and enter the following:
Billing Process Subprocess Billable Item Class Billable Item Type Grouping Variant
3. Choose Save.
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Financial Accounting Contracts Account Receivable and Payable Convergent Invoicing Basic
Functions Consumption Items Consumption Item Management .
The screen Change View “Field Derivation Schema”: Overview is displayed.
2. Choose New Entries and enter the following:
3. Choose Save.
4. Choose SB01 Maintain Field Values .
5. Choose New Entries and enter the following:
CITIDTYPE 01
CITTYPE S001
SRCTATYPE REVCL
1. Access the transaction SPRO and navigate as follows in the SAP Customizing Implementation Guide:
Financial Accounting Contracts Account Receivable and Payable Convergent Invoicing Invoicing
Invoicing Processes Define Bill Form .
The screen Change View: “Maintenance of Key for Billing Form”: Overview is displayed.
Integration Guide
224 PUBLIC Integration with SAP S/4HANA
2. Choose New Entries and enter the following:
3. Choose Save.
To enable replication of data, you need configure integration in SAP Cloud Integration.
Prerequisites
• You have received a SAP Cloud Integration provisioning email from SAP, after which the administrator
needs to create the required users in SAP Cloud Integration. The users require the following roles:
• AuthGroup.IntegrationDeveloper
• AuthGroup.BusinessExpert
• esbmessagestorage.read
• ESBMessaging.send
• To connect to the SAP S/4HANA system, you must install and configure the Cloud Connector that is part
of the SAP Connectivity service. For setup information, see Install and Configure SAP Connectivity service
[page 225].
This section describes the installation and configuration procedures in SAP Connectivity service.
Serving as a link between SAP BTP applications and on-premise systems, the Connectivity service runs as an
on-premise agent in secured networks.
Before you can use the Connectivity service to link SAP S/4HANA and SAP BTP, ensure that you have installed
the cloud connector. For more information on installation, see Installation in the SAP Connectivity service
documentation.
After installing the cloud connector and starting the cloud connector daemon, you can log on to the daemon
and perform required configurations to make your cloud connector operational. For more information, see
Initial Configuration in the SAP Connectivity service documentation.
In addition, specify the SAP S/4HANA web service that can be accessed by integration flows using HTTP. For
more information, see Configure Access Control (HTTP) in the SAP Connectivity service documentation.
Integration Guide
Integration with SAP S/4HANA PUBLIC 225
Procedure
You need to deploy an OAuth2 credentials artifact to be able to connect to SAP Subscription Billing, which
requires OAuth 2.0 authentication.
Procedure
1. Log on to the tenant management node of the SAP Cloud Integration system with the URL https://
<tenant management node URL>/itspaces.
2. In the navigation panel, choose Monitor.
3. Choose Manage Security Security Material .
4. Choose Add OAuth2 Credentials .
5. Specify the following fields in the Add OAuth2 Credentials dialog box.
Integration Guide
226 PUBLIC Integration with SAP S/4HANA
Field Naame Entry Value
For information about getting the client ID and client secret, see the SAP BTP Configuration Guide (setion
about creating a service key).
6. Choose Deploy.
Procedure
1. Log on to the tenant management node of the SAP Cloud Integration system with the URL https://
<tenant management node URL>/itspaces.
2. In the navigation panel, choose Monitor.
3. Go to Manage Security Security Material .
4. Choose Create User Credentials .
5. Enter a name for the credential and enter a user (with password) that has authorization to access the SAP
S/4HANA back-end system.
6. Choose Deploy.
You have the following options for integrating business partner master data:
Recommendation
This is the recommended replication scenario. If you use this, you do not need to complete the other
configuration steps described in the current section. Instead, refer to the following documentation
Integration Guide
Integration with SAP S/4HANA PUBLIC 227
to set up integration between SAP Subscription Billing and SAP Master Data Integration: Business
Partner Data Replication [page 358]
• Replicate business partners (customers) to SAP Subscription Billing using an integration flow in SAP Cloud
Integration.
If you use this option, follow the instructions in the current section of the guide.
Prerequisites
The business partners in SAP S/4HANA or SAP Master Data Integration must have MKK (Contract Partner)
and FLCU01 (Customer) roles.
If you use the integration flow option, the business partners for which additional Business Partner Roles are
configured in the integration flow Replicate Business Partners to SAP Subscription Billing will be replicated to
SAP Subscription Billing.
You must maintain sales areas for the business partners in SAP S/4HANA or SAP Master Data Integration. The
sales areas maps to markets in SAP Subscription Billing.
Required Data
Business partners in SAP S/4HANA must be created and linked with contract accounts that are already
created.
Procedure
You can copy integration package to customer workspace using the following procedure:
Integration Guide
228 PUBLIC Integration with SAP S/4HANA
4.3.8.9.4.2 Configure Integration Flow for Business Partner
Replication
Procedure
You can configure the integration flow using the following procedure:
Integration Guide
Integration with SAP S/4HANA PUBLIC 229
Name Value Remark
8. Choose Save.
Procedure
You can deploy integration flows for business partner replication using the following procedure:
Integration Guide
230 PUBLIC Integration with SAP S/4HANA
4.3.8.9.5 Replication of Products to SAP S/4HANA
To use the integration with Convergent Invoicing, you must first replicate subscription products from SAP
Subscription Billing to SAP S/4HANA.
After the replication, the products and rate elements in SAP Subscription Billing will be mapped to products in
SAP S/4HANA.
Prerequisites
The following are the prerequisites for replicating products to SAP S/4HANA:
• The SAP Cloud Platform Integration tenant has been provisioned. For details, see Initial Setup.
• SAP BTP has been configured and service keys created. This is described in the SAP BTP Configuration
Guide.
• Certain integration scopes are required to integrate with the SAP Subscription Billing solution. For details,
see SAP Subscription Billing API Scopes in the SAP Subscription Billing API Guide.
Note
• The description length cannot exceed 40 characters and will be trimmed accordingly when required.
• To ensure that the product can be used in SAP S/4HANA, additional information must be maintained
for the replicated products in SAP S/4HANA. For example, distribution chains, item category group,
account assignment group, and tax classification.
• For rate element replication, the unit of the rate element in SAP Subscription Billing must exist as a
commercial unit in SAP S/4HANA.
product.code productInternalID
M industrySectorCode
SBPD productTypecode
product.names description
EA baseMeasureUnitCode
Integration Guide
Integration with SAP S/4HANA PUBLIC 231
Field Mapping for Rate Elements
ratePlanElement.id productInternalID
M industrySectorCode
SBRE productTypecode
ratePlanElement.labels description
ratePlanElement.unit baseMeasureUnitCode
Procedure
You can copy the an integration package to the customer workspace using the following procedure:
Note
Although the package name refers to "SAP S/4HANA Cloud", the package is are also valid for
integration with the on-premise suite.
5. To copy the integration package from the catalog to your customer workspace, select the package to open
it and choose Copy.
You can configure the integration flow for product replication using the following procedure:
Integration Guide
232 PUBLIC Integration with SAP S/4HANA
1. Log on as an SAP Cloud Integration developer on your SAP Cloud Integration tenant (for example, https://
<your SAP Cloud Integration tenant URL>/itspaces).
2. In the navigation panel, choose Design.
3. Select the package SAP Subscription Billing Integration with SAP S/4HANA Cloud - Product, and go to
Artifacts Actions Configure for the integration flow Replicate Products to SAP S4HANA Cloud.
Note: Although the package and flow names refer to "SAP S/4HANA Cloud", they are also valid for
integration with the on-premise suite.
4. On the Timer tab, define the execution schedule and frequency of the integration flow.
5. On the Receiver tab, provide the address for the receiver system. Select the appropriate authentication
type (either certificate-based or basic authentication).
• If you select SubscriptionBilling as receiver, enter the following parameters:
• Subscription_Billing_API_Home_Path: The API home path mentioned in the SAP BTP
Configuration Guide (refer to the section about creating a service key). For example:
eu10.revenue.cloud.sap/api
• Adapter: HTTP
• Query: The query condition for API calls.
• Credential Name: The credential name created in the activity Create OAuth2.0 Credentials for SAP
Subscription Billing [page 226].
• If you select S4HCE as receiver, enter the following parameters:
• Adapter Type: SOAP
• Address: The URL for the corresponding configuration object in the SOA Manager (see SOA
Manager Settings for Product Replication [page 195]).
• Proxy Type: On-Premise
• Authentication/Credential Name:
If you want to use a basic authentication, choose Basic and enter the credential name created in
the activity Create SAP S/4HANA User Credentials in Integration [page 227].
• If you want to extend the capabilities of standard integration flow, select PostExitProduct as receiver
and maintain the Address for your custom integration flow.
6. On the More tab, configure the other parameters as below:
7. Choose Save.
Integration Guide
Integration with SAP S/4HANA PUBLIC 233
4.3.8.9.5.2.2 Configure Integration Flow for Rate Element
Replication
You can configure the integration flow for product replication using the following procedure:
7. Choose Save.
Integration Guide
234 PUBLIC Integration with SAP S/4HANA
4.3.8.9.5.2.3 Maintain and Deploy the SAP S/4HANA Value
Mapping
Procedure
You can maintain and deploy the SAP S/4HANA value mapping using the following procedure:
Note: Although the integration package and flow names refer to "SAP S/4HANA Cloud", they are also valid for
integration with the on-premise suite.
Integration Guide
Integration with SAP S/4HANA PUBLIC 235
Deploy Integration Flow for Rate Element Replication
To use the integration with Convergent Invoicing, you must replicate billing data from SAP Subscription Billing
to SAP S/4HANA.
Replication Process
Bills are transferred from SAP Subscription Billing to SAP S/4HANA, at a frequency you define, resulting in the
creation of billable items that can be invoiced.
Integration Guide
236 PUBLIC Integration with SAP S/4HANA
4.3.8.9.6.1 Copy Integration Package to Customer Workspace
Procedure
You can copy integration package to customer workspace using the following procedure:
Procedure
You can configure the integration flow, in this scenario, using the following procedure:
Integration Guide
Integration with SAP S/4HANA PUBLIC 237
• Credential Name: The credential name you created in secure parameter in Create OAuth2.0
Credentials for SAP Subscription Billing [page 226].
2. Select S4H_CreateBIT as receiver and enter the following parameters:
• Address: You can find the URL for the corresponding configuration object in the SOA Manager (see
SOA Manager Settings for Billing Data Replication [page 198]).
• Proxy Type: On-Premise
• Authentication/Credential Name
If you would like to use a basic authentication, choose Basic and enter the credential name you've
created in the activity Create SAP S/4HANA User Credentials in Integration [page 227].
5. If you want to extend the capabilities of the standard integration flow, select BillableItemsPostExit as
receiver and enter the Address for your custom integration flow.
6. On the More tab, configure the other parameters as follows:
Billing_Process Y001/Y002 If the value is Y001, a billing document is created without invoic
ing, immediately after bill transfer, in SAP S/4HANA. You can
The default value is
combine this billing document with other billing documents and
Y001
invoice them together later, but there is no chance to update
invoice information in SAP Subscription Billing. In SAP Subscrip
tion Billing, you can only see the billing document under the
Transfer tab, in the Manage Billing Data app.
SubscriptionBillingSystemI <User-defined ID> An ID that refers to the SAP Subscription Billing tenant
D
7. Choose Save.
Integration Guide
238 PUBLIC Integration with SAP S/4HANA
4.3.8.9.6.2.2 Configure Integration Flow for Confirmation of
Billable Item Creation
Procedure
You can configure integration flow (in this scenario) using the following procedure:
6. Choose Save.
Integration Guide
Integration with SAP S/4HANA PUBLIC 239
4.3.8.9.6.2.3 Value Mapping for Convergent Invoicing
Define how a field derivation schema is determined for a billable item. You do this by mapping rating types
(and, optionally, condition types) to derivation schemas.
Procedure
Example
onetime SB01
recurring SB02
usage SB03
1-1-1 SB01
Integration Guide
240 PUBLIC Integration with SAP S/4HANA
Note
Statistical pricing elements (Statistical = X) are excluded for value mappings based on the rating
type.
However, you could also define a value mapping for the condition type:
PMP1 ZSB01
PCSC ZSBCO
1-1-1 ZSB01
1-1-2 ZSBCO
Note
Statistical pricing elements (Statistical = X) are included for value mappings based on the
condition type.
7. Choose Save.
8. Select Deploy in the Actions menu for Value Mapping for SAP S4HANA Convergent Invoicing.
Procedure
You can deploy integration flow to confirm billable item creation using the following procedure:
1. Log on as SAP Cloud Platform Integration developer on your SAP Cloud Platform Integration tenant (for
example, https://<your SAP Cloud Platform Integration tenant URL>/itspaces).
2. Select Design section from the drop-down menu. You will see all available integration packages for the
tenant.
3. Search for and select the integration package SAP Subscription Billing Integration with SAP S/4HANA -
Subscription Management with Convergent Invoicing. The package content list will appear.
Integration Guide
Integration with SAP S/4HANA PUBLIC 241
4. Select Artifacts. All artifacts will be listed at the bottom of the page.
5. Select Deploy in the Actions menu for the integration flow Confirm Billable Items Creation to SAP
Subscription Billing.
Procedure
You can deploy integration flow to transfer billable items using the following procedure:
Purpose
In this activity you enhance the following subscription products in SAP S/4HANA that correspond to rate
elements in SAP Subscription Billing: The products are created in SAP Subscription Billing and replicated to
SAP S/4 HANA.
Integration Guide
242 PUBLIC Integration with SAP S/4HANA
Procedure
Product: R_ONETIME
Test
Step
Number Test Step Name Instruction Expected Result Comments
1 Log On Log on to the SAP Fiori Launch The Home page appears.
pad with the role Master Data
Specialist - Product Data.
2 Access the SAP Choose the Manage Product The Manage Product Master Data
Fiori app Master Data tile. app appears.
3 Find Product In the search area, enter the Your product is displayed in the re
R_ONETIME Product:R-ONETIME port list.
Click on Go.
4 Open Product and On the Product view, in the The product should be open and For country ver
Maintain Distribu Distribution Chains area, choose general information is maintained. sion Germany,
tion Chains: General Create and maintain the following maintain the fol
Information data: lowing value in
stead of 1710:
Sales Organization: 1710
(Dom. Sales Org US) Sales
Organization:
Distribution Channel: 10
1010 (Dom.
(Direct Sales)
Sales Org
Cash Discount: Yes DE)
Integration Guide
Integration with SAP S/4HANA PUBLIC 243
Test
Step
Number Test Step Name Instruction Expected Result Comments
5 Maintain Distribu Navigate to the Grouping Terms Grouping terms are maintained For country ver
tion Chains: Group area and maintain the following and the product is saved. sion Germany,
ing Terms data: maintain the fol
lowing value in
Account Assignment Group: X9
stead of 1 (Full
(Periodic Service)
Tax):
Tax Classification: 1 (Full
Tax
Tax) Classification: 6
Then choose Apply. (Full Tax
(Services))
Product: R_SEATS
Test
Step
Number Test Step Name Instruction Expected Result Comments
1 Log On Log on to the SAP Fiori Launch The Home page appears.
pad with the role Master Data
Specialist - Product Data.
2 Access the SAP Choose the Manage Product The Manage Product Master Data
Fiori app Master Data tile. app appears.
3 Find Product In the search area, enter the Your product is displayed in the re
R_SEATS Product:R-SEATS port list.
Click on Go.
Integration Guide
244 PUBLIC Integration with SAP S/4HANA
Test
Step
Number Test Step Name Instruction Expected Result Comments
4 Choose the product from the re The product should be open and For country ver
port list. general information is maintained. sion Germany,
maintain the fol
On the Product view, click on Edit.
lowing value in
In the Distribution Chains area, stead of 1710:
choose Create and maintain
Sales
the following data:Open Product
Organization:
and Maintain Distribution Chains:
1010 (Dom.
General Information
Sales Org
Sales Organization: 1710 DE)
(Dom. Sales Org US)
The other en
Distribution Channel: 10 tries are the
(Direct Sales) same for both
countries.
Note
5 Maintain Distribu Navigate to the Grouping Terms Grouping terms are maintained For country ver
tion Chains: Group area and maintain the following and the product is saved. sion Germany,
ing Terms data: maintain the fol
lowing value in
Account Assignment Group: X9
stead of 1 (Full
(Periodic Service)
Tax):
Tax Classification: 1 (Full
Tax
Tax) Classification: 6
Then choose Apply. (Full Tax
(Services))
Integration Guide
Integration with SAP S/4HANA PUBLIC 245
Test
Step
Number Test Step Name Instruction Expected Result Comments
Product: R_TICKETS
Test
Step
Number Test Step Name Instruction Expected Result Comments
1 Log On Log on to the SAP Fiori Launch The Home page appears.
pad with the role Master Data
Specialist - Product Data.
2 Access the SAP Choose the Manage Product The Manage Product Master Data
Fiori app Master Data tile. app appears.
3 Find Product In the search area, enter the Your product is displayed in the re
R_TICKETS Product:R-TICKETS port list.
Click on Go.
Integration Guide
246 PUBLIC Integration with SAP S/4HANA
Test
Step
Number Test Step Name Instruction Expected Result Comments
4 Open Product and Choose the product from the re The product should be open and For country ver
Maintain Distribu port list. general information is maintained. sion Germany,
tion Chains: General maintain the fol
On the Product view, click on Edit.
Information lowing value in
In the Distribution Chains area, stead of 1710:
choose Create and maintain the
Sales
following data:
Organization:
Sales Organization: 1710 1010 (Dom.
(Dom. Sales Org US) Sales Org
DE)
Distribution Channel: 10
(Direct Sales) The other en
tries are the
Note same for both
5 Maintain Distribu Navigate to the Grouping Terms Grouping terms are maintained For country ver
tion Chains: Group area and maintain the following and the product is saved. sion Germany,
ing Terms data: maintain the fol
lowing value in
Account Assignment Group: X9
stead of 1 (Full
(Periodic Service)
Tax):
Tax Classification: 1 (Full
Tax
Tax) Classification: 6
Then choose Apply. (Full Tax
(Services))
Integration Guide
Integration with SAP S/4HANA PUBLIC 247
4.3.8.10.2 Enrich Subscription Billing Products
Purpose
In this activity you enhance the subscription product P-CLOUD_STORAGE in SAP S/4HANA. This product is
created in SAP Subscription Billing and replicated to SAP S/4 HANA.
Procedure
Product: P-CLOUD_COMM
Test
Step # Test Step Name Instruction Expected Result Comments
1 Log On Log on to the SAP Fiori Launch The Home page appears.
pad with the role Master Data
Specialist - Product Data.
2 Access the SAP Choose the Manage Product The Manage Product Master Data
Fiori app Master Data tile. app appears.
3 Find Product P- In the search area on the top, Your product is displayed in the re
CLOUD_COMM port list.
enter the Product:P-
CLOUD_COMM.
Integration Guide
248 PUBLIC Integration with SAP S/4HANA
Test
Step # Test Step Name Instruction Expected Result Comments
4 Open Product and Choose the Product from the re The product should be open and
Maintain Distribu port list, general information is maintained.
tion Chains: General
Product Number: P-
Information
CLOUD_COMM
• Base Unit: EA
• Product Type: SBPD (Sub.
Billing Product)
Note
In DescriptionLanguage and
Product details for spe
cific region, for example,
Language: English and
Product: Subscription
Billing Product.
5 Maintain Distribu On the Product view, in the Grouping terms are maintained For country ver
tion Chains: General Distribution Chains area, choose and the product is saved. sion Germany,
Information provide Create and maintain the following maintain the fol
the data: lowing value in
stead of 1 (Full
Sales Organization: 1710
Tax):
(Dom. Sales Org US)
Tax Classifica-
Distribution Channel: 10
tion: 6 (Full Tax
(Direct Sales) (Services))
Integration Guide
Integration with SAP S/4HANA PUBLIC 249
Test
Step # Test Step Name Instruction Expected Result Comments
Product: P-CLOUD_SUPPORT
Test Step Number Test Step Name Instruction Expected Result Comments
2 Access the SAP Fiori Choose the Manage The Manage Product
app Product Master Data Master Data app ap
tile. pears.
Integration Guide
250 PUBLIC Integration with SAP S/4HANA
Test Step Number Test Step Name Instruction Expected Result Comments
• Base Unit: EA
• Product Type:
SBPD (Sub.
Billing
Product)
Note
In Description pro
vide the Language
and Product de
tails for specific
region, for exam
ple, Language:
English
and Product:
Subscription
Billing
Product.
5 Maintain Distribution On the Product view, in Grouping terms are For country version
Chains: General Infor the Distribution Chains maintained and the Germany, maintain the
mation area, choose Create product is saved. following value instead
and maintain the fol of 1 (Full Tax):
lowing data:
Tax Classification: 6
Sales Organization: (Full Tax (Services))
1710 (Dom.
The other entries are
Sales Org US) the same for both
Distribution Channel: countries.
10 (Direct
Sales)
Integration Guide
Integration with SAP S/4HANA PUBLIC 251
Test Step Number Test Step Name Instruction Expected Result Comments
Item Category
Group: SBPD
(Sub. Billing
Product)
Account Assignment
Group: X9
(Periodic
Service)
Tax Classification: 1
(Full Tax)
4.3.8.11 Error Handling
AIF functionality is needed for error handling in the event handler class CL_FICA_SUBSCRIPTION_HANDLER. If
it is not available, an exception is raised and provider contracts are not be created. The event will get stuck in
the event queue. To avoid this error, AIF Customizing must extracted.
These are the steps that need to be followed for AIF extraction:
Integration Guide
252 PUBLIC Integration with SAP S/4HANA
5 Integration with SAP S/4HANA Cloud
You can integrate SAP Subscription Billing with SAP S/4HANA Cloud to support end-to-end processes for your
subscription business.
Subscription Management with Sales Billing (57Z) [page This integration enables the transfer of billing and subscrip
254]
tion data to SAP S/4HANA Cloud for invoicing in Sales Bill
ing.
Subscription Management with Convergent Invoicing (5IK) This integration enables the transfer of billing and subscrip
[page 302]
tion data to SAP S/4HANA Cloud Convergent Invoicing, al
lowing charges from multiple billing streams to be consoli
dated into invoices.
Note
SAP Subscription Billing is a component of the following solution variants in the Lead to Cash business process
(the links take you to process overviews in the SAP Business Accelerator Hub):
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 253
5.1 Subscription Management with Sales Billing (57Z)
This integration enables the transfer of billing and subscription data from SAP Subscription Billing to SAP
S/4HANA Cloud for invoicing in Sales Billing, with subsequent financial processes.
Subscriptions can be created via APIs from transactions in upstream systems, for example from solution
orders in SAP S/4HANA Cloud.
This integration is enabled by the SAP Best Practices scope item 57Z.
Note
This integration supports pricing in SAP Subscription Billing with pricing schemes only.
Individual usage rating is not supported by the standard integration. If you want to use individual usage
rating (see Individual Usage Rating) in this integration scenario, please contact SAP beforehand by
creating an incident on the component CEC-SAL-SB. You can also consider using the integration scenario
Subscription Management with Convergent Invoicing (5IK) [page 302] instead.
Business Process
1. Creation of subscriptions in SAP Subscription Billing from upstream systems, via APIs.
For example, subscriptions can be created from released subscription billing items of solution orders in
SAP S/4HANA Cloud.
2. Collection of usage records and automated rating of usage, recurring, and one-time charges in SAP
Subscription Billing.
3. Transfer of billing data from SAP Subscription Billing to SAP S/4HANA Cloud Sales Billing, resulting in the
creation of billing document requests.
Billing clerks can process the billing document requests to create customer invoices. For solution orders,
the billing document requests can be processed together with the other subsequent documents of solution
orders to create combined customer invoices.
You can optionally use this integration to generate subscriptions in SAP Subscription Billing from solution
orders in SAP S/4HANA Cloud. The solution order is a business transaction for selling any combination of
different products, such as physical goods, one-time services, and long-running service contracts. To sell these
product types, the solution order offers different item types. For subscriptions, the item type is "subscription
billing item".
To find out more about the end-to-end solution order management process, take a look at the Solution Order
Management section of the SAP S/4HANA Cloud documentation.
You can find more details on the interaction between solution orders and subscriptions under Data Exchange
Between Solution Orders and Subscriptions [page 265].
Integration Guide
254 PUBLIC Integration with SAP S/4HANA Cloud
Financial Processes
Accounting-relevant billing data in billing document requests is forwarded from invoices in Sales Billing to SAP
S/4HANA Cloud Finance. Supported financial processes include receivables management, margin and revenue
analysis on subscription level, as well as event-based revenue recognition (EBRR).
To provide further information for financial processes, the following objects are created automatically in SAP
S/4HANA Cloud:
For more information about financial processes for subscriptions, see Transfer of Subscription-Related Data to
Finance [page 285].
Integrated Data
You can find a graphical overview in Data Flow Overview [page 257].
• Business partners in SAP S/4HANA Cloud or SAP Master Data Integration are replicated as customers in
SAP Subscription Billing.
• Products and rate elements in SAP Subscription Billing are replicated as products in SAP S/4HANA
Cloud.
• Subscription billing items in solution orders in SAP S/4HANA Cloud (if used) are replicated as
subscriptions in SAP Subscription Billing.
• Subscriptions in SAP Subscription Billing are replicated as provider contracts in SAP S/4HANA Cloud.
• Billing forecasts are replicated as billing plans in SAP S/4HANA Cloud.
• Billing data in SAP Subscription Billing is replicated as subscription billing document requests (request
type SBDR) in SAP S/4HANA Cloud.
Restrictions
• A maximum of 25,000 subscriptions per hour can be created/changed and replicated to provider
contracts in SAP S/4HANA Cloud. If you want to migrate data or run any other process that result in
mass changes to subscriptions, please contact SAP beforehand by creating an incident on the component
CEC-SAL-SB. In addition, the general technical constraints of the SAP Event Mesh default plan apply.
• A maximum of 165,000 billing forecasts per hour can be created/changed and replicated to SAP S/4HANA
Cloud. If you want to migrate data or run any other process that result in mass changes to billing forecasts,
please contact SAP beforehand by creating an incident on the component CEC-SAL-SB.
• For the integration of SAP Subscription Billing with the SAP Data Retention Manager service and SAP
Personal Data Manager service, a legal entity (on which basis the data residence and retention periods
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 255
are defined) corresponds to an SAP BTP subaccount. As there can only be one subaccount for an SAP
Subscription Billing tenant, the tenant is restricted to one legal entity. Accordingly, if different markets in
SAP Subscription Billing map to SAP S/4HANA sales areas for which the sales organizations belong to
different legal entities, this cannot be reflected in the data protection functionality for SAP Subscription
Billing. This is also the case for integration with S/4HANA Cloud. While you can restrict the access of
business users in the SAP Subscription Billing user interface based on markets, the SAP Data Retention
Manager service and SAP Personal Data Manager service provide access to all data of all markets. The use
of data protection functionality for SAP Subscription Billing therefore assumes that the data of only one
data controller is being processed within the tenant. For more information, see Deletion of Personal Data
(section Integrated Data) in the Setup and Administration Guide.
• Currently, the customer number in SAP Subscription Billing must be identical to the business partner
number in SAP S/4HANA Cloud.
• Only billing forecasts for subscriptions with the price type "Net" can be replicated to billing plans.
• Some functional restrictions apply regarding subscriptions that have been replicated to provider contracts
in SAP S/4HANA Cloud. See Replication of Subscriptions to Provider Contracts [page 267].
Setup
To set up the integration, use the instructions and predefined content for scope item 57Z (Subscription
Management with Sales Billing). We recommend that you use a guided workflow in the Maintenance Planner
to help reduce the setup time and to ensure that you complete all the necessary tasks. You can find more
information about the workflow at the beginning of the Setup Instructions .
You can also find the instructions and more information about the scope item in the Process Navigator in
SAP for Me.
If you want to use solution orders in SAP S/4HANA Cloud, you need to implement the scope item 4GT.
You require a separate license for SAP Event Mesh, which is used to enable the replication of subscription and
billing forecast data.
If you implement this integration, you cannot use the following services and applications with SAP Subscription
Billing:
• SAP digital payments add-on: Payments are managed in Accounts Receivable (FI-AR).
• SAP Contract Accounts Receivable and Payable (FI-CA): Payments are managed in Accounts Receivable
(FI-AR).
Integration Guide
256 PUBLIC Integration with SAP S/4HANA Cloud
5.1.1 Data Flow Overview
Overview of data flow between the applications and services that are part of the integration Subscription
Management with Sales Billing (57Z) with SAP S/4HANA Cloud:
To ensure consistency of data between the applications, business partner data must be replicated from SAP
S/4HANA Cloud to SAP Subscription Billing
Business partners in SAP S/4HANA Cloud are created as customers in SAP Subscription Billing.
• SAP Master Data Integration service (this is the recommended replication method).
For details, see SAP Master Data Integration: Business Partner Data Replication [page 358].
• SAP Cloud Integration with predefined integration content.
Note
With integration via SAP Cloud Integration, only customers with one of the following business partner
roles can be replicated from SAP S/4HANA Cloud to SAP Subscription Billing:
• FLCU01 (Customer)
• FLCU00 (Customer (Financial Accounting))
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 257
• Additional business partner roles configured in the integration flow Replicate Business Partners to
SAP Subscription Billing
Required Data
Currently, the customer number in SAP Subscription Billing must be identical to the business partner number
in SAP S/4HANA Cloud.
You must specify sales areas for the business partners in SAP S/4HANA Cloud or SAP Master Data Integration.
The sales areas maps to markets in SAP Subscription Billing.
Partner Functions
The partner information is passed on from subscriptions to billing data in SAP Subscription Billing. The payer
and bill-to party are included in the bill header, the ship-to party is included in the bill items.
To ensure consistency of data between the applications, products and rate elements must be replicated from
SAP Subscription Billing to SAP S/4HANA Cloud.
Both products and rate elements from SAP Subscription Billing are created as products in SAP S/4HANA
Cloud.
Integration Guide
258 PUBLIC Integration with SAP S/4HANA Cloud
You have the following replication options:
Note
Regardless of the option you choose, you can only use units with unit codes that are identical to ISO codes
for the units of rate elements.
Required Data
• The description length in SAP S/4HANA Cloud cannot exceed 40 characters. Longer descriptions will be
truncated accordingly.
• For rate element replication, the unit of the rate element in SAP Subscription Billing must exist as a
commercial unit in SAP S/4HANA Cloud.
• To enable the replicated products to be used, as part of the integration setup you need to additional data to
them in SAP S/4HANA Cloud as shown in the table below. You are guided to do this by the setup workflow
and instructions.
Product Type SBPD Product Type SBRE Product Type SBPD Product Type SBRE
Field Mapping
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 259
Replication with SAP Cloud Integration
product.code productInternalID
M industrySectorCode
SBPD productTypecode
product.names description
EA baseMeasureUnitCode
ratePlanElement.id productInternalID
M industrySectorCode
SBRE productTypecode
ratePlanElement.labels description
ratePlanElement.unit baseMeasureUnitCode
This page lists all of the units supported for rate elements. These are units with codes that are identical to ISO
codes, as required by the integration.
The conversion formula column indicates whether one unit can be converted to another and how.
Integration Guide
260 PUBLIC Integration with SAP S/4HANA Cloud
5.1.2.3.2 Amount of Substance
5.1.2.3.3 Area
5.1.2.3.4 Density
4O 4O Microfarad 1E-6 F
4T 4T Pikofarad 1E-12 F
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 261
5.1.2.3.6 Electrical Conductivity
5.1.2.3.10 Energy
Integration Guide
262 PUBLIC Integration with SAP S/4HANA Cloud
5.1.2.3.11 Force
5.1.2.3.12 Frequency
5.1.2.3.13 Mass Flow
5.1.2.3.14 Miscellaneous Units
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 263
5.1.2.3.15 Power
5.1.2.3.16 Pressure
5.1.2.3.17 Radioactivity
5.1.2.3.18 Speed
Integration Guide
264 PUBLIC Integration with SAP S/4HANA Cloud
5.1.2.3.19 Time
5.1.2.3.20 Volume
4G 4G Microliter 1E-9 M3
Subscriptions in SAP Subscription Billing can be automatically created from solution orders in SAP S/4HANA
Cloud.
The solution order is a business transaction for selling any combination of different products, such as physical
goods, one-time services, and long-running service contracts. To sell these product types, the solution order
offers different item types. For subscriptions, the item type is Subscription Billing Item.
If you want to create subscriptions from solution orders in SAP S/4HANA Cloud, take a look at the overview
of the end-to-end process and supported features in the Solution Order Management section of the SAP
S/4HANA Cloud documentation.
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 265
Data Exchange
The following is a summary of the communication and data flow between SAP S/4HANA Cloud solution orders
and SAP Subscription Billing. You can find detailed information about the flow in the SAP S/4HANA Cloud
documentation under Subscription Billing Items in Solution Orders and Solution Order Orchestration.
Simulation
The simulation feature for subscription billing items triggers communication between SAP S/4HANA Cloud
and SAP Subscription Billing. It retrieves, sends, and validates data relating to the subscription, including price
details, parameters, and terms.
Creation of Subscriptions
When subscription billing items are released, follow-up subscriptions are automatically created in SAP
Subscription Billing. For each subscription billing item, one subscription is created. Depending on the product
configuration, subscriptions can be created as pending.
When subscriptions are set to Active in SAP Subscription Billing, the relevant subscription billing items are set
to Completed in the solution order.
When a subscription is withdrawn in SAP Subscription Billing, the relevant subscription billing item is Rejected
in the solution order.
Note
You can't update subscription billing items in the solution order once subscriptions have been created in
SAP Subscription Billing.
Field Mapping
To see the technical mapping between subscription billing items (in solution orders) and subscriptions, see
Field Mapping in the SAP S/4HANA Cloud documentation.
To provide the required information for accounting processes and revenue recognition, the subscriptions from
SAP Subscription Billing are replicated to provider contracts in SAP S/4HANA Cloud.
A provider contract comprises all agreements regarding the provision and billing of services required for the
processing of subscriptions in the S/4HANA Cloud system.
Integration Guide
266 PUBLIC Integration with SAP S/4HANA Cloud
Context
The provider contract represents the subscription contract in SAP S/4HANA Cloud.
Replication Process
SAP Subscription Billing sends a business event with the entire subscription data via SAP Event Mesh to SAP
S/4HANA Cloud every time that you create or change a subscription. This event triggers the creation or update
of the provider contract depending on the sent data and the event type.
You can also learn more about supported business events in these articles of the API Guide:
• Business Events
• Subscription Events
Therefore, when you change the subscription in SAP Subscription Billing, the change is also replicated to the
provider contract and its items.
Example
If you extend or cancel a subscription, the end date of the respective provider contract item is updated
automatically.
Restriction
A maximum of 25,000 subscriptions per hour can be created/changed and replicated to SAP S/4HANA
Cloud. If you want to migrate data or run any other process that result in mass changes to subscriptions,
please contact SAP beforehand by creating an incident on the component CEC-SAL-SB.
To enable a seamless replication process, the subscriptions in SAP Subscription Billing are subject to the
following restrictions:
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 267
• Replicated subscriptions can't be deleted.
• Replicated subscriptions must have either an expiration date or an expected term (end).
• Pending subscriptions aren't replicated.
• Backdated cancellations and changes to replicated subscriptions aren't supported. You can cancel or
update replicated subscriptions only as of today's date.
Note
With the Subscriptions API, you can backdate subscription parameters for the Sales Billing
scenario. To learn more, see Update Subscription Parameters in the API Guide.
Product New items are created. They start on the effective date of
the subscription snapshot.
• Product sold
• Product
The items for the previous product and product sold end on
the day before the new item starts.
Field Mapping
Header
The replication generates a provider contract with the same ID as the subscription. The header fields are
mapped as follows:
• The company code of the provider contract is derived from the sales area, which is the combination of
an organization, a distribution channel and a division. You can see the sales area in the provider contract
items. The sales area is mapped with the market from SAP Subscription Billing.
Integration Guide
268 PUBLIC Integration with SAP S/4HANA Cloud
• The duration of the provider contract matches the duration of the subscription. The expiration date defines
the end of the subscription. If the subscription has no expiration date, the provider contract ends on
9999-12-31.
• Pending subscriptions aren't replicated to SAP S/4HANA Cloud. All other subscriptions are replicated and
the status of the subscription is mapped with the status Active of the provider contract.
• The subscription uses either a subscription-specific time zone, which is provided upon creation, or the
time zone of the market. The subscription time zone is mapped to the local time zone of the provider
contract. All contract-related dates, except for the create and change dates, are displayed in the local time
zone.
Status: Status:
Items
The replication generates one provider contract item per charge
• The product sold, which represents the subscription product. The product sold is mapped with the product
from SAP Subscription Billing. If a subscription item has multiple charges, multiple provider contract items
share the same product sold.
• The product, which represents an individual charge for which the subscriber pays. The product is mapped
with the rate element of the charge from the rate plan in SAP Subscription Billing. The product is unique
per item.
Example
A subscription has two items, one for the main product and one for an add-on product. Each subscription
item has three charges. In the provider contract, this structure is replicated into six provider contract items.
Three items are assigned to the main product of the first subscription item, and three items, to the add-on
product from the second subscription item.
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 269
Other fields of the provider contract item are mapped with the subscription as follows:
• The end of duration is populated based on the expected term end of the subscription.
If the subscription doesn't have an expected term, or if the expected term end is later than the expiration
date, then the end of duration of the item is populated based on the expiration date of the subscription.
• The customer reference and date are mapped with the customer purchase reference and date of the
subscription. In SAP S/4HANA Cloud, you can use the customer reference to split the billing document,
and you can also include both the reference number and date on the printed invoice.
• The charge type of the item is mapped with the rating type of the charge in SAP Subscription Billing. In SAP
S/4HANA Cloud, the rating type is used to determine the revenue recognition key for the provider contract
item in event-based revenue recognition (EBRR).
Integration Guide
270 PUBLIC Integration with SAP S/4HANA Cloud
Field Mapping of Items
Subscription Subscription Item Provider Contract Item
• Sales organization
• Distribution channel
• Division
• Company code
• Profit center
• Segment
End of duration
• Expected term end
• Expiration date
You can replicate custom references (custom fields) from the subscription header and the subscription item to
the provider contract in SAP S/4HANA Cloud.
In the S/4HANA Cloud system, in the Custom Logic app use the BAdI Subscription: Map Custom Fields
to Provider Contract (ID: FKK_EVENT_0540) in the business context Provider Contract Item to map custom
references to the custom fields of the provider contract item or to the table that contains external references in
the provider contract header.
For more information, see the documentation of the BAdI in the Custom Logic app.
To enable the replication of subscriptions from SAP Subscription Billing to provider contracts in SAP S/4HANA
Cloud, the subscriptions must have certain data.
If you're using the integration scenario with Solution Order Management, the subscriptions created from a
solution order already fulfill the requirements due to the settings that you've made during the integration setup
and the required data for solution orders. If you're not using Solution Order Management, ensure that your
subscriptions fulfill the requirements as described here.
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 271
Prerequisites
• You've defined the required settings for markets and subscription profiles in Business Configuration.
These settings are described in the scope item setup instructions.
• You've created products of subscription type Commercial in the Manage Products app.
Note
Details
Subscription profile Assign a subscription profile for which replication of subscriptions to provider contracts is
activated.
Recommendation
Product Assign a product of subscription type Commercial. This subscription type ensures that the
provider contract items are billed and printed on the invoice.
Duration (subscription Specify the duration of the subscription via the subscription terms. If your subscriptions are
terms)
open-ended, use the expected term to indicate the projected duration. You can predefine
the terms via the product or define specific terms for individual subscriptions.
The following term end dates are used to set the end of duration of the provider contract
items:
When the subscriptions are created, they appear on the Manage Subscriptions app. In the subscription header
you see the reference to the replicated provider contract, under General Info Processing Data . In this tab
you can also see the integration settings of the assigned subscription profile.
Integration Guide
272 PUBLIC Integration with SAP S/4HANA Cloud
5.1.4.2 Provider Contract for Sales Billing
To process subscriptions in the S/4HANA Cloud system, provider contracts for Sales Billing are created in the
S/4HANA Cloud system via replication of subscriptions from SAP Subscription Billing.
The replicated provider contracts comprise all agreements regarding the provision and billing of services
required for the processing of subscriptions in the S/4HANA Cloud system.
Structure
A provider contract relates to exactly one business partner. A provider contract consists of a contract header
and contract items.
Header
The header of the provider contract contains the following data:
Note
If the subscription doesn't have an expiration date, the provider contract end date is set to 12/31/9999.
• Time zone
• Managing company code (used for authorization checks)
• Sender (SAP Subscription Billing)
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 273
• Status
Only the status active is replicated from SAP Subscription Billing.
Contract Items
The header of each provider contract references the contract items. Each provider contract item represents a
charge from a subscription item.
Using the Display Provider Contract for Sales Billing app, you can display provider contracts in the S/4HANA
Cloud system as follows:
The General Data tab page displays general information about the contract that is valid for all items, such as
the time zone status of the contract and the contract start date and end date.
The tab pages for the contract item data show in the upper area either all contract items, or the items of the
provider contract that are valid at the time of validity.
Note
The system displays the contract items in the ABAP List Viewer (ALV). To change the display, use the layout
functions of the ABAP List Viewer.
Integration Guide
274 PUBLIC Integration with SAP S/4HANA Cloud
When you click on a contract item, the system displays the data for the selected item in the lower area of
the screen:
The Items: General Data tab page displays the following information:
The Items: Account Assignments tab page displays the following information:
• Organizational data
• The default account assignments derived from the system settings in the configuration activity Define
Specifications for the Derivation of Standard Account Assignment (such as the company code)
• Products included
Via API, Sales Billing receives billing data from SAP Subscription Billing and creates billing document requests
(BDR). These billing document requests contain a reference to a provider contract item.
With the billing documents created, the provider contract item reference is transferred with the profitability
segment to general ledger in Finance. For more details, please see Forwarding Billing Data to Financial
Accounting.
In the apps available for processing and displaying billing documents, as well as for the transfer of data to
Finance, Sales Billing displays the provider contract reference.
Related Information
To provide the required information for accounting processes and revenue recognition, the billing forecasts
from SAP Subscription Billing are replicated to billing plans in SAP S/4HANA Cloud.
Billing Plan
In SAP S/4HANA Cloud, a billing plan in Convergent Invoicing defines when and how often an amount is
invoiced to a customer.
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 275
• A billing plan consists of a billing plan header and billing plan items. The header of each billing plan
references the billing plan items.
• Billing plan items contain one or more items with the amount due, billing cycle, and validity period.
Context
Billing forecasts in SAP Subscription Billing provide an estimate of the charges that are expected for
subscription items during a specified period. This simulated outlook on future billing cycles of a subscription
allows users to have a better idea of their upcoming subscription revenue. For more information, see Billing
Forecasts in the Feature Overview.
In SAP S/4HANA Cloud, a billing plan represents the billing forecast for a subscription. It contains the forecast
data that is required for revenue recognition.
Note
Billing plans that are created from a subscription in SAP Subscription Billing are not integrated in other
processes of Convergent Invoicing, such as the request of billing plan items for billing.
Replicated billing plans can only have the status Open. Replicated billing plan items can only have the
status Not Yet Requested.
Replication Process
SAP Subscription Billing sends a business event with the entire billing forecast data via SAP Event Mesh to SAP
S/4HANA Cloud every time that a billing forecast is created or changed. This event triggers the creation or
update of the billing plan depending on the sent data and the event type.
You can also learn more about supported events in these articles of the API Guide:
• Business Events
• Billing Forecast Events
Note
To enable a seamless replication process, billing plans that have been replicated from billing forecasts in
SAP Subscription Billing cannot be deleted.
Restriction
A maximum of 165,000 billing forecasts per hour can be created/changed and replicated to SAP S/4HANA
Cloud. If you want to migrate data or run any other process that result in mass changes to billing forecasts,
please contact SAP beforehand by creating an incident on the component CEC-SAL-SB.
Only the billing forecasts for a subscription whose price type is Net can be replicated to billing plans.
Integration Guide
276 PUBLIC Integration with SAP S/4HANA Cloud
Field Mapping
subscriptionDocumentId Contract
subscriptionVersion Version
Billing Plan Category Billing Plan for Provider Contract without request (BIPV1)
Billing Plan Type If Contract Category =Provider Contract: Billing Plan for
Provider Contract (no request) (SBPC1)
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 277
Billing Forecast Billing Plan Item
forecast-item-monetaryAmount-taxIncluded Gross
subscriptionDocumentId Contract
forecast-item-pricingElements- Amount
conditionValue-amount
forecast-item-pricingElements- Currency
conditionValue-currency
Integration Guide
278 PUBLIC Integration with SAP S/4HANA Cloud
5.1.6 Transfer of Billing Data to Sales Billing
Preparatory billing data in SAP Subscription Billing is transferred to SAP S/4HANA Cloud or SAP S/4HANA
(both referred to below as "SAP S/4HANA") where it is used in subsequent billing, invoicing, and financial
processes.
Transfer to Sales Billing takes place via SAP Cloud Integration, using predefined integration content.
• Billing data stored in bills is transferred to SAP S/4HANA, resulting in the creation of subscription billing
document requests in Sales Billing. These are external billing document requests (BDRs) of the type SBDR.
• The IDs of the BDRs are transferred back to SAP Subscription Billing. In the Manage Billing Data app of SAP
Subscription Billing, the successor document ID and successor system are displayed for the replicated bills
on the Transfer tab.
The replication is done by the asynchronous inbound service SUBSCRIPTIONBDRREQUEST_IN using SOAP
messages.
Each item in a bill has one or more charges or credits. These are mapped as follows in Sales Billing:
Field Mapping
In the standard integration flow, the fields are mapped as follows in the service
SUBSCRIPTIONBDRREQUEST_IN:
CreationDateTime Date and time (timestamp) when the message was created
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 279
Node 3: Action Control (ActionControl)
AllItemsOfBllbleDocAreProcessableChk 1
Value
Example: 001000
Example: 001001
SalesDocumentType SBD
BillingDocumentRequestType SBDR
Integration Guide
280 PUBLIC Integration with SAP S/4HANA Cloud
Value
externalObjectRefer
ences[externalIdTyp
eCode=sap.sb.custom
er-purchase-
reference.id].exter
nalId
HigherLevelItem The
ReferenceDocumentItem
of the main item.
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 281
Value
externalObjectRefer
ences[externalIdTyp
eCode=sap.s4.soluti
on-order-
management.order.id
].externalId
externalObjectRefer
ences[externalIdTyp
eCode=sap.s4.soluti
on-order-
management.order.it
em.id].externalId
externalObjectRefer
ences[externalIdTyp
eCode=sap.s4.provid
er-
contract.item.id].e
xternalId
externalObjectRefer
ences[externalIdTyp
eCode=
sap.s4.pricing-
procedure.id].exter
nalId
Integration Guide
282 PUBLIC Integration with SAP S/4HANA Cloud
Value
ConditionQuantity 1
Note
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 283
Value
Note
If bill items have different general data, for example different customer purchase orders, they are split into
different BDRs in SAP S/4HANA. For more information, see the Sales Billing documentation:
SAP S/4HANA
Example
A bill has 2 bill items, each with 3 charges. In the subscription billing document request, this bill is replicated
into 8 billing document items. For each bill item there is a main item with the subscription product and 3
subitems with corresponding rate elements for each charge.
Bill
R-RECURRING USD 20 20
Integration Guide
284 PUBLIC Integration with SAP S/4HANA Cloud
Higher-Level Billing Quan Item Net
Item Item ID Product Item Category Item tity Amount
To enable financial accounting, controlling, and revenue accounting for subscriptions, data is transferred from
SAP Subscription Billing to SAP S/4HANA Cloud and made available in SAP S/4HANA Cloud Finance.
The items of the provider contract store additional attributes that are relevant for follow-on processes in SAP
S/4HANA Cloud Finance, including:
The provider contract becomes part of the market segment and the journal, and is the basis for profitability
analysis in SAP S/4HANA Cloud for subscriptions.
For more information, see Replication of Subscriptions to Provider Contracts [page 266].
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 285
For more information, see the section Event-Based Revenue Recognition [page 286] below and also Replication
of Billing Forecasts to Billing Plans [page 275].
To enable analysis of how well a product sells, in SAP S/4HANA Cloud Finance the top-level product is mapped
to the product sold while the sub-level products are passed through as "products used". From the top-level
product, the revenue recognition key can be derived, for example.
For more information, see Replication of Products and Rate Elements [page 258].
If event-based revenue recognition is used, the billed revenue from the invoice is deferred.
For more information, see Transfer of Billing Data to Sales Billing [page 279].
Financial Accounting
When billing document requests (BDRs) are invoiced in SAP S/4HANA Cloud Sales Billing, the provider
contract item reference is transferred along with the profitability segment to general ledger entries in Finance.
For more information, see Forwarding Billing Data to Financial Accounting in the Sales Billing documentation.
Particularly in subscription scenarios, a common requirement is to recognize revenue as it's earned, for
example as the service is consumed by the customer. In this case, event-based revenue recognition (EBRR)
can be used to accrue revenue according to the fulfillment progress, independently from billing. A prerequisite
for EBRR is that the expected total contract value is known. To this effect, billing forecasts in SAP Subscription
Billing provide estimates of predicted billable amounts during a given time frame. Billing forecasts are mapped
to billing plans in SAP S/4HANA Cloud, which in turn are referenced in the provider contract item.
Integration Guide
286 PUBLIC Integration with SAP S/4HANA Cloud
For more information, see Event-Based Revenue Recognition for Provider Contracts in the Finance
documentation.
Note
Margin Analysis
The tight integration of subscription-related data into accounting and controlling allows margin analysis of
revenues and cost not only on subscription level but also combined on the aggregated level of the solution
order.
You need to make specific settings to enable the integration of SAP Subscription Billing apps with the SAP Fiori
launchpad of SAP S/4HANA Cloud.
When integrating SAP Subscription Billing and SAP S/4HANA Cloud with scope items Subscription
Management with Convergent Invoicing (5IK) or Subscription Management with Sales Billing (57Z), the SAP
Subscription Billing apps can be made available in the SAP S/4HANA Cloud launchpad for business users. To
achieve this, you have to make user management settings in both systems.
For more information about the integration with scope items 5IK and 57Z, see Integration with SAP S/4HANA
Cloud [page 253] in the SAP Subscription Billing Integration Guide. The same guide also includes information
about the general setup of the scope items Setup for 57Z and Setup for 5IK.
Authentication
As SAP Subscription Billing is an SAP Business Technology Platform (SAP BTP) application, user management
settings have to be done in the SAP BTP Cockpit. On SAP BTP, identity information is provided by identity
providers (IdPs) and not stored on SAP BTP itself. Accordingly, authentication of business users to access
the SAP Subscription Billing user interface is delegated to the identity providers, and users log on with
the mechanisms and credentials defined there: for example, with their username and password. Identity
information can also be stored in the SAP Authorization and Trust Management service per SAP BTP
subaccount. For more information, see SAP Authorization and Trust Management Service in the Cloud Foundry
Environment.
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 287
For the integration with SAP S/4HANA Cloud, SAP Cloud Identity Services - Identity Authentication takes
the role of a proxy for your corporate identity provider as described in Secure Authentication. Connect the
SAP Subscription Billing test and quality tenants to the SAP Cloud Identity Services test tenant, and the
SAP Subscription Billing production tenant to the SAP Cloud Identity Services production tenant. For more
information on SAP Subscription Billing user management settings, see SAP BTP Configuration Guide.
User Authorization
To make SAP Subscription Billing apps available in the SAP S/4HANA Cloud launchpad for business users, you
first define your business roles and then you authorize users.
You assign business catalogs to business roles that are assigned to users. For more information about the
authorization concept in SAP S/4HANA Cloud, see Authorization Concept for Business Users.
In your SAP S/4HANA Cloud system, you can find the business role templates and the relevant business
catalogs for the integration with scope items 5IK and 57Z. Usually, assigning a business role to a business user
gives that user access rights to the apps nested in the assigned business roles. As access to SAP Subscription
Billing apps is configured in the SAP BTP cockpit, those settings have to be made additionally.
The mapping between the SAP Subscription Billing business role templates and business catalogs in SAP
S/4HANA Cloud and the SAP Subscription Billing apps are listed in the table below. You need to know this
information for the authorization step. For access to each SAP Subscription Billing app, users need certain role
assignments.
1. Decide which business catalog in SAP S/4HANA Cloud you require for your integration.
2. Check which SAP Subscription Billing apps are assigned to this catalog.
3. Look up which roles are needed for the user to access the apps. All apps and roles are listed in the section
Roles for SAP Subscription Billing under Build Role Collections.
4. Assign the relevant SAP Subscription Billing roles to the user in the SAP BTP Cockpit. Follow the procedure
described in the SAP BTP Configuration Guide.
Subscription Specialist Subscription Billing - Billing Data Processing Manage Billing Data
(Subscription Billing)
(SAP_CEC_BC_SBL_BILLDATA_PC) Manage Usage Records
(SAP_BR_SUBSCR_BILLG_SPC
LST)
Billing Clerk
(SAP_BR_BILLING_CLERK)
Integration Guide
288 PUBLIC Integration with SAP S/4HANA Cloud
Business Role Template in SAP SAP Subscription Billing Apps As
S/4HANA Cloud Business Catalog in SAP S/4HANA Cloud signed to the Catalog
(SAP_BR_INVOICING_SPEC_C
INV)
Billing Clerk
(SAP_BR_BILLING_CLERK)
(SAP_BR_SOLN_ORDER_SPCLS
T)
(Subscription Billing)
(SAP_CEC_BC_SBL_CONFIG_PC)
(SAP_BR_CONFIG_EXPERT_SB
L)
Configuration Expert Subscription Billing - Rate Plan Template Manage Rate Plan Templates
(SAP_BR_CONFIG_EXPERT_SB (SAP_CEC_BC_SBL_PRICECFG_PC)
L)
Pricing Specialist (Subscription Subscription Billing - Product and Price Manage Allowance Templates
Billing) Processing
Manage Products
(SAP_BR_PRICING_SPCLST_S (SAP_CEC_BC_SBL_PRODUCT_PC)
Manage Rate Plans
BL)
Billing)
(SAP_CEC_BC_SBL_RATING_PC)
(SAP_BR_PRICING_SPCLST_S
BL)
Subscription Specialist
(Subscription Billing)
(SAP_BR_SUBSCR_BILLG_SPC
LST)
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 289
Business Role Template in SAP SAP Subscription Billing Apps As
S/4HANA Cloud Business Catalog in SAP S/4HANA Cloud signed to the Catalog
(SAP_BR_ADMIN_APR_FICA) (SAP_FICA_BC_SBL_SUBSCRIP_PC)
(SAP_BR_APR_ACCOUNTANT_F
ICA)
(SAP_BR_COLL_SPECIALIST_
FICA)
(SAP_BR_EXT_AUDITOR_APR_
FICA)
Reconciliation Specialist -
Accounts Payable and
Receivable (FI-CA)
(SAP_BR_RECONC_SPEC_APR_
FICA)
Authorize Users
Role collections control user authorization for the SAP Subscription Billing apps and their data. To define
authorizations, you create role collections and assign these to business users as described in the SAP BTP
Configuration Guide under Enable UI Access Build role collections .
Authorize SAP Subscription Billing users for the integration with SAP S/4HANA Cloud, by creating role
collections in the SAP BTP Cockpit, in the subaccount in which the SAP Subscription Billing tenant is
subscribed.
See the topic Build Role Collections for a list of which role templates are needed for giving users basic view
or manage authorization for each SAP Subscription Billing app. Make sure you include all the necessary role
templates in the role collection for each app that you want the user to have access to. Depending on your use
case, you can add additional authorizations to enhance the basic roles mentioned in the table.
By defining authorizations for markets, you can restrict user access to certain markets only. SAP Subscription
Billing markets are mapped to SAP S/4HANA sales areas as part of the integration of SAP Subscription Billing.
For more information on market authorizations, see Market Authorizations in Build Role Collections.
Integration Guide
290 PUBLIC Integration with SAP S/4HANA Cloud
Launchpad Setup
You need to make the following settings to configure the joint Fiori launchpad for SAP Subscription Billing and
SAP S/4HANA Cloud.
Communication Scenario
As part of the setup of scope items 57Z and 5IK, you create communication arrangements in your SAP S/
4HANA Cloud system that are based on communication scenarios, including communication scenarios that
are relevant for the joint launchpad. Some communication scenario requirements differ depending on whether
you are configuring the launchpad for a new or existing integration.
Set up the joint launchpad for a new integration
1. Create a communication arrangement from the communication scenario Subscription and Provider
Contract Integration (SAP_COM_0642).
This communication scenario includes a deprecated user interface navigation link and the REST calls from
SAP S/4HANA Cloud to SAP Subscription Billing.
2. Deactivate the deprecated user interface link service in the newly created communication arrangement.
3. Create a second communication arrangement from the communication scenario SAP Subscription Billing
- UI Integration (SAP_COM_0845) for the new user interface navigation between SAP S/4HANA Cloud and
SAP Subscription Billing.
Migrate from the standalone SAP Subscription Billing launchpad to the integrated launchpad with SAP
S/4HANA Cloud
If you already have an existing integration, be aware that the user interface navigation part of the
communication scenario SAP_COM_0642 is deprecated. You need to move your existing user interface
navigation from the communication scenario SAP_COM_0642 to the communication scenario SAP_COM_0845.
1. Deactivate the deprecated outbound service user interface link from your existing communication
arrangement that was created from the communication scenario Subscription and Provider Contract
Integration (SAP_COM_0642).
2. Create a communication arrangement from the communication scenario SAP Subscription Billing - UI
Integration (SAP_COM_0845) for the user interface navigation between SAP S/4HANA Cloud and SAP
Subscription Billing.
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 291
5.1.9 Integration-Specific Data in SAP Subscription Billing
If you implement Subscription Management with Sales Billing, data related to SAP S/4HANA Cloud is available
in SAP Subscription Billing.
Customers
The IDs of business partners replicated from SAP S/4HANA Cloud or SAP Master Data Integration are stored
as external object references.
Subscriptions
• Subscription terms: In the solution order you indicate the duration of the subscription via one of the
following terms. The duration is used to calculate the total contract value of the subscription billing item.
• Fixed Term: Determines the default length of the subscription and sets the expiration date, which
marks the first day on which the subscription is no longer active.
• Expected Term: Determines the projected end date of the subscription. If the subscription has no
expiration date, the expected term end is used for the total contract value instead.
Note
In SAP S/4HANA Cloud, the total contract value of the subscription appears in Solution Order
Management and in Revenue Recognition.
• Partners: In the solution order you indicate the involved parties (business partners), which are transferred
to the subscription. The sold-to party becomes the customer of the subscription, whereas the payer, the
bill-to party, and the ship-to party are added to the subscription.
• Related documents: In the subscription header you see the following:
• The solution order from which the subscription was generated.
• The reference and date from the customer to a purchase order. In the solution order, the purchase
order number is stored under External Reference; in the subscription, under Customer Purchase
Reference.
Sales Billing
• Related documents: In the subscription you see the reference to the replicated provider contract.
• Subscription settings: In the assigned subscription profile you see the prefix of the subscription ID, which
is the same for the provider contract ID.
Integration Guide
292 PUBLIC Integration with SAP S/4HANA Cloud
Bills
In addition to the standard set of data that is required for billing and invoicing, bills for this integration contain
the following specific references:
Sales Billing
• Provider contract: Included in the bill item and it's charges/credits, originates in the subscription item. *
• Successor document: Included in the transfer data of relevant bills. This is the subscription billing
document request (SBDR) in SAP S/4HANA Cloud.
Depending on the data that's replicated and the replication method, you have different monitoring options.
You can use SAP Cloud ALM to monitor the status of data replication via SAP Master Data Integration for the
following objects:
• Business partners
• Products (for products, you can also use monitoring in SAP S/4HANA Cloud)
In SAP S/4HANA Cloud you can monitor data replication via SAP Cloud Integration for the following objects:
• Business partners
• Products (for products, you can also monitor replication via SAP Master Data Integration)
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 293
• Provider contracts
• Billing plans
• Subscription billing document requests
You can use the following monitoring apps from the business catalog Communication Management - Message
Monitoring and Error Handling (SAP_CA_BC_COM_ERR_PC):
• Message Dashboard
• Message Monitoring
You can select the following specific interfaces to check detailed messages:
/CMDBP – BPCONF_IN
/CMDPR– PRDCONFOUT
/SDBIL – BDR_S_C_OU
Prerequisites
In the Assign Recipients to Users app in SAP S/4HANA Cloud, assign the following recipients from the business
catalog Communication Management - Message Monitoring Configuration (SAP_CA_BC_COM_CONF_PC) to the
users that monitor the replication:
Integration Guide
294 PUBLIC Integration with SAP S/4HANA Cloud
Data to be Monitored Namespace Recipient Name
SDBIL_BDR_S_C_OU_RECIPIENT
More Information
Message Monitoring
5.1.11 Troubleshooting
Provider contracts and billing plans are not/no longer being created or updated when
subscriptions are created or updated
How to resolve: Check the Setup and Consumption of Business Events [page 296]
5.1.11.1 Reporting Issues
When you report an issue to SAP, choose the relevant component as follows.
Functionality Component
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 295
Functionality Component
SAP S/4HANA integration content (use if you know that the CA-GTF-INT
issue is caused by the predefined integration content)
If you discover an issue with SAP Event Mesh that you can't resolve using the instructions below, please create
an incident on the component BC-CP-EM-MES.
Subscriptions and billing forecasts are replicated from SAP Subscription Billing to SAP S/4HANA Cloud
via business events. For event consumption in SAP S/4HANA Cloud, a communication arrangement for
communication scenario SAP_COM_0092 is required and the channel must be active.
With the communication arrangement for scenario ID SAP_COM_0092, an active channel is established for the
consumption of events from SAP Event Mesh. The event configuration defines which events are consumed
from a queue that you have set up for this integration.
To check event configuration for the SAP Event Mesh default plan:
Integration Guide
296 PUBLIC Integration with SAP S/4HANA Cloud
2. Open the Enterprise Event Enablement – Configure Channel Binding app from the launchpad.
3. Choose Go and select the channel for the SAP Subscription Billing integration. The name of this channel
corresponds to the name of the communication arrangement for event messaging (SAP_COM_0092).
If the channel is missing, the communication arrangement for event messaging has not been set up. You
need to complete the setup as described in the setup instructions or setup workflow for the scope item.
4. If the channel for the integration exists, check the following:
• Under Subscriptions: You should see subscriptions to a queue with the status Acknowledged for both
subscription events and billing forecast events.
• Under Inbound Topics: You should see the following inbound topic bindings with the status OK
sap/billing/sb/subscription/*
sap/billing/sb/billingForecast/*
If a queue subscription has the status Inactive or New, no events are being consumed by SAP S/4HANA
Cloud and the events will remain in the queue in SAP Event Mesh. You can try to resolve this by reactivating
event consumption as described in Reactivate event consumption in SAP S/4HANA Cloud [page 297]. A
subscription to a queue is New while a check runs to ensure that the queue exists. If a queue subscription
is Inactive, the event channel created by the communication arrangement is not active.
If the queue subscription has the status Rejected, either the queue does not exist or it was not part of
the same Event Mesh instance as the service key when you created the SAP_COM_0092 communication
arrangement. If the status was Acknowledged before, but changed recently to Rejected, that either the
Event Mesh instance from the communication arrangement was updated or the queue was deleted. Check
the queue name in the Event Mesh user interface:
1. Access the Event Mesh user interface and select the messaging client:
1. Open the SAP BTP cockpit and choose your global account and subaccount.
2. Choose Services Instances and Subscriptions in the navigation pane.
3. In the list of subscriptions, choose the Go to Application icon for the Event Mesh application.
The Event Mesh user interface opens.
4. Expand Default Plan and choose Message Clients.
You see a tile for each Event Mesh subscription and instance of the default plan of your
subaccount.
5. Select the relevant tile for your messaging client (type Instance).
2. Choose Queues and check the queue name.
The easiest way to do this is to reactivate the communication arrangement in the list of communication
arrangements:
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 297
2. Open the Communication Arrangements app from the launchpad.
All existing communication arrangements are listed on the initial screen.
3. Enter SAP_COM_0092 in the Scenario ID filter field and choose Go.
4. Select the relevant communication arrangement in the list and choose Reactivate.
Note
Use a single queue for subscription events and billing forecast events. If more than one queue is created,
the system will face performance issues and events will be received in the wrong sequence. This is a critical
issue during mass operations and billing forecast events will be registered in the Application Interface
Framework (AIF) where can events are monitored and managed.
1. Access the Event Mesh user interface and select the messaging client:
1. Open the SAP BTP cockpit and choose your global account and subaccount.
2. Choose Services Instances and Subscriptions in the navigation pane.
3. In the list of subscriptions, choose the Go to Application icon for the Event Mesh application.
The Event Mesh user interface opens.
4. Expand Default Plan and choose Message Clients.
You see a tile for each Event Mesh subscription and instance of the default plan of your subaccount.
5. Select the relevant tile for your messaging client (type Instance).
2. Select the queue defined for the integration of SAP Subscription Billing and S/4HANA Cloud.
3. Under Actions, select Queue Subscriptions.
4. Ensure that the following topics are subscribed:
sap/billing/sb/ce/sap/billing/sb/subscription/created/v1
sap/billing/sb/ce/sap/billing/sb/subscription/canceled/v1
sap/billing/sb/ce/sap/billing/sb/subscription/cancellationReversed/v1
sap/billing/sb/ce/sap/billing/sb/subscription/extended/v1
sap/billing/sb/ce/sap/billing/sb/subscription/withdrawn/v1
sap/billing/sb/ce/sap/billing/sb/subscription/productChanged/v1
sap/billing/sb/ce/sap/billing/sb/subscription/productOptionsAdded/v1
sap/billing/sb/ce/sap/billing/sb/subscription/productOptionsRemoved/v1
sap/billing/sb/ce/sap/billing/sb/subscription/changed/v1
sap/billing/sb/ce/sap/billing/sb/subscription/deleted/v1
sap/billing/sb/ce/sap/billing/sb/subscription/createdAsPending/v1
sap/billing/sb/ce/sap/billing/sb/subscription/changedAsPending/v1
sap/billing/sb/ce/sap/billing/sb/subscription/deletedAsPending/v1
sap/billing/sb/ce/sap/billing/sb/billingForecast/created/v1
sap/billing/sb/ce/sap/billing/sb/billingForecast/changed/v1
Integration Guide
298 PUBLIC Integration with SAP S/4HANA Cloud
Check whether events are stuck in the SAP Event Mesh queue
You can use the Event Mesh user interface to check the queues for the SAP Event Mesh default plan. Make sure
that your user has at minimum the role ReadRole (see User Roles for Event Mesh).
1. Access the Event Mesh user interface and select the messaging client:
1. Open the SAP BTP cockpit and choose your global account and subaccount.
2. Choose Services Instances and Subscriptions in the navigation pane.
3. In the list of subscriptions, choose the Go to Application icon for the Event Mesh application.
The Event Mesh user interface opens.
4. Expand Default Plan and choose Message Clients.
You see a tile for each Event Mesh subscription and instance of the default plan of your subaccount.
5. Select the relevant tile for your messaging client (type Instance).
2. Choose Queues and check that the queues configured for consumption in SAP S/4HANA Cloud have 0
messages. Other queues that may have been created for monitoring reasons can contain messages.
3. If there are messages in the queues and these remain when you choose Refresh, this could be an indication
that event consumption in SAP S/4HANA Cloud is not working properly. You can try to resolve this by
reactivating event consumption as described under Reactivate event consumption in SAP S/4HANA Cloud
[page 297].
Check if / how many events are being sent via SAP Event Mesh
To have a better overview of whether events are being sent through the SAP Event Mesh default plan and how
many events are being sent, it can help to create monitoring queues.
Monitoring queues are normal queues which subscribe to the same event types as the queue for consumption
by SAP S/4HANA Cloud, but which are not registered for consumption in SAP S/4HANA Cloud or by any
other consumer. Events published by SAP Subscription Billing will remain in the monitoring queues and can be
checked in the Event Mesh user interface. You can also check the event payload.
Recommendation
To avoid unnecessary effort, we recommend that you only set up monitoring queues in error situations or if
the initial setup does not work and you want to check whether events are reaching SAP Event Mesh.
Use the Event Mesh user interface to create queues. Make sure that your user has the role ManageRole (see
User Roles for Event Mesh).
Tip
While only one queue should be used for consuming subscription and billing forecast events in SAP S/
4HANA Cloud, for the purpose of monitoring, we recommend creating 2 separate monitoring queues. This
provides better transparency regarding whether and how many subscription and billing forecast events are
being sent from SAP Subscription Billing to SAP Event Mesh.
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 299
1. Access the Event Mesh user interface and select the messaging client:
1. Open the SAP BTP cockpit and choose your global account and subaccount.
2. Choose Services Instances and Subscriptions in the navigation pane.
3. In the list of subscriptions, choose the Go to Application icon for the Event Mesh application.
The Event Mesh user interface opens.
4. Expand Default Plan and choose Message Clients.
You see a tile for each Event Mesh subscription and instance of the default plan of your subaccount.
5. Select the relevant tile for your messaging client (type Instance).
2. Choose the Queues tab.
3. In the dialog box, enter a queue name and choose Create.
For example, you can use the following name patterns:
• <namespace>/subscriptions4monitoring for subscription events
• <namespace>/billingforecasts4monitoring for billing forecast events
4. For each queue, go to Actions Queue Subscriptions .
In the dialog box, enter the following topic names:
For the subscription event monitoring queue:
• sap/billing/sb/ce/sap/billing/sb/subscription/*
Note
The wild card (*) includes topics for all subscription events. Therefore, ensure that only those
subscription event topics that are relevant for the integration are subscribed in the queue. You can
find a list of relevant topics under Check the queue configuration with Event Mesh user interface
[page 298].
Events will be collected in these queues as they are not consumed, giving you a good overview. From time to
time, you should clear the queue (under Actions, choose Purge Messages).
If needed, you can check the event payload in the Event Mesh user interface. Make sure that your user has at
minimum the role ReadRole (see User Roles for Event Mesh):
1. Access the Event Mesh user interface and select the messaging client:
1. Open the SAP BTP cockpit and choose your global account and subaccount.
2. Choose Services Instances and Subscriptions in the navigation pane.
3. In the list of subscriptions, choose the Go to Application icon for the Event Mesh application.
The Event Mesh user interface opens.
4. Expand Default Plan and choose Message Clients.
You see a tile for each Event Mesh subscription and instance of the default plan of your subaccount.
5. Select the relevant tile for your messaging client (type Instance).
2. Choose the Test tab in the main view (not the navigation panel).
3. Under Consume Messages, select Queue and enter the name of the monitoring queue.
4. Choose Consume Messages and check the message data that appears.
Integration Guide
300 PUBLIC Integration with SAP S/4HANA Cloud
Check event messaging while triggering events
Instead of using a monitoring queue, you can also check "live" (while triggering events) whether events are
processed by SAP Event Mesh. Use the Event Mesh user interface to do this. Make sure that your user has the
role TestRole (see User Roles for Event Mesh).
1. Access the Event Mesh user interface and select the messaging client:
1. Open the SAP BTP cockpit and choose your global account and subaccount.
2. Choose Services Instances and Subscriptions in the navigation pane.
3. In the list of subscriptions, choose the Go to Application icon for the Event Mesh application.
The Event Mesh user interface opens.
4. Expand Default Plan and choose Message Clients.
You see a tile for each Event Mesh subscription and instance of the default plan of your subaccount.
5. Select the relevant tile for your messaging client (type Instance).
2. Choose the Queues tab.
3. Choose Refresh while triggering events in SAP Subscription Billing.
If events reach SAP Event Mesh, you will see the messages in the consumed queue changing to 1 and then
back to 0.
If you have integrated SAP Subscription Billing and SAP S/4HANA Cloud and want to stop using SAP
Subscription Billing, you need to ensure that certain prerequisites are fulfilled beforehand.
Before discontinuing usage of SAP Subscription Billing, use APIs to extract all the data that you require going
forward:
• You must extract billing data for future auditing purposes, using the Bills API (GET on /bills).
After you stop using SAP Subscription Billing, you'll no longer have an audit trail for billable items via
navigation to the relevant bill.
• You can use the Subscriptions API (GET on /subscriptions) to extract subscription data if required.
After you stop using SAP Subscription Billing, no change history is available for subscriptions.
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 301
SAP S/4HANA Cloud
• You must roll back the integration for scope item 57Z, including adjusting Customizing and deactivating
communication arrangements.
• All solution order items with open subscription billing items must be in status Completed (either the items
must be deleted or the subscription processing completed).
• All products that were replicated from SAP Subscription Billing must be marked for deletion.
Products that are marked for deletion are deleted during archiving if all business transactions in which they
are used have been concluded.
If you use the SAP Master Data Integration [page 355] service for master data replication, you must roll back
integration with this service.
After Discontinuation
• Navigation between transactions and business documents in the other systems is no longer available.
Once the communication arrangement is deactivated, navigation links disappear.
• No change history is available for subscriptions. Therefore, if you require historical data you should use an
API to extract it before discontinuation.
This integration enables the transfer of billing and subscription data from SAP Subscription Billing to SAP
S/4HANA Cloud Convergent Invoicing, with subsequent financial processes. Convergent invoicing supports the
consolidation of charges from multiple billing streams into invoices.
This integration is enabled by the SAP Best Practices scope item 5IK.
Note
This integration supports pricing in SAP Subscription Billing with pricing schemes only.
Business Process
Integration Guide
302 PUBLIC Integration with SAP S/4HANA Cloud
1. Creation of subscriptions in SAP Subscription Billing from upstream applications, via APIs.
2. Management of subscriptions in SAP Subscription Billing.
3. Collection of usage records and automated rating of usage, recurring, and one-time charges in SAP
Subscription Billing.
4. Transfer of billing data from SAP Subscription Billing to SAP S/4HANA Cloud Convergent Invoicing,
resulting in the creation of billable items and consumption items.
Customer invoices are created to consolidate charges from multiple sources.
Financial Processes
Accounting-relevant billing data in billable items is forwarded from invoices in Convergent Invoicing to SAP S/
4HANA Cloud Financials. Supported financial processes include receivables management, margin and revenue
analysis on subscription level, as well as contract-based revenue recognition (CBRR).
To provide further information for financial processes, the following objects are created automatically in SAP
S/4HANA Cloud:
Integrated Data
You can find a graphical overview in Data Flow Overview [page 305].
• Business partners in SAP S/4HANA Cloud or SAP Master Data Integration are replicated as customers in
SAP Subscription Billing.
• Products and rate elements in SAP Subscription Billing are replicated as products in SAP S/4HANA
Cloud.
• Subscriptions in SAP Subscription Billing are replicated as provider contracts in SAP S/4HANA Cloud.
• Billing forecasts are replicated as billing plans in SAP S/4HANA Cloud.
• Billing data in SAP Subscription Billing is replicated as billable items and consumption items in SAP
S/4HANA Cloud.
Restrictions
• A maximum of 25,000 subscriptions per hour can be created/changed and replicated to provider
contracts in SAP S/4HANA Cloud. If you want to migrate data or run any other process that result in
mass changes to subscriptions, please contact SAP beforehand by creating an incident on the component
CEC-SAL-SB. In addition, the general technical constraints of the SAP Event Mesh default plan apply.
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 303
• A maximum of 165,000 billing forecasts per hour can be created/changed and replicated to SAP S/4HANA
Cloud. If you want to migrate data or run any other process that result in mass changes to billing forecasts,
please contact SAP beforehand by creating an incident on the component CEC-SAL-SB.
• A maximum of 100 usage records per charge or credit can be replicated as consumption items in SAP
S/4HANA Cloud.
• For the integration of SAP Subscription Billing with the SAP Data Retention Manager service and SAP
Personal Data Manager service, a legal entity (on which basis the data residence and retention periods
are defined) corresponds to an SAP BTP subaccount. As there can only be one subaccount for an SAP
Subscription Billing tenant, the tenant is restricted to one legal entity. Accordingly, if different markets in
SAP Subscription Billing map to SAP S/4HANA sales areas for which the sales organizations belong to
different legal entities, this cannot be reflected in the data protection functionality for SAP Subscription
Billing. This is also the case for integration with S/4HANA Cloud. While you can restrict the access of
business users in the SAP Subscription Billing user interface based on markets, the SAP Data Retention
Manager service and SAP Personal Data Manager service provide access to all data of all markets. The use
of data protection functionality for SAP Subscription Billing therefore assumes that the data of only one
data controller is being processed within the tenant. For more information, see Deletion of Personal Data
(section Integrated Data) in the Setup and Administration Guide.
• Currently, the customer number in SAP Subscription Billing must be identical to the business partner
number in SAP S/4HANA Cloud.
• Only billing forecasts for subscriptions with the price type "Net" can be replicated to billing plans.
• Some functional restrictions apply regarding subscriptions that have been replicated to provider contracts
in SAP S/4HANA Cloud. See Replication of Subscriptions to Provider Contracts [page 314].
Setup
To set up the integration, follow the instructions provided for the scope item 5IK (Subscription Management
with Convergent Invoicing). We recommend that you use a guided workflow in the Maintenance Planner to help
reduce the setup time and to ensure that you complete all the necessary tasks. You can find more information
about the workflow at the beginning of the Setup Instructions .
You can also find the instructions and more information about the scope item in the Process Navigator in
SAP for Me .
The scope items 1NN, 2AR, 2BG, and 2T3 are also required to set up this integration.
You require a separate license for SAP Event Mesh, which is used to enable the replication of subscription and
billing forecast data.
If you implement this integration, you cannot use the following services and applications in SAP Subscription
Billing:
• SAP digital payments add-on: Payments are managed in Contract Accounting (FI-CA).
Integration Guide
304 PUBLIC Integration with SAP S/4HANA Cloud
5.2.1 Data Flow Overview
Overview of data flow between the applications and services that are part of the integration Subscription
Management with Convergent Invoicing (5IK) with SAP S/4HANA Cloud:
To ensure consistency of data between the applications, business partner data must be replicated from SAP
S/4HANA Cloud to SAP Subscription Billing.
Business partners in SAP S/4HANA Cloud are created as customers in SAP Subscription Billing.
• SAP Master Data Integration service (this is the recommended replication method).
For details, see SAP Master Data Integration: Business Partner Data Replication [page 358].
• SAP Cloud Integration with predefined integration content.
Note
With integration via SAP Cloud Integration, only customers with one of the following business partner
roles can be replicated from SAP S/4HANA Cloud to SAP Subscription Billing:
• FLCU01 (Customer)
• MKK (Contract Partner)
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 305
• Additional business partner roles configured in the integration flow Replicate Business Partners to
SAP Subscription Billing
Required Data
Currently, the customer number in SAP Subscription Billing must be identical to the business partner number
in SAP S/4HANA.
You must specify sales areas for the business partners in SAP S/4HANA Cloud or SAP Master Data Integration.
The sales areas maps to markets in SAP Subscription Billing.
Partner Functions
Business partners are transferred and mapped from the subscription and bill in SAP Subscription Billing to
subsequent business documents and transactions in SAP S/4HANA as follows:
Provider Contract
Subscription Provider Contract Item Billing Plan Billable Item
Bill-to party
To ensure consistency of data between the applications, products and rate elements must be replicated from
SAP Subscription Billing to SAP S/4HANA Cloud.
Both products and rate elements from SAP Subscription Billing are created as products in SAP S/4HANA
Cloud.
Note
To use this option for rate element replication, you can only use units with unit codes that are identical
to ISO codes for the units of rate elements.
Integration Guide
306 PUBLIC Integration with SAP S/4HANA Cloud
• Use SAP Cloud Integration with predefined integration content.
For more information, see the descriptions below.
Required Data
• The description length in SAP S/4HANA Cloud cannot exceed 40 characters. Longer descriptions will be
truncated accordingly.
• For rate element replication, the unit of the rate element in SAP Subscription Billing must exist as a
commercial unit in SAP S/4HANA Cloud.
• To enable the replicated products to be used, as part of the integration setup you need to additional data to
them in SAP S/4HANA Cloud as shown in the table below. You are guided to do this by the setup workflow
and instructions.
Product Type SBPD Product Type SBRE Product Type SBPD Product Type SBRE
Field Mapping
product.code productInternalID
M industrySectorCode
SBPD productTypecode
product.names description
EA baseMeasureUnitCode
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 307
SAP Subscription Billing Rate Element SAP S/4HANA Cloud Product
ratePlanElement.id productInternalID
M industrySectorCode
SBRE productTypecode
ratePlanElement.labels description
ratePlanElement.unit baseMeasureUnitCode
This page lists all of the units supported for rate elements. These are units with codes that are identical to ISO
codes, as required by the integration.
The conversion formula column indicates whether one unit can be converted to another and how.
5.2.2.3.3 Area
Integration Guide
308 PUBLIC Integration with SAP S/4HANA Cloud
Unit Code ISO Code Description Conversion Formula
5.2.2.3.4 Density
4O 4O Microfarad 1E-6 F
4T 4T Pikofarad 1E-12 F
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 309
Unit Code ISO Code Description Conversion Formula
5.2.2.3.10 Energy
5.2.2.3.11 Force
Integration Guide
310 PUBLIC Integration with SAP S/4HANA Cloud
5.2.2.3.12 Frequency
5.2.2.3.13 Mass Flow
5.2.2.3.14 Miscellaneous Units
5.2.2.3.15 Power
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 311
5.2.2.3.16 Pressure
5.2.2.3.17 Radioactivity
5.2.2.3.18 Speed
5.2.2.3.19 Time
Integration Guide
312 PUBLIC Integration with SAP S/4HANA Cloud
5.2.2.3.20 Volume
4G 4G Microliter 1E-9 M3
To provide the required information for accounting processes and revenue recognition, the subscriptions from
SAP Subscription Billing are replicated to provider contracts in SAP S/4HANA Cloud.
Provider Contract
A provider contract comprises all agreements regarding the provision and billing of services required for the
processing of subscriptions in the S/4HANA Cloud system.
Note
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 313
Context
The provider contract represents the subscription contract in SAP S/4HANA Cloud.
Replication Process
SAP Subscription Billing sends a business event with the entire subscription data via SAP Event Mesh to SAP
S/4HANA Cloud every time that you create or change a subscription. This event triggers the creation or update
of the provider contract depending on the sent data and the event type.
You can also learn more about supported events in these articles of the API Guide:
• Business Events
• Subscription Events
Restriction
A maximum of 25,000 subscriptions per hour can be created/changed and replicated to SAP S/4HANA
Cloud. If you want to migrate data or run any other process that result in mass changes to subscriptions,
please contact SAP beforehand by creating an incident on the component CEC-SAL-SB.
To enable a seamless replication process, the subscriptions in SAP Subscription Billing are subject to the
following restrictions:
Integration Guide
314 PUBLIC Integration with SAP S/4HANA Cloud
Replicated Data Changes
When you edit the subscription on both header and item level, the changes that are relevant for the
provider contract are replicated. This table shows which fields of the provider contract are updated from the
subscription:
Product New items are created. They start on the effective date of
the subscription snapshot.
• Product sold
• Product
The items for the previous product and product sold end on
the day before the new item starts.
Field Mapping
Header
The replication generates a provider contract with the same ID as the subscription. The header fields are
mapped as follows:
• The managing company code of the provider contract is derived from the sales area, which is the
combination of a sales organization, a distribution channel and a division. You can display the sales area in
the provider contract items. The sales area is mapped with the market from SAP Subscription Billing
• The duration of the provider contract matches the duration of the subscription. The expiration date defines
the end of the subscription. If the subscription has no expiration date, the provider contract ends on
9999-12-31.
• Pending subscriptions aren't replicated to SAP S/4HANA Cloud. All other subscriptions are replicated, and
the status of the subscription is mapped with the status Active of the provider contract.
• The subscription uses either a subscription-specific time zone, which is provided upon creation, or the
time zone of the market. The subscription time zone is mapped to the local time zone of the provider
contract. All contract-related dates, except for the create and change dates, are displayed in the local time
zone.
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 315
Field Mapping of Headers
Subscription Provider Contract
Items
The replication generates one provider contract item per charge from the subscription item. The provider
contract item shows the following products:
• The product sold, which represents the subscription product. The product sold is mapped with the product
from SAP Subscription Billing. If a subscription item has multiple charges, multiple provider contract items
share the same product sold.
• The product, which represents an individual charge for which the subscriber pays. The product is mapped
with the rate element of the charge from the rate plan in SAP Subscription Billing. The product is unique
per item.
Example
A subscription has two items, one for the main product and one for an add-on product. Each subscription
item has three charges. In the provider contract, this structure is replicated into six provider contract items.
Three items are assigned to the main product of the first subscription item, and three items, to the add-on
product from the second subscription item.
Integration Guide
316 PUBLIC Integration with SAP S/4HANA Cloud
Other fields of the provider contract item are mapped with the subscription and its items as follows:
• The end of duration is populated based on the expected term end of the subscription.
If the subscription doesn't have an expected term, or if the expected term end is later than the expiration
date, then the end of duration of the item is populated based on the expiration date of the subscription.
• The customer reference and date are mapped with the customer purchase reference and date of the
subscription. In SAP S/4HANA Cloud, you can use the customer reference to split the billing document,
and you can also include both the reference number and date on the printed invoice.
• The charge type of the item is mapped with the rating type of the charge in SAP Subscription Billing. In SAP
S/4HANA Cloud, the rating type is used, along with the sales area, to determine the relevance for revenue
accounting in contract-based revenue recognition.
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 317
Field Mapping of Items
Subscription Subscription Item Provider Contract Item
• Sales organization
• Distribution channel
• Division
• Company code
• Profit center
• Segment
End of duration
• Expected term end
• Expiration date
Note
• The bill-to party of the subscription isn't mapped to the provider contract item in this integration
scenario.
• If you change the contract account of a subscription item, this change creates a new provider contract
item.
In the S/4HANA Cloud system, in the Custom Logic app use the BAdI Subscription: Map Custom Fields
to Provider Contract (ID: FKK_EVENT_0540) in the business context Provider Contract Item to map custom
references to the custom fields of the provider contract item or to the table that contains external references in
the provider contract header.
For more information, see the documentation of the BAdI in the Custom Logic app.
Integration Guide
318 PUBLIC Integration with SAP S/4HANA Cloud
5.2.3.1 Required Subscription Data
To enable the replication of subscriptions from SAP Subscription Billing to provider contracts in SAP S/4HANA
or SAP S/4HANA Cloud, the subscriptions must have certain data.
Prerequisites
• You've defined the required settings for markets and subscription profiles in Business Configuration.
These settings are described in the scope item setup instructions.
• You've created products of subscription type Commercial in the Manage Products app.
Note
Details
Subscription profile Assign a subscription profile with replication of subscriptions to provider contracts acti
vated, a billing forecast type assigned, and with the requirement of a contract account
enabled.
Recommendation
Product Assign a product of subscription type Commercial. This subscription type ensures that the
provider contract items are billed and printed on the invoice.
Billing cycle-related data For subscriptions with calendar billing, either use a rate plan that prorates the first billing
cycle (option Prorate First Cycle activated) or ensure that the subscription starts at the
beginning of the relevant calendar period.
This ensures that there are no rating periods outside the subscription validity period, which
would cause errors in data transfer.
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 319
Subscription Data Requirement
Object references Provide the following object references for accounting in SAP S/4HANA or SAP S/4HANA
Cloud:
• In the subscription header, the revenue accounting reference that is used to determine
or create the revenue contract for the subscription. This reference can be:
• The subscription itself, in which case you don't need to provide any reference.
The revenue accounting reference is automatically generated when you create the
subscription and contains the subscription ID.
• Any other object, for example, an order, in which case you need to provide the
object ID and the reference type EXT.
• In the subscription items, the contract account that is used to manage payment details
for the subscription.
Duration (subscription Specify the duration of the subscription via the subscription terms. If your subscriptions are
terms)
open-ended, use the expected term to indicate the projected duration. You can predefine
the terms via the product or define specific terms for individual subscriptions.
The following term end dates are used to set the end of duration of the provider contract
items:
When the subscriptions are created, they appear on the Manage Subscriptions app. In the subscription header
you see the reference to the replicated provider contract, under General Info Processing Data . In this tab
you can also see the integration settings of the assigned subscription profile.
Integration Guide
320 PUBLIC Integration with SAP S/4HANA Cloud
5.2.3.2 Display Provider Contract
Using the Maintain Provider Contract app, you can display provider contracts in the SAP S/4HANA Cloud
system as follows:
The General Data tab page displays general information about the contract that is valid for all items, such as
the time zone status of the contract and the contract start date and end date.
The tab pages for the contract item data show in the upper area either all contract items, or the items of the
provider contract that are valid at the time of validity.
Note
The system displays the contract items in the ABAP List Viewer (ALV). To change the display, use the layout
functions of the ABAP List Viewer.
When you click on a contract item, the system displays the data for the selected item in the lower area of the
screen:
The Items: General Data tab page displays the validity and status of the item and contract account.
The Items: Account Assignments tab page displays the following information:
• Organizational data
The default account assignments derived from the system settings in the configuration step Define
Specifications for the Derivation of Standard Account Assignment (such as the company code)
• Products included
The Items: Revenue Accounting tab page displays the following information:
Via API, Convergent Invoicing receives billable items (BITs) from SAP Subscription Billing and creates billing
documents and invoicing documents. Billable items, billing document items and invoice document items
contain a reference to a provider contract item.
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 321
5.2.4 Replication of Billing Forecasts to Billing Plans
To provide the required information for accounting processes and revenue recognition, the billing forecasts
from SAP Subscription Billing are replicated to billing plans in SAP S/4HANA Cloud.
Billing Plan
In SAP S/4HANA Cloud, a billing plan in Convergent Invoicing defines when and how often an amount is
invoiced to a customer.
Context
Billing forecasts in SAP Subscription Billing provide an estimate of the charges that are expected for
subscription items during a specified period. This simulated outlook on future billing cycles of a subscription
allows users to have a better idea of their upcoming subscription revenue. For more information, see Billing
Forecasts in the Feature Overview.
In SAP S/4HANA Cloud, a billing plan represents the billing forecast for a subscription. It contains the forecast
data that is required for revenue recognition.
Note
Billing plans that are created from a subscription in SAP Subscription Billing are not integrated in other
processes of Convergent Invoicing, such as the request of billing plan items for billing.
Replicated billing plans can only have the status Open. Replicated billing plan items can only have the
status Not Yet Requested.
Replication Process
SAP Subscription Billing sends a business event with the entire billing forecast data via SAP Event Mesh to SAP
S/4HANA Cloud every time that a billing forecast is created or changed. This event triggers the creation or
update of the billing plan depending on the sent data and the event type.
You can also learn more about supported events in these articles of the API Guide:
• Business Events
• Billing Forecast Events
Integration Guide
322 PUBLIC Integration with SAP S/4HANA Cloud
Note
To enable a seamless replication process, billing plans that have been replicated from billing forecasts in
SAP Subscription Billing cannot be deleted.
Restriction
A maximum of 165,000 billing forecasts per hour can be created/changed and replicated to SAP S/4HANA
Cloud. If you want to migrate data or run any other process that result in mass changes to billing forecasts,
please contact SAP beforehand by creating an incident on the component CEC-SAL-SB.
Only the billing forecasts for a subscription whose price type is Net can be replicated to billing plans.
Field Mapping
subscriptionDocumentId Contract
subscriptionVersion Version
Billing Plan Category Billing Plan for Provider Contract without request (BIPV1)
Billing Plan Type If Contract Category =Provider Contract: Billing Plan for
Provider Contract (no request) (SBPC1)
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 323
Billing Plan Items
The following fields are mapped from the billing forecast:
forecast-item-monetaryAmount-taxIncluded Gross
subscriptionDocumentId Contract
forecast-item-pricingElements- Amount
conditionValue-amount
forecast-item-pricingElements- Currency
conditionValue-currency
Integration Guide
324 PUBLIC Integration with SAP S/4HANA Cloud
Billing Plan Item Field Value
Preparatory billing data and usage data in SAP Subscription Billing is transferred to SAP S/4HANA or SAP
S/4HANA Cloud (both referred to below as "SAP S/4HANA") where it is used in subsequent billing, invoicing,
and financial processes.
Transfer to Convergent Invoicing takes place via SAP Cloud Integration, using predefined integration content.
Billing data stored in bills is transferred to SAP S/4HANA, resulting in the creation of billable items and
consumption items in Convergent Invoicing. Usage data is replicated as consumption items in Convergent
Invoicing. The replication is done by the asynchronous inbound service BillableItemsCreateRequest_In.
Each bill item has one or more charges or credits, and each charge or credit has one or more pricing
elements and associated usage records (which can also have their own items). These are mapped as follows in
Convergent Invoicing:
Restriction
A maximum of 100 usage records per charge or credit can be replicated as consumption items in SAP
S/4HANA.
Billable items and consumption items are linked together by the source transaction ID, which is the bill number
in SAP Subscription Billing.
Field Mapping
In the standard integration flow, the fields are mapped as follows in the service
BillableItemsCreateRequest_In:
CAIsSimulated False
CAReturnLogIsRequested True
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 325
Additional Parameters for Billable Items Value
Value
BillableItemsBasicCreate
Example: 1-2-1
CASubApplication P
Integration Guide
326 PUBLIC Integration with SAP S/4HANA Cloud
Value
BillableItemsTextCreate
CABllbleItmSourceTransType REVCL
Example: 1-2-1
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 327
Value
Example: ProductCode-
MetricId SubMetricId
SpecificationCode
BillableItemsAdditionalCreate (only applicable if the SAP Subscription Billing bill item’s charge/credit has an original bill
reference)
CABllbleItmSourceTransType REVCL
Example: 1-2-1
Example: 1-2-1
ConsumptionItemsRatedCreate
AdditionalParameters.CACnsmpnItmFieldDrvtnSchema SB01
CASubApplication P
Integration Guide
328 PUBLIC Integration with SAP S/4HANA Cloud
Value
Example
A bill has 2 bill items, one item for subscription A item 10 and one item for subscription B item 20. Each bill item
has 3 charges and each charge has 2 pricing elements. A total of 12 billable items will be created for this bill.
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 329
Some charges have related usage. For each usage record, a consumption item is created.
DRV1 USD -1
Technical re
source ID:
TR00001 /
Quantity 70 /
July 16 - July 30
DRV1 USD -2
Technical re
source ID:
TR00002 /
Quantity 40 /
July 16 - July 30
Billable Items
Integration Guide
330 PUBLIC Integration with SAP S/4HANA Cloud
Source Transac Source Transac Billable Item Billable Item
tion ID tion Item ID Provider Contract Amount Quantity Condition Type
Consumption Items
Consumption Quan
Source Transaction ID Access User ID Date From Date To tity
Define how a field derivation schema is determined for a billable item. You do this by mapping rating types
(and, optionally, condition types) to derivation schemas.
Procedure
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 331
5. To configure the value mapping, choose Configure in the Actions column for the artifact.
6. In the Value Mapping section, you define how a field derivation schema is determined for a billable item.
Field derivation schemas are determined from a rating type or condition type mapping. As a minimum, you
must define a rating type mapping, in addition you can optionally define a condition type mapping. If you
define both, the mapping based on condition types takes precedence.
Mappings must be defined separately for charge and credit pricing elements.
Example
onetime SB01
recurring SB02
usage SB03
1-1-1 SB01
Note
Statistical pricing elements (Statistical = X) are excluded for value mappings based on the rating
type.
However, you could also define a value mapping for the condition type:
PMP1 ZSB01
PCSC ZSBCO
1-1-1 ZSB01
1-1-2 ZSBCO
Integration Guide
332 PUBLIC Integration with SAP S/4HANA Cloud
Note
Statistical pricing elements (Statistical = X) are included for value mappings based on the
condition type.
7. Choose Save.
8. Select Deploy in the Actions menu for Value Mapping for SAP S4HANA Convergent Invoicing.
To provide the required information for contract-based revenue recognition (CBRR), data relating to
subscriptions is transferred from Convergent Invoicing to Revenue Accounting.
Data Flow
For revenue accounting, data is required from subscriptions, billing forecasts, and bills in SAP Subscription
Billing. This data includes information about the condition types of pricing elements, estimated or billed
amounts during a specified period, and billable charges.
Convergent Invoicing determines the relevance of provider contract items for revenue accounting, and creates
transfer records as follows to transfer data to Revenue Accounting:
• Order items
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 333
• For recurring and one-time charges: Created from the billing plan.
• For usage-based charges: Created from the provider contract item.
After the order items are transferred to Revenue Accounting, performance obligations are created in
revenue accounting contracts.
• Fulfillment items
Created when billable items are created.
• Invoice items
Created when billable items are invoiced.
You can use the Display Transfer Records app to do the following:
• Search for transfer records using various search criteria such as master data and selection variants.
• Display general information and data for CBRR and show details such as billable items and invoices.
• Determine how performance obligations are fulfilled for the provider contract.
• Calculate the fulfillments for time-based performance obligations based on deferral methods derived as
performance obligation attributes.
Related Information
You need to make specific settings to enable the integration of SAP Subscription Billing apps with the SAP Fiori
launchpad of SAP S/4HANA Cloud.
When integrating SAP Subscription Billing and SAP S/4HANA Cloud with scope items Subscription
Management with Convergent Invoicing (5IK) or Subscription Management with Sales Billing (57Z), the SAP
Subscription Billing apps can be made available in the SAP S/4HANA Cloud launchpad for business users. To
achieve this, you have to make user management settings in both systems.
Integration Guide
334 PUBLIC Integration with SAP S/4HANA Cloud
For more information about the integration with scope items 5IK and 57Z, see Integration with SAP S/4HANA
Cloud [page 253] in the SAP Subscription Billing Integration Guide. The same guide also includes information
about the general setup of the scope items Setup for 57Z and Setup for 5IK.
Authentication
As SAP Subscription Billing is an SAP Business Technology Platform (SAP BTP) application, user management
settings have to be done in the SAP BTP Cockpit. On SAP BTP, identity information is provided by identity
providers (IdPs) and not stored on SAP BTP itself. Accordingly, authentication of business users to access
the SAP Subscription Billing user interface is delegated to the identity providers, and users log on with
the mechanisms and credentials defined there: for example, with their username and password. Identity
information can also be stored in the SAP Authorization and Trust Management service per SAP BTP
subaccount. For more information, see SAP Authorization and Trust Management Service in the Cloud Foundry
Environment.
For the integration with SAP S/4HANA Cloud, SAP Cloud Identity Services - Identity Authentication takes
the role of a proxy for your corporate identity provider as described in Secure Authentication. Connect the
SAP Subscription Billing test and quality tenants to the SAP Cloud Identity Services test tenant, and the
SAP Subscription Billing production tenant to the SAP Cloud Identity Services production tenant. For more
information on SAP Subscription Billing user management settings, see SAP BTP Configuration Guide.
User Authorization
To make SAP Subscription Billing apps available in the SAP S/4HANA Cloud launchpad for business users, you
first define your business roles and then you authorize users.
In your SAP S/4HANA Cloud system, you can find the business role templates and the relevant business
catalogs for the integration with scope items 5IK and 57Z. Usually, assigning a business role to a business user
gives that user access rights to the apps nested in the assigned business roles. As access to SAP Subscription
Billing apps is configured in the SAP BTP cockpit, those settings have to be made additionally.
The mapping between the SAP Subscription Billing business role templates and business catalogs in SAP
S/4HANA Cloud and the SAP Subscription Billing apps are listed in the table below. You need to know this
information for the authorization step. For access to each SAP Subscription Billing app, users need certain role
assignments.
1. Decide which business catalog in SAP S/4HANA Cloud you require for your integration.
2. Check which SAP Subscription Billing apps are assigned to this catalog.
3. Look up which roles are needed for the user to access the apps. All apps and roles are listed in the section
Roles for SAP Subscription Billing under Build Role Collections.
4. Assign the relevant SAP Subscription Billing roles to the user in the SAP BTP Cockpit. Follow the procedure
described in the SAP BTP Configuration Guide.
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 335
Business Role Template in SAP SAP Subscription Billing Apps As
S/4HANA Cloud Business Catalog in SAP S/4HANA Cloud signed to the Catalog
Subscription Specialist Subscription Billing - Billing Data Processing Manage Billing Data
(Subscription Billing)
(SAP_CEC_BC_SBL_BILLDATA_PC) Manage Usage Records
(SAP_BR_SUBSCR_BILLG_SPC
LST)
Billing Clerk
(SAP_BR_BILLING_CLERK)
(SAP_BR_INVOICING_SPEC_C
INV)
Billing Clerk
(SAP_BR_BILLING_CLERK)
(SAP_BR_SOLN_ORDER_SPCLS
T)
(Subscription Billing)
(SAP_CEC_BC_SBL_CONFIG_PC)
(SAP_BR_CONFIG_EXPERT_SB
L)
Configuration Expert Subscription Billing - Rate Plan Template Manage Rate Plan Templates
(SAP_BR_CONFIG_EXPERT_SB (SAP_CEC_BC_SBL_PRICECFG_PC)
L)
Pricing Specialist (Subscription Subscription Billing - Product and Price Manage Allowance Templates
Billing) Processing
Manage Products
(SAP_BR_PRICING_SPCLST_S (SAP_CEC_BC_SBL_PRODUCT_PC)
Manage Rate Plans
BL)
Integration Guide
336 PUBLIC Integration with SAP S/4HANA Cloud
Business Role Template in SAP SAP Subscription Billing Apps As
S/4HANA Cloud Business Catalog in SAP S/4HANA Cloud signed to the Catalog
Billing)
(SAP_CEC_BC_SBL_RATING_PC)
(SAP_BR_PRICING_SPCLST_S
BL)
Subscription Specialist
(Subscription Billing)
(SAP_BR_SUBSCR_BILLG_SPC
LST)
(SAP_BR_ADMIN_APR_FICA) (SAP_FICA_BC_SBL_SUBSCRIP_PC)
(SAP_BR_APR_ACCOUNTANT_F
ICA)
(SAP_BR_COLL_SPECIALIST_
FICA)
(SAP_BR_EXT_AUDITOR_APR_
FICA)
Reconciliation Specialist -
Accounts Payable and
Receivable (FI-CA)
(SAP_BR_RECONC_SPEC_APR_
FICA)
Authorize Users
Role collections control user authorization for the SAP Subscription Billing apps and their data. To define
authorizations, you create role collections and assign these to business users as described in the SAP BTP
Configuration Guide under Enable UI Access Build role collections .
Authorize SAP Subscription Billing users for the integration with SAP S/4HANA Cloud, by creating role
collections in the SAP BTP Cockpit, in the subaccount in which the SAP Subscription Billing tenant is
subscribed.
See the topic Build Role Collections for a list of which role templates are needed for giving users basic view
or manage authorization for each SAP Subscription Billing app. Make sure you include all the necessary role
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 337
templates in the role collection for each app that you want the user to have access to. Depending on your use
case, you can add additional authorizations to enhance the basic roles mentioned in the table.
By defining authorizations for markets, you can restrict user access to certain markets only. SAP Subscription
Billing markets are mapped to SAP S/4HANA sales areas as part of the integration of SAP Subscription Billing.
For more information on market authorizations, see Market Authorizations in Build Role Collections.
Launchpad Setup
You need to make the following settings to configure the joint Fiori launchpad for SAP Subscription Billing and
SAP S/4HANA Cloud.
Communication Scenario
As part of the setup of scope items 57Z and 5IK, you create communication arrangements in your SAP S/
4HANA Cloud system that are based on communication scenarios, including communication scenarios that
are relevant for the joint launchpad. Some communication scenario requirements differ depending on whether
you are configuring the launchpad for a new or existing integration.
1. Create a communication arrangement from the communication scenario Subscription and Provider
Contract Integration (SAP_COM_0642).
This communication scenario includes a deprecated user interface navigation link and the REST calls from
SAP S/4HANA Cloud to SAP Subscription Billing.
2. Deactivate the deprecated user interface link service in the newly created communication arrangement.
3. Create a second communication arrangement from the communication scenario SAP Subscription Billing
- UI Integration (SAP_COM_0845) for the new user interface navigation between SAP S/4HANA Cloud and
SAP Subscription Billing.
Migrate from the standalone SAP Subscription Billing launchpad to the integrated launchpad with SAP
S/4HANA Cloud
If you already have an existing integration, be aware that the user interface navigation part of the
communication scenario SAP_COM_0642 is deprecated. You need to move your existing user interface
navigation from the communication scenario SAP_COM_0642 to the communication scenario SAP_COM_0845.
1. Deactivate the deprecated outbound service user interface link from your existing communication
arrangement that was created from the communication scenario Subscription and Provider Contract
Integration (SAP_COM_0642).
2. Create a communication arrangement from the communication scenario SAP Subscription Billing - UI
Integration (SAP_COM_0845) for the user interface navigation between SAP S/4HANA Cloud and SAP
Subscription Billing.
Integration Guide
338 PUBLIC Integration with SAP S/4HANA Cloud
5.2.8 Integration-Specific Data in SAP Subscription Billing
If you implement integration with Convergent Invoicing, data related to SAP S/4HANA Cloud or SAP S/
4HANAis available in SAP Subscription Billing.
Customers
The IDs of business partners replicated from SAP S/4HANA Cloud/SAP S/4HANA or SAP Master Data
Integration are stored as external object references.
Subscriptions
The following data from SAP S/4HANA Cloud or SAP S/4HANA is available in subscriptions:
• Involved partners: In the subscription you indicate the involved business partners, which are transferred to
the replicated provider contract:
• The payer, which is the business partner of the provider contract.
• The ship-to party, which is the service recipient of the provider contract.
• The bill-to party.
• Related documents:
• In the subscription header you see the following:
• The reference to the replicated provider contract
• The reference to the revenue accounting contract (only via the Subscriptions API)
• The customer reference and date for a purchase order.
• In the subscription items you see the reference to the related contract account.
• Subscription settings: In the assigned subscription profile you see the prefix of the subscription ID, which
is the same for the provider contract ID.
Bills
In addition to the standard set of data that is required for billing and invoicing, bills for Convergent Invoicing
contain the following specific references:
• Contract account: Included in the bill header, originating in the subscription item.
• Provider contract: Included in bill item and it's charges/credits, originating in the subscription item.
This attribute is available via the Bills API (subset billItems.externalObjectReferences).
• Partners: The payer and bill-to party are included in the bill header. The ship-to party is included in the bill
items. All the partners originate in the subscription.
• Successor document: This is displayed in the bill header and originates in Convergent Invoicing. The
successor document is a billing document or an invoicing document, depending on how the integration is
configured.
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 339
In the Manage Billing Data app, you can see the reference on the Transfer tab. For invoicing documents, you
can also display a PDF if this option is configured.
Depending on the data that's replicated and the replication method, you have different monitoring options.
You can use SAP Cloud ALM to monitor the status of data replication via SAP Master Data Integration for the
following objects:
• Business partners
• Products (for products, you can also use monitoring in SAP S/4HANA Cloud)
In SAP S/4HANA Cloud you can monitor data replication via SAP Cloud Integration for the following objects:
• Business partners
• Products (for products, you can also monitor replication via SAP Master Data Integration)
• Provider contracts
• Billing plans
• Billable items in Convergent Invoicing
You can use the following monitoring apps from the business catalog Communication Management - Message
Monitoring and Error Handling (SAP_CA_BC_COM_ERR_PC):
• Message Dashboard
• Message Monitoring
You can select the following specific interfaces to check detailed messages:
/CMDBP – BPCONF_IN
/CMDPR – PRDCONFOUT
Integration Guide
340 PUBLIC Integration with SAP S/4HANA Cloud
Data to be Monitored Interface
/FINCI SNGBIT_OUT
Prerequisites
In the Assign Recipients to Users app in SAP S/4HANA Cloud, assign the following recipients from the business
catalog Communication Management - Message Monitoring Configuration (SAP_CA_BC_COM_CONF_PC) to the
users that monitor the replication:
CI_SNGLBIT_OUT_RECIPIENT
More Information
Message Monitoring
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 341
5.2.10 Troubleshooting
Provider contracts and billing plans are not/no longer being created or updated when
subscriptions are created or updated
How to resolve: Check the Setup and Consumption of Business Events [page 342]
5.2.10.1 Reporting Issues
When you report an issue to SAP, choose the relevant component as follows.
Functionality Component
SAP S/4HANA integration content (use if you know that the CA-GTF-INT
issue is caused by the predefined integration content)
If you discover an issue with SAP Event Mesh that you can't resolve using the instructions below, please create
an incident on the component BC-CP-EM-MES.
Subscriptions and billing forecasts are replicated from SAP Subscription Billing to SAP S/4HANA Cloud
via business events. For event consumption in SAP S/4HANA Cloud, a communication arrangement for
communication scenario SAP_COM_0092 is required and the channel must be active.
Integration Guide
342 PUBLIC Integration with SAP S/4HANA Cloud
Your user needs to have the administrator business role which contains the business catalog
SAP_CORE_BC_COM (Communication Management), for example SAP_BR_ADMINISTRATOR.
2. Open the Communication Arrangements app from the launchpad.
All existing communication arrangements are listed on the initial screen.
3. Enter SAP_COM_0092 in the Scenario ID filter field and choose Go.
4. Choose the relevant communication arrangement from the list.
5. Under Outbound Services Delivery of Events , check that the Service Status is Active.
6. Choose Check Connection for the outbound service.
If the connection test is successful, the communication arrangement is configured correctly and the
channel is active. You can continue with Check event configuration in SAP S/4HANA Cloud [page 296].
If the check is not successful, continue with Reactivate event consumption in SAP S/4HANA Cloud [page
297].
With the communication arrangement for scenario ID SAP_COM_0092, an active channel is established for the
consumption of events from SAP Event Mesh. The event configuration defines which events are consumed
from a queue that you have set up for this integration.
To check event configuration for the SAP Event Mesh default plan:
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 343
2. Choose Services Instances and Subscriptions in the navigation pane.
3. In the list of subscriptions, choose the Go to Application icon for the Event Mesh application.
The Event Mesh user interface opens.
4. Expand Default Plan and choose Message Clients.
You see a tile for each Event Mesh subscription and instance of the default plan of your
subaccount.
5. Select the relevant tile for your messaging client (type Instance).
2. Choose Queues and check the queue name.
The easiest way to do this is to reactivate the communication arrangement in the list of communication
arrangements:
Note
Use a single queue for subscription events and billing forecast events. If more than one queue is created,
the system will face performance issues and events will be received in the wrong sequence. This is a critical
issue during mass operations and billing forecast events will be registered in the Application Interface
Framework (AIF) where can events are monitored and managed.
1. Access the Event Mesh user interface and select the messaging client:
1. Open the SAP BTP cockpit and choose your global account and subaccount.
2. Choose Services Instances and Subscriptions in the navigation pane.
3. In the list of subscriptions, choose the Go to Application icon for the Event Mesh application.
The Event Mesh user interface opens.
4. Expand Default Plan and choose Message Clients.
You see a tile for each Event Mesh subscription and instance of the default plan of your subaccount.
Integration Guide
344 PUBLIC Integration with SAP S/4HANA Cloud
5. Select the relevant tile for your messaging client (type Instance).
2. Select the queue defined for the integration of SAP Subscription Billing and S/4HANA Cloud.
3. Under Actions, select Queue Subscriptions.
4. Ensure that the following topics are subscribed:
sap/billing/sb/ce/sap/billing/sb/subscription/created/v1
sap/billing/sb/ce/sap/billing/sb/subscription/canceled/v1
sap/billing/sb/ce/sap/billing/sb/subscription/cancellationReversed/v1
sap/billing/sb/ce/sap/billing/sb/subscription/extended/v1
sap/billing/sb/ce/sap/billing/sb/subscription/withdrawn/v1
sap/billing/sb/ce/sap/billing/sb/subscription/productChanged/v1
sap/billing/sb/ce/sap/billing/sb/subscription/productOptionsAdded/v1
sap/billing/sb/ce/sap/billing/sb/subscription/productOptionsRemoved/v1
sap/billing/sb/ce/sap/billing/sb/subscription/changed/v1
sap/billing/sb/ce/sap/billing/sb/subscription/deleted/v1
sap/billing/sb/ce/sap/billing/sb/subscription/createdAsPending/v1
sap/billing/sb/ce/sap/billing/sb/subscription/changedAsPending/v1
sap/billing/sb/ce/sap/billing/sb/subscription/deletedAsPending/v1
sap/billing/sb/ce/sap/billing/sb/billingForecast/created/v1
sap/billing/sb/ce/sap/billing/sb/billingForecast/changed/v1
Check whether events are stuck in the SAP Event Mesh queue
You can use the Event Mesh user interface to check the queues for the SAP Event Mesh default plan. Make sure
that your user has at minimum the role ReadRole (see User Roles for Event Mesh).
1. Access the Event Mesh user interface and select the messaging client:
1. Open the SAP BTP cockpit and choose your global account and subaccount.
2. Choose Services Instances and Subscriptions in the navigation pane.
3. In the list of subscriptions, choose the Go to Application icon for the Event Mesh application.
The Event Mesh user interface opens.
4. Expand Default Plan and choose Message Clients.
You see a tile for each Event Mesh subscription and instance of the default plan of your subaccount.
5. Select the relevant tile for your messaging client (type Instance).
2. Choose Queues and check that the queues configured for consumption in SAP S/4HANA Cloud have 0
messages. Other queues that may have been created for monitoring reasons can contain messages.
3. If there are messages in the queues and these remain when you choose Refresh, this could be an indication
that event consumption in SAP S/4HANA Cloud is not working properly. You can try to resolve this by
reactivating event consumption as described under Reactivate event consumption in SAP S/4HANA Cloud
[page 297].
Check if / how many events are being sent via SAP Event Mesh
To have a better overview of whether events are being sent through the SAP Event Mesh default plan and how
many events are being sent, it can help to create monitoring queues.
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 345
Monitoring queues are normal queues which subscribe to the same event types as the queue for consumption
by SAP S/4HANA Cloud, but which are not registered for consumption in SAP S/4HANA Cloud or by any
other consumer. Events published by SAP Subscription Billing will remain in the monitoring queues and can be
checked in the Event Mesh user interface. You can also check the event payload.
Recommendation
To avoid unnecessary effort, we recommend that you only set up monitoring queues in error situations or if
the initial setup does not work and you want to check whether events are reaching SAP Event Mesh.
Tip
While only one queue should be used for consuming subscription and billing forecast events in SAP S/
4HANA Cloud, for the purpose of monitoring, we recommend creating 2 separate monitoring queues. This
provides better transparency regarding whether and how many subscription and billing forecast events are
being sent from SAP Subscription Billing to SAP Event Mesh.
1. Access the Event Mesh user interface and select the messaging client:
1. Open the SAP BTP cockpit and choose your global account and subaccount.
2. Choose Services Instances and Subscriptions in the navigation pane.
3. In the list of subscriptions, choose the Go to Application icon for the Event Mesh application.
The Event Mesh user interface opens.
4. Expand Default Plan and choose Message Clients.
You see a tile for each Event Mesh subscription and instance of the default plan of your subaccount.
5. Select the relevant tile for your messaging client (type Instance).
2. Choose the Queues tab.
3. In the dialog box, enter a queue name and choose Create.
For example, you can use the following name patterns:
• <namespace>/subscriptions4monitoring for subscription events
• <namespace>/billingforecasts4monitoring for billing forecast events
4. For each queue, go to Actions Queue Subscriptions .
In the dialog box, enter the following topic names:
For the subscription event monitoring queue:
• sap/billing/sb/ce/sap/billing/sb/subscription/*
Note
The wild card (*) includes topics for all subscription events. Therefore, ensure that only those
subscription event topics that are relevant for the integration are subscribed in the queue. You can
find a list of relevant topics under Check the queue configuration with Event Mesh user interface
[page 298].
Integration Guide
346 PUBLIC Integration with SAP S/4HANA Cloud
Events will be collected in these queues as they are not consumed, giving you a good overview. From time to
time, you should clear the queue (under Actions, choose Purge Messages).
1. Access the Event Mesh user interface and select the messaging client:
1. Open the SAP BTP cockpit and choose your global account and subaccount.
2. Choose Services Instances and Subscriptions in the navigation pane.
3. In the list of subscriptions, choose the Go to Application icon for the Event Mesh application.
The Event Mesh user interface opens.
4. Expand Default Plan and choose Message Clients.
You see a tile for each Event Mesh subscription and instance of the default plan of your subaccount.
5. Select the relevant tile for your messaging client (type Instance).
2. Choose the Test tab in the main view (not the navigation panel).
3. Under Consume Messages, select Queue and enter the name of the monitoring queue.
4. Choose Consume Messages and check the message data that appears.
1. Access the Event Mesh user interface and select the messaging client:
1. Open the SAP BTP cockpit and choose your global account and subaccount.
2. Choose Services Instances and Subscriptions in the navigation pane.
3. In the list of subscriptions, choose the Go to Application icon for the Event Mesh application.
The Event Mesh user interface opens.
4. Expand Default Plan and choose Message Clients.
You see a tile for each Event Mesh subscription and instance of the default plan of your subaccount.
5. Select the relevant tile for your messaging client (type Instance).
2. Choose the Queues tab.
3. Choose Refresh while triggering events in SAP Subscription Billing.
If events reach SAP Event Mesh, you will see the messages in the consumed queue changing to 1 and then
back to 0.
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 347
5.2.11 Discontinuing Use of SAP Subscription Billing:
Prerequisites
If you have integrated SAP Subscription Billing and SAP S/4HANA Cloud and want to stop using SAP
Subscription Billing, you need to ensure that certain prerequisites are fulfilled beforehand.
1. All bills that need to be invoiced have been successfully transferred to SAP S/4HANA Cloud, with billable
items and consumption items created.
2. Invoicing has been completed in SAP S/4HANA Cloud.
3. All subscriptions have been successfully replicated as provider contracts and have expired.
You can no longer manage subscriptions once you stop using SAP Subscription Billing).
Before discontinuing usage of SAP Subscription Billing, use APIs to extract all the data that you require going
forward:
• You must extract billing data for future auditing purposes, using the Bills API (GET on /bills).
After you stop using SAP Subscription Billing, you'll no longer have an audit trail for billable items via
navigation to the relevant bill.
• You can use the Subscriptions API (GET on /subscriptions) to extract subscription data if required.
After you stop using SAP Subscription Billing, no change history is available for subscriptions.
• You must roll back the integration for scope item 5IK, including adjusting Customizing and deactivating
communication arrangements.
• All products that were replicated from SAP Subscription Billing must be marked for deletion.
Products that are marked for deletion are deleted during archiving if all business transactions in which they
are used have been concluded.
If you use the SAP Master Data Integration [page 355] service for master data replication, you must roll back
integration with this service.
After Discontinuation
• Navigation between transactions and business documents in the other systems is no longer available.
Once the communication arrangement is deactivated, navigation links disappear.
Integration Guide
348 PUBLIC Integration with SAP S/4HANA Cloud
• No change history is available for subscriptions. Therefore, if you require historical data you should use an
API to extract it before discontinuation.
Integration Guide
Integration with SAP S/4HANA Cloud PUBLIC 349
6 Integration with SAP Commerce
This integration enables you to sell subscriptions with SAP Commerce, and to use SAP Subscription Billing for
subscription provisioning, rating of subscription charges, and generation of billing data.
You can find detailed information on the integration in the SAP Commerce documentation: SAP Subscription
Billing Integration
Note
Integration Guide
350 PUBLIC Integration with SAP Commerce
7 Integration with SAP Entitlement
Management
You can replicate subscription data from SAP Subscription Billing to entitlements in SAP Entitlement
Management and then manage entitlements for the products and services to which customers have
subscribed.
In the context of a subscription business model, entitlements are the rights to benefits that a customer
receives upon subscribing to purchase a product or service, for example user licenses, rights to download
software, warranties and so on.
In SAP Subscription Billing, a subscription contains at least one subscription item, and the corresponding
rights are reflected in SAP Entitlement Management as entitlements. Each subscription item can have multiple
entitlements.
Setup
You can find instructions for configuring the integration in the Integration Guide for SAP Entitlement
Management.
Integration Guide
Integration with SAP Entitlement Management PUBLIC 351
8 Integration with SAP CPQ
This integration enables you to use SAP CPQ to define and sell subscriptions, and to use SAP Subscription
Billing for subscription provisioning and management, rating of subscription charges, and generation of billing
data.
You can find detailed information about setting up the integration in the SAP CPQ documentation, under SAP
Subscription Billing Integration for Quote 2.0.
The integration is enabled by the integration package SAP CPQ Integration with SAP Subscription Billing .
Note
Prerequisites
Business partner (customer) master data must be replicated from the back-end system to both SAP CPQ
and SAP Subscription Billing. If your back-end system is SAP S/4HANA, you can use predefined integration
packages to do this:
At least one rate plan template must be defined and published in SAP Subscription Billing for defining rate
plans in SAP CPQ subscription products. The rate plan template defines the basic pricing structure of the
product.
Process Flow
Integration Guide
352 PUBLIC Integration with SAP CPQ
1. Users define rate plan templates in SAP Subscription Billing.
2. Users create subscription products in SAP CPQ. For pricing, users select a rate plan template from SAP
Subscription Billing and define rate plans per market based on this template.
3. Products and rate plans are replicated from SAP CPQ to SAP Subscription Billing.
4. Users create quotes in SAP CPQ and add subscription products.
5. When the quotes are accepted and orders placed in SAP CPQ, the quotes trigger the creation of
subscriptions in SAP Subscription Billing.
Whenever a product, rate plan, or quote is changed in SAP CPQ this triggers an update in SAP Subscription
Billing.
Important Notes
Please note the following considerations and requirements from the point of view of SAP Subscription Billing:
• Only subscriptions with a single root item are supported. No subitems are supported.
• Markets are not replicated between the solutions. You need to ensure that the relevant markets are defined
with the same ID and time zone in both systems.
• When defining rate plan templates in SAP Subscription Billing, we recommend that you define the currency
and all amounts (prices) as parameters.
Caution
• Custom amounts (defined in rate plan templates) are not supported in SAP CPQ. If any customs amounts
are defined in a product's rate plan, these will not be taken over into quotes but will appear in the bill.
Caution
In your rate plan templates, do not use parameters that are used exclusively for custom amounts,
otherwise associated rate plans can't be replicated from SAP CPQ to SAP Subscription Billing.
• Price changes in rate plans must only be done in SAP CPQ, using rate plan snapshots, otherwise rate plans
cannot be kept consistent between the systems.
• For the rate element type of usage, you must turn on the Autogenerate Technical Resource switch in Rate
Elements in Business Configuration so that the system can generate the technical resource of this type
automatically when you create the subscription.
Products
Products replicated from SAP CPQ have the following special characteristics:
• The product ID is the system ID of the product in SAP CPQ (this identifies the corresponding product for
the integration).
Integration Guide
Integration with SAP CPQ PUBLIC 353
• A reference to the rate plan template used to create the rate plan in SAP CPQ
• Subscription parameters and technical resources are derived from the rate plan template rather than the
rate plan.
Caution
In SAP Subscription Billing, do not edit products created in SAP CPQ. SAP CPQ is the leading system for
product data in this integration scenario.
Subscriptions
Subscriptions created in SAP Subscription Billing (as a follow-on to accepted quotes in SAP CPQ) store a
reference to the quote.
• The Effective Date of the quote as the Pricing Date of the subscription.
• The discounted prices of the quote as pricing parameters
• The value of subscription parameters as defined in the quote
• The rate plan of the subscription product, representing the standard list prices
• The Contract End Date of the quote as the Valid To date of the subscription
• The minimum term of the subscription
Integration Guide
354 PUBLIC Integration with SAP CPQ
9 Integration with SAP Master Data
Integration
This integration enables you to synchronize business partner data, products and rate elements between SAP
Master Data Integration service and SAP Subscription Billing.
SAP Master Data Integration service serves as a central entry point for master data integration within the
Intelligent Suite. SAP Subscription Billing provides the integration with SAP Master Data Integration as follows:
• Replicate business partner data from SAP Master Data Integration to SAP Subscription Billing.
• Replicate products from SAP Subscription Billing to SAP Master Data Integration.
• Replicate rate elements from SAP Subscription Billing to SAP Master Data Integration.
Prerequisite
SAP Master Data Orchestration is subscribed. For details, see Subscription Process for SAP Master Data
Orchestration in the SAP Master Data Integration documentation.
This section describes the connectivity settings between SAP Master Data Integration and SAP Subscription
Billing.
In order to connect to the SAP Master Data Integration service, clients need credentials, which are obtained
from service keys residing in service instances. Service instances in the same subaccount will have access
to the same data. To create the instance and service key, follow the steps described in Connecting Clients in
the SAP Master Data Integration documentation. The information of uri, clientid, clientsecret, and url in the
service key details will be used in the next step of creating destination.
Note
When creating a service instance according to Connecting Clients, for the step Configure Instance
Parameters, we recommend you to provide the subdomain name of your SAP Subscription Billing tenant
Integration Guide
Integration with SAP Master Data Integration PUBLIC 355
as the businessSystemId parameter and hrc as the application parameter in JSON format by
completing the following JSON template:
Sample Code
{
"businessSystemId":
"<Subdomain_name_of_your_Subscription_Billing_tenant>",
"application": "hrc",
"writePermissions": [{
"entityType": "sap.odm.businesspartner.BusinessPartner"
}, {
"entityType": "sap.odm.product.Product"
}
]
}
You need to set up the connectivity between SAP Subscription Billing and SAP Master Data Integration by
defining destinations in SAP BTP.
Note
To manage destinations, you must be a global account member on SAP BTP. The destinations are
configured in the subaccount of SAP Subscription Billing.
Type HTTP
Integration Guide
356 PUBLIC Integration with SAP Master Data Integration
Field Name/Setting Value Comment
Authentication OAuth2ClientCredentials
Client ID The clientid in your service key. You need to have created service
keys in your subaccount for the SAP
Master Data Integration.
Client Secret The clientsecret in your service key. See above comment.
Token Service URL <the url in your service key>/oauth/ Example: https://
token {Subdomain}.authenticatio
n.
{eu10}.hana.ondemand.com/
oauth/token
Note
If you changed the SAP Master Data Integration instance after the activation of customer replication, you
need to deactivate the customer replication first and save it. Then activate the customer replication and
save it again. This retriggers the initial load. The replication reports will be refreshed but customers that
were already replicated will not be impacted. For details, see Activate Customer Replication [page 361].
Integration Guide
Integration with SAP Master Data Integration PUBLIC 357
9.2 Business Partner Data Replication
This section provides steps to synchronize business partner information from SAP Master Data Integration
service to SAP Subscription Billing.
The integration replicates business partners with following roles from SAP Master Data Integration to SAP
Subscription Billing:
• FLCU01
• FLCU00
• CRM000
• CRM002
• CRM003
• CRM004
The replication happens periodically for every 5 minutes. For the first time you activate the replication,
depending on the data volume, the initial load can take a while. To reduce the data volume, it is strongly
recommended to configure the filter (see Configuration in SAP Master Data Orchestration [page 359]) so that
only relevant customers will be replicated to SAP Subscription Billing.
If you want the business partner ID used in SAP Subscription Billing to be the same with one of the source
systems, you can configure the source application and source tenant in Business Configuration (see Activate
Customer Replication [page 361]). In this case, only the business partners which have the local ID maintained
for the source system will be replicated.
Note
Currently, the Replication of Subscriptions to Provider Contracts and Replication of Billing Forecasts to
Billing Plans integration scenarios require the identical IDs to be used for customer between SAP S/4HANA
Cloud and SAP Subscription Billing systems. If such integrations are in scope, you need to configure the
SAP S/4HANA Cloud system as the source application for customer ID and source tenant for customer ID.
Configuration Steps
1. Create an instance of the SAP Master Data Integration service and define the destination of the SAP
Master Data Integration instance. See Set Up Connectivity [page 355].
Integration Guide
358 PUBLIC Integration with SAP Master Data Integration
If you use the "Business Partner Data Replication" and "Product and Rate Element Replication" scenarios,
this needs to be done once only.
2. Create a distribution model in SAP Master Data Orchestration. See Configuration in SAP Master Data
Orchestration [page 359].
3. Map sales areas in SAP S/4HANA Cloud to markets in SAP Subscription Billing. See Map Sales Areas to
Markets [page 360].
4. Activate customer replication in SAP Subscription Billing. See Activate Customer Replication [page 361].
Maintain the distribution model for business partner replication in SAP Master Data Orchestration:
Integration Guide
Integration with SAP Master Data Integration PUBLIC 359
Note
The Replicate button on the page header has no effect for the replication. The replication is managed and
controlled by SAP Subscription Billing. See Activate Customer Replication [page 361] for details.
To use the integration, you need to make several configuration settings in the SAP Subscription Billing solution.
Organizational units are represented by different master data in SAP Subscription Billing and SAP S/4HANA
Cloud. You must map these master data to enable the integration between both solutions.
Context
In SAP Subscription Billing, a market represents the organizational unit that offers a product. For subscription
products, each subscription is associated with a single market. In SAP S/4HANA Cloud, this organizational unit
is represented by the sales area, which consists of a sales organization, a distribution channel and a division.
To map these master data between both solutions, you must enter the sales areas into the matching markets in
SAP Subscription Billing. One sales area corresponds to exactly one market.
Prerequisites
Procedure
Integration Guide
360 PUBLIC Integration with SAP Master Data Integration
5. Repeat these steps for further markets.
You need to activate the replication of customer data from SAP Master Data Integration in SAP Subscription
Billing Business Configuration to enable the integration.
Note
The following scenarios will retrigger the initial load: Changes after the initial setting of Source Application
for Customer ID and Source Tenant for Customer ID; You deactivate the customer replication and save it,
and then activate the customer replication and save it again.
The replication report will be refreshed but customers that were already replicated will not be impacted.
This section provides information for monitoring and troubleshooting business partner replication.
Monitoring
You can monitor the status of business partner replication in the following ways:
• Use the Business Partners API (operation Retrieve SAP Master Data Integration Business Partner
Replication Reports (GET on /mdi/replication-reports)). You can find information about accessing SAP
Subscription Billing APIs under Getting Started with APIs in the SAP Subscription Billing API Guide.
• Monitor in SAP Cloud ALM as described in Monitoring in SAP Cloud ALM [page 375].
Integration Guide
Integration with SAP Master Data Integration PUBLIC 361
Troubleshooting
Note
The field names used below are the field names in the /mdi/replication-reports API. If you check the
message in SAP Cloud ALM, the corresponding fields in the log entry of SAP Cloud ALM are as follows:
replicationStatus Status, code ErrorCode .
• If the replicationStatus is FAILURE, check the data issue and correct it in source system. Here are the
common data errors that may cause replication failure of business partner:
• No valid default address.
• The value of the Country / Region field is not in ISO standard.
• If the replicationStatus is SKIPPED, you can check and troubleshoot according to the following error
codes:
• code = SkippedRoleOrType. The business partner is not a person or organization or it is not in the
following role list: FLCU01, FLCU00, CRM000, CRM002, CRM003 and CRM004.
Check the business partner type and role in the source system and correct it there.
• code = SkippedLocalId. No local ID is available for the configured source application and tenant with
additionalContext of sap.oitc.888.
In the Manage Business Configuration app, open Integration Settings. Under SAP Master Data
Integration, check if the Source Application for Customer ID and Source Tenant for Customer ID are
correct. If they are correct, then check the integration between your source system and SAP Master
Data Integration to find out why the local ID is not available.
• whether the integration configuration is finished. Follow the configuration steps described in the
integration guide to finish the configuration.
• whether the customer has been replicated to SAP Master Data Integration from the source system. Check
the respective document to ensure the customer has been replicated to SAP Master Data Integration first.
• whether the connection works. In the Manage Business Configuration app, open Integration Settings.
Under SAP Master Data Integration, choose Test Connection. If the connection is not working, check the
destination configuration.
Integration Guide
362 PUBLIC Integration with SAP Master Data Integration
• whether there is any change of SAP Master Data Integration instance for SAP Subscription Billing after the
integration is activated. In the Manage Business Configuration app, open Integration Settings. Under SAP
Master Data Integration, click Deactivate Customer Replication and then save it. After saving, click Activate
Customer Replication and then save it again.
9.2.4 Field Mapping
This section provides detailed field mapping information between SAP Master Data Integration and SAP
Subscription Billing.
You can find the field mapping information for customer as follows:
person.nameDetails.lastName Last Name The last name is mandatory for individual cus
tomers.
addressData [*].usages [*] N/A Only the first addressData with at least
one usage whose code is XXDEFAULT and
the validFrom and validTo period cover
the replication job time is mapped to SAP
Subscription Billing Customer as address.
Integration Guide
Integration with SAP Master Data Integration PUBLIC 363
Field Name in SAP Master Data Field Name in SAP Subscription
Integration Billing Comment
addressData [*].personPostalAd Country / Region This filed is mandatory and it should be ISO
dress (or organizationPostalAd 3166-1 alpha-2 code.
dress).country.code
Integration Guide
364 PUBLIC Integration with SAP Master Data Integration
Field Name in SAP Master Data Field Name in SAP Subscription
Integration Billing Comment
This section provides steps to synchronize product and rate element information from SAP Subscription Billing
to SAP Master Data Integration service.
After the configuration steps are successfully completed, the replication happens periodically every 5 minutes.
During the initial replication, all products and rate elements are replicated. After that, only the new products
and rate elements as well as updated products and rate elements will be replicated.
Note
The replication from SAP Master Data Integration to the target system might fail unless the following
requirements are fulfilled:
Integration Guide
Integration with SAP Master Data Integration PUBLIC 365
Configuration Steps
1. Create an instance of the SAP Master Data Integration service and define the destination of the SAP
Master Data Integration instance. If you use the "Business Partner Data Replication" and "Product and Rate
Element Replication" scenarios, this needs to be done once only . See Set Up Connectivity [page 355].
2. Create a distribution model in SAP Master Data Orchestration. See Configuration in SAP Master Data
Orchestration [page 366].
3. Map sales areas in SAP S/4HANA Cloud to markets in SAP Subscription Billing. See Map Sales Areas to
Markets [page 367].
4. Make settings for product replication. See Make Settings for Product Replication [page 368].
5. Activate the product and rate element replication and maintain the code mappings in SAP Subscription
Billing. See Activate Replication and Maintain Code Mapping [page 370].
This section describes the configuration settings in SAP Master Data Orchestration.
Maintain the distribution model for product and rate element replication in SAP Master Data Orchestration:
Integration Guide
366 PUBLIC Integration with SAP Master Data Integration
11. (Optional) Similarly, fill in the Data Scope section if applicable. For more information, see the Data Scope
Filters section in the Maintenance of the Distribution Model in SAP Master Data Orchestration section of
the SAP Master Data Integration documentation.
12. In Key Mapping section, activate Distribute Key Mapping.
13. Select Save. The replication model is created with the status Inactive. To activate the replication model,
click Activate at the top right corner.
Note
The Replicate button on the page header has no effect for the replication. The replication is managed and
controlled by SAP Subscription Billing. See Activate Replication and Maintain Code Mapping [page 370] for
details. The purpose for this distribution model is to allow SAP Subscription Billing to receive the change
logs so that SAP Subscription Billing will know if the replication to SAP Master Data Integration succeeded
or failed and then update the replication status accordingly.
To use the integration, you need to make several configuration settings in the SAP Subscription Billing solution.
Organizational units are represented by different master data in SAP Subscription Billing and SAP S/4HANA
Cloud. You must map these master data to enable the integration between both solutions.
Context
In SAP Subscription Billing, a market represents the organizational unit that offers a product. For subscription
products, each subscription is associated with a single market. In SAP S/4HANA Cloud, this organizational unit
is represented by the sales area, which consists of a sales organization, a distribution channel and a division.
To map these master data between both solutions, you must enter the sales areas into the matching markets in
SAP Subscription Billing. One sales area corresponds to exactly one market.
Prerequisites
Integration Guide
Integration with SAP Master Data Integration PUBLIC 367
Procedure
The products and rate elements of SAP Subscription Billing must be mapped to products of different
types in SAP S/4HANA Cloud. To ensure consistent mapping, some configuration steps are needed in SAP
Subscription Billing.
• Integration Settings: Activate the upper case conversion and the validation of IDs.
• Language Settings: Enable language-dependent names and descriptions for rate elements and products.
Context
Integration Settings
In SAP S/4HANA Cloud, system administrators must define a number range for the object IDs. To ensure that
the IDs created in SAP Subscription Billing are within the same number range as used in SAP S/4HANA Cloud,
you must define the integration of master data IDs in SAP Subscription Billing.
Language Settings
In SAP S/4HANA Cloud, system administrators can maintain the name and description of products in
different languages. This setting allows them to localize their products in the communication language of
their customers, for example, in document outputs. To ensure that the products and rate elements of SAP
Subscription Billing are also language-dependent, you must define language settings for these master data.
Details
Integration Settings
The integration settings for the IDs of rate elements and products consist of the following:
• Activate ID Upper Case Conversion: To convert lower case letters to upper case letters in the IDs. SAP
S/4HANA Cloud allows only for upper case in object IDs. This setting avoids mapping errors if the IDs
erroneously contain lower case letters.
Integration Guide
368 PUBLIC Integration with SAP Master Data Integration
• Activate ID Validation: To ensure that the IDs fit into the allowed length (18 characters) and number ranges.
• From Number and To Number: To define the allowed number range, from a minimum value to a maximum
value. These values must match the number range that you defined for each product type (SBPD for the
product, SBRE for the rate element) in SAP S/4HANA Cloud.
Note
The number ranges for products and rate elements must not overlap. Both products and rate elements are
replicated as products in SAP S/4HANA Cloud and you can create only one product with the same ID in
SAP S/4HANA Cloud, regardless of the product type.
Language Settings
By activating the textual user input translation and setting the default language, you will be able to maintain
language-dependent texts for rate elements and products.
Once the default language is specified, you can maintain language-dependent texts in the following places:
• In the Manage Products app, you can maintain language-dependent texts for the name and description of a
product.
• In the Manage Business Configuration app, you can maintain language-dependent texts for the label and
description of a rate element under Rate Elements.
Procedure
Integration Settings
1. In the Manage Business Configuration app, open Integration Settings.
2. Under Master Data, choose the object for which you want to configure the IDs.
3. Define the settings as follows:
• Activate the ID upper case conversion.
• Activate the ID validation.
• Enter a minimum value and a maximum value for the number range.
4. Save your changes.
5. Repeat these steps for further objects.
Language Settings
1. In the Manage Business Configuration app, open Language Settings.
2. Switch on Activate Textual User Input Translation.
Integration Guide
Integration with SAP Master Data Integration PUBLIC 369
3. Choose from the list the default language for your system.
4. Save your changes.
Note
You cannot deactivate the textual user input translation once it is activated.
You need to activate the replication of products and rate elements of SAP Subscription Billing in Business
Configuration to enable the integration.
Integration Guide
370 PUBLIC Integration with SAP Master Data Integration
Maintain Code Mapping
If you activated Subscription Management with Sales Billing (57Z) or Subscription Management with
Convergent Invoicing (5IK) in SAP S/4HANA Cloud, you can maintain the default codes as follows:
Note
This section provides information for monitoring and troubleshooting product and rate element replication.
Monitoring
You can monitor the product and rate element replication status in the following ways:
• Check the status in the Manage Products app and the Manage Business Configuration app.
• To check the product replication status, search the product in the Manage Products app and then open
the product detail page. Go to the section Master Data Integration where you can see the replication
status and the error details if the replication failed.
• To check the rate element replication status, go to the Manage Business Configuration app and then
select Rate Elements. On the rate element detail page, go to the section Master Data Integration where
you can see the replication status and the error message if the replication failed.
• Call the Retrieve SAP Master Data Integration Product Replication Reports (GET on /mdi/
replicationReports) API. See Getting Started with APIs to see how to access the API.
• Monitor in SAP Cloud ALM as described in Monitoring in SAP Cloud ALM [page 375].
Integration Guide
Integration with SAP Master Data Integration PUBLIC 371
Troubleshooting
Check whether the connection works. In the Manage Business Configuration app, open Integration Settings.
Under SAP Master Data Integration, choose Test Connection. If the connection does not work, check the
destination configuration. If the connection works, try to make some change to the product or rate element
and retrigger the replication.
Integration Guide
372 PUBLIC Integration with SAP Master Data Integration
9.3.4 Field Mapping
This section provides detailed field mapping information between SAP Subscription Billing and SAP Master
Data Integration.
You can find the field mapping information for both product and rate element as follows:
Description description
N/A type The value is set to the Product Type code which
you have configured in step 2.b. in the Activate
Product Replication topic in Activate Replication
and Maintain Code Mapping [page 370].
N/A salesAspect.durationUnit The value is set to "M" when the product's ini
tial fixed term is maintained in SAP Subscription
Billing.
N/A salesAspect.isInitialFixedDuration The value is set to "true" when the product's ini
tial fixed term is maintained in SAP Subscription
Billing.
N/A salesAspect.minimumDurationUnit The value is set to "M" when the product's min
imum term is maintained in SAP Subscription
Billing.
Integration Guide
Integration with SAP Master Data Integration PUBLIC 373
Field Name in SAP Subscription Field Name in SAP Master Data
Billing Integration Comment
N/A salesAspect.extensionDurationUnit The value is set to "M" when the product's re
newal term is maintained in SAP Subscription
Billing.
N/A salesAspect.salesDistribution See the comment above. The value is set to the
Chains[*].distributionChannel Distribution Channel of the Sales Area of the
Market.
N/A salesAspect.salesDistribution See the comment above. The value is set to the
Chains[*].ratePlans[*].division Division of the Sales Area of the Market.
Integration Guide
374 PUBLIC Integration with SAP Master Data Integration
Rate Element Field Mapping
Label name
Description description
Note
Active isMarkedForDeletion
SAP Subscription Billing provides out-of-box integration with SAP Cloud ALM so that you can monitor the
status of business partner and product replication between SAP Subscription Billing and SAP Master Data
Integration.
The Integration & Exception Monitoring application of SAP Cloud ALM provides functions such as message
monitoring, message search and alerting on failed messages or exceptions.
Integration Guide
Integration with SAP Master Data Integration PUBLIC 375
Configuration
To set up the monitoring, you must have a subscription to SAP Cloud ALM.
Note
If you already have the business service which includes the SAP Master Data Integration service, you can
just add the SAP Subscription Billing tenant to the existing business service.
To do this, follow the instructions on the page Business Service Configuration to create a new business
service and add the SAP Subscription Billing service and the SAP Master Data Integration service to the
business service. In the play-list Videos: SAP Cloud ALM for Operations , the demo video How to Create
and Monitor a Scenario in Integration & Exception Monitoring shows how to create and configure the business
service.
Optionally, you can also add other services that are integrated with the same SAP Master Data Integration
service to the business service. For example, if SAP S/4HANA Cloud is also integrated with the SAP Master
Data Integration service for product and business partner replication, you can first connect SAP S/4HANA
Cloud to SAP Cloud ALM if they are not connected yet (see Setup for SAP S/4HANA Cloud ) and then add
the SAP S/4HANA Cloud service to the business service.
Within the business service, you can also set the paths in the business service as shown below to have better
view of the message flow:
Optionally, if you only want to see the messages related to product and business partner replication, you can
set up the filters for the services as shown below:
Product
Integration Guide
376 PUBLIC Integration with SAP Master Data Integration
Service Category Parameter
Business Partner
Monitoring
After the configuration, you can monitor the messages in the Integration & Exception Monitoring application of
SAP Cloud ALM.
You can search for replication messages from SAP Subscription Billing, SAP Master Data Integration and SAP
S/4HANA Cloud as follows:
• For product replication, the messages can be searched by the product ID. The messages from SAP
Subscription Billing, SAP Master Data Integration and SAP S/4HANA Cloud can be correlated.
• For business partner replication, the messages can be searched by the customer ID. However, only the
messages from SAP Subscription Billing and SAP Master Data Integration can be correlated.
For details on how to use the application for monitoring, see Integration & Exception Monitoring .
More information
Visit SAP Cloud ALM to get more information about SAP Cloud ALM. Here you can find information about how
to request SAP Cloud ALM, and you also have access to learning materials, demo videos and more.
Integration Guide
Integration with SAP Master Data Integration PUBLIC 377
10 Integration with SAP Convergent
Mediation by DigitalRoute, cloud edition
This integration enables you to collect usage data and ensure its quality using SAP Convergent Mediation by
DigitalRoute, cloud edition, and to send the data to SAP Subscription Billing for rating and billing.
You can find information about setting up the integration in the DigitalRoute documentation .
Integration Guide
378 PUBLIC Integration with SAP Convergent Mediation by DigitalRoute, cloud edition
11 Integration with SAP Digital Payments
Add-On
SAP digital payments add-on is a SAP BTP application that enables consumer applications to support credit
card and other digital payment methods. SAP digital payments add-on provides ready-to-use connectivity to
external payment service providers (PSPs).
By integrating SAP digital payments add-on with SAP Subscription Billing, you enable the following processes:
• Tokenization of credit card data to ensure fulfillment of the Payment Card Industry Data Security Standard
• Validation of credit card tokens
• Settlement of credit card payments
By default, settlement of credit card payments for subscriptions is triggered by a back-end system that is also
integrated with the SAP digital payments add-on (namely SAP S/4HANA, SAP S/4HANA Cloud, or an external
back-end system). Alternatively you can choose to trigger the settlement of credit card payments directly from
SAP Subscription Billing. You can find detailed information about these scenarios below in the setup step 3.
Activate credit card payments and determine settlement.
Note
You can also integrate SAP Subscription Billing directly with an external payment service provider (PSP)
instead of integrating with SAP digital payments add-on. In this case some restrictions apply. For more
information, see Payments in the Feature Overview.
Prerequisites
• You require a separate license to use the SAP digital payments add-on.
• To enable SAP Subscription Billing to trigger credit card payment settlement, you must use gross amounts
and select the price type Gross Prices for the relevant markets in Business Configuration.
Note
The user interfaces of the SAP digital payments add-on are only available in English.
To set up integration with the SAP digital payments add-on, complete the following steps in the given
sequence:
You need to configure your payment service providers in the SAP digital payments add-on. The determination
of PSPs and merchant IDs is based on the following parameters and values:
Integration Guide
Integration with SAP Digital Payments Add-On PUBLIC 379
Parameter Provided by SAP Digital Payments Add-On Value Provided by SAP Subscription Billing
Payment Method CC
Currency (only supported for PSPs that store credit card tokens inde
pendently of the merchant)
Some payment service providers store credit card tokens on merchant level (different tokens for each
merchant ID for the same credit card). Others PSPs store tokens independently of the merchant. If your PSP
stores credit card tokens on merchant level, you cannot use the currency as a parameter for determining the
PSP and merchant ID. This is because SAP Subscription Billing does not always know the currency when the
credit card data is entered.
If your PSP stores only one credit card token for all of your merchant IDs, you can use the currency to
determine the PSP. In this case, the merchant is only determined when you create a charge or a refund. Since
charges and refunds always contain the currency, the merchant can be determined accordingly.
2. Define a destination
You need to set up the connectivity between SAP Subscription Billing and SAP digital payments add-on by
defining destinations in SAP BTP.
Note
Integration Guide
380 PUBLIC Integration with SAP Digital Payments Add-On
Field Name/Setting Value Comment
Type HTTP
Authentication OAuth2ClientCredentials
Client ID The clientid in your service key. You must have created service keys
in your subaccount for the SAP digital
payments add-on.
Client Secret The clientsecret in your service key. See above comment.
Integration Guide
Integration with SAP Digital Payments Add-On PUBLIC 381
Field Name/Setting Value Comment
Once you have configured PSPs and defined a destination, you can activate credit cards as a payment method
in SAP Subscription Billing. If you do not activate credit cards, the payment method Invoice is used by default.
You activate credit card payments in Business Configuration (in theManage Business Configuration app, you do
this on the Integration Settings screen). After activating, you can test the connection to SAP digital payments
add-on. If the connection is not successful, check the credentials you received and the entries you made
and try to set up the connection again. If it continues to fail, please create a ticket using the component
FIN-FSCM-HCP-DP.
Note
If you deactivate credit card payments later, credit cards cannot be entered for new documents. However,
existing documents with credit cards will not be affected and will continue to be settled unless the payment
method is changed to Invoice manually or by API.
Settlements
In Business Configuration, you determine which system should trigger the settlement of credit card payments
(in the Manage Business Configuration app, you make this setting on the Integration Settings screen). The
following scenarios are supported:
• Default setting: Settlement is triggered by the back-end system (SAP S/4HANA, SAP S/4HANA Cloud, or
an external system) that is integrated with SAP digital payments add-on.
• Settlement is triggered by SAP Subscription Billing, not by the external back-end system (even if it is
integrated with SAP digital payments add-on).
Note
If no predefined integration exists between SAP Subscription Billing and the back-end system, you need to
implement a custom integration.
Integration Guide
382 PUBLIC Integration with SAP Digital Payments Add-On
The following graphics show the data flow for these scenarios:
Settlement Triggered by SAP S/4HANA, SAP S/4HANA Cloud, or an External Back-End System
If you trigger the settlement of credit card payments directly from SAP Subscription Billing, the bill amount is
charged or credited once a bill reaches its billing date. Payment transaction details are linked to the bill and can
be retrieved using the Bills API (see Bills in the API Guide).
Note
Settlement is triggered once automatically. If it fails, the payment status Failed/FAILED (for card-related
problems) or Technical Error/ERROR is set for the bill. In case of technical errors, it can make sense to
retrigger settlement using the Bills API.
Integration Guide
Integration with SAP Digital Payments Add-On PUBLIC 383
More Information
You can find all the information that you need to set up and configure SAP digital payments add-on in the
Administration Guide for SAP Digital Payments Add-On.
Integration Guide
384 PUBLIC Integration with SAP Digital Payments Add-On
Important Disclaimers and Legal Information
Hyperlinks
Some links are classified by an icon and/or a mouseover text. These links provide additional information.
About the icons:
• Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your
agreements with SAP) to this:
• The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.
• SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any
damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.
• Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering an SAP-hosted Web site. By using
such links, you agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this
information.
Example Code
Any software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax
and phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of
example code unless damages have been caused by SAP's gross negligence or willful misconduct.
Bias-Free Language
SAP supports a culture of diversity and inclusion. Whenever possible, we use unbiased language in our documentation to refer to people of all cultures, ethnicities,
genders, and abilities.
Integration Guide
Important Disclaimers and Legal Information PUBLIC 385
www.sap.com/contactsap
SAP and other SAP products and services mentioned herein as well as
their respective logos are trademarks or registered trademarks of SAP
SE (or an SAP affiliate company) in Germany and other countries. All
other product and service names mentioned are the trademarks of their
respective companies.