Module sap.s4hana.api_credit_memo_request_srv

ballerinax/sap.s4hana.api_credit_memo_request_srv Ballerina library

1.0.0

Overview

S/4HANA is a robust enterprise resource planning (ERP) solution, designed for large-scale enterprises by SAP SE.

The SAP S/4HANA Sales connector provides APIs that enable seamless integration with the Credit Memo Request (A2X) API v1.0.0. The service allows to create, read, update, and delete credit memo requests, including their items, partners, pricing elements, and texts.

Key Features

  • Create, read, update, and delete credit memo requests in SAP S/4HANA
  • Seamless integration with the Credit Memo Request (A2X) API v1.0.0
  • Support for basic and OAuth 2.0 authentication
  • Manage items, partners, pricing elements, and texts, and release or reject approval requests

Setup guide

  1. Sign in to your S/4HANA dashboard.

  2. Under the Communication Management section, click on the Display Communications Scenario title.

    Display Scenarios

  3. In the search bar, type Credit Memo Request Integration and select the corresponding scenario from the results.

    Search Sales Order

  4. In the top right corner of the screen, click on Create Communication Arrangement.

    Click Create Arrangement

  5. Enter a unique name for the arrangement.

    Give Arrangement Name

  6. Choose an existing Communication System from the dropdown menu and save your arrangement.

    Select Existing Communication Arrangement

  7. The hostname (<unique id>-api.s4hana.cloud.sap) will be displayed in the top right corner of the screen.

    View Hostname

Quickstart

To use the sap.s4hana.api_credit_memo_request_srv connector in your Ballerina application, modify the .bal file as follows:

Step 1: Import the module

Import the sap.s4hana.api_credit_memo_request_srv module.

Copy
import ballerinax/sap.s4hana.api_credit_memo_request_srv as creditmemo;

Step 2: Instantiate a new connector

Use the hostname and credentials to initiate a client

Copy
configurable string hostname = ?;
configurable string username = ?;
configurable string password = ?;

creditmemo:Client creditMemoClient = check new (
    {
      auth: {
        username,
        password
      }
    },
    hostname
);

Step 3: Invoke the connector operation

Now, utilize the available connector operations.

Copy
creditmemo:CollectionOfA_CreditMemoRequestWrapper listACreditMemoRequests = check creditMemoClient->listA_CreditMemoRequests();

Step 4: Run the Ballerina application

Copy
bal run

Examples

The S/4 HANA Sales and Distribution Ballerina connectors provide practical examples illustrating usage in various scenarios. Explore these examples, covering use cases like accessing S/4HANA Sales Order (A2X) API.

  1. Salesforce to S/4HANA Integration - Demonstrates leveraging the sap.s4hana.api_sales_order_srv:Client in Ballerina for S/4HANA API interactions. It specifically showcases how to respond to a Salesforce Opportunity Close Event by automatically generating a Sales Order in the S/4HANA SD module.

  2. Shopify to S/4HANA Integration - Details the integration process between Shopify, a leading e-commerce platform, and SAP S/4HANA, a comprehensive ERP system. The objective is to automate SAP sales order creation for new orders placed on Shopify, enhancing efficiency and accuracy in order management.

Import

import ballerinax/sap.s4hana.api_credit_memo_request_srv;Copy

Other versions

1.0.0

Metadata

Released date: about 19 hours ago

Version: 1.0.0

License: Apache-2.0


Security

No known vulnerabilities in libraries

Checked on 2026-11-13 via OSV.dev


Compatibility

Platform: any

Ballerina version: 2201.13.0

GraalVM compatible: Yes


Pull count

Total: 1

Current verison: 1


Weekly downloads


Source repository


Keywords

Name/SAP S/4HANA Credit Memo Request API

Type/Connector

Vendor/SAP

Area/ERP & Business Operations

Business Management/ERP

Cost/Paid

Sales and Distribution

SD


Contributors