@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultSalesDocumentWithCreditBlocksService") public class DefaultSalesDocumentWithCreditBlocksService extends Object implements SalesDocumentWithCreditBlocksService
The service contains entities for credit blocked sales document and reject reason. 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: | API_SLS_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: | SalesOrder |
DEFAULT_SERVICE_PATH
Constructor and Description |
---|
DefaultSalesDocumentWithCreditBlocksService()
Creates a service using
SalesDocumentWithCreditBlocksService.DEFAULT_SERVICE_PATH to send the requests. |
Modifier and Type | Method and Description |
---|---|
DefaultSalesDocumentWithCreditBlocksServiceBatch |
batch()
Instantiate a new FluentHelper instance for a single OData batch request.
|
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.
|
DefaultSalesDocumentWithCreditBlocksService |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
public DefaultSalesDocumentWithCreditBlocksService()
SalesDocumentWithCreditBlocksService.DEFAULT_SERVICE_PATH
to send the requests.@Nonnull public DefaultSalesDocumentWithCreditBlocksService withServicePath(@Nonnull String servicePath)
SalesDocumentWithCreditBlocksService
withServicePath
in interface SalesDocumentWithCreditBlocksService
servicePath
- Service path that will override the default.@Nonnull public DefaultSalesDocumentWithCreditBlocksServiceBatch batch()
batch
in interface BatchService<SalesDocumentWithCreditBlocksServiceBatch>
@Nonnull public CreditBlockedSalesDocumentFluentHelper getAllCreditBlockedSalesDocument()
SalesDocumentWithCreditBlocksService
CreditBlockedSalesDocument
entities.getAllCreditBlockedSalesDocument
in interface SalesDocumentWithCreditBlocksService
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 public CreditBlockedSalesDocumentByKeyFluentHelper getCreditBlockedSalesDocumentByKey(String salesDocument)
SalesDocumentWithCreditBlocksService
CreditBlockedSalesDocument
entity using key fields.getCreditBlockedSalesDocumentByKey
in interface SalesDocumentWithCreditBlocksService
salesDocument
- The number that uniquely identifies the 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 public SalesDocumentRjcnReasonFluentHelper getAllSalesDocumentRjcnReason()
SalesDocumentWithCreditBlocksService
SalesDocumentRjcnReason
entities.getAllSalesDocumentRjcnReason
in interface SalesDocumentWithCreditBlocksService
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)
SalesDocumentWithCreditBlocksService
SalesDocumentRjcnReason
entity using key fields.getSalesDocumentRjcnReasonByKey
in interface SalesDocumentWithCreditBlocksService
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(String sDDocumentCategory, String salesDocument)
SalesDocumentWithCreditBlocksService
Creates a fluent helper for the CheckCreditBlock OData function import.
checkCreditBlock
in interface SalesDocumentWithCreditBlocksService
sDDocumentCategory
- Constraints: none
Original parameter name from the Odata EDM: SDDocumentCategory
salesDocument
- Constraints: none
Original parameter name from the Odata EDM: SalesDocument
execute
method on the fluent helper object.@Nonnull public RejectCreditBlockFluentHelper rejectCreditBlock(String sDDocumentCategory, String salesDocumentRjcnReason, String salesDocument)
SalesDocumentWithCreditBlocksService
Creates a fluent helper for the RejectCreditBlock OData function import.
rejectCreditBlock
in interface SalesDocumentWithCreditBlocksService
sDDocumentCategory
- Constraints: none
Original parameter name from the Odata EDM: SDDocumentCategory
salesDocumentRjcnReason
- Constraints: none
Original parameter name from the Odata EDM: SalesDocumentRjcnReason
salesDocument
- Constraints: none
Original parameter name from the Odata EDM: SalesDocument
execute
method on the fluent helper object.@Nonnull public ReleaseCreditBlockFluentHelper releaseCreditBlock(String salesDocument, String sDDocumentCategory)
SalesDocumentWithCreditBlocksService
Creates a fluent helper for the ReleaseCreditBlock OData function import.
releaseCreditBlock
in interface SalesDocumentWithCreditBlocksService
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.