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

Interface PersonnelSettlementDocumentService

All Superinterfaces:

BatchService<PersonnelSettlementDocumentServiceBatch>

All Known Implementing Classes:

DefaultPersonnelSettlementDocumentService

public interface PersonnelSettlementDocumentService
extends BatchService<PersonnelSettlementDocumentServiceBatch>

The service enables you to read the transactional data of personnel settlement documents. It is based on the OData protocol and it is intended for consumption in background by remote interfaces for application integration scenarios. In every API call, you can make use of the following operations: - You can retrieve an individual personnel settlement document by document number - You can retrieve multiple documents by filtering on the available properties - You can request additional information on the assignment of settled amounts to cost centers - You can retrieve delta information by filtering on date and time to only get documents which have been created after that point in time.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PERS_SETTLMT_DOC
API Version:	1
Communication Scenario:	Logistics - Employee Central Personnel Settlement Document Integration (SAP_COM_0469)
Scope Items:	Internal Commissions Settlement with SAP Sales Cloud (3TD)
Authentication Methods:	Basic, x509
Business Object:	PersonnelSettlementDocument

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
PersCompnElmntCostAssgmtFluentHelper	getAllPersCompnElmntCostAssgmt() Fetch multiple PersCompnElmntCostAssgmt entities.
PersonnelCompensationElementFluentHelper	getAllPersonnelCompensationElement() Fetch multiple PersonnelCompensationElement entities.
PersCompnElmntCostAssgmtByKeyFluentHelper	getPersCompnElmntCostAssgmtByKey(String personnelSettlementDocument, String controllingArea, String costCenter) Fetch a single PersCompnElmntCostAssgmt entity using key fields.
PersonnelCompensationElementByKeyFluentHelper	getPersonnelCompensationElementByKey(String personnelSettlementDocument) Fetch a single PersonnelCompensationElement entity using key fields.
PersonnelSettlementDocumentService	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
PersonnelSettlementDocumentService 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.

getAllPersCompnElmntCostAssgmt

@Nonnull
PersCompnElmntCostAssgmtFluentHelper getAllPersCompnElmntCostAssgmt()

Fetch multiple PersCompnElmntCostAssgmt entities.

Returns:

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

getPersCompnElmntCostAssgmtByKey

@Nonnull
PersCompnElmntCostAssgmtByKeyFluentHelper getPersCompnElmntCostAssgmtByKey(String personnelSettlementDocument,
                                                                                    String controllingArea,
                                                                                    String costCenter)

Fetch a single PersCompnElmntCostAssgmt entity using key fields.

Parameters:

personnelSettlementDocument - Personnel Settlement Document Number

Constraints: Not nullable, Maximum length: 10

costCenter - Cost Center

Constraints: Not nullable, Maximum length: 10

controllingArea - Controlling Area

Constraints: Not nullable, Maximum length: 4

Returns:

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

getAllPersonnelCompensationElement

@Nonnull
PersonnelCompensationElementFluentHelper getAllPersonnelCompensationElement()

Fetch multiple PersonnelCompensationElement entities.

Returns:

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

getPersonnelCompensationElementByKey

@Nonnull
PersonnelCompensationElementByKeyFluentHelper getPersonnelCompensationElementByKey(String personnelSettlementDocument)

Fetch a single PersonnelCompensationElement entity using key fields.

Parameters:

personnelSettlementDocument - Personnel Settlement Document Number

Constraints: Not nullable, Maximum length: 10

Returns:

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