com.sap.cloud.sdk.s4hana.onpremise.datamodel.odata.services

Interface CreditManagementMasterDataIntegrationService

All Superinterfaces:

BatchService<CreditManagementMasterDataIntegrationServiceBatch>

All Known Implementing Classes:

DefaultCreditManagementMasterDataIntegrationService

public interface CreditManagementMasterDataIntegrationService
extends BatchService<CreditManagementMasterDataIntegrationServiceBatch>

This service uses Credit Management Business Partner and Credit Management Account nodes. Use the Credit Management Business Partner node to read, create and update data related to credit management for business partners in the business partner role SAP Credit Management, such as risk class, limit rule, or check rule. Use the Credit Management Account node to read, create, update, and delete credit segment data, such as credit limit, special attention flag, block reason, and others. If you want to create credit-management-related master data for an existing business partner, you send data for both nodes in a post request as a payload. If it’s not already maintained, the SAP Credit Management role (UKM000) is automatically added to the business partners. If you want to add or change credit-management-related master data, you may send requests addressing the related entities directly. If there are any issues with the data passed, the system displays error messages in the response. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_CRDTMBUSINESSPARTNER_0001
API Version:	1.0.0
Minimum ERP Version:	2022
Business Object:	Credit Management Business Partner

Field Summary

Fields

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.

Method Summary

Modifier and Type	Method and Description
CreditMgmtBusinessPartnerCreateFluentHelper	createCreditMgmtBusinessPartner(CreditMgmtBusinessPartner creditMgmtBusinessPartner) Create a new CreditMgmtBusinessPartner entity and save it to the S/4HANA system.
CreditManagementAccountDeleteFluentHelper	deleteCreditManagementAccount(CreditManagementAccount creditManagementAccount) Deletes an existing CreditManagementAccount entity in the S/4HANA system.
CreditManagementAccountFluentHelper	getAllCreditManagementAccount() Fetch multiple CreditManagementAccount entities.
CreditMgmtBusinessPartnerFluentHelper	getAllCreditMgmtBusinessPartner() Fetch multiple CreditMgmtBusinessPartner entities.
CreditManagementAccountByKeyFluentHelper	getCreditManagementAccountByKey(String businessPartner, String creditSegment) Fetch a single CreditManagementAccount entity using key fields.
CreditMgmtBusinessPartnerByKeyFluentHelper	getCreditMgmtBusinessPartnerByKey(String businessPartner) Fetch a single CreditMgmtBusinessPartner entity using key fields.
CreditManagementAccountUpdateFluentHelper	updateCreditManagementAccount(CreditManagementAccount creditManagementAccount) Update an existing CreditManagementAccount entity and save it to the S/4HANA system.
CreditMgmtBusinessPartnerUpdateFluentHelper	updateCreditMgmtBusinessPartner(CreditMgmtBusinessPartner creditMgmtBusinessPartner) Update an existing CreditMgmtBusinessPartner entity and save it to the S/4HANA system.
CreditManagementMasterDataIntegrationService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

static final 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.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
CreditManagementMasterDataIntegrationService withServicePath(@Nonnull
                                                                      String servicePath)

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

getAllCreditMgmtBusinessPartner

@Nonnull
CreditMgmtBusinessPartnerFluentHelper getAllCreditMgmtBusinessPartner()

Fetch multiple CreditMgmtBusinessPartner entities.

Returns:

A fluent helper to fetch multiple CreditMgmtBusinessPartner 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.

getCreditMgmtBusinessPartnerByKey

@Nonnull
CreditMgmtBusinessPartnerByKeyFluentHelper getCreditMgmtBusinessPartnerByKey(String businessPartner)

Fetch a single CreditMgmtBusinessPartner entity using key fields.

Parameters:

businessPartner - Business Partner Number

Constraints: Not nullable, Maximum length: 10

Returns:

A fluent helper to fetch a single CreditMgmtBusinessPartner 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.

createCreditMgmtBusinessPartner

@Nonnull
CreditMgmtBusinessPartnerCreateFluentHelper createCreditMgmtBusinessPartner(@Nonnull
                                                                                     CreditMgmtBusinessPartner creditMgmtBusinessPartner)

Create a new CreditMgmtBusinessPartner entity and save it to the S/4HANA system.

Parameters:

creditMgmtBusinessPartner - CreditMgmtBusinessPartner entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new CreditMgmtBusinessPartner entity. To perform execution, call the execute method on the fluent helper object.

updateCreditMgmtBusinessPartner

@Nonnull
CreditMgmtBusinessPartnerUpdateFluentHelper updateCreditMgmtBusinessPartner(@Nonnull
                                                                                     CreditMgmtBusinessPartner creditMgmtBusinessPartner)

Update an existing CreditMgmtBusinessPartner entity and save it to the S/4HANA system.

Parameters:

creditMgmtBusinessPartner - CreditMgmtBusinessPartner entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing CreditMgmtBusinessPartner entity. To perform execution, call the execute method on the fluent helper object.

getAllCreditManagementAccount

@Nonnull
CreditManagementAccountFluentHelper getAllCreditManagementAccount()

Fetch multiple CreditManagementAccount entities.

Returns:

A fluent helper to fetch multiple CreditManagementAccount 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.

getCreditManagementAccountByKey

@Nonnull
CreditManagementAccountByKeyFluentHelper getCreditManagementAccountByKey(String businessPartner,
                                                                                  String creditSegment)

Fetch a single CreditManagementAccount entity using key fields.

Parameters:

creditSegment - Credit Segment

Constraints: Not nullable, Maximum length: 10

businessPartner - Business Partner Number

Constraints: Not nullable, Maximum length: 10

Returns:

A fluent helper to fetch a single CreditManagementAccount 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.

updateCreditManagementAccount

@Nonnull
CreditManagementAccountUpdateFluentHelper updateCreditManagementAccount(@Nonnull
                                                                                 CreditManagementAccount creditManagementAccount)

Update an existing CreditManagementAccount entity and save it to the S/4HANA system.

Parameters:

creditManagementAccount - CreditManagementAccount entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing CreditManagementAccount entity. To perform execution, call the execute method on the fluent helper object.

deleteCreditManagementAccount

@Nonnull
CreditManagementAccountDeleteFluentHelper deleteCreditManagementAccount(@Nonnull
                                                                                 CreditManagementAccount creditManagementAccount)

Deletes an existing CreditManagementAccount entity in the S/4HANA system.

Parameters:

creditManagementAccount - CreditManagementAccount entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing CreditManagementAccount entity. To perform execution, call the execute method on the fluent helper object.