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

Interface GoldenTaxInterfaceCustomerTypeService

All Superinterfaces:

BatchService<GoldenTaxInterfaceCustomerTypeServiceBatch>

All Known Implementing Classes:

DefaultGoldenTaxInterfaceCustomerTypeService

public interface GoldenTaxInterfaceCustomerTypeService
extends BatchService<GoldenTaxInterfaceCustomerTypeServiceBatch>

This service contains the customer type information for GTI. It is used to update the customer type so that the corresponding invoice types can be issued for customers. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_GTI_UPDATE_CUSTOMER_TYPE_SRV
API Version:	1
Communication Scenario:	Customer Type Integration (SAP_COM_0730)
Scope Items:	Accounts Receivable (J59)
Authentication Methods:	Basic, x509
Business Object:	CN_ValueAddedTaxInvoice

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
GTICustomerFluentHelper	getAllGTICustomer() Fetch multiple GTICustomer entities.
GTICustomerByKeyFluentHelper	getGTICustomerByKey(String customer) Fetch a single GTICustomer entity using key fields.
UpdateGTICustomerFluentHelper	updateGTICustomerType(String customer, String customerType) Creates a fluent helper for the UpdateGTICustomerType OData function import.
GoldenTaxInterfaceCustomerTypeService	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
GoldenTaxInterfaceCustomerTypeService 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.

getAllGTICustomer

@Nonnull
GTICustomerFluentHelper getAllGTICustomer()

Fetch multiple GTICustomer entities.

Returns:

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

getGTICustomerByKey

@Nonnull
GTICustomerByKeyFluentHelper getGTICustomerByKey(String customer)

Fetch a single GTICustomer entity using key fields.

Parameters:

customer - Gives an alphanumeric key, which clearly identifies the customer or vendor in the SAP system.

Constraints: Not nullable, Maximum length: 10

Returns:

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

updateGTICustomerType

@Nonnull
UpdateGTICustomerFluentHelper updateGTICustomerType(@Nonnull
                                                             String customer,
                                                             @Nonnull
                                                             String customerType)

Creates a fluent helper for the UpdateGTICustomerType OData function import.

Parameters:

customerType - Constraints: Not nullable, Maximum length: 1

Original parameter name from the Odata EDM: CustomerType

customer - Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: Customer

Returns:

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