public interface SalesDocumentWithCreditBlocksService extends BatchService<SalesDocumentWithCreditBlocksServiceBatch>
The service contains entities for credit blocked sales document and reject reason. The information is sent in the request as a URL. Once the sales document has been checked, released, or rejected, a success message containing the document number is sent in the response. Once the credit blocked sales 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 sales document, the system displays error messages in the response..
Reference: SAP API Business Hub
OData Service: | OP_API_SLS_DOC_WITH_CREDIT_BLOCK_0001 |
API Version: | 1 |
Minimum ERP Version: | 2020 |
Authentication Methods: | Basic, x509 |
Business Object: | Sales Order |
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 sDDocumentCategory,
String salesDocument)
Creates a fluent helper for the CheckCreditBlock OData function import.
|
CreditBlockedSalesDocumentFluentHelper |
getAllCreditBlockedSalesDocument()
Fetch multiple
CreditBlockedSalesDocument entities. |
SalesDocumentRjcnReasonFluentHelper |
getAllSalesDocumentRjcnReason()
Fetch multiple
SalesDocumentRjcnReason entities. |
CreditBlockedSalesDocumentByKeyFluentHelper |
getCreditBlockedSalesDocumentByKey(String salesDocument)
Fetch a single
CreditBlockedSalesDocument entity using key fields. |
SalesDocumentRjcnReasonByKeyFluentHelper |
getSalesDocumentRjcnReasonByKey(String salesDocumentRjcnReason)
Fetch a single
SalesDocumentRjcnReason entity using key fields. |
RejectCreditBlockFluentHelper |
rejectCreditBlock(String sDDocumentCategory,
String salesDocumentRjcnReason,
String salesDocument)
Creates a fluent helper for the RejectCreditBlock OData function import.
|
ReleaseCreditBlockFluentHelper |
releaseCreditBlock(String salesDocument,
String sDDocumentCategory)
Creates a fluent helper for the ReleaseCreditBlock OData function import.
|
SalesDocumentWithCreditBlocksService |
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 SalesDocumentWithCreditBlocksService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull CreditBlockedSalesDocumentFluentHelper getAllCreditBlockedSalesDocument()
CreditBlockedSalesDocument
entities.CreditBlockedSalesDocument
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 CreditBlockedSalesDocumentByKeyFluentHelper getCreditBlockedSalesDocumentByKey(String salesDocument)
CreditBlockedSalesDocument
entity using key fields.salesDocument
- Sales Document
Constraints: Not nullable, Maximum length: 10
CreditBlockedSalesDocument
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
- Reason for Rejection of Sales Documents
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 sDDocumentCategory, String salesDocument)
Creates a fluent helper for the CheckCreditBlock OData function import.
salesDocument
- Constraints: none
Original parameter name from the Odata EDM: SalesDocument
sDDocumentCategory
- Constraints: none
Original parameter name from the Odata EDM: SDDocumentCategory
execute
method on the fluent helper object.@Nonnull RejectCreditBlockFluentHelper rejectCreditBlock(String sDDocumentCategory, String salesDocumentRjcnReason, String salesDocument)
Creates a fluent helper for the RejectCreditBlock OData function import.
salesDocument
- Constraints: none
Original parameter name from the Odata EDM: SalesDocument
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 salesDocument, String sDDocumentCategory)
Creates a fluent helper for the ReleaseCreditBlock OData function import.
salesDocument
- Constraints: none
Original parameter name from the Odata EDM: SalesDocument
sDDocumentCategory
- Constraints: none
Original parameter name from the Odata EDM: SDDocumentCategory
execute
method on the fluent helper object.Copyright © 2021 SAP SE. All rights reserved.