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

Interface DeliveryDocumentWithCreditBlocksService

All Superinterfaces:

BatchService<DeliveryDocumentWithCreditBlocksServiceBatch>

All Known Implementing Classes:

DefaultDeliveryDocumentWithCreditBlocksService

public interface DeliveryDocumentWithCreditBlocksService
extends BatchService<DeliveryDocumentWithCreditBlocksServiceBatch>

This synchronous inbound service enables you to read delivery documents that contain credit blocks, and check, release and reject the blocked delivery documents. It is based on the OData protocol and can be consumed in Fiori apps and on other user interfaces.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_DEL_DOC_WITH_CREDIT_BLOCK
API Version:	1
Communication Scenario:	Sales Credit Management Integration (SAP_COM_0325)
Scope Items:	Basic Credit Management (BD6)
Authentication Methods:	Basic, x509, OAuth2

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
CheckCreditBlockFluentHelper	checkCreditBlock(String deliveryDocument, String sDDocumentCategory) Check
CreditBlockedDeliveryDocFluentHelper	getAllCreditBlockedDeliveryDoc() Fetch multiple CreditBlockedDeliveryDoc entities.
SalesDocumentRjcnReasonFluentHelper	getAllSalesDocumentRjcnReason() Fetch multiple SalesDocumentRjcnReason entities.
CreditBlockedDeliveryDocByKeyFluentHelper	getCreditBlockedDeliveryDocByKey(String deliveryDocument) Fetch a single CreditBlockedDeliveryDoc entity using key fields.
SalesDocumentRjcnReasonByKeyFluentHelper	getSalesDocumentRjcnReasonByKey(String salesDocumentRjcnReason) Fetch a single SalesDocumentRjcnReason entity using key fields.
RejectCreditBlockFluentHelper	rejectCreditBlock(String deliveryDocument, String salesDocumentRjcnReason, String sDDocumentCategory) Reject
ReleaseCreditBlockFluentHelper	releaseCreditBlock(String sDDocumentCategory, String deliveryDocument) Release
DeliveryDocumentWithCreditBlocksService	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.s4hana.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
DeliveryDocumentWithCreditBlocksService 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.

getAllCreditBlockedDeliveryDoc

@Nonnull
CreditBlockedDeliveryDocFluentHelper getAllCreditBlockedDeliveryDoc()

Fetch multiple CreditBlockedDeliveryDoc entities.

Returns:

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

getCreditBlockedDeliveryDocByKey

@Nonnull
CreditBlockedDeliveryDocByKeyFluentHelper getCreditBlockedDeliveryDocByKey(String deliveryDocument)

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

getAllSalesDocumentRjcnReason

@Nonnull
SalesDocumentRjcnReasonFluentHelper getAllSalesDocumentRjcnReason()

Fetch multiple SalesDocumentRjcnReason entities.

Returns:

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

getSalesDocumentRjcnReasonByKey

@Nonnull
SalesDocumentRjcnReasonByKeyFluentHelper getSalesDocumentRjcnReasonByKey(String salesDocumentRjcnReason)

Fetch a single SalesDocumentRjcnReason entity using key fields.

Parameters:

salesDocumentRjcnReason - The reason for rejecting a sales document (for example, a sales quotation or a sales order).

Constraints: Not nullable, Maximum length: 2

Returns:

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

checkCreditBlock

@Nonnull
CheckCreditBlockFluentHelper checkCreditBlock(String deliveryDocument,
                                                       String sDDocumentCategory)

Check

Creates a fluent helper for the CheckCreditBlock OData function import.

Parameters:

deliveryDocument - Constraints: none

Original parameter name from the Odata EDM: DeliveryDocument

sDDocumentCategory - Constraints: none

Original parameter name from the Odata EDM: SDDocumentCategory

Returns:

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

rejectCreditBlock

@Nonnull
RejectCreditBlockFluentHelper rejectCreditBlock(String deliveryDocument,
                                                         String salesDocumentRjcnReason,
                                                         String sDDocumentCategory)

Reject

Creates a fluent helper for the RejectCreditBlock OData function import.

Parameters:

deliveryDocument - Constraints: none

Original parameter name from the Odata EDM: DeliveryDocument

sDDocumentCategory - Constraints: none

Original parameter name from the Odata EDM: SDDocumentCategory

salesDocumentRjcnReason - Constraints: none

Original parameter name from the Odata EDM: SalesDocumentRjcnReason

Returns:

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

releaseCreditBlock

@Nonnull
ReleaseCreditBlockFluentHelper releaseCreditBlock(String sDDocumentCategory,
                                                           String deliveryDocument)

Release

Creates a fluent helper for the ReleaseCreditBlock OData function import.

Parameters:

deliveryDocument - Constraints: none

Original parameter name from the Odata EDM: DeliveryDocument

sDDocumentCategory - Constraints: none

Original parameter name from the Odata EDM: SDDocumentCategory

Returns:

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