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

Interface InboundDeliveryV2Service

All Superinterfaces:

BatchService<InboundDeliveryV2ServiceBatch>

All Known Implementing Classes:

DefaultInboundDeliveryV2Service

public interface InboundDeliveryV2Service
extends BatchService<InboundDeliveryV2ServiceBatch>

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

Business Documentation

Reference: SAP API Business Hub

Details:

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

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
AddSerialNumberToDeliveryItemFluentHelper	addSerialNumberToDeliveryItem(String deliveryDocument, String deliveryDocumentItem, String serialNumber) Creates a fluent helper for the AddSerialNumberToDeliveryItem OData function import.
ConfirmPutawayAllItemsFluentHelper	confirmPutawayAllItems(String deliveryDocument) Creates a fluent helper for the ConfirmPutawayAllItems OData function import.
ConfirmPutawayOneItemFluentHelper	confirmPutawayOneItem(String deliveryDocument, String deliveryDocumentItem) Creates a fluent helper for the ConfirmPutawayOneItem OData function import.
InbDeliveryHeaderCreateFluentHelper	createInbDeliveryHeader(InbDeliveryHeader inbDeliveryHeader) Create a new InbDeliveryHeader entity and save it to the S/4HANA system.
DeleteAllSerialNumbersFromDeliveryItemFluentHelper	deleteAllSerialNumbersFromDeliveryItem(String deliveryDocument, String deliveryDocumentItem) Creates a fluent helper for the DeleteAllSerialNumbersFromDeliveryItem OData function import.
InbDeliveryHeaderDeleteFluentHelper	deleteInbDeliveryHeader(InbDeliveryHeader inbDeliveryHeader) Deletes an existing InbDeliveryHeader entity in the S/4HANA system.
InbDeliveryItemDeleteFluentHelper	deleteInbDeliveryItem(InbDeliveryItem inbDeliveryItem) Deletes an existing InbDeliveryItem entity in the S/4HANA system.
DeleteSerialNumberFromDeliveryItemFluentHelper	deleteSerialNumberFromDeliveryItem(String deliveryDocument, String deliveryDocumentItem, String serialNumber) Creates a fluent helper for the DeleteSerialNumberFromDeliveryItem OData function import.
InbDeliveryHeaderFluentHelper	getAllInbDeliveryHeader() Fetch multiple InbDeliveryHeader entities.
InbDeliveryItemFluentHelper	getAllInbDeliveryItem() Fetch multiple InbDeliveryItem entities.
InbDeliveryDocFlowByKeyFluentHelper	getInbDeliveryDocFlowByKey(String precedingDocument, String precedingDocumentItem, String subsequentDocumentCategory) Fetch a single InbDeliveryDocFlow entity using key fields.
InbDeliveryHeaderByKeyFluentHelper	getInbDeliveryHeaderByKey(String deliveryDocument) Fetch a single InbDeliveryHeader entity using key fields.
InbDeliveryItemByKeyFluentHelper	getInbDeliveryItemByKey(String deliveryDocument, String deliveryDocumentItem) Fetch a single InbDeliveryItem entity using key fields.
InbDeliveryPartnerByKeyFluentHelper	getInbDeliveryPartnerByKey(String partnerFunction, String sDDocument) Fetch a single InbDeliveryPartner entity using key fields.
InbDeliverySerialNmbrByKeyFluentHelper	getInbDeliverySerialNmbrByKey(Long maintenanceItemObjectList) Fetch a single InbDeliverySerialNmbr 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 deliveryDocument, String deliveryDocumentItem) Creates a fluent helper for the PutawayOneItem OData function import.
PutawayOneItemWithBaseQuantityFluentHelper	putawayOneItemWithBaseQuantity(BigDecimal actualDeliveredQtyInBaseUnit, String baseUnit, String deliveryDocument, String deliveryDocumentItem) Creates a fluent helper for the PutawayOneItemWithBaseQuantity OData function import.
PutawayOneItemWithSalesQuantityFluentHelper	putawayOneItemWithSalesQuantity(BigDecimal actualDeliveryQuantity, String deliveryDocument, String deliveryDocumentItem, String deliveryQuantityUnit) 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.
InbDeliveryDocFlowUpdateFluentHelper	updateInbDeliveryDocFlow(InbDeliveryDocFlow inbDeliveryDocFlow) Update an existing InbDeliveryDocFlow entity and save it to the S/4HANA system.
InbDeliveryHeaderUpdateFluentHelper	updateInbDeliveryHeader(InbDeliveryHeader inbDeliveryHeader) Update an existing InbDeliveryHeader entity and save it to the S/4HANA system.
InbDeliveryItemUpdateFluentHelper	updateInbDeliveryItem(InbDeliveryItem inbDeliveryItem) Update an existing InbDeliveryItem entity and save it to the S/4HANA system.
InboundDeliveryV2Service	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
InboundDeliveryV2Service 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.

getInbDeliveryDocFlowByKey

@Nonnull
InbDeliveryDocFlowByKeyFluentHelper getInbDeliveryDocFlowByKey(String precedingDocument,
                                                                        String precedingDocumentItem,
                                                                        String subsequentDocumentCategory)

Fetch a single InbDeliveryDocFlow 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 InbDeliveryDocFlow 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.

updateInbDeliveryDocFlow

@Nonnull
InbDeliveryDocFlowUpdateFluentHelper updateInbDeliveryDocFlow(@Nonnull
                                                                       InbDeliveryDocFlow inbDeliveryDocFlow)

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

Parameters:

inbDeliveryDocFlow - InbDeliveryDocFlow entity object that will be updated in the S/4HANA system.

Returns:

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

getAllInbDeliveryHeader

@Nonnull
InbDeliveryHeaderFluentHelper getAllInbDeliveryHeader()

Fetch multiple InbDeliveryHeader entities.

Returns:

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

getInbDeliveryHeaderByKey

@Nonnull
InbDeliveryHeaderByKeyFluentHelper getInbDeliveryHeaderByKey(String deliveryDocument)

Fetch a single InbDeliveryHeader 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 InbDeliveryHeader 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.

createInbDeliveryHeader

@Nonnull
InbDeliveryHeaderCreateFluentHelper createInbDeliveryHeader(@Nonnull
                                                                     InbDeliveryHeader inbDeliveryHeader)

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

Parameters:

inbDeliveryHeader - InbDeliveryHeader entity object that will be created in the S/4HANA system.

Returns:

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

updateInbDeliveryHeader

@Nonnull
InbDeliveryHeaderUpdateFluentHelper updateInbDeliveryHeader(@Nonnull
                                                                     InbDeliveryHeader inbDeliveryHeader)

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

Parameters:

inbDeliveryHeader - InbDeliveryHeader entity object that will be updated in the S/4HANA system.

Returns:

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

deleteInbDeliveryHeader

@Nonnull
InbDeliveryHeaderDeleteFluentHelper deleteInbDeliveryHeader(@Nonnull
                                                                     InbDeliveryHeader inbDeliveryHeader)

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

Parameters:

inbDeliveryHeader - InbDeliveryHeader entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllInbDeliveryItem

@Nonnull
InbDeliveryItemFluentHelper getAllInbDeliveryItem()

Fetch multiple InbDeliveryItem entities.

Returns:

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

getInbDeliveryItemByKey

@Nonnull
InbDeliveryItemByKeyFluentHelper getInbDeliveryItemByKey(String deliveryDocument,
                                                                  String deliveryDocumentItem)

Fetch a single InbDeliveryItem 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 InbDeliveryItem 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.

updateInbDeliveryItem

@Nonnull
InbDeliveryItemUpdateFluentHelper updateInbDeliveryItem(@Nonnull
                                                                 InbDeliveryItem inbDeliveryItem)

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

Parameters:

inbDeliveryItem - InbDeliveryItem entity object that will be updated in the S/4HANA system.

Returns:

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

deleteInbDeliveryItem

@Nonnull
InbDeliveryItemDeleteFluentHelper deleteInbDeliveryItem(@Nonnull
                                                                 InbDeliveryItem inbDeliveryItem)

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

Parameters:

inbDeliveryItem - InbDeliveryItem entity object that will be deleted in the S/4HANA system.

Returns:

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

getInbDeliveryPartnerByKey

@Nonnull
InbDeliveryPartnerByKeyFluentHelper getInbDeliveryPartnerByKey(String partnerFunction,
                                                                        String sDDocument)

Fetch a single InbDeliveryPartner 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 InbDeliveryPartner 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.

getInbDeliverySerialNmbrByKey

@Nonnull
InbDeliverySerialNmbrByKeyFluentHelper getInbDeliverySerialNmbrByKey(Long maintenanceItemObjectList)

Fetch a single InbDeliverySerialNmbr entity using key fields.

Parameters:

maintenanceItemObjectList - Number identifying the object list

Constraints: Not nullable

Returns:

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

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 deliveryDocument,
                                                                 String deliveryDocumentItem)

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.

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.

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 deliveryDocument,
                                                   String deliveryDocumentItem)

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.

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.

addSerialNumberToDeliveryItem

@Nonnull
AddSerialNumberToDeliveryItemFluentHelper addSerialNumberToDeliveryItem(String deliveryDocument,
                                                                                 String deliveryDocumentItem,
                                                                                 String serialNumber)

Creates a fluent helper for the AddSerialNumberToDeliveryItem OData function import.

Parameters:

serialNumber - Serial Number

Constraints: Not nullable, Maximum length: 18

Original parameter name from the Odata EDM: SerialNumber

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 AddSerialNumberToDeliveryItem OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

deleteAllSerialNumbersFromDeliveryItem

@Nonnull
DeleteAllSerialNumbersFromDeliveryItemFluentHelper deleteAllSerialNumbersFromDeliveryItem(String deliveryDocument,
                                                                                                   String deliveryDocumentItem)

Creates a fluent helper for the DeleteAllSerialNumbersFromDeliveryItem 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 DeleteAllSerialNumbersFromDeliveryItem OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

deleteSerialNumberFromDeliveryItem

@Nonnull
DeleteSerialNumberFromDeliveryItemFluentHelper deleteSerialNumberFromDeliveryItem(String deliveryDocument,
                                                                                           String deliveryDocumentItem,
                                                                                           String serialNumber)

Creates a fluent helper for the DeleteSerialNumberFromDeliveryItem OData function import.

Parameters:

serialNumber - Serial Number

Constraints: Not nullable, Maximum length: 18

Original parameter name from the Odata EDM: SerialNumber

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 DeleteSerialNumberFromDeliveryItem 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(BigDecimal actualDeliveredQtyInBaseUnit,
                                                                                   String baseUnit,
                                                                                   String deliveryDocument,
                                                                                   String deliveryDocumentItem)

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(BigDecimal actualDeliveryQuantity,
                                                                                     String deliveryDocument,
                                                                                     String deliveryDocumentItem,
                                                                                     String deliveryQuantityUnit)

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.