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

Class DefaultPersonnelSettlementDocumentService

java.lang.Object

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

All Implemented Interfaces:

BatchService<PersonnelSettlementDocumentServiceBatch>, PersonnelSettlementDocumentService

@Named(value="com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.DefaultPersonnelSettlementDocumentService")
public class DefaultPersonnelSettlementDocumentService
extends Object
implements PersonnelSettlementDocumentService

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:	OP_API_PERS_SETTLMT_DOC_0001
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509
Business Object:	Personnel Settlement Document

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.PersonnelSettlementDocumentService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultPersonnelSettlementDocumentService() Creates a service using PersonnelSettlementDocumentService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultPersonnelSettlementDocumentServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
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.
DefaultPersonnelSettlementDocumentService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultPersonnelSettlementDocumentService

public DefaultPersonnelSettlementDocumentService()

Creates a service using PersonnelSettlementDocumentService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultPersonnelSettlementDocumentService withServicePath(@Nonnull
                                                                          String servicePath)

Description copied from interface: PersonnelSettlementDocumentService

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

Specified by:

withServicePath in interface PersonnelSettlementDocumentService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultPersonnelSettlementDocumentServiceBatch batch()

Instantiate a new FluentHelper instance for a single OData batch request.

Specified by:

batch in interface BatchService<PersonnelSettlementDocumentServiceBatch>

Returns:

A new instance of an OData batch request associated with the service object.

getAllPersCompnElmntCostAssgmt

@Nonnull
public PersCompnElmntCostAssgmtFluentHelper getAllPersCompnElmntCostAssgmt()

Description copied from interface: PersonnelSettlementDocumentService

Fetch multiple PersCompnElmntCostAssgmt entities.

Specified by:

getAllPersCompnElmntCostAssgmt in interface PersonnelSettlementDocumentService

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
public PersCompnElmntCostAssgmtByKeyFluentHelper getPersCompnElmntCostAssgmtByKey(String personnelSettlementDocument,
                                                                                           String controllingArea,
                                                                                           String costCenter)

Description copied from interface: PersonnelSettlementDocumentService

Fetch a single PersCompnElmntCostAssgmt entity using key fields.

Specified by:

getPersCompnElmntCostAssgmtByKey in interface PersonnelSettlementDocumentService

Parameters:

personnelSettlementDocument - Personnel Settlement Document Number

Constraints: Not nullable, Maximum length: 10

controllingArea - Controlling Area

Constraints: Not nullable, Maximum length: 4

costCenter - Cost Center

Constraints: Not nullable, Maximum length: 10

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
public PersonnelCompensationElementFluentHelper getAllPersonnelCompensationElement()

Description copied from interface: PersonnelSettlementDocumentService

Fetch multiple PersonnelCompensationElement entities.

Specified by:

getAllPersonnelCompensationElement in interface PersonnelSettlementDocumentService

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
public PersonnelCompensationElementByKeyFluentHelper getPersonnelCompensationElementByKey(String personnelSettlementDocument)

Description copied from interface: PersonnelSettlementDocumentService

Fetch a single PersonnelCompensationElement entity using key fields.

Specified by:

getPersonnelCompensationElementByKey in interface PersonnelSettlementDocumentService

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.