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

Interface WorkforceTimesheetService

All Superinterfaces:

BatchService<WorkforceTimesheetServiceBatch>

All Known Implementing Classes:

DefaultWorkforceTimesheetService

public interface WorkforceTimesheetService
extends BatchService<WorkforceTimesheetServiceBatch>

This service enables you to create, read, update, and delete (CRUD) data related to timesheet of a workforce (Employees or Contingent Workers) with the data provided in a payload, in an API call. This service also supports automatic posting of timesheet data to the controlling module synchronously.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_MANAGE_WORKFORCE_TIMESHEET
API Version:	1
Communication Scenario:	Workforce Timesheet Integration (SAP_COM_0027)
Scope Items:	Time Recording (1Q4), Time Recording - Project-Based Services (J12)
Authentication Methods:	Basic, x509

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
TimeSheetEntryCreateFluentHelper	createTimeSheetEntry(TimeSheetEntry timeSheetEntry) Create a new TimeSheetEntry entity and save it to the S/4HANA system.
TimeSheetEntryFluentHelper	getAllTimeSheetEntry() Fetch multiple TimeSheetEntry entities.
TimeSheetEntryByKeyFluentHelper	getTimeSheetEntryByKey(String personWorkAgreementExternalID, String companyCode, String timeSheetRecord) Fetch a single TimeSheetEntry entity using key fields.
WorkforceTimesheetService	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
WorkforceTimesheetService 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.

getAllTimeSheetEntry

@Nonnull
TimeSheetEntryFluentHelper getAllTimeSheetEntry()

Fetch multiple TimeSheetEntry entities.

Returns:

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

getTimeSheetEntryByKey

@Nonnull
TimeSheetEntryByKeyFluentHelper getTimeSheetEntryByKey(String personWorkAgreementExternalID,
                                                                String companyCode,
                                                                String timeSheetRecord)

Fetch a single TimeSheetEntry entity using key fields.

Parameters:

personWorkAgreementExternalID - Work Agreement External ID

Constraints: Not nullable, Maximum length: 20

companyCode - The company code is an organizational unit within financial accounting.

Constraints: Not nullable, Maximum length: 4

timeSheetRecord - The system assigns time sheet records a counter. The counter represents a record's unique database ID.

Constraints: Not nullable, Maximum length: 12

Returns:

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

createTimeSheetEntry

@Nonnull
TimeSheetEntryCreateFluentHelper createTimeSheetEntry(@Nonnull
                                                               TimeSheetEntry timeSheetEntry)

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

Parameters:

timeSheetEntry - TimeSheetEntry entity object that will be created in the S/4HANA system.

Returns:

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