public interface DeliveryDocumentWithCreditBlocksService extends BatchService<DeliveryDocumentWithCreditBlocksServiceBatch>
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 |
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. |
Modifier and Type | Method and Description |
---|---|
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.
|
DeliveryDocumentWithCreditBlocksService |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
batch
static final String DEFAULT_SERVICE_PATH
withServicePath(String)
method, this is the default service path
used to access the endpoint.@Nonnull DeliveryDocumentWithCreditBlocksService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull CreditBlockedDeliveryDocFluentHelper getAllCreditBlockedDeliveryDoc()
CreditBlockedDeliveryDoc
entities.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 CreditBlockedDeliveryDocByKeyFluentHelper getCreditBlockedDeliveryDocByKey(String deliveryDocument)
CreditBlockedDeliveryDoc
entity using key fields.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 SalesDocumentRjcnReasonFluentHelper getAllSalesDocumentRjcnReason()
SalesDocumentRjcnReason
entities.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 SalesDocumentRjcnReasonByKeyFluentHelper getSalesDocumentRjcnReasonByKey(String salesDocumentRjcnReason)
SalesDocumentRjcnReason
entity using key fields.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 CheckCreditBlockFluentHelper checkCreditBlock(String deliveryDocument, String sDDocumentCategory)
Creates a fluent helper for the CheckCreditBlock OData function import.
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 RejectCreditBlockFluentHelper rejectCreditBlock(String deliveryDocument, String salesDocumentRjcnReason, String sDDocumentCategory)
Creates a fluent helper for the RejectCreditBlock OData function import.
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
execute
method on the fluent helper object.@Nonnull ReleaseCreditBlockFluentHelper releaseCreditBlock(String sDDocumentCategory, String deliveryDocument)
Creates a fluent helper for the ReleaseCreditBlock OData function import.
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.Copyright © 2020 SAP SE. All rights reserved.