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

Interface CostRateService

All Superinterfaces:

BatchService<CostRateServiceBatch>

All Known Implementing Classes:

DefaultCostRateService

public interface CostRateService
extends BatchService<CostRateServiceBatch>

This service contains plan cost rate, actual cost rate and service cost rate. For each type you can read a list of existing cost rates, create a new one, update or delete an existing one. During creation or update, the information is used to create a new cost rate or to update an existing one - including all necessary checks for restricted values and authorizations. Created or updated cost rates are included in the response. An existing cost rate that needs to be modified or deleted is identified by the mandatory parameter - AccountingCostRateUUID. If there are any issues, the system displays error messages in the response..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_FCO_COST_RATE_SRV
API Version:	1
Communication Scenario:	Finance - Activity Type Integration (SAP_COM_0129)
Scope Items:	Overhead Cost Accounting (J54)
Authentication Methods:	Basic, x509
Business Object:	AccountingCostRate

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
ActualCostRateCreateFluentHelper	createActualCostRate(ActualCostRate actualCostRate) Create a new ActualCostRate entity and save it to the S/4HANA system.
PlanCostRateCreateFluentHelper	createPlanCostRate(PlanCostRate planCostRate) Create a new PlanCostRate entity and save it to the S/4HANA system.
ServiceCostRateCreateFluentHelper	createServiceCostRate(ServiceCostRate serviceCostRate) Create a new ServiceCostRate entity and save it to the S/4HANA system.
ActualCostRateDeleteFluentHelper	deleteActualCostRate(ActualCostRate actualCostRate) Deletes an existing ActualCostRate entity in the S/4HANA system.
PlanCostRateDeleteFluentHelper	deletePlanCostRate(PlanCostRate planCostRate) Deletes an existing PlanCostRate entity in the S/4HANA system.
ServiceCostRateDeleteFluentHelper	deleteServiceCostRate(ServiceCostRate serviceCostRate) Deletes an existing ServiceCostRate entity in the S/4HANA system.
ActualCostRateByKeyFluentHelper	getActualCostRateByKey(UUID accountingCostRateUUID) Fetch a single ActualCostRate entity using key fields.
ActualCostRateFluentHelper	getAllActualCostRate() Fetch multiple ActualCostRate entities.
PlanCostRateFluentHelper	getAllPlanCostRate() Fetch multiple PlanCostRate entities.
ServiceCostRateFluentHelper	getAllServiceCostRate() Fetch multiple ServiceCostRate entities.
PlanCostRateByKeyFluentHelper	getPlanCostRateByKey(UUID accountingCostRateUUID) Fetch a single PlanCostRate entity using key fields.
ServiceCostRateByKeyFluentHelper	getServiceCostRateByKey(UUID accountingCostRateUUID) Fetch a single ServiceCostRate entity using key fields.
ActualCostRateUpdateFluentHelper	updateActualCostRate(ActualCostRate actualCostRate) Update an existing ActualCostRate entity and save it to the S/4HANA system.
PlanCostRateUpdateFluentHelper	updatePlanCostRate(PlanCostRate planCostRate) Update an existing PlanCostRate entity and save it to the S/4HANA system.
ServiceCostRateUpdateFluentHelper	updateServiceCostRate(ServiceCostRate serviceCostRate) Update an existing ServiceCostRate entity and save it to the S/4HANA system.
CostRateService	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
CostRateService 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.

getAllActualCostRate

@Nonnull
ActualCostRateFluentHelper getAllActualCostRate()

Fetch multiple ActualCostRate entities.

Returns:

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

getActualCostRateByKey

@Nonnull
ActualCostRateByKeyFluentHelper getActualCostRateByKey(UUID accountingCostRateUUID)

Fetch a single ActualCostRate entity using key fields.

Parameters:

accountingCostRateUUID - Cost Rate UUID

Constraints: Not nullable

Returns:

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

createActualCostRate

@Nonnull
ActualCostRateCreateFluentHelper createActualCostRate(@Nonnull
                                                               ActualCostRate actualCostRate)

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

Parameters:

actualCostRate - ActualCostRate entity object that will be created in the S/4HANA system.

Returns:

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

updateActualCostRate

@Nonnull
ActualCostRateUpdateFluentHelper updateActualCostRate(@Nonnull
                                                               ActualCostRate actualCostRate)

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

Parameters:

actualCostRate - ActualCostRate entity object that will be updated in the S/4HANA system.

Returns:

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

deleteActualCostRate

@Nonnull
ActualCostRateDeleteFluentHelper deleteActualCostRate(@Nonnull
                                                               ActualCostRate actualCostRate)

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

Parameters:

actualCostRate - ActualCostRate entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllPlanCostRate

@Nonnull
PlanCostRateFluentHelper getAllPlanCostRate()

Fetch multiple PlanCostRate entities.

Returns:

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

getPlanCostRateByKey

@Nonnull
PlanCostRateByKeyFluentHelper getPlanCostRateByKey(UUID accountingCostRateUUID)

Fetch a single PlanCostRate entity using key fields.

Parameters:

accountingCostRateUUID - Cost Rate UUID

Constraints: Not nullable

Returns:

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

createPlanCostRate

@Nonnull
PlanCostRateCreateFluentHelper createPlanCostRate(@Nonnull
                                                           PlanCostRate planCostRate)

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

Parameters:

planCostRate - PlanCostRate entity object that will be created in the S/4HANA system.

Returns:

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

updatePlanCostRate

@Nonnull
PlanCostRateUpdateFluentHelper updatePlanCostRate(@Nonnull
                                                           PlanCostRate planCostRate)

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

Parameters:

planCostRate - PlanCostRate entity object that will be updated in the S/4HANA system.

Returns:

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

deletePlanCostRate

@Nonnull
PlanCostRateDeleteFluentHelper deletePlanCostRate(@Nonnull
                                                           PlanCostRate planCostRate)

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

Parameters:

planCostRate - PlanCostRate entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllServiceCostRate

@Nonnull
ServiceCostRateFluentHelper getAllServiceCostRate()

Fetch multiple ServiceCostRate entities.

Returns:

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

getServiceCostRateByKey

@Nonnull
ServiceCostRateByKeyFluentHelper getServiceCostRateByKey(UUID accountingCostRateUUID)

Fetch a single ServiceCostRate entity using key fields.

Parameters:

accountingCostRateUUID - Cost Rate UUID

Constraints: Not nullable

Returns:

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

createServiceCostRate

@Nonnull
ServiceCostRateCreateFluentHelper createServiceCostRate(@Nonnull
                                                                 ServiceCostRate serviceCostRate)

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

Parameters:

serviceCostRate - ServiceCostRate entity object that will be created in the S/4HANA system.

Returns:

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

updateServiceCostRate

@Nonnull
ServiceCostRateUpdateFluentHelper updateServiceCostRate(@Nonnull
                                                                 ServiceCostRate serviceCostRate)

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

Parameters:

serviceCostRate - ServiceCostRate entity object that will be updated in the S/4HANA system.

Returns:

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

deleteServiceCostRate

@Nonnull
ServiceCostRateDeleteFluentHelper deleteServiceCostRate(@Nonnull
                                                                 ServiceCostRate serviceCostRate)

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

Parameters:

serviceCostRate - ServiceCostRate entity object that will be deleted in the S/4HANA system.

Returns:

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