Class DefaultPersonnelSettlementDocumentService
- All Implemented Interfaces:
BatchService<PersonnelSettlementDocumentServiceBatch>,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.
Reference: SAP Business Accelerator Hub
Details:
| OData Service: | API_PERS_SETTLMT_DOC |
| API Version: | 1.0.1 |
| Minimum ERP Version: | 2302 |
| Communication Scenario: | Logistics - Employee Central Personnel Settlement Document Integration(SAP_COM_0469) |
| Scope Items: | Internal Commissions Settlement with SAP Sales Cloud(3TD) |
| Authentication Methods: | x509 |
| Business Object: | Personnel Settlement Document |
-
Field Summary
Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.PersonnelSettlementDocumentService
DEFAULT_SERVICE_PATH -
Constructor Summary
ConstructorsConstructorDescriptionDeprecated.Creates a service usingPersonnelSettlementDocumentService.DEFAULT_SERVICE_PATHto send the requests. -
Method Summary
Modifier and TypeMethodDescriptionbatch()Deprecated.Deprecated.Fetch multiplePersCompnElmntCostAssgmtentities.Deprecated.Fetch multiplePersonnelCompensationElemententities.getPersCompnElmntCostAssgmtByKey(String personnelSettlementDocument, String controllingArea, String costCenter) Deprecated.Fetch a singlePersCompnElmntCostAssgmtentity using key fields.getPersonnelCompensationElementByKey(String personnelSettlementDocument) Deprecated.Fetch a singlePersonnelCompensationElemententity using key fields.withServicePath(String servicePath) Deprecated.Overrides the default service path and returns a new service instance with the specified service path.
-
Constructor Details
-
DefaultPersonnelSettlementDocumentService
public DefaultPersonnelSettlementDocumentService()Deprecated.Creates a service usingPersonnelSettlementDocumentService.DEFAULT_SERVICE_PATHto send the requests.
-
-
Method Details
-
withServicePath
@Nonnull public DefaultPersonnelSettlementDocumentService withServicePath(@Nonnull String servicePath) Deprecated.Description copied from interface:PersonnelSettlementDocumentServiceOverrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.- Specified by:
withServicePathin interfacePersonnelSettlementDocumentService- 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<PersonnelSettlementDocumentServiceBatch>
-
getAllPersCompnElmntCostAssgmt
Deprecated.Description copied from interface:PersonnelSettlementDocumentServiceFetch multiplePersCompnElmntCostAssgmtentities.- Specified by:
getAllPersCompnElmntCostAssgmtin interfacePersonnelSettlementDocumentService- Returns:
- A fluent helper to fetch multiple
PersCompnElmntCostAssgmtentities. 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.
-
getPersCompnElmntCostAssgmtByKey
@Nonnull public PersCompnElmntCostAssgmtByKeyFluentHelper getPersCompnElmntCostAssgmtByKey(String personnelSettlementDocument, String controllingArea, String costCenter) Deprecated.Description copied from interface:PersonnelSettlementDocumentServiceFetch a singlePersCompnElmntCostAssgmtentity using key fields.- Specified by:
getPersCompnElmntCostAssgmtByKeyin interfacePersonnelSettlementDocumentService- Parameters:
personnelSettlementDocument- Personnel Settlement Document NumberConstraints: Not nullable, Maximum length: 10
controllingArea- Controlling AreaConstraints: Not nullable, Maximum length: 4
costCenter- Cost CenterConstraints: Not nullable, Maximum length: 10
- Returns:
- A fluent helper to fetch a single
PersCompnElmntCostAssgmtentity 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.
-
getAllPersonnelCompensationElement
Deprecated.Description copied from interface:PersonnelSettlementDocumentServiceFetch multiplePersonnelCompensationElemententities.- Specified by:
getAllPersonnelCompensationElementin interfacePersonnelSettlementDocumentService- Returns:
- A fluent helper to fetch multiple
PersonnelCompensationElemententities. 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.
-
getPersonnelCompensationElementByKey
@Nonnull public PersonnelCompensationElementByKeyFluentHelper getPersonnelCompensationElementByKey(String personnelSettlementDocument) Deprecated.Description copied from interface:PersonnelSettlementDocumentServiceFetch a singlePersonnelCompensationElemententity using key fields.- Specified by:
getPersonnelCompensationElementByKeyin interfacePersonnelSettlementDocumentService- Parameters:
personnelSettlementDocument- Personnel Settlement Document NumberConstraints: Not nullable, Maximum length: 10
- Returns:
- A fluent helper to fetch a single
PersonnelCompensationElemententity 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.
-