Simulation API for Returns/CMR/DMR

[former_member624357]

Following 3 new OData APIs are available as of SAP S/4HANA Cloud 2302:

• Credit Memo Request – Simulate (A2X)


• Debit Memo Request – Simulate (A2X)


• Customer Return – Simulate (A2X)

This synchronous inbound OData services enable you to simulate the creation of a credit memo request (CMR), debit memo request (DMR), and returns order.

The simulation helps you get the correct information about the CMR, DMR, and returns order, such as the document data, business partners, and price elements. The customer fields and customer logic are also supported. The simulated CMR, DMR, returns order is not saved.

If the request of the simulated CMR, DMR, returns order is successful, you can use it to create a CMR/DMR/Return by the related OData APIs. If the error happened, error message from backend would be raised in the response.

The 3 new OData APIs’ information is listed below:

• Technical name: API_CREDIT_MEMO_REQ_SIMULATION_SRV


• Technical name: API_DEBIT_MEMO_REQ_SIMULATION_SRV


• Technical name: API_CUSTOMER_RETURN_SIMULATION_SRV

HOW TO USE SIMULATION API?

For example, you can simulate a CMR with one item via the Credit Memo Request – Simulate (A2X) API.

1. Open and Configure your Postman (including your login password, service URL, method)


2. Prepared your payload about credit memo request data


3. Click send and waiting for the response in the body


4. Check the response body which including the message you would like to create (but actually the document will not be saved).


5. If error happened, the error message will be observed in the response body

For another example, you can also simulate a CMR with reference a billing document including one item via the Credit Memo Request – Simulate (A2X) API.

1. Open and Configure your Postman (including your login password, service URL, method) as the same way


2. Prepared your payload about credit memo request data, in the case of simulating a CMR with reference, you could provide the field ReferenceSDDocument.


3. Check the response body which including the message you would like to create (but actually the document will not be saved).

 

For further understanding, you could check the Help Documents of the Simulation APIs:

Customer Return - Simulate (A2X) | SAP Help Portal

Credit Memo Request - Simulate (A2X) | SAP Help Portal

Debit Memo Request - Simulate (A2X) | SAP Help Portal