Documentation Index

Fetch the complete documentation index at: https://payhawk.document360.io/llms.txt

Use this file to discover all available pages before exploring further.

Enabling API services on SAP S/4HANA Cloud, Private Edition

Prev Next

When building custom or standard integrations with SAP S/4HANA® Private Cloud, simply granting user authorizations is only half of the work. The target interfaces must be explicitly activated and published within the system's communication frameworks.

SAP S/4HANA environments utilize three distinct communication architectures: OData V2, OData V4, and SOAP Web Services. Since they run on separate technical engines, they are activated using different transactions.

This guide provides a straightforward blueprint for publishing your required financial, project, and master data endpoints.

Part 1: Activating OData V2 Services (Transaction /IWFND/MAINT_SERVICE)

Traditional SAP REST-based APIs utilize the OData V2 architecture. These services must be added to your system's service catalog and linked to a system alias to turn on their URLs.

Target V2 Service Inventory

Verify and enable the following services using this method:

  • Chart of Accounts: API_CHARTOFACCOUNTS_SRV

  • GL Accounts in Chart of Accounts: API_GLACCOUNTINCHARTOFACCOUNTS_SRV

  • Company Code: API_COMPANYCODE_SRV

  • Bank Reconciliation: API_CN_BANK_RECONCILIAITON_SRV

  • Business Partner: API_BUSINESS_PARTNER

  • Enterprise Project: API_ENTERPRISE_PROJECT_SRV (Ensure that version is set to 0002 during setup)

  • Supplier Invoice Process: API_SUPPLIERINVOICE_PROCESS_SRV

  • Attachments: API_CV_ATTACHMENT_SRV

  • Accounting Document Items: API_OPLACCTGDOCITEMCUBE_SRV

  • WBS Elements: API_FINWBSELEMENT_SRV

  • Internal Orders: API_INTERNALORDER_SRV

  • Profit Center: API_PROFITCENTER_SRV

Activation Steps

  1. Execute transaction /IWFND/MAINT_SERVICE in the SAP GUI.

  2. Look at the Service Catalog table. If a service from the inventory list is missing, click the Add Service button on the top toolbar.

  3. In the next screen, enter LOCAL in the System Alias field.

  4. Paste the technical name of your target service (for example, API_COMPANYCODE_SRV) into the Technical Service Name field and press Enter.

  5. Select the matching service row from the search results grid and click Add Selected Services.

  6. In the popup window, assign a package assignment (or choose $TMP for local, untransported testing) and confirm.

  7. Go back to the main catalog screen, select your newly added service, and verify under ICF Nodes (bottom left) that the status light is green. If it is red, click ICF Node > Activate.

Part 2: Publishing OData V4 Service Groups (Transaction /IWFND/V4_ADMIN)

Modern S/4HANA applications leverage the high-performance OData V4 architecture. Unlike V2, OData V4 endpoints are published as consolidated Service Groups.

Target V4 Service Group Inventory

Publish the following next-generation endpoints using the OData V4 gateway engine:

Technical Service Name

Target Service Group ID

API Path Endpoint

Z_BANK_ACCOUNT_SRV

Z_BANK_ACCOUNT_SRV_O4

/sap/opu/odata4/sap/z_bank_account_srv_o4/...

COSTCENTER

API_COST_CENTER

/sap/opu/odata4/sap/api_cost_center/...

ZUI_TAXCODE_API_PUB

ZAPI_TAXCODE_V4_PUB

/sap/opu/odata4/sap/zapi_taxcode_v4_pub/...

ZUI_TAXCODE_API_PRIV

ZAPI_TAXCODE_V4_PRIV

/sap/opu/odata4/sap/zapi_taxcode_v4_priv/...

Z_GLACCOUNT_SRV

Z_GLACCOUNT_SB

/sap/opu/odata4/sap/z_glaccount_sb/...

Activation steps

  1. Execute transaction /IWFND/V4_ADMIN in the SAP GUI.

  2. On the top toolbar, click the Publish Service Groups button.

  3. Enter LOCAL in the System Alias field.

  4. Input your target Service Group ID from the table above (for example, API_COST_CENTER) and click Get Service Groups.

  5. Select the service group line item from the grid and click Publish Service Groups.

  6. Provide a description if prompted, select your development package (or $TMP), and assign a Customizing Transport Request if required by your landscape's transport rules.

  7. Click Confirm. The service group will now appear in your active V4 catalog.

Part 3: Simplified Web Service Configuration (via SOAMANAGER)

For transactional document processing and bulk data transmissions (such as posting journal entries or processing bank statements), S/4HANA utilizes inbound SOAP Web Services. Instead of clicking through a complex deployment wizard for every single interface, you can activate them all at once using the simplified configuration manager.

Target SOAP Web Service Inventory

Enable communication channels for these specific backend interfaces:

  • Bank Statement Posting: BANKSTATEMENTPOST_IN

  • Journal Entry Bulk Clearing: JOURNALENTRYBULKCLEARINGREQUES

  • Journal Entry Confirmation: JOURNALENTRYCREATEREQUESTCONFI

Configuration steps

  1. Execute transaction SOAMANAGER in your SAP GUI. This will automatically open the SOA Manager administration console in your web browser.

  2. Navigate to the Simplified Web Service Configuration tool (located under the Service Administration tab).

  3. In the Search Pattern field at the top of the screen, type JOURNAL* (or target a specific service from the list) and click Go.

  4. Locate your target services in the grid rows.

  5. For each service, simply check the boxes under both the User Name/Password (Basic) and X.509 Client Certificate columns.

  6. Click on the Save button on the top-left toolbar.

The system will activate the endpoints immediately and display an Activation successful message at the bottom of the screen, making the interfaces instantly ready to receive incoming data.

Next steps