@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultDeliveryDocumentWithCreditBlocksService") public class DefaultDeliveryDocumentWithCreditBlocksService extends Object implements DeliveryDocumentWithCreditBlocksService
The service contains entities for credit blocked delivery document and reject reason. Once the delivery document has been checked, released, or rejected, a success message containing the document number is sent in the response. Once the credit blocked delivery document has been retrieved, the data is sent in the response. If there are any issues when reading, checking, releasing, or rejecting the credit blocked delivery document, the system displays error messages in the response.
Reference: SAP API Business Hub
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 |
Business Object: | OutboundDelivery |
DEFAULT_SERVICE_PATH
Constructor and Description |
---|
DefaultDeliveryDocumentWithCreditBlocksService()
Creates a service using
DeliveryDocumentWithCreditBlocksService.DEFAULT_SERVICE_PATH to send the
requests. |
Modifier and Type | Method and Description |
---|---|
DefaultDeliveryDocumentWithCreditBlocksServiceBatch |
batch()
Instantiate a new FluentHelper instance for a single OData batch request.
|
CheckCreditBlockFluentHelper |
checkCreditBlock(String deliveryDocument,
String sDDocumentCategory)
Creates a fluent helper for the CheckCreditBlock OData function import.
|
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)
Creates a fluent helper for the RejectCreditBlock OData function import.
|
ReleaseCreditBlockFluentHelper |
releaseCreditBlock(String sDDocumentCategory,
String deliveryDocument)
Creates a fluent helper for the ReleaseCreditBlock OData function import.
|
DefaultDeliveryDocumentWithCreditBlocksService |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
public DefaultDeliveryDocumentWithCreditBlocksService()
DeliveryDocumentWithCreditBlocksService.DEFAULT_SERVICE_PATH
to send the
requests.@Nonnull public DefaultDeliveryDocumentWithCreditBlocksService withServicePath(@Nonnull String servicePath)
DeliveryDocumentWithCreditBlocksService
withServicePath
in interface DeliveryDocumentWithCreditBlocksService
servicePath
- Service path that will override the default.@Nonnull public DefaultDeliveryDocumentWithCreditBlocksServiceBatch batch()
batch
in interface BatchService<DeliveryDocumentWithCreditBlocksServiceBatch>
@Nonnull public CreditBlockedDeliveryDocFluentHelper getAllCreditBlockedDeliveryDoc()
DeliveryDocumentWithCreditBlocksService
CreditBlockedDeliveryDoc
entities.getAllCreditBlockedDeliveryDoc
in interface DeliveryDocumentWithCreditBlocksService
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.@Nonnull public CreditBlockedDeliveryDocByKeyFluentHelper getCreditBlockedDeliveryDocByKey(String deliveryDocument)
DeliveryDocumentWithCreditBlocksService
CreditBlockedDeliveryDoc
entity using key fields.getCreditBlockedDeliveryDocByKey
in interface DeliveryDocumentWithCreditBlocksService
deliveryDocument
- The number that uniquely identifies the delivery.
Constraints: Not nullable, Maximum length: 10
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.@Nonnull public SalesDocumentRjcnReasonFluentHelper getAllSalesDocumentRjcnReason()
DeliveryDocumentWithCreditBlocksService
SalesDocumentRjcnReason
entities.getAllSalesDocumentRjcnReason
in interface DeliveryDocumentWithCreditBlocksService
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.@Nonnull public SalesDocumentRjcnReasonByKeyFluentHelper getSalesDocumentRjcnReasonByKey(String salesDocumentRjcnReason)
DeliveryDocumentWithCreditBlocksService
SalesDocumentRjcnReason
entity using key fields.getSalesDocumentRjcnReasonByKey
in interface DeliveryDocumentWithCreditBlocksService
salesDocumentRjcnReason
- The reason for rejecting a sales document (for example, a sales quotation or a sales order).
Constraints: Not nullable, Maximum length: 2
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.@Nonnull public CheckCreditBlockFluentHelper checkCreditBlock(@Nonnull String deliveryDocument, @Nonnull String sDDocumentCategory)
DeliveryDocumentWithCreditBlocksService
Creates a fluent helper for the CheckCreditBlock OData function import.
checkCreditBlock
in interface DeliveryDocumentWithCreditBlocksService
deliveryDocument
- Constraints: none
Original parameter name from the Odata EDM: DeliveryDocument
sDDocumentCategory
- Constraints: none
Original parameter name from the Odata EDM: SDDocumentCategory
execute
method on the fluent helper object.@Nonnull public RejectCreditBlockFluentHelper rejectCreditBlock(@Nonnull String deliveryDocument, @Nonnull String salesDocumentRjcnReason, @Nonnull String sDDocumentCategory)
DeliveryDocumentWithCreditBlocksService
Creates a fluent helper for the RejectCreditBlock OData function import.
rejectCreditBlock
in interface DeliveryDocumentWithCreditBlocksService
deliveryDocument
- Constraints: none
Original parameter name from the Odata EDM: DeliveryDocument
salesDocumentRjcnReason
- Constraints: none
Original parameter name from the Odata EDM: SalesDocumentRjcnReason
sDDocumentCategory
- Constraints: none
Original parameter name from the Odata EDM: SDDocumentCategory
execute
method on the fluent helper object.@Nonnull public ReleaseCreditBlockFluentHelper releaseCreditBlock(@Nonnull String sDDocumentCategory, @Nonnull String deliveryDocument)
DeliveryDocumentWithCreditBlocksService
Creates a fluent helper for the ReleaseCreditBlock OData function import.
releaseCreditBlock
in interface DeliveryDocumentWithCreditBlocksService
sDDocumentCategory
- Constraints: none
Original parameter name from the Odata EDM: SDDocumentCategory
deliveryDocument
- Constraints: none
Original parameter name from the Odata EDM: DeliveryDocument
execute
method on the fluent helper object.Copyright © 2021 SAP SE. All rights reserved.