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

Interface ReadCustomerReturnsService

All Known Implementing Classes:

DefaultReadCustomerReturnsService

public interface ReadCustomerReturnsService

This service enables external applications to integrate with read methods for processing customer returns in SAP S/4HANA Cloud. It enables you to retrieve customer returns in an API call.

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), 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
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.
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.
CustomerReturnScheduleLineByKeyFluentHelper	getCustomerReturnScheduleLineByKey(String customerReturn, String customerReturnItem, String scheduleLine) Fetch a single CustomerReturnScheduleLine entity using key fields.

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.

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.

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.

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.

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.

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.

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.