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

Interface CustomerReturnsDeliveryV2Service

All Superinterfaces:

BatchService<CustomerReturnsDeliveryV2ServiceBatch>

All Known Implementing Classes:

DefaultCustomerReturnsDeliveryV2Service

public interface CustomerReturnsDeliveryV2Service
extends BatchService<CustomerReturnsDeliveryV2ServiceBatch>

This synchronous inbound service enables you to read, create, update, and delete customer returns deliveries. It can be consumed in Fiori apps and on other user interfaces.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_CUSTOMER_RETURNS_DELIVERY_SRV_0002
API Version:	2
Communication Scenario:	Delivery Processing Integration (SAP_COM_0106)
Scope Items:	Delivery Processing without Order Reference (1MI), Sell from Stock (BD9), Free of Charge Delivery (BDA), Accelerated Customer Returns (BKP), Procurement of Direct Materials (J45)
Authentication Methods:	Basic, x509
Business Object:	CustomerReturnsDelivery

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

Method Summary

Modifier and Type	Method and Description
ConfirmPutawayAllItemsFluentHelper	confirmPutawayAllItems(String deliveryDocument) Creates a fluent helper for the ConfirmPutawayAllItems OData function import.
ConfirmPutawayOneItemFluentHelper	confirmPutawayOneItem(String deliveryDocumentItem, String deliveryDocument) Creates a fluent helper for the ConfirmPutawayOneItem OData function import.
ReturnsDeliveryHeaderCreateFluentHelper	createReturnsDeliveryHeader(ReturnsDeliveryHeader returnsDeliveryHeader) Create a new ReturnsDeliveryHeader entity and save it to the S/4HANA system.
ReturnsDeliveryHeaderDeleteFluentHelper	deleteReturnsDeliveryHeader(ReturnsDeliveryHeader returnsDeliveryHeader) Deletes an existing ReturnsDeliveryHeader entity in the S/4HANA system.
ReturnsDeliveryItemDeleteFluentHelper	deleteReturnsDeliveryItem(ReturnsDeliveryItem returnsDeliveryItem) Deletes an existing ReturnsDeliveryItem entity in the S/4HANA system.
ReturnsDeliveryHeaderFluentHelper	getAllReturnsDeliveryHeader() Fetch multiple ReturnsDeliveryHeader entities.
ReturnsDeliveryItemFluentHelper	getAllReturnsDeliveryItem() Fetch multiple ReturnsDeliveryItem entities.
ReturnsDeliveryDocFlowByKeyFluentHelper	getReturnsDeliveryDocFlowByKey(String precedingDocument, String precedingDocumentItem, String subsequentDocumentCategory) Fetch a single ReturnsDeliveryDocFlow entity using key fields.
ReturnsDeliveryHeaderByKeyFluentHelper	getReturnsDeliveryHeaderByKey(String deliveryDocument) Fetch a single ReturnsDeliveryHeader entity using key fields.
ReturnsDeliveryItemByKeyFluentHelper	getReturnsDeliveryItemByKey(String deliveryDocument, String deliveryDocumentItem) Fetch a single ReturnsDeliveryItem entity using key fields.
ReturnsDeliveryPartnerByKeyFluentHelper	getReturnsDeliveryPartnerByKey(String partnerFunction, String sDDocument) Fetch a single ReturnsDeliveryPartner entity using key fields.
ReturnsDeliverySrlNmbrByKeyFluentHelper	getReturnsDeliverySrlNmbrByKey(Long maintenanceItemObjectList) Fetch a single ReturnsDeliverySrlNmbr entity using key fields.
PostGoodsReceiptFluentHelper	postGoodsReceipt(String deliveryDocument) Creates a fluent helper for the PostGoodsReceipt OData function import.
PutawayAllItemsFluentHelper	putawayAllItems(String deliveryDocument) Creates a fluent helper for the PutawayAllItems OData function import.
PutawayOneItemFluentHelper	putawayOneItem(String deliveryDocumentItem, String deliveryDocument) Creates a fluent helper for the PutawayOneItem OData function import.
PutawayOneItemWithBaseQuantityFluentHelper	putawayOneItemWithBaseQuantity(String deliveryDocumentItem, BigDecimal actualDeliveredQtyInBaseUnit, String baseUnit, String deliveryDocument) Creates a fluent helper for the PutawayOneItemWithBaseQuantity OData function import.
PutawayOneItemWithSalesQuantityFluentHelper	putawayOneItemWithSalesQuantity(String deliveryDocument, String deliveryDocumentItem, String deliveryQuantityUnit, BigDecimal actualDeliveryQuantity) Creates a fluent helper for the PutawayOneItemWithSalesQuantity OData function import.
ReverseGoodsReceiptFluentHelper	reverseGoodsReceipt(String deliveryDocument, LocalDateTime actualGoodsMovementDate) Creates a fluent helper for the ReverseGoodsReceipt OData function import.
SetPutawayQuantityWithBaseQuantityFluentHelper	setPutawayQuantityWithBaseQuantity(BigDecimal actualDeliveredQtyInBaseUnit, String baseUnit, String deliveryDocument, String deliveryDocumentItem) Creates a fluent helper for the SetPutawayQuantityWithBaseQuantity OData function import.
ReturnsDeliveryDocFlowUpdateFluentHelper	updateReturnsDeliveryDocFlow(ReturnsDeliveryDocFlow returnsDeliveryDocFlow) Update an existing ReturnsDeliveryDocFlow entity and save it to the S/4HANA system.
ReturnsDeliveryHeaderUpdateFluentHelper	updateReturnsDeliveryHeader(ReturnsDeliveryHeader returnsDeliveryHeader) Update an existing ReturnsDeliveryHeader entity and save it to the S/4HANA system.
ReturnsDeliveryItemUpdateFluentHelper	updateReturnsDeliveryItem(ReturnsDeliveryItem returnsDeliveryItem) Update an existing ReturnsDeliveryItem entity and save it to the S/4HANA system.
CustomerReturnsDeliveryV2Service	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
CustomerReturnsDeliveryV2Service withServicePath(@Nonnull
                                                          String servicePath)

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

getReturnsDeliveryDocFlowByKey

@Nonnull
ReturnsDeliveryDocFlowByKeyFluentHelper getReturnsDeliveryDocFlowByKey(String precedingDocument,
                                                                                String precedingDocumentItem,
                                                                                String subsequentDocumentCategory)

Fetch a single ReturnsDeliveryDocFlow entity using key fields.

Parameters:

precedingDocument - Number that uniquely identifies the preceding sales, delivery, or billing document (for example, the quotation from which you created a sales order).

Constraints: Not nullable, Maximum length: 10

precedingDocumentItem - Preceding Item of an SD Document

Constraints: Not nullable, Maximum length: 6

subsequentDocumentCategory - The document category of the sales document that you have created from a preceding document (for example, a delivery note that has been created from a sales order).

Constraints: Not nullable, Maximum length: 4

Returns:

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

updateReturnsDeliveryDocFlow

@Nonnull
ReturnsDeliveryDocFlowUpdateFluentHelper updateReturnsDeliveryDocFlow(@Nonnull
                                                                               ReturnsDeliveryDocFlow returnsDeliveryDocFlow)

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

Parameters:

returnsDeliveryDocFlow - ReturnsDeliveryDocFlow entity object that will be updated in the S/4HANA system.

Returns:

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

getAllReturnsDeliveryHeader

@Nonnull
ReturnsDeliveryHeaderFluentHelper getAllReturnsDeliveryHeader()

Fetch multiple ReturnsDeliveryHeader entities.

Returns:

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

getReturnsDeliveryHeaderByKey

@Nonnull
ReturnsDeliveryHeaderByKeyFluentHelper getReturnsDeliveryHeaderByKey(String deliveryDocument)

Fetch a single ReturnsDeliveryHeader entity using key fields.

Parameters:

deliveryDocument - The number that uniquely identifies the delivery.

Constraints: Not nullable, Maximum length: 10

Returns:

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

createReturnsDeliveryHeader

@Nonnull
ReturnsDeliveryHeaderCreateFluentHelper createReturnsDeliveryHeader(@Nonnull
                                                                             ReturnsDeliveryHeader returnsDeliveryHeader)

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

Parameters:

returnsDeliveryHeader - ReturnsDeliveryHeader entity object that will be created in the S/4HANA system.

Returns:

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

updateReturnsDeliveryHeader

@Nonnull
ReturnsDeliveryHeaderUpdateFluentHelper updateReturnsDeliveryHeader(@Nonnull
                                                                             ReturnsDeliveryHeader returnsDeliveryHeader)

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

Parameters:

returnsDeliveryHeader - ReturnsDeliveryHeader entity object that will be updated in the S/4HANA system.

Returns:

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

deleteReturnsDeliveryHeader

@Nonnull
ReturnsDeliveryHeaderDeleteFluentHelper deleteReturnsDeliveryHeader(@Nonnull
                                                                             ReturnsDeliveryHeader returnsDeliveryHeader)

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

Parameters:

returnsDeliveryHeader - ReturnsDeliveryHeader entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllReturnsDeliveryItem

@Nonnull
ReturnsDeliveryItemFluentHelper getAllReturnsDeliveryItem()

Fetch multiple ReturnsDeliveryItem entities.

Returns:

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

getReturnsDeliveryItemByKey

@Nonnull
ReturnsDeliveryItemByKeyFluentHelper getReturnsDeliveryItemByKey(String deliveryDocument,
                                                                          String deliveryDocumentItem)

Fetch a single ReturnsDeliveryItem entity using key fields.

Parameters:

deliveryDocument - The number that uniquely identifies the delivery.

Constraints: Not nullable, Maximum length: 10

deliveryDocumentItem - The number that uniquely identifies the item in a delivery.

Constraints: Not nullable, Maximum length: 6

Returns:

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

updateReturnsDeliveryItem

@Nonnull
ReturnsDeliveryItemUpdateFluentHelper updateReturnsDeliveryItem(@Nonnull
                                                                         ReturnsDeliveryItem returnsDeliveryItem)

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

Parameters:

returnsDeliveryItem - ReturnsDeliveryItem entity object that will be updated in the S/4HANA system.

Returns:

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

deleteReturnsDeliveryItem

@Nonnull
ReturnsDeliveryItemDeleteFluentHelper deleteReturnsDeliveryItem(@Nonnull
                                                                         ReturnsDeliveryItem returnsDeliveryItem)

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

Parameters:

returnsDeliveryItem - ReturnsDeliveryItem entity object that will be deleted in the S/4HANA system.

Returns:

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

getReturnsDeliveryPartnerByKey

@Nonnull
ReturnsDeliveryPartnerByKeyFluentHelper getReturnsDeliveryPartnerByKey(String partnerFunction,
                                                                                String sDDocument)

Fetch a single ReturnsDeliveryPartner entity using key fields.

Parameters:

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

Constraints: Not nullable, Maximum length: 2

sDDocument - 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 ReturnsDeliveryPartner 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.

getReturnsDeliverySrlNmbrByKey

@Nonnull
ReturnsDeliverySrlNmbrByKeyFluentHelper getReturnsDeliverySrlNmbrByKey(Long maintenanceItemObjectList)

Fetch a single ReturnsDeliverySrlNmbr entity using key fields.

Parameters:

maintenanceItemObjectList - Number identifying the object list

Constraints: Not nullable

Returns:

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

reverseGoodsReceipt

@Nonnull
ReverseGoodsReceiptFluentHelper reverseGoodsReceipt(String deliveryDocument,
                                                             LocalDateTime actualGoodsMovementDate)

Creates a fluent helper for the ReverseGoodsReceipt OData function import.

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: DeliveryDocument

actualGoodsMovementDate - Actual GI Date

Constraints: Not nullable, Precision: 0

Original parameter name from the Odata EDM: ActualGoodsMovementDate

Returns:

A fluent helper object that will execute the ReverseGoodsReceipt OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

postGoodsReceipt

@Nonnull
PostGoodsReceiptFluentHelper postGoodsReceipt(String deliveryDocument)

Creates a fluent helper for the PostGoodsReceipt OData function import.

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: DeliveryDocument

Returns:

A fluent helper object that will execute the PostGoodsReceipt OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

confirmPutawayAllItems

@Nonnull
ConfirmPutawayAllItemsFluentHelper confirmPutawayAllItems(String deliveryDocument)

Creates a fluent helper for the ConfirmPutawayAllItems OData function import.

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: DeliveryDocument

Returns:

A fluent helper object that will execute the ConfirmPutawayAllItems OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

confirmPutawayOneItem

@Nonnull
ConfirmPutawayOneItemFluentHelper confirmPutawayOneItem(String deliveryDocumentItem,
                                                                 String deliveryDocument)

Creates a fluent helper for the ConfirmPutawayOneItem OData function import.

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: DeliveryDocument

deliveryDocumentItem - Item

Constraints: Not nullable, Maximum length: 6

Original parameter name from the Odata EDM: DeliveryDocumentItem

Returns:

A fluent helper object that will execute the ConfirmPutawayOneItem OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

putawayAllItems

@Nonnull
PutawayAllItemsFluentHelper putawayAllItems(String deliveryDocument)

Creates a fluent helper for the PutawayAllItems OData function import.

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: DeliveryDocument

Returns:

A fluent helper object that will execute the PutawayAllItems OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

putawayOneItem

@Nonnull
PutawayOneItemFluentHelper putawayOneItem(String deliveryDocumentItem,
                                                   String deliveryDocument)

Creates a fluent helper for the PutawayOneItem OData function import.

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: DeliveryDocument

deliveryDocumentItem - Item

Constraints: Not nullable, Maximum length: 6

Original parameter name from the Odata EDM: DeliveryDocumentItem

Returns:

A fluent helper object that will execute the PutawayOneItem OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

setPutawayQuantityWithBaseQuantity

@Nonnull
SetPutawayQuantityWithBaseQuantityFluentHelper setPutawayQuantityWithBaseQuantity(BigDecimal actualDeliveredQtyInBaseUnit,
                                                                                           String baseUnit,
                                                                                           String deliveryDocument,
                                                                                           String deliveryDocumentItem)

Creates a fluent helper for the SetPutawayQuantityWithBaseQuantity OData function import.

Parameters:

baseUnit - Base Unit

Constraints: Not nullable, Maximum length: 3

Original parameter name from the Odata EDM: BaseUnit

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: DeliveryDocument

actualDeliveredQtyInBaseUnit - Qty (stckp.unt)

Constraints: Not nullable, Precision: 3, Scale: 3

Original parameter name from the Odata EDM: ActualDeliveredQtyInBaseUnit

deliveryDocumentItem - Item

Constraints: Not nullable, Maximum length: 6

Original parameter name from the Odata EDM: DeliveryDocumentItem

Returns:

A fluent helper object that will execute the SetPutawayQuantityWithBaseQuantity OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

putawayOneItemWithBaseQuantity

@Nonnull
PutawayOneItemWithBaseQuantityFluentHelper putawayOneItemWithBaseQuantity(String deliveryDocumentItem,
                                                                                   BigDecimal actualDeliveredQtyInBaseUnit,
                                                                                   String baseUnit,
                                                                                   String deliveryDocument)

Creates a fluent helper for the PutawayOneItemWithBaseQuantity OData function import.

Parameters:

baseUnit - Base Unit

Constraints: Not nullable, Maximum length: 3

Original parameter name from the Odata EDM: BaseUnit

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: DeliveryDocument

actualDeliveredQtyInBaseUnit - Qty (stckp.unt)

Constraints: Not nullable, Precision: 3, Scale: 3

Original parameter name from the Odata EDM: ActualDeliveredQtyInBaseUnit

deliveryDocumentItem - Item

Constraints: Not nullable, Maximum length: 6

Original parameter name from the Odata EDM: DeliveryDocumentItem

Returns:

A fluent helper object that will execute the PutawayOneItemWithBaseQuantity OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

putawayOneItemWithSalesQuantity

@Nonnull
PutawayOneItemWithSalesQuantityFluentHelper putawayOneItemWithSalesQuantity(String deliveryDocument,
                                                                                     String deliveryDocumentItem,
                                                                                     String deliveryQuantityUnit,
                                                                                     BigDecimal actualDeliveryQuantity)

Creates a fluent helper for the PutawayOneItemWithSalesQuantity OData function import.

Parameters:

deliveryDocument - Delivery

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: DeliveryDocument

deliveryQuantityUnit - Sales Unit

Constraints: Not nullable, Maximum length: 3

Original parameter name from the Odata EDM: DeliveryQuantityUnit

actualDeliveryQuantity - Delivery qty

Constraints: Not nullable, Precision: 3, Scale: 3

Original parameter name from the Odata EDM: ActualDeliveryQuantity

deliveryDocumentItem - Item

Constraints: Not nullable, Maximum length: 6

Original parameter name from the Odata EDM: DeliveryDocumentItem

Returns:

A fluent helper object that will execute the PutawayOneItemWithSalesQuantity OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.