com.sap.cloud.sdk.s4hana.datamodel.odata.services

Interface CustomerReturnService

All Known Implementing Classes:

DefaultCustomerReturnService

public interface CustomerReturnService

You can use this service to integrate external applications with customer return processing (including SAP Advanced Returns Management (ARM)) in SAP S/4HANA Cloud. In every API call, you can make use of the following operations: - You can retrieve customer returns. Apply any of the filters provided or retrieve all existing data. - You can create customer returns. 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 customer returns, 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 customer returns, you can update the header, header partner, header pricing element, item, item partner, and item pricing element. - For existing customer returns, 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_CUSTOMER_RETURN_SRV
API Version:	1
Communication Scenario:	Customer Return Integration (SAP_COM_0157)
Scope Items:	Accelerated Third Party Returns (1Z3), Accelerated Customer Returns (BKP)
Business Object:	CustomerReturn

Method Summary

Modifier and Type	Method and Description
CustomerReturnCreateFluentHelper	createCustomerReturn(CustomerReturn customerReturn) Create a new CustomerReturn entity and save it to the S/4HANA system.
CustomerReturnItemCreateFluentHelper	createCustomerReturnItem(CustomerReturnItem customerReturnItem) Create a new CustomerReturnItem entity and save it to the S/4HANA system.
CustomerReturnDeleteFluentHelper	deleteCustomerReturn(CustomerReturn customerReturn) Deletes an existing CustomerReturn entity in the S/4HANA system.
CustomerReturnItemDeleteFluentHelper	deleteCustomerReturnItem(CustomerReturnItem customerReturnItem) Deletes an existing CustomerReturnItem entity in the S/4HANA system.
CustomerReturnItemPartnerDeleteFluentHelper	deleteCustomerReturnItemPartner(CustomerReturnItemPartner customerReturnItemPartner) Deletes an existing CustomerReturnItemPartner entity in the S/4HANA system.
CustomerReturnItemPrcgElmntDeleteFluentHelper	deleteCustomerReturnItemPrcgElmnt(CustomerReturnItemPrcgElmnt customerReturnItemPrcgElmnt) Deletes an existing CustomerReturnItemPrcgElmnt entity in the S/4HANA system.
CustomerReturnPartnerDeleteFluentHelper	deleteCustomerReturnPartner(CustomerReturnPartner customerReturnPartner) Deletes an existing CustomerReturnPartner entity in the S/4HANA system.
CustomerReturnPrcgElmntDeleteFluentHelper	deleteCustomerReturnPrcgElmnt(CustomerReturnPrcgElmnt customerReturnPrcgElmnt) Deletes an existing CustomerReturnPrcgElmnt entity in the S/4HANA system.
CustomerReturnFluentHelper	getAllCustomerReturn() Fetch multiple CustomerReturn entities.
CustomerReturnItemFluentHelper	getAllCustomerReturnItem() Fetch multiple CustomerReturnItem entities.
CustomerReturnItemPartnerFluentHelper	getAllCustomerReturnItemPartner() Fetch multiple CustomerReturnItemPartner entities.
CustomerReturnItemPrcgElmntFluentHelper	getAllCustomerReturnItemPrcgElmnt() Fetch multiple CustomerReturnItemPrcgElmnt entities.
CustomerReturnPartnerFluentHelper	getAllCustomerReturnPartner() Fetch multiple CustomerReturnPartner entities.
CustomerReturnPrcgElmntFluentHelper	getAllCustomerReturnPrcgElmnt() Fetch multiple CustomerReturnPrcgElmnt entities.
CustomerReturnProcessStepFluentHelper	getAllCustomerReturnProcessStep() Fetch multiple CustomerReturnProcessStep entities.
CustomerReturnScheduleLineFluentHelper	getAllCustomerReturnScheduleLine() Fetch multiple CustomerReturnScheduleLine entities.
CustomerReturnByKeyFluentHelper	getCustomerReturnByKey(String customerReturn) Fetch a single CustomerReturn entity using key fields.
CustomerReturnItemByKeyFluentHelper	getCustomerReturnItemByKey(String customerReturn, String customerReturnItem) Fetch a single CustomerReturnItem entity using key fields.
CustomerReturnItemPartnerByKeyFluentHelper	getCustomerReturnItemPartnerByKey(String customerReturn, String customerReturnItem, String partnerFunction) Fetch a single CustomerReturnItemPartner entity using key fields.
CustomerReturnItemPrcgElmntByKeyFluentHelper	getCustomerReturnItemPrcgElmntByKey(String customerReturn, String customerReturnItem, String pricingProcedureStep, String pricingProcedureCounter) Fetch a single CustomerReturnItemPrcgElmnt entity using key fields.
CustomerReturnPartnerByKeyFluentHelper	getCustomerReturnPartnerByKey(String customerReturn, String partnerFunction) Fetch a single CustomerReturnPartner entity using key fields.
CustomerReturnPrcgElmntByKeyFluentHelper	getCustomerReturnPrcgElmntByKey(String customerReturn, String pricingProcedureStep, String pricingProcedureCounter) Fetch a single CustomerReturnPrcgElmnt entity using key fields.
CustomerReturnProcessStepByKeyFluentHelper	getCustomerReturnProcessStepByKey(String retsMgmtProcess, String retsMgmtProcessItem, String retsMgmtProcItmQtySplit, String retsMgmtProcessStep, String returnsDocumentType, String returnsDocument, String returnsDocumentItem) Fetch a single CustomerReturnProcessStep entity using key fields.
CustomerReturnScheduleLineByKeyFluentHelper	getCustomerReturnScheduleLineByKey(String customerReturn, String customerReturnItem, String scheduleLine) Fetch a single CustomerReturnScheduleLine entity using key fields.
CustomerReturnUpdateFluentHelper	updateCustomerReturn(CustomerReturn customerReturn) Update an existing CustomerReturn entity and save it to the S/4HANA system.
CustomerReturnItemUpdateFluentHelper	updateCustomerReturnItem(CustomerReturnItem customerReturnItem) Update an existing CustomerReturnItem entity and save it to the S/4HANA system.
CustomerReturnItemPartnerUpdateFluentHelper	updateCustomerReturnItemPartner(CustomerReturnItemPartner customerReturnItemPartner) Update an existing CustomerReturnItemPartner entity and save it to the S/4HANA system.
CustomerReturnItemPrcgElmntUpdateFluentHelper	updateCustomerReturnItemPrcgElmnt(CustomerReturnItemPrcgElmnt customerReturnItemPrcgElmnt) Update an existing CustomerReturnItemPrcgElmnt entity and save it to the S/4HANA system.
CustomerReturnPartnerUpdateFluentHelper	updateCustomerReturnPartner(CustomerReturnPartner customerReturnPartner) Update an existing CustomerReturnPartner entity and save it to the S/4HANA system.
CustomerReturnPrcgElmntUpdateFluentHelper	updateCustomerReturnPrcgElmnt(CustomerReturnPrcgElmnt customerReturnPrcgElmnt) Update an existing CustomerReturnPrcgElmnt entity and save it to the S/4HANA system.

Method Detail

getAllCustomerReturn

CustomerReturnFluentHelper getAllCustomerReturn()

Fetch multiple CustomerReturn entities.

Returns:

A fluent helper to fetch multiple CustomerReturn 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.

getCustomerReturnByKey

CustomerReturnByKeyFluentHelper getCustomerReturnByKey(String customerReturn)

Fetch a single CustomerReturn entity using key fields.

Parameters:

customerReturn - Customer Return

Constraints: Not nullable, Maximum length: 10

Returns:

A fluent helper to fetch a single CustomerReturn 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.

createCustomerReturn

CustomerReturnCreateFluentHelper createCustomerReturn(CustomerReturn customerReturn)

Create a new CustomerReturn entity and save it to the S/4HANA system.

Parameters:

customerReturn - CustomerReturn entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new CustomerReturn entity. To perform execution, call the execute method on the fluent helper object.

updateCustomerReturn

CustomerReturnUpdateFluentHelper updateCustomerReturn(CustomerReturn customerReturn)

Update an existing CustomerReturn entity and save it to the S/4HANA system.

Parameters:

customerReturn - CustomerReturn entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing CustomerReturn entity. To perform execution, call the execute method on the fluent helper object.

deleteCustomerReturn

CustomerReturnDeleteFluentHelper deleteCustomerReturn(CustomerReturn customerReturn)

Deletes an existing CustomerReturn entity in the S/4HANA system.

Parameters:

customerReturn - CustomerReturn entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing CustomerReturn entity. To perform execution, call the execute method on the fluent helper object.

getAllCustomerReturnItem

CustomerReturnItemFluentHelper getAllCustomerReturnItem()

Fetch multiple CustomerReturnItem entities.

Returns:

A fluent helper to fetch multiple CustomerReturnItem 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.

getCustomerReturnItemByKey

CustomerReturnItemByKeyFluentHelper getCustomerReturnItemByKey(String customerReturn,
                                                               String customerReturnItem)

Fetch a single CustomerReturnItem entity using key fields.

Parameters:

customerReturnItem - Customer Return Item

Constraints: Not nullable, Maximum length: 6

customerReturn - Customer Return

Constraints: Not nullable, Maximum length: 10

Returns:

A fluent helper to fetch a single CustomerReturnItem 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.

createCustomerReturnItem

CustomerReturnItemCreateFluentHelper createCustomerReturnItem(CustomerReturnItem customerReturnItem)

Create a new CustomerReturnItem entity and save it to the S/4HANA system.

Parameters:

customerReturnItem - CustomerReturnItem entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new CustomerReturnItem entity. To perform execution, call the execute method on the fluent helper object.

updateCustomerReturnItem

CustomerReturnItemUpdateFluentHelper updateCustomerReturnItem(CustomerReturnItem customerReturnItem)

Update an existing CustomerReturnItem entity and save it to the S/4HANA system.

Parameters:

customerReturnItem - CustomerReturnItem entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing CustomerReturnItem entity. To perform execution, call the execute method on the fluent helper object.

deleteCustomerReturnItem

CustomerReturnItemDeleteFluentHelper deleteCustomerReturnItem(CustomerReturnItem customerReturnItem)

Deletes an existing CustomerReturnItem entity in the S/4HANA system.

Parameters:

customerReturnItem - CustomerReturnItem entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing CustomerReturnItem entity. To perform execution, call the execute method on the fluent helper object.

getAllCustomerReturnItemPartner

CustomerReturnItemPartnerFluentHelper getAllCustomerReturnItemPartner()

Fetch multiple CustomerReturnItemPartner entities.

Returns:

A fluent helper to fetch multiple CustomerReturnItemPartner 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.

getCustomerReturnItemPartnerByKey

CustomerReturnItemPartnerByKeyFluentHelper getCustomerReturnItemPartnerByKey(String customerReturn,
                                                                             String customerReturnItem,
                                                                             String partnerFunction)

Fetch a single CustomerReturnItemPartner entity using key fields.

Parameters:

partnerFunction - The abbreviated form of the name that identifies the partner function.

Constraints: Not nullable, Maximum length: 2

customerReturnItem - The number that uniquely identifies the item in the sales, shipping, or billing document.

Constraints: Not nullable, Maximum length: 6

customerReturn - 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 CustomerReturnItemPartner 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.

updateCustomerReturnItemPartner

CustomerReturnItemPartnerUpdateFluentHelper updateCustomerReturnItemPartner(CustomerReturnItemPartner customerReturnItemPartner)

Update an existing CustomerReturnItemPartner entity and save it to the S/4HANA system.

Parameters:

customerReturnItemPartner - CustomerReturnItemPartner entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing CustomerReturnItemPartner entity. To perform execution, call the execute method on the fluent helper object.

deleteCustomerReturnItemPartner

CustomerReturnItemPartnerDeleteFluentHelper deleteCustomerReturnItemPartner(CustomerReturnItemPartner customerReturnItemPartner)

Deletes an existing CustomerReturnItemPartner entity in the S/4HANA system.

Parameters:

customerReturnItemPartner - CustomerReturnItemPartner entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing CustomerReturnItemPartner entity. To perform execution, call the execute method on the fluent helper object.

getAllCustomerReturnItemPrcgElmnt

CustomerReturnItemPrcgElmntFluentHelper getAllCustomerReturnItemPrcgElmnt()

Fetch multiple CustomerReturnItemPrcgElmnt entities.

Returns:

A fluent helper to fetch multiple CustomerReturnItemPrcgElmnt 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.

getCustomerReturnItemPrcgElmntByKey

CustomerReturnItemPrcgElmntByKeyFluentHelper getCustomerReturnItemPrcgElmntByKey(String customerReturn,
                                                                                 String customerReturnItem,
                                                                                 String pricingProcedureStep,
                                                                                 String pricingProcedureCounter)

Fetch a single CustomerReturnItemPrcgElmnt entity using key fields.

Parameters:

customerReturnItem - 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

customerReturn - 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 CustomerReturnItemPrcgElmnt 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.

updateCustomerReturnItemPrcgElmnt

CustomerReturnItemPrcgElmntUpdateFluentHelper updateCustomerReturnItemPrcgElmnt(CustomerReturnItemPrcgElmnt customerReturnItemPrcgElmnt)

Update an existing CustomerReturnItemPrcgElmnt entity and save it to the S/4HANA system.

Parameters:

customerReturnItemPrcgElmnt - CustomerReturnItemPrcgElmnt entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing CustomerReturnItemPrcgElmnt entity. To perform execution, call the execute method on the fluent helper object.

deleteCustomerReturnItemPrcgElmnt

CustomerReturnItemPrcgElmntDeleteFluentHelper deleteCustomerReturnItemPrcgElmnt(CustomerReturnItemPrcgElmnt customerReturnItemPrcgElmnt)

Deletes an existing CustomerReturnItemPrcgElmnt entity in the S/4HANA system.

Parameters:

customerReturnItemPrcgElmnt - CustomerReturnItemPrcgElmnt entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing CustomerReturnItemPrcgElmnt entity. To perform execution, call the execute method on the fluent helper object.

getAllCustomerReturnPartner

CustomerReturnPartnerFluentHelper getAllCustomerReturnPartner()

Fetch multiple CustomerReturnPartner entities.

Returns:

A fluent helper to fetch multiple CustomerReturnPartner 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.

getCustomerReturnPartnerByKey

CustomerReturnPartnerByKeyFluentHelper getCustomerReturnPartnerByKey(String customerReturn,
                                                                     String partnerFunction)

Fetch a single CustomerReturnPartner entity using key fields.

Parameters:

partnerFunction - The abbreviated form of the name that identifies the partner function.

Constraints: Not nullable, Maximum length: 2

customerReturn - 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 CustomerReturnPartner 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.

updateCustomerReturnPartner

CustomerReturnPartnerUpdateFluentHelper updateCustomerReturnPartner(CustomerReturnPartner customerReturnPartner)

Update an existing CustomerReturnPartner entity and save it to the S/4HANA system.

Parameters:

customerReturnPartner - CustomerReturnPartner entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing CustomerReturnPartner entity. To perform execution, call the execute method on the fluent helper object.

deleteCustomerReturnPartner

CustomerReturnPartnerDeleteFluentHelper deleteCustomerReturnPartner(CustomerReturnPartner customerReturnPartner)

Deletes an existing CustomerReturnPartner entity in the S/4HANA system.

Parameters:

customerReturnPartner - CustomerReturnPartner entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing CustomerReturnPartner entity. To perform execution, call the execute method on the fluent helper object.

getAllCustomerReturnPrcgElmnt

CustomerReturnPrcgElmntFluentHelper getAllCustomerReturnPrcgElmnt()

Fetch multiple CustomerReturnPrcgElmnt entities.

Returns:

A fluent helper to fetch multiple CustomerReturnPrcgElmnt 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.

getCustomerReturnPrcgElmntByKey

CustomerReturnPrcgElmntByKeyFluentHelper getCustomerReturnPrcgElmntByKey(String customerReturn,
                                                                         String pricingProcedureStep,
                                                                         String pricingProcedureCounter)

Fetch a single CustomerReturnPrcgElmnt entity using key fields.

Parameters:

pricingProcedureCounter - Access number of the conditions within a step in the pricing procedure.

Constraints: Not nullable, Maximum length: 3

customerReturn - 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 CustomerReturnPrcgElmnt 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.

updateCustomerReturnPrcgElmnt

CustomerReturnPrcgElmntUpdateFluentHelper updateCustomerReturnPrcgElmnt(CustomerReturnPrcgElmnt customerReturnPrcgElmnt)

Update an existing CustomerReturnPrcgElmnt entity and save it to the S/4HANA system.

Parameters:

customerReturnPrcgElmnt - CustomerReturnPrcgElmnt entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing CustomerReturnPrcgElmnt entity. To perform execution, call the execute method on the fluent helper object.

deleteCustomerReturnPrcgElmnt

CustomerReturnPrcgElmntDeleteFluentHelper deleteCustomerReturnPrcgElmnt(CustomerReturnPrcgElmnt customerReturnPrcgElmnt)

Deletes an existing CustomerReturnPrcgElmnt entity in the S/4HANA system.

Parameters:

customerReturnPrcgElmnt - CustomerReturnPrcgElmnt entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing CustomerReturnPrcgElmnt entity. To perform execution, call the execute method on the fluent helper object.

getAllCustomerReturnProcessStep

CustomerReturnProcessStepFluentHelper getAllCustomerReturnProcessStep()

Fetch multiple CustomerReturnProcessStep entities.

Returns:

A fluent helper to fetch multiple CustomerReturnProcessStep 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.

getCustomerReturnProcessStepByKey

CustomerReturnProcessStepByKeyFluentHelper getCustomerReturnProcessStepByKey(String retsMgmtProcess,
                                                                             String retsMgmtProcessItem,
                                                                             String retsMgmtProcItmQtySplit,
                                                                             String retsMgmtProcessStep,
                                                                             String returnsDocumentType,
                                                                             String returnsDocument,
                                                                             String returnsDocumentItem)

Fetch a single CustomerReturnProcessStep entity using key fields.

Parameters:

returnsDocumentType - Specifies the returns document type, such as a returns order, goods movement, or credit memo.

Constraints: Not nullable, Maximum length: 2

retsMgmtProcessStep - Describes a given document, such as a returns order, an inbound delivery, or a purchase order, in the advanced returns process. Table MSR_I_STEP contains all valid step IDs.

Constraints: Not nullable, Maximum length: 4

returnsDocumentItem - Specifies an item of the displayed document.

Constraints: Not nullable, Maximum length: 10

retsMgmtProcess - Specifies the unique identifier of the advanced returns process.

Constraints: Not nullable, Maximum length: 10

retsMgmtProcessItem - Specifies an item in the start document of a returns process. This can be a returns order, a returns purchase order, or a returns stock transport order.

Constraints: Not nullable, Maximum length: 6

retsMgmtProcItmQtySplit - Identifies partial qantities of a specific returns item.

Constraints: Not nullable, Maximum length: 3

returnsDocument - Specifies the document number of a returns document.

Constraints: Not nullable, Maximum length: 30

Returns:

A fluent helper to fetch a single CustomerReturnProcessStep 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.

getAllCustomerReturnScheduleLine

CustomerReturnScheduleLineFluentHelper getAllCustomerReturnScheduleLine()

Fetch multiple CustomerReturnScheduleLine entities.

Returns:

A fluent helper to fetch multiple CustomerReturnScheduleLine 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.

getCustomerReturnScheduleLineByKey

CustomerReturnScheduleLineByKeyFluentHelper getCustomerReturnScheduleLineByKey(String customerReturn,
                                                                               String customerReturnItem,
                                                                               String scheduleLine)

Fetch a single CustomerReturnScheduleLine entity using key fields.

Parameters:

customerReturnItem - The number that uniquely identifies the item in the sales document.

Constraints: Not nullable, Maximum length: 6

scheduleLine - The number that uniquely identifies the schedule line in the sales document.

Constraints: Not nullable, Maximum length: 4

customerReturn - The number that uniquely identifies the sales document.

Constraints: Not nullable, Maximum length: 10

Returns:

A fluent helper to fetch a single CustomerReturnScheduleLine 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.