CreditMemoRequestService (SAP S/4HANA Cloud SDK

All Known Implementing Classes:: DefaultCreditMemoRequestService

public interface CreditMemoRequestService

You can use this service to integrate external applications with credit memo request processing in SAP S/4HANA Cloud. In every API call, you can make use of the following operations: - You can retrieve credit memo requests. Apply any of the filters provided or retrieve all existing data. - You can create credit memo requests. Note that you must use “deep insert” requests (a header plus the following entities: header partner, header pricing element, item, item partner, and item pricing element). You cannot create entities without including any related entities. - For existing credit memo requests, you can create new items. Note that you must use “deep insert” requests (with the following entities: item partner and item pricing element). You cannot create entities without including any related entities. - For existing credit memo requests, you can update the header, header partner, header pricing element, item, item partner, and item pricing element. - For existing credit memo requests, you can delete the header, header partner, header pricing element, item, item partner, and item pricing element..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_CREDIT_MEMO_REQUEST_SRV
API Version:	1
Communication Scenario:	Credit Memo Request Integration (SAP_COM_0158)
Scope Items:	Credit Memo Processing (1EZ), Invoice Correction Process with Credit Memo (BKL)
Business Object:	CreditMemoRequest

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CreditMemoRequestCreateFluentHelper`	`createCreditMemoRequest(CreditMemoRequest creditMemoRequest)` Create a new `CreditMemoRequest` entity and save it to the S/4HANA system.
`CreditMemoRequestItemCreateFluentHelper`	`createCreditMemoRequestItem(CreditMemoRequestItem creditMemoRequestItem)` Create a new `CreditMemoRequestItem` entity and save it to the S/4HANA system.
`CreditMemoReqItemPartnerDeleteFluentHelper`	`deleteCreditMemoReqItemPartner(CreditMemoReqItemPartner creditMemoReqItemPartner)` Deletes an existing `CreditMemoReqItemPartner` entity in the S/4HANA system.
`CreditMemoReqItemPrcgElmntDeleteFluentHelper`	`deleteCreditMemoReqItemPrcgElmnt(CreditMemoReqItemPrcgElmnt creditMemoReqItemPrcgElmnt)` Deletes an existing `CreditMemoReqItemPrcgElmnt` entity in the S/4HANA system.
`CreditMemoReqPartnerDeleteFluentHelper`	`deleteCreditMemoReqPartner(CreditMemoReqPartner creditMemoReqPartner)` Deletes an existing `CreditMemoReqPartner` entity in the S/4HANA system.
`CreditMemoReqPrcgElmntDeleteFluentHelper`	`deleteCreditMemoReqPrcgElmnt(CreditMemoReqPrcgElmnt creditMemoReqPrcgElmnt)` Deletes an existing `CreditMemoReqPrcgElmnt` entity in the S/4HANA system.
`CreditMemoRequestDeleteFluentHelper`	`deleteCreditMemoRequest(CreditMemoRequest creditMemoRequest)` Deletes an existing `CreditMemoRequest` entity in the S/4HANA system.
`CreditMemoRequestItemDeleteFluentHelper`	`deleteCreditMemoRequestItem(CreditMemoRequestItem creditMemoRequestItem)` Deletes an existing `CreditMemoRequestItem` entity in the S/4HANA system.
`CreditMemoReqItemPartnerFluentHelper`	`getAllCreditMemoReqItemPartner()` Fetch multiple `CreditMemoReqItemPartner` entities.
`CreditMemoReqItemPrcgElmntFluentHelper`	`getAllCreditMemoReqItemPrcgElmnt()` Fetch multiple `CreditMemoReqItemPrcgElmnt` entities.
`CreditMemoReqPartnerFluentHelper`	`getAllCreditMemoReqPartner()` Fetch multiple `CreditMemoReqPartner` entities.
`CreditMemoReqPrcgElmntFluentHelper`	`getAllCreditMemoReqPrcgElmnt()` Fetch multiple `CreditMemoReqPrcgElmnt` entities.
`CreditMemoRequestFluentHelper`	`getAllCreditMemoRequest()` Fetch multiple `CreditMemoRequest` entities.
`CreditMemoRequestItemFluentHelper`	`getAllCreditMemoRequestItem()` Fetch multiple `CreditMemoRequestItem` entities.
`CreditMemoReqItemPartnerByKeyFluentHelper`	`getCreditMemoReqItemPartnerByKey(String creditMemoRequest, String creditMemoRequestItem, String partnerFunction)` Fetch a single `CreditMemoReqItemPartner` entity using key fields.
`CreditMemoReqItemPrcgElmntByKeyFluentHelper`	`getCreditMemoReqItemPrcgElmntByKey(String creditMemoRequest, String creditMemoRequestItem, String pricingProcedureStep, String pricingProcedureCounter)` Fetch a single `CreditMemoReqItemPrcgElmnt` entity using key fields.
`CreditMemoReqPartnerByKeyFluentHelper`	`getCreditMemoReqPartnerByKey(String creditMemoRequest, String partnerFunction)` Fetch a single `CreditMemoReqPartner` entity using key fields.
`CreditMemoReqPrcgElmntByKeyFluentHelper`	`getCreditMemoReqPrcgElmntByKey(String creditMemoRequest, String pricingProcedureStep, String pricingProcedureCounter)` Fetch a single `CreditMemoReqPrcgElmnt` entity using key fields.
`CreditMemoRequestByKeyFluentHelper`	`getCreditMemoRequestByKey(String creditMemoRequest)` Fetch a single `CreditMemoRequest` entity using key fields.
`CreditMemoRequestItemByKeyFluentHelper`	`getCreditMemoRequestItemByKey(String creditMemoRequest, String creditMemoRequestItem)` Fetch a single `CreditMemoRequestItem` entity using key fields.
`CreditMemoReqItemPartnerUpdateFluentHelper`	`updateCreditMemoReqItemPartner(CreditMemoReqItemPartner creditMemoReqItemPartner)` Update an existing `CreditMemoReqItemPartner` entity and save it to the S/4HANA system.
`CreditMemoReqItemPrcgElmntUpdateFluentHelper`	`updateCreditMemoReqItemPrcgElmnt(CreditMemoReqItemPrcgElmnt creditMemoReqItemPrcgElmnt)` Update an existing `CreditMemoReqItemPrcgElmnt` entity and save it to the S/4HANA system.
`CreditMemoReqPartnerUpdateFluentHelper`	`updateCreditMemoReqPartner(CreditMemoReqPartner creditMemoReqPartner)` Update an existing `CreditMemoReqPartner` entity and save it to the S/4HANA system.
`CreditMemoReqPrcgElmntUpdateFluentHelper`	`updateCreditMemoReqPrcgElmnt(CreditMemoReqPrcgElmnt creditMemoReqPrcgElmnt)` Update an existing `CreditMemoReqPrcgElmnt` entity and save it to the S/4HANA system.
`CreditMemoRequestUpdateFluentHelper`	`updateCreditMemoRequest(CreditMemoRequest creditMemoRequest)` Update an existing `CreditMemoRequest` entity and save it to the S/4HANA system.
`CreditMemoRequestItemUpdateFluentHelper`	`updateCreditMemoRequestItem(CreditMemoRequestItem creditMemoRequestItem)` Update an existing `CreditMemoRequestItem` entity and save it to the S/4HANA system.

- Method Detail
  - getAllCreditMemoReqItemPartner
```
CreditMemoReqItemPartnerFluentHelper getAllCreditMemoReqItemPartner()
```
    Fetch multiple CreditMemoReqItemPartner entities.
    
    Returns:
    
    A fluent helper to fetch multiple CreditMemoReqItemPartner entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - getCreditMemoReqItemPartnerByKey
```
CreditMemoReqItemPartnerByKeyFluentHelper getCreditMemoReqItemPartnerByKey(String creditMemoRequest,
                                                                           String creditMemoRequestItem,
                                                                           String partnerFunction)
```
    Fetch a single CreditMemoReqItemPartner entity using key fields.
    
    Parameters:
    
    partnerFunction - The abbreviated form of the name that identifies the partner function.
    Constraints: Not nullable, Maximum length: 2
    
    creditMemoRequest - The number that uniquely identifies the sales, delivery, or billing document.
    Constraints: Not nullable, Maximum length: 10
    
    creditMemoRequestItem - The number that uniquely identifies the item in the sales, shipping, or billing document.
    Constraints: Not nullable, Maximum length: 6
    
    Returns:
    
    A fluent helper to fetch a single CreditMemoReqItemPartner entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - updateCreditMemoReqItemPartner
```
CreditMemoReqItemPartnerUpdateFluentHelper updateCreditMemoReqItemPartner(CreditMemoReqItemPartner creditMemoReqItemPartner)
```
    Update an existing CreditMemoReqItemPartner entity and save it to the S/4HANA system.
    
    Parameters:
    
    creditMemoReqItemPartner - CreditMemoReqItemPartner entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing CreditMemoReqItemPartner entity. To perform execution, call the execute method on the fluent helper object.
  - deleteCreditMemoReqItemPartner
```
CreditMemoReqItemPartnerDeleteFluentHelper deleteCreditMemoReqItemPartner(CreditMemoReqItemPartner creditMemoReqItemPartner)
```
    Deletes an existing CreditMemoReqItemPartner entity in the S/4HANA system.
    
    Parameters:
    
    creditMemoReqItemPartner - CreditMemoReqItemPartner entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing CreditMemoReqItemPartner entity. To perform execution, call the execute method on the fluent helper object.
  - getAllCreditMemoReqItemPrcgElmnt
```
CreditMemoReqItemPrcgElmntFluentHelper getAllCreditMemoReqItemPrcgElmnt()
```
    Fetch multiple CreditMemoReqItemPrcgElmnt entities.
    
    Returns:
    
    A fluent helper to fetch multiple CreditMemoReqItemPrcgElmnt entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - getCreditMemoReqItemPrcgElmntByKey
```
CreditMemoReqItemPrcgElmntByKeyFluentHelper getCreditMemoReqItemPrcgElmntByKey(String creditMemoRequest,
                                                                               String creditMemoRequestItem,
                                                                               String pricingProcedureStep,
                                                                               String pricingProcedureCounter)
```
    Fetch a single CreditMemoReqItemPrcgElmnt entity using key fields.
    
    Parameters:
    
    pricingProcedureCounter - Access number of the conditions within a step in the pricing procedure.
    Constraints: Not nullable, Maximum length: 3
    
    creditMemoRequest - The number that uniquely identifies the sales document.
    Constraints: Not nullable, Maximum length: 10
    
    creditMemoRequestItem - The number that uniquely identifies the condition item.
    Constraints: Not nullable, Maximum length: 6
    
    pricingProcedureStep - Number that determines the sequence of the condition within a procedure.
    Constraints: Not nullable, Maximum length: 3
    
    Returns:
    
    A fluent helper to fetch a single CreditMemoReqItemPrcgElmnt entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - updateCreditMemoReqItemPrcgElmnt
```
CreditMemoReqItemPrcgElmntUpdateFluentHelper updateCreditMemoReqItemPrcgElmnt(CreditMemoReqItemPrcgElmnt creditMemoReqItemPrcgElmnt)
```
    Update an existing CreditMemoReqItemPrcgElmnt entity and save it to the S/4HANA system.
    
    Parameters:
    
    creditMemoReqItemPrcgElmnt - CreditMemoReqItemPrcgElmnt entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing CreditMemoReqItemPrcgElmnt entity. To perform execution, call the execute method on the fluent helper object.
  - deleteCreditMemoReqItemPrcgElmnt
```
CreditMemoReqItemPrcgElmntDeleteFluentHelper deleteCreditMemoReqItemPrcgElmnt(CreditMemoReqItemPrcgElmnt creditMemoReqItemPrcgElmnt)
```
    Deletes an existing CreditMemoReqItemPrcgElmnt entity in the S/4HANA system.
    
    Parameters:
    
    creditMemoReqItemPrcgElmnt - CreditMemoReqItemPrcgElmnt entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing CreditMemoReqItemPrcgElmnt entity. To perform execution, call the execute method on the fluent helper object.
  - getAllCreditMemoReqPartner
```
CreditMemoReqPartnerFluentHelper getAllCreditMemoReqPartner()
```
    Fetch multiple CreditMemoReqPartner entities.
    
    Returns:
    
    A fluent helper to fetch multiple CreditMemoReqPartner entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - getCreditMemoReqPartnerByKey
```
CreditMemoReqPartnerByKeyFluentHelper getCreditMemoReqPartnerByKey(String creditMemoRequest,
                                                                   String partnerFunction)
```
    Fetch a single CreditMemoReqPartner entity using key fields.
    
    Parameters:
    
    partnerFunction - The abbreviated form of the name that identifies the partner function.
    Constraints: Not nullable, Maximum length: 2
    
    creditMemoRequest - The number that uniquely identifies the sales, delivery, or billing document.
    Constraints: Not nullable, Maximum length: 10
    
    Returns:
    
    A fluent helper to fetch a single CreditMemoReqPartner entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - updateCreditMemoReqPartner
```
CreditMemoReqPartnerUpdateFluentHelper updateCreditMemoReqPartner(CreditMemoReqPartner creditMemoReqPartner)
```
    Update an existing CreditMemoReqPartner entity and save it to the S/4HANA system.
    
    Parameters:
    
    creditMemoReqPartner - CreditMemoReqPartner entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing CreditMemoReqPartner entity. To perform execution, call the execute method on the fluent helper object.
  - deleteCreditMemoReqPartner
```
CreditMemoReqPartnerDeleteFluentHelper deleteCreditMemoReqPartner(CreditMemoReqPartner creditMemoReqPartner)
```
    Deletes an existing CreditMemoReqPartner entity in the S/4HANA system.
    
    Parameters:
    
    creditMemoReqPartner - CreditMemoReqPartner entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing CreditMemoReqPartner entity. To perform execution, call the execute method on the fluent helper object.
  - getAllCreditMemoReqPrcgElmnt
```
CreditMemoReqPrcgElmntFluentHelper getAllCreditMemoReqPrcgElmnt()
```
    Fetch multiple CreditMemoReqPrcgElmnt entities.
    
    Returns:
    
    A fluent helper to fetch multiple CreditMemoReqPrcgElmnt entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - getCreditMemoReqPrcgElmntByKey
```
CreditMemoReqPrcgElmntByKeyFluentHelper getCreditMemoReqPrcgElmntByKey(String creditMemoRequest,
                                                                       String pricingProcedureStep,
                                                                       String pricingProcedureCounter)
```
    Fetch a single CreditMemoReqPrcgElmnt entity using key fields.
    
    Parameters:
    
    pricingProcedureCounter - Access number of the conditions within a step in the pricing procedure.
    Constraints: Not nullable, Maximum length: 3
    
    creditMemoRequest - The number that uniquely identifies the sales document.
    Constraints: Not nullable, Maximum length: 10
    
    pricingProcedureStep - Number that determines the sequence of the condition within a procedure.
    Constraints: Not nullable, Maximum length: 3
    
    Returns:
    
    A fluent helper to fetch a single CreditMemoReqPrcgElmnt entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - updateCreditMemoReqPrcgElmnt
```
CreditMemoReqPrcgElmntUpdateFluentHelper updateCreditMemoReqPrcgElmnt(CreditMemoReqPrcgElmnt creditMemoReqPrcgElmnt)
```
    Update an existing CreditMemoReqPrcgElmnt entity and save it to the S/4HANA system.
    
    Parameters:
    
    creditMemoReqPrcgElmnt - CreditMemoReqPrcgElmnt entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing CreditMemoReqPrcgElmnt entity. To perform execution, call the execute method on the fluent helper object.
  - deleteCreditMemoReqPrcgElmnt
```
CreditMemoReqPrcgElmntDeleteFluentHelper deleteCreditMemoReqPrcgElmnt(CreditMemoReqPrcgElmnt creditMemoReqPrcgElmnt)
```
    Deletes an existing CreditMemoReqPrcgElmnt entity in the S/4HANA system.
    
    Parameters:
    
    creditMemoReqPrcgElmnt - CreditMemoReqPrcgElmnt entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing CreditMemoReqPrcgElmnt entity. To perform execution, call the execute method on the fluent helper object.
  - getAllCreditMemoRequest
```
CreditMemoRequestFluentHelper getAllCreditMemoRequest()
```
    Fetch multiple CreditMemoRequest entities.
    
    Returns:
    
    A fluent helper to fetch multiple CreditMemoRequest entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - getCreditMemoRequestByKey
```
CreditMemoRequestByKeyFluentHelper getCreditMemoRequestByKey(String creditMemoRequest)
```
    Fetch a single CreditMemoRequest entity using key fields.
    
    Parameters:
    
    creditMemoRequest - Credit Memo Request
    Constraints: Not nullable, Maximum length: 10
    
    Returns:
    
    A fluent helper to fetch a single CreditMemoRequest entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - createCreditMemoRequest
```
CreditMemoRequestCreateFluentHelper createCreditMemoRequest(CreditMemoRequest creditMemoRequest)
```
    Create a new CreditMemoRequest entity and save it to the S/4HANA system.
    
    Parameters:
    
    creditMemoRequest - CreditMemoRequest entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new CreditMemoRequest entity. To perform execution, call the execute method on the fluent helper object.
  - updateCreditMemoRequest
```
CreditMemoRequestUpdateFluentHelper updateCreditMemoRequest(CreditMemoRequest creditMemoRequest)
```
    Update an existing CreditMemoRequest entity and save it to the S/4HANA system.
    
    Parameters:
    
    creditMemoRequest - CreditMemoRequest entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing CreditMemoRequest entity. To perform execution, call the execute method on the fluent helper object.
  - deleteCreditMemoRequest
```
CreditMemoRequestDeleteFluentHelper deleteCreditMemoRequest(CreditMemoRequest creditMemoRequest)
```
    Deletes an existing CreditMemoRequest entity in the S/4HANA system.
    
    Parameters:
    
    creditMemoRequest - CreditMemoRequest entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing CreditMemoRequest entity. To perform execution, call the execute method on the fluent helper object.
  - getAllCreditMemoRequestItem
```
CreditMemoRequestItemFluentHelper getAllCreditMemoRequestItem()
```
    Fetch multiple CreditMemoRequestItem entities.
    
    Returns:
    
    A fluent helper to fetch multiple CreditMemoRequestItem entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - getCreditMemoRequestItemByKey
```
CreditMemoRequestItemByKeyFluentHelper getCreditMemoRequestItemByKey(String creditMemoRequest,
                                                                     String creditMemoRequestItem)
```
    Fetch a single CreditMemoRequestItem entity using key fields.
    
    Parameters:
    
    creditMemoRequest - Credit Memo Request
    Constraints: Not nullable, Maximum length: 10
    
    creditMemoRequestItem - Credit Memo Request Item
    Constraints: Not nullable, Maximum length: 6
    
    Returns:
    
    A fluent helper to fetch a single CreditMemoRequestItem entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.
  - createCreditMemoRequestItem
```
CreditMemoRequestItemCreateFluentHelper createCreditMemoRequestItem(CreditMemoRequestItem creditMemoRequestItem)
```
    Create a new CreditMemoRequestItem entity and save it to the S/4HANA system.
    
    Parameters:
    
    creditMemoRequestItem - CreditMemoRequestItem entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new CreditMemoRequestItem entity. To perform execution, call the execute method on the fluent helper object.
  - updateCreditMemoRequestItem
```
CreditMemoRequestItemUpdateFluentHelper updateCreditMemoRequestItem(CreditMemoRequestItem creditMemoRequestItem)
```
    Update an existing CreditMemoRequestItem entity and save it to the S/4HANA system.
    
    Parameters:
    
    creditMemoRequestItem - CreditMemoRequestItem entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing CreditMemoRequestItem entity. To perform execution, call the execute method on the fluent helper object.
  - deleteCreditMemoRequestItem
```
CreditMemoRequestItemDeleteFluentHelper deleteCreditMemoRequestItem(CreditMemoRequestItem creditMemoRequestItem)
```
    Deletes an existing CreditMemoRequestItem entity in the S/4HANA system.
    
    Parameters:
    
    creditMemoRequestItem - CreditMemoRequestItem entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing CreditMemoRequestItem entity. To perform execution, call the execute method on the fluent helper object.

Interface CreditMemoRequestService

Details:

Method Summary

Method Detail

getAllCreditMemoReqItemPartner

getCreditMemoReqItemPartnerByKey

updateCreditMemoReqItemPartner

deleteCreditMemoReqItemPartner

getAllCreditMemoReqItemPrcgElmnt

getCreditMemoReqItemPrcgElmntByKey

updateCreditMemoReqItemPrcgElmnt

deleteCreditMemoReqItemPrcgElmnt

getAllCreditMemoReqPartner

getCreditMemoReqPartnerByKey

updateCreditMemoReqPartner

deleteCreditMemoReqPartner

getAllCreditMemoReqPrcgElmnt

getCreditMemoReqPrcgElmntByKey

updateCreditMemoReqPrcgElmnt

deleteCreditMemoReqPrcgElmnt

getAllCreditMemoRequest

getCreditMemoRequestByKey

createCreditMemoRequest

updateCreditMemoRequest

deleteCreditMemoRequest

getAllCreditMemoRequestItem

getCreditMemoRequestItemByKey

createCreditMemoRequestItem

updateCreditMemoRequestItem

deleteCreditMemoRequestItem