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

Interface ServiceEntrySheetService

All Superinterfaces:

BatchService<ServiceEntrySheetServiceBatch>

All Known Implementing Classes:

DefaultServiceEntrySheetService

public interface ServiceEntrySheetService
extends BatchService<ServiceEntrySheetServiceBatch>

This synchronous inbound OData service enables a remote system to read and create service entry sheets from or in the SAP S/4HANA system. You can use this service to submit a service entry sheet for approval, withdraw it from approval, or revoke approval of an already approved service entry sheet.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_SERVICE_ENTRY_SHEET_SRV
API Version:	1
Communication Scenario:	Service Entry Sheet Integration (SAP_COM_0146)
Scope Items:	Procurement of Services (22Z), Consumable Purchasing (BNX), Service and Material Procurement - Project-Based Services (J13)
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
ServiceEntrySheetCreateFluentHelper	createServiceEntrySheet(ServiceEntrySheet serviceEntrySheet) Create a new ServiceEntrySheet entity and save it to the S/4HANA system.
ServiceEntrySheetFluentHelper	getAllServiceEntrySheet() Fetch multiple ServiceEntrySheet entities.
ServiceEntrySheetItemFluentHelper	getAllServiceEntrySheetItem() Fetch multiple ServiceEntrySheetItem entities.
SrvcEntrShtAcctAssignmentFluentHelper	getAllSrvcEntrShtAcctAssignment() Fetch multiple SrvcEntrShtAcctAssignment entities.
ServiceEntrySheetByKeyFluentHelper	getServiceEntrySheetByKey(String serviceEntrySheet) Fetch a single ServiceEntrySheet entity using key fields.
ServiceEntrySheetItemByKeyFluentHelper	getServiceEntrySheetItemByKey(String serviceEntrySheet, String serviceEntrySheetItem) Fetch a single ServiceEntrySheetItem entity using key fields.
SrvcEntrShtAcctAssignmentByKeyFluentHelper	getSrvcEntrShtAcctAssignmentByKey(String serviceEntrySheet, String serviceEntrySheetItem, String accountAssignment) Fetch a single SrvcEntrShtAcctAssignment entity using key fields.
RevokeApprovalFluentHelper	revokeApproval(String postingDate, String serviceEntrySheet) Revoke Approval
SubmitForApprovalFluentHelper	submitForApproval(String serviceEntrySheet) Submit for Approval
ServiceEntrySheetUpdateFluentHelper	updateServiceEntrySheet(ServiceEntrySheet serviceEntrySheet) Update an existing ServiceEntrySheet entity and save it to the S/4HANA system.
ServiceEntrySheetItemUpdateFluentHelper	updateServiceEntrySheetItem(ServiceEntrySheetItem serviceEntrySheetItem) Update an existing ServiceEntrySheetItem entity and save it to the S/4HANA system.
SrvcEntrShtAcctAssignmentUpdateFluentHelper	updateSrvcEntrShtAcctAssignment(SrvcEntrShtAcctAssignment srvcEntrShtAcctAssignment) Update an existing SrvcEntrShtAcctAssignment entity and save it to the S/4HANA system.
WithdrawFromApprovalFluentHelper	withdrawFromApproval(String serviceEntrySheet) Withdraw from Approval
ServiceEntrySheetService	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.s4hana.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
ServiceEntrySheetService 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.

getAllServiceEntrySheet

@Nonnull
ServiceEntrySheetFluentHelper getAllServiceEntrySheet()

Fetch multiple ServiceEntrySheet entities.

Returns:

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

getServiceEntrySheetByKey

@Nonnull
ServiceEntrySheetByKeyFluentHelper getServiceEntrySheetByKey(String serviceEntrySheet)

Fetch a single ServiceEntrySheet entity using key fields.

Parameters:

serviceEntrySheet - Service Entry Sheet

Constraints: Not nullable, Maximum length: 10

Returns:

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

createServiceEntrySheet

@Nonnull
ServiceEntrySheetCreateFluentHelper createServiceEntrySheet(@Nonnull
                                                                     ServiceEntrySheet serviceEntrySheet)

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

Parameters:

serviceEntrySheet - ServiceEntrySheet entity object that will be created in the S/4HANA system.

Returns:

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

updateServiceEntrySheet

@Nonnull
ServiceEntrySheetUpdateFluentHelper updateServiceEntrySheet(@Nonnull
                                                                     ServiceEntrySheet serviceEntrySheet)

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

Parameters:

serviceEntrySheet - ServiceEntrySheet entity object that will be updated in the S/4HANA system.

Returns:

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

getAllServiceEntrySheetItem

@Nonnull
ServiceEntrySheetItemFluentHelper getAllServiceEntrySheetItem()

Fetch multiple ServiceEntrySheetItem entities.

Returns:

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

getServiceEntrySheetItemByKey

@Nonnull
ServiceEntrySheetItemByKeyFluentHelper getServiceEntrySheetItemByKey(String serviceEntrySheet,
                                                                              String serviceEntrySheetItem)

Fetch a single ServiceEntrySheetItem entity using key fields.

Parameters:

serviceEntrySheetItem - Item Number of Service Entry Sheet

Constraints: Not nullable, Maximum length: 5

serviceEntrySheet - Service Entry Sheet

Constraints: Not nullable, Maximum length: 10

Returns:

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

updateServiceEntrySheetItem

@Nonnull
ServiceEntrySheetItemUpdateFluentHelper updateServiceEntrySheetItem(@Nonnull
                                                                             ServiceEntrySheetItem serviceEntrySheetItem)

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

Parameters:

serviceEntrySheetItem - ServiceEntrySheetItem entity object that will be updated in the S/4HANA system.

Returns:

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

getAllSrvcEntrShtAcctAssignment

@Nonnull
SrvcEntrShtAcctAssignmentFluentHelper getAllSrvcEntrShtAcctAssignment()

Fetch multiple SrvcEntrShtAcctAssignment entities.

Returns:

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

getSrvcEntrShtAcctAssignmentByKey

@Nonnull
SrvcEntrShtAcctAssignmentByKeyFluentHelper getSrvcEntrShtAcctAssignmentByKey(String serviceEntrySheet,
                                                                                      String serviceEntrySheetItem,
                                                                                      String accountAssignment)

Fetch a single SrvcEntrShtAcctAssignment entity using key fields.

Parameters:

accountAssignment - Number uniquely defining the account assignment of a purchase document item.

Constraints: Not nullable, Maximum length: 2

serviceEntrySheetItem - Item Number of Service Entry Sheet

Constraints: Not nullable, Maximum length: 5

serviceEntrySheet - Service Entry Sheet

Constraints: Not nullable, Maximum length: 10

Returns:

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

updateSrvcEntrShtAcctAssignment

@Nonnull
SrvcEntrShtAcctAssignmentUpdateFluentHelper updateSrvcEntrShtAcctAssignment(@Nonnull
                                                                                     SrvcEntrShtAcctAssignment srvcEntrShtAcctAssignment)

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

Parameters:

srvcEntrShtAcctAssignment - SrvcEntrShtAcctAssignment entity object that will be updated in the S/4HANA system.

Returns:

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

submitForApproval

@Nonnull
SubmitForApprovalFluentHelper submitForApproval(String serviceEntrySheet)

Submit for Approval

Creates a fluent helper for the SubmitForApproval OData function import.

Parameters:

serviceEntrySheet - Service Entry Sheet

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: ServiceEntrySheet

Returns:

A fluent helper object that will execute the SubmitForApproval OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

revokeApproval

@Nonnull
RevokeApprovalFluentHelper revokeApproval(String postingDate,
                                                   String serviceEntrySheet)

Revoke Approval

Creates a fluent helper for the RevokeApproval OData function import.

Parameters:

serviceEntrySheet - Service Entry Sheet

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: ServiceEntrySheet

postingDate - Posting Date

Constraints: Not nullable, Maximum length: 8

Original parameter name from the Odata EDM: PostingDate

Returns:

A fluent helper object that will execute the RevokeApproval OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

withdrawFromApproval

@Nonnull
WithdrawFromApprovalFluentHelper withdrawFromApproval(String serviceEntrySheet)

Withdraw from Approval

Creates a fluent helper for the WithdrawFromApproval OData function import.

Parameters:

serviceEntrySheet - Service Entry Sheet

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: ServiceEntrySheet

Returns:

A fluent helper object that will execute the WithdrawFromApproval OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.