Class DefaultSalesDocumentWithCreditBlocksService
- All Implemented Interfaces:
BatchService<SalesDocumentWithCreditBlocksServiceBatch>,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 Business Accelerator Hub
Details:
| OData Service: | API_SLS_DOC_WITH_CREDIT_BLOCK |
| API Version: | 1.0.0 |
| Minimum ERP Version: | 2302 |
| Communication Scenario: | Sales Credit Management Integration(SAP_COM_0325) |
| Scope Items: | Basic Credit Management(BD6) |
| Authentication Methods: | x509 |
| Business Object: | Sales Order |
-
Field Summary
Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.SalesDocumentWithCreditBlocksService
DEFAULT_SERVICE_PATH -
Constructor Summary
ConstructorsConstructorDescriptionDeprecated.Creates a service usingSalesDocumentWithCreditBlocksService.DEFAULT_SERVICE_PATHto send the requests. -
Method Summary
Modifier and TypeMethodDescriptionbatch()Deprecated.checkCreditBlock(String sDDocumentCategory, String salesDocument) Deprecated.Creates a fluent helper for the CheckCreditBlock OData function import.Deprecated.Fetch multipleCreditBlockedSalesDocumententities.Deprecated.Fetch multipleSalesDocumentRjcnReasonentities.getCreditBlockedSalesDocumentByKey(String salesDocument) Deprecated.Fetch a singleCreditBlockedSalesDocumententity using key fields.getSalesDocumentRjcnReasonByKey(String salesDocumentRjcnReason) Deprecated.Fetch a singleSalesDocumentRjcnReasonentity using key fields.rejectCreditBlock(String sDDocumentCategory, String salesDocumentRjcnReason, String salesDocument) Deprecated.Creates a fluent helper for the RejectCreditBlock OData function import.releaseCreditBlock(String salesDocument, String sDDocumentCategory) Deprecated.Creates a fluent helper for the ReleaseCreditBlock OData function import.withServicePath(String servicePath) Deprecated.Overrides the default service path and returns a new service instance with the specified service path.
-
Constructor Details
-
DefaultSalesDocumentWithCreditBlocksService
public DefaultSalesDocumentWithCreditBlocksService()Deprecated.Creates a service usingSalesDocumentWithCreditBlocksService.DEFAULT_SERVICE_PATHto send the requests.
-
-
Method Details
-
withServicePath
@Nonnull public DefaultSalesDocumentWithCreditBlocksService withServicePath(@Nonnull String servicePath) Deprecated.Description copied from interface:SalesDocumentWithCreditBlocksServiceOverrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.- Specified by:
withServicePathin interfaceSalesDocumentWithCreditBlocksService- Parameters:
servicePath- Service path that will override the default.- Returns:
- A new service instance with the specified service path.
-
batch
Deprecated.- Specified by:
batchin interfaceBatchService<SalesDocumentWithCreditBlocksServiceBatch>
-
getAllCreditBlockedSalesDocument
Deprecated.Description copied from interface:SalesDocumentWithCreditBlocksServiceFetch multipleCreditBlockedSalesDocumententities.- Specified by:
getAllCreditBlockedSalesDocumentin interfaceSalesDocumentWithCreditBlocksService- Returns:
- A fluent helper to fetch multiple
CreditBlockedSalesDocumententities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getCreditBlockedSalesDocumentByKey
@Nonnull public CreditBlockedSalesDocumentByKeyFluentHelper getCreditBlockedSalesDocumentByKey(String salesDocument) Deprecated.Description copied from interface:SalesDocumentWithCreditBlocksServiceFetch a singleCreditBlockedSalesDocumententity using key fields.- Specified by:
getCreditBlockedSalesDocumentByKeyin interfaceSalesDocumentWithCreditBlocksService- Parameters:
salesDocument- Sales DocumentConstraints: Not nullable, Maximum length: 10
- Returns:
- A fluent helper to fetch a single
CreditBlockedSalesDocumententity 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 theexecutemethod on the fluent helper object.
-
getAllSalesDocumentRjcnReason
Deprecated.Description copied from interface:SalesDocumentWithCreditBlocksServiceFetch multipleSalesDocumentRjcnReasonentities.- Specified by:
getAllSalesDocumentRjcnReasonin interfaceSalesDocumentWithCreditBlocksService- Returns:
- A fluent helper to fetch multiple
SalesDocumentRjcnReasonentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getSalesDocumentRjcnReasonByKey
@Nonnull public SalesDocumentRjcnReasonByKeyFluentHelper getSalesDocumentRjcnReasonByKey(String salesDocumentRjcnReason) Deprecated.Description copied from interface:SalesDocumentWithCreditBlocksServiceFetch a singleSalesDocumentRjcnReasonentity using key fields.- Specified by:
getSalesDocumentRjcnReasonByKeyin interfaceSalesDocumentWithCreditBlocksService- Parameters:
salesDocumentRjcnReason- Reason for Rejection of Sales DocumentsConstraints: Not nullable, Maximum length: 2
- Returns:
- A fluent helper to fetch a single
SalesDocumentRjcnReasonentity 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 theexecutemethod on the fluent helper object.
-
checkCreditBlock
@Nonnull public CheckCreditBlockFluentHelper checkCreditBlock(@Nonnull String sDDocumentCategory, @Nonnull String salesDocument) Deprecated.Description copied from interface:SalesDocumentWithCreditBlocksServiceCreates a fluent helper for the CheckCreditBlock OData function import.
- Specified by:
checkCreditBlockin interfaceSalesDocumentWithCreditBlocksService- Parameters:
sDDocumentCategory- Constraints: noneOriginal parameter name from the Odata EDM: SDDocumentCategory
salesDocument- Constraints: noneOriginal parameter name from the Odata EDM: SalesDocument
- Returns:
- A fluent helper object that will execute the CheckCreditBlock OData function import with the
provided parameters. To perform execution, call the
executemethod on the fluent helper object.
-
rejectCreditBlock
@Nonnull public RejectCreditBlockFluentHelper rejectCreditBlock(@Nonnull String sDDocumentCategory, @Nonnull String salesDocumentRjcnReason, @Nonnull String salesDocument) Deprecated.Description copied from interface:SalesDocumentWithCreditBlocksServiceCreates a fluent helper for the RejectCreditBlock OData function import.
- Specified by:
rejectCreditBlockin interfaceSalesDocumentWithCreditBlocksService- Parameters:
sDDocumentCategory- Constraints: noneOriginal parameter name from the Odata EDM: SDDocumentCategory
salesDocumentRjcnReason- Constraints: noneOriginal parameter name from the Odata EDM: SalesDocumentRjcnReason
salesDocument- Constraints: noneOriginal parameter name from the Odata EDM: SalesDocument
- Returns:
- A fluent helper object that will execute the RejectCreditBlock OData function import with the
provided parameters. To perform execution, call the
executemethod on the fluent helper object.
-
releaseCreditBlock
@Nonnull public ReleaseCreditBlockFluentHelper releaseCreditBlock(@Nonnull String salesDocument, @Nonnull String sDDocumentCategory) Deprecated.Description copied from interface:SalesDocumentWithCreditBlocksServiceCreates a fluent helper for the ReleaseCreditBlock OData function import.
- Specified by:
releaseCreditBlockin interfaceSalesDocumentWithCreditBlocksService- Parameters:
salesDocument- Constraints: noneOriginal parameter name from the Odata EDM: SalesDocument
sDDocumentCategory- Constraints: noneOriginal 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
executemethod on the fluent helper object.
-