DebitMemoRequestService (SAP S/4HANA Cloud SDK

All Known Implementing Classes:: DefaultDebitMemoRequestService

public interface DebitMemoRequestService

You can use this service to integrate external applications with debit memo request processing in SAP S/4HANA Cloud. In every API call, you can make use of the following operations: - You can retrieve debit memo requests. Apply any of the filters provided or retrieve all existing data. - You can create debit 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 debit 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 debit memo requests, you can update the header, header partner, header pricing element, item, item partner, and item pricing element. - For existing debit 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_DEBIT_MEMO_REQUEST_SRV
API Version:	1
Communication Scenario:	Debit Memo Request Integration (SAP_COM_0159)
Scope Items:	Debit Memo Processing (1F1), Invoice Correction Process with Debit Memo (BDQ)
Business Object:	DebitMemoRequest

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`DebitMemoRequestCreateFluentHelper`	`createDebitMemoRequest(DebitMemoRequest debitMemoRequest)` Create a new `DebitMemoRequest` entity and save it to the S/4HANA system.
`DebitMemoRequestItemCreateFluentHelper`	`createDebitMemoRequestItem(DebitMemoRequestItem debitMemoRequestItem)` Create a new `DebitMemoRequestItem` entity and save it to the S/4HANA system.
`DebitMemoReqItemPartnerDeleteFluentHelper`	`deleteDebitMemoReqItemPartner(DebitMemoReqItemPartner debitMemoReqItemPartner)` Deletes an existing `DebitMemoReqItemPartner` entity in the S/4HANA system.
`DebitMemoReqItemPrcgElmntDeleteFluentHelper`	`deleteDebitMemoReqItemPrcgElmnt(DebitMemoReqItemPrcgElmnt debitMemoReqItemPrcgElmnt)` Deletes an existing `DebitMemoReqItemPrcgElmnt` entity in the S/4HANA system.
`DebitMemoReqPartnerDeleteFluentHelper`	`deleteDebitMemoReqPartner(DebitMemoReqPartner debitMemoReqPartner)` Deletes an existing `DebitMemoReqPartner` entity in the S/4HANA system.
`DebitMemoReqPrcgElmntDeleteFluentHelper`	`deleteDebitMemoReqPrcgElmnt(DebitMemoReqPrcgElmnt debitMemoReqPrcgElmnt)` Deletes an existing `DebitMemoReqPrcgElmnt` entity in the S/4HANA system.
`DebitMemoRequestDeleteFluentHelper`	`deleteDebitMemoRequest(DebitMemoRequest debitMemoRequest)` Deletes an existing `DebitMemoRequest` entity in the S/4HANA system.
`DebitMemoRequestItemDeleteFluentHelper`	`deleteDebitMemoRequestItem(DebitMemoRequestItem debitMemoRequestItem)` Deletes an existing `DebitMemoRequestItem` entity in the S/4HANA system.
`DebitMemoReqItemPartnerFluentHelper`	`getAllDebitMemoReqItemPartner()` Fetch multiple `DebitMemoReqItemPartner` entities.
`DebitMemoReqItemPrcgElmntFluentHelper`	`getAllDebitMemoReqItemPrcgElmnt()` Fetch multiple `DebitMemoReqItemPrcgElmnt` entities.
`DebitMemoReqPartnerFluentHelper`	`getAllDebitMemoReqPartner()` Fetch multiple `DebitMemoReqPartner` entities.
`DebitMemoReqPrcgElmntFluentHelper`	`getAllDebitMemoReqPrcgElmnt()` Fetch multiple `DebitMemoReqPrcgElmnt` entities.
`DebitMemoRequestFluentHelper`	`getAllDebitMemoRequest()` Fetch multiple `DebitMemoRequest` entities.
`DebitMemoRequestItemFluentHelper`	`getAllDebitMemoRequestItem()` Fetch multiple `DebitMemoRequestItem` entities.
`DebitMemoReqItemPartnerByKeyFluentHelper`	`getDebitMemoReqItemPartnerByKey(String debitMemoRequest, String debitMemoRequestItem, String partnerFunction)` Fetch a single `DebitMemoReqItemPartner` entity using key fields.
`DebitMemoReqItemPrcgElmntByKeyFluentHelper`	`getDebitMemoReqItemPrcgElmntByKey(String debitMemoRequest, String debitMemoRequestItem, String pricingProcedureStep, String pricingProcedureCounter)` Fetch a single `DebitMemoReqItemPrcgElmnt` entity using key fields.
`DebitMemoReqPartnerByKeyFluentHelper`	`getDebitMemoReqPartnerByKey(String debitMemoRequest, String partnerFunction)` Fetch a single `DebitMemoReqPartner` entity using key fields.
`DebitMemoReqPrcgElmntByKeyFluentHelper`	`getDebitMemoReqPrcgElmntByKey(String debitMemoRequest, String pricingProcedureStep, String pricingProcedureCounter)` Fetch a single `DebitMemoReqPrcgElmnt` entity using key fields.
`DebitMemoRequestByKeyFluentHelper`	`getDebitMemoRequestByKey(String debitMemoRequest)` Fetch a single `DebitMemoRequest` entity using key fields.
`DebitMemoRequestItemByKeyFluentHelper`	`getDebitMemoRequestItemByKey(String debitMemoRequest, String debitMemoRequestItem)` Fetch a single `DebitMemoRequestItem` entity using key fields.
`DebitMemoReqItemPartnerUpdateFluentHelper`	`updateDebitMemoReqItemPartner(DebitMemoReqItemPartner debitMemoReqItemPartner)` Update an existing `DebitMemoReqItemPartner` entity and save it to the S/4HANA system.
`DebitMemoReqItemPrcgElmntUpdateFluentHelper`	`updateDebitMemoReqItemPrcgElmnt(DebitMemoReqItemPrcgElmnt debitMemoReqItemPrcgElmnt)` Update an existing `DebitMemoReqItemPrcgElmnt` entity and save it to the S/4HANA system.
`DebitMemoReqPartnerUpdateFluentHelper`	`updateDebitMemoReqPartner(DebitMemoReqPartner debitMemoReqPartner)` Update an existing `DebitMemoReqPartner` entity and save it to the S/4HANA system.
`DebitMemoReqPrcgElmntUpdateFluentHelper`	`updateDebitMemoReqPrcgElmnt(DebitMemoReqPrcgElmnt debitMemoReqPrcgElmnt)` Update an existing `DebitMemoReqPrcgElmnt` entity and save it to the S/4HANA system.
`DebitMemoRequestUpdateFluentHelper`	`updateDebitMemoRequest(DebitMemoRequest debitMemoRequest)` Update an existing `DebitMemoRequest` entity and save it to the S/4HANA system.
`DebitMemoRequestItemUpdateFluentHelper`	`updateDebitMemoRequestItem(DebitMemoRequestItem debitMemoRequestItem)` Update an existing `DebitMemoRequestItem` entity and save it to the S/4HANA system.

- Method Detail
  - getAllDebitMemoReqItemPartner
```
DebitMemoReqItemPartnerFluentHelper getAllDebitMemoReqItemPartner()
```
    Fetch multiple DebitMemoReqItemPartner entities.
    
    Returns:
    
    A fluent helper to fetch multiple DebitMemoReqItemPartner 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.
  - getDebitMemoReqItemPartnerByKey
```
DebitMemoReqItemPartnerByKeyFluentHelper getDebitMemoReqItemPartnerByKey(String debitMemoRequest,
                                                                         String debitMemoRequestItem,
                                                                         String partnerFunction)
```
    Fetch a single DebitMemoReqItemPartner entity using key fields.
    
    Parameters:
    
    partnerFunction - The abbreviated form of the name that identifies the partner function.
    Constraints: Not nullable, Maximum length: 2
    
    debitMemoRequestItem - The number that uniquely identifies the item in the sales, shipping, or billing document.
    Constraints: Not nullable, Maximum length: 6
    
    debitMemoRequest - 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 DebitMemoReqItemPartner 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.
  - updateDebitMemoReqItemPartner
```
DebitMemoReqItemPartnerUpdateFluentHelper updateDebitMemoReqItemPartner(DebitMemoReqItemPartner debitMemoReqItemPartner)
```
    Update an existing DebitMemoReqItemPartner entity and save it to the S/4HANA system.
    
    Parameters:
    
    debitMemoReqItemPartner - DebitMemoReqItemPartner entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing DebitMemoReqItemPartner entity. To perform execution, call the execute method on the fluent helper object.
  - deleteDebitMemoReqItemPartner
```
DebitMemoReqItemPartnerDeleteFluentHelper deleteDebitMemoReqItemPartner(DebitMemoReqItemPartner debitMemoReqItemPartner)
```
    Deletes an existing DebitMemoReqItemPartner entity in the S/4HANA system.
    
    Parameters:
    
    debitMemoReqItemPartner - DebitMemoReqItemPartner entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing DebitMemoReqItemPartner entity. To perform execution, call the execute method on the fluent helper object.
  - getAllDebitMemoReqItemPrcgElmnt
```
DebitMemoReqItemPrcgElmntFluentHelper getAllDebitMemoReqItemPrcgElmnt()
```
    Fetch multiple DebitMemoReqItemPrcgElmnt entities.
    
    Returns:
    
    A fluent helper to fetch multiple DebitMemoReqItemPrcgElmnt 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.
  - getDebitMemoReqItemPrcgElmntByKey
```
DebitMemoReqItemPrcgElmntByKeyFluentHelper getDebitMemoReqItemPrcgElmntByKey(String debitMemoRequest,
                                                                             String debitMemoRequestItem,
                                                                             String pricingProcedureStep,
                                                                             String pricingProcedureCounter)
```
    Fetch a single DebitMemoReqItemPrcgElmnt entity using key fields.
    
    Parameters:
    
    debitMemoRequestItem - The number that uniquely identifies the condition item.
    Constraints: Not nullable, Maximum length: 6
    
    pricingProcedureCounter - Access number of the conditions within a step in the pricing procedure.
    Constraints: Not nullable, Maximum length: 3
    
    debitMemoRequest - 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 DebitMemoReqItemPrcgElmnt 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.
  - updateDebitMemoReqItemPrcgElmnt
```
DebitMemoReqItemPrcgElmntUpdateFluentHelper updateDebitMemoReqItemPrcgElmnt(DebitMemoReqItemPrcgElmnt debitMemoReqItemPrcgElmnt)
```
    Update an existing DebitMemoReqItemPrcgElmnt entity and save it to the S/4HANA system.
    
    Parameters:
    
    debitMemoReqItemPrcgElmnt - DebitMemoReqItemPrcgElmnt entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing DebitMemoReqItemPrcgElmnt entity. To perform execution, call the execute method on the fluent helper object.
  - deleteDebitMemoReqItemPrcgElmnt
```
DebitMemoReqItemPrcgElmntDeleteFluentHelper deleteDebitMemoReqItemPrcgElmnt(DebitMemoReqItemPrcgElmnt debitMemoReqItemPrcgElmnt)
```
    Deletes an existing DebitMemoReqItemPrcgElmnt entity in the S/4HANA system.
    
    Parameters:
    
    debitMemoReqItemPrcgElmnt - DebitMemoReqItemPrcgElmnt entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing DebitMemoReqItemPrcgElmnt entity. To perform execution, call the execute method on the fluent helper object.
  - getAllDebitMemoReqPartner
```
DebitMemoReqPartnerFluentHelper getAllDebitMemoReqPartner()
```
    Fetch multiple DebitMemoReqPartner entities.
    
    Returns:
    
    A fluent helper to fetch multiple DebitMemoReqPartner 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.
  - getDebitMemoReqPartnerByKey
```
DebitMemoReqPartnerByKeyFluentHelper getDebitMemoReqPartnerByKey(String debitMemoRequest,
                                                                 String partnerFunction)
```
    Fetch a single DebitMemoReqPartner entity using key fields.
    
    Parameters:
    
    partnerFunction - The abbreviated form of the name that identifies the partner function.
    Constraints: Not nullable, Maximum length: 2
    
    debitMemoRequest - 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 DebitMemoReqPartner 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.
  - updateDebitMemoReqPartner
```
DebitMemoReqPartnerUpdateFluentHelper updateDebitMemoReqPartner(DebitMemoReqPartner debitMemoReqPartner)
```
    Update an existing DebitMemoReqPartner entity and save it to the S/4HANA system.
    
    Parameters:
    
    debitMemoReqPartner - DebitMemoReqPartner entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing DebitMemoReqPartner entity. To perform execution, call the execute method on the fluent helper object.
  - deleteDebitMemoReqPartner
```
DebitMemoReqPartnerDeleteFluentHelper deleteDebitMemoReqPartner(DebitMemoReqPartner debitMemoReqPartner)
```
    Deletes an existing DebitMemoReqPartner entity in the S/4HANA system.
    
    Parameters:
    
    debitMemoReqPartner - DebitMemoReqPartner entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing DebitMemoReqPartner entity. To perform execution, call the execute method on the fluent helper object.
  - getAllDebitMemoReqPrcgElmnt
```
DebitMemoReqPrcgElmntFluentHelper getAllDebitMemoReqPrcgElmnt()
```
    Fetch multiple DebitMemoReqPrcgElmnt entities.
    
    Returns:
    
    A fluent helper to fetch multiple DebitMemoReqPrcgElmnt 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.
  - getDebitMemoReqPrcgElmntByKey
```
DebitMemoReqPrcgElmntByKeyFluentHelper getDebitMemoReqPrcgElmntByKey(String debitMemoRequest,
                                                                     String pricingProcedureStep,
                                                                     String pricingProcedureCounter)
```
    Fetch a single DebitMemoReqPrcgElmnt entity using key fields.
    
    Parameters:
    
    pricingProcedureCounter - Access number of the conditions within a step in the pricing procedure.
    Constraints: Not nullable, Maximum length: 3
    
    debitMemoRequest - 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 DebitMemoReqPrcgElmnt 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.
  - updateDebitMemoReqPrcgElmnt
```
DebitMemoReqPrcgElmntUpdateFluentHelper updateDebitMemoReqPrcgElmnt(DebitMemoReqPrcgElmnt debitMemoReqPrcgElmnt)
```
    Update an existing DebitMemoReqPrcgElmnt entity and save it to the S/4HANA system.
    
    Parameters:
    
    debitMemoReqPrcgElmnt - DebitMemoReqPrcgElmnt entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing DebitMemoReqPrcgElmnt entity. To perform execution, call the execute method on the fluent helper object.
  - deleteDebitMemoReqPrcgElmnt
```
DebitMemoReqPrcgElmntDeleteFluentHelper deleteDebitMemoReqPrcgElmnt(DebitMemoReqPrcgElmnt debitMemoReqPrcgElmnt)
```
    Deletes an existing DebitMemoReqPrcgElmnt entity in the S/4HANA system.
    
    Parameters:
    
    debitMemoReqPrcgElmnt - DebitMemoReqPrcgElmnt entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing DebitMemoReqPrcgElmnt entity. To perform execution, call the execute method on the fluent helper object.
  - getAllDebitMemoRequest
```
DebitMemoRequestFluentHelper getAllDebitMemoRequest()
```
    Fetch multiple DebitMemoRequest entities.
    
    Returns:
    
    A fluent helper to fetch multiple DebitMemoRequest 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.
  - getDebitMemoRequestByKey
```
DebitMemoRequestByKeyFluentHelper getDebitMemoRequestByKey(String debitMemoRequest)
```
    Fetch a single DebitMemoRequest entity using key fields.
    
    Parameters:
    
    debitMemoRequest - Debit Memo Request
    Constraints: Not nullable, Maximum length: 10
    
    Returns:
    
    A fluent helper to fetch a single DebitMemoRequest 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.
  - createDebitMemoRequest
```
DebitMemoRequestCreateFluentHelper createDebitMemoRequest(DebitMemoRequest debitMemoRequest)
```
    Create a new DebitMemoRequest entity and save it to the S/4HANA system.
    
    Parameters:
    
    debitMemoRequest - DebitMemoRequest entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new DebitMemoRequest entity. To perform execution, call the execute method on the fluent helper object.
  - updateDebitMemoRequest
```
DebitMemoRequestUpdateFluentHelper updateDebitMemoRequest(DebitMemoRequest debitMemoRequest)
```
    Update an existing DebitMemoRequest entity and save it to the S/4HANA system.
    
    Parameters:
    
    debitMemoRequest - DebitMemoRequest entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing DebitMemoRequest entity. To perform execution, call the execute method on the fluent helper object.
  - deleteDebitMemoRequest
```
DebitMemoRequestDeleteFluentHelper deleteDebitMemoRequest(DebitMemoRequest debitMemoRequest)
```
    Deletes an existing DebitMemoRequest entity in the S/4HANA system.
    
    Parameters:
    
    debitMemoRequest - DebitMemoRequest entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing DebitMemoRequest entity. To perform execution, call the execute method on the fluent helper object.
  - getAllDebitMemoRequestItem
```
DebitMemoRequestItemFluentHelper getAllDebitMemoRequestItem()
```
    Fetch multiple DebitMemoRequestItem entities.
    
    Returns:
    
    A fluent helper to fetch multiple DebitMemoRequestItem 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.
  - getDebitMemoRequestItemByKey
```
DebitMemoRequestItemByKeyFluentHelper getDebitMemoRequestItemByKey(String debitMemoRequest,
                                                                   String debitMemoRequestItem)
```
    Fetch a single DebitMemoRequestItem entity using key fields.
    
    Parameters:
    
    debitMemoRequestItem - Debit Memo Request Item
    Constraints: Not nullable, Maximum length: 6
    
    debitMemoRequest - Debit Memo Request
    Constraints: Not nullable, Maximum length: 10
    
    Returns:
    
    A fluent helper to fetch a single DebitMemoRequestItem 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.
  - createDebitMemoRequestItem
```
DebitMemoRequestItemCreateFluentHelper createDebitMemoRequestItem(DebitMemoRequestItem debitMemoRequestItem)
```
    Create a new DebitMemoRequestItem entity and save it to the S/4HANA system.
    
    Parameters:
    
    debitMemoRequestItem - DebitMemoRequestItem entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new DebitMemoRequestItem entity. To perform execution, call the execute method on the fluent helper object.
  - updateDebitMemoRequestItem
```
DebitMemoRequestItemUpdateFluentHelper updateDebitMemoRequestItem(DebitMemoRequestItem debitMemoRequestItem)
```
    Update an existing DebitMemoRequestItem entity and save it to the S/4HANA system.
    
    Parameters:
    
    debitMemoRequestItem - DebitMemoRequestItem entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing DebitMemoRequestItem entity. To perform execution, call the execute method on the fluent helper object.
  - deleteDebitMemoRequestItem
```
DebitMemoRequestItemDeleteFluentHelper deleteDebitMemoRequestItem(DebitMemoRequestItem debitMemoRequestItem)
```
    Deletes an existing DebitMemoRequestItem entity in the S/4HANA system.
    
    Parameters:
    
    debitMemoRequestItem - DebitMemoRequestItem entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing DebitMemoRequestItem entity. To perform execution, call the execute method on the fluent helper object.

Interface DebitMemoRequestService

Details:

Method Summary

Method Detail

getAllDebitMemoReqItemPartner

getDebitMemoReqItemPartnerByKey

updateDebitMemoReqItemPartner

deleteDebitMemoReqItemPartner

getAllDebitMemoReqItemPrcgElmnt

getDebitMemoReqItemPrcgElmntByKey

updateDebitMemoReqItemPrcgElmnt

deleteDebitMemoReqItemPrcgElmnt

getAllDebitMemoReqPartner

getDebitMemoReqPartnerByKey

updateDebitMemoReqPartner

deleteDebitMemoReqPartner

getAllDebitMemoReqPrcgElmnt

getDebitMemoReqPrcgElmntByKey

updateDebitMemoReqPrcgElmnt

deleteDebitMemoReqPrcgElmnt

getAllDebitMemoRequest

getDebitMemoRequestByKey

createDebitMemoRequest

updateDebitMemoRequest

deleteDebitMemoRequest

getAllDebitMemoRequestItem

getDebitMemoRequestItemByKey

createDebitMemoRequestItem

updateDebitMemoRequestItem

deleteDebitMemoRequestItem