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

Interface ContractAccountingBusinessPartnerInvoiceService

All Known Implementing Classes:

DefaultContractAccountingBusinessPartnerInvoiceService

public interface ContractAccountingBusinessPartnerInvoiceService

Read invoice items for a business partner and read the corresponding invoice headers with this service. For each invoice you can read correspondence data including the printed document. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_CABUSPARTINVOICE_0001
API Version:	1
Communication Scenario:	Finance - Contract Accounting Open Item Management Integration (SAP_COM_0361)
Scope Items:	Contract Accounting - Open Item Management (2UJ)
Authentication Methods:	Basic, x509
Service Group Name:	API_CABUSPARTINVOICE
Business Object:	ContrAcctgDocContainer

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
BatchRequestBuilder	batch() Creates a batch request builder object.
CountRequestBuilder<BusPartInvoiceParameters>	countBusPartInvoice() Fetch the number of entries from the BusPartInvoiceParameters entity collection matching the filter and search expressions.
CountRequestBuilder<BusPartInvoiceCorrespnc>	countBusPartInvoiceCorrespnc() Fetch the number of entries from the BusPartInvoiceCorrespnc entity collection matching the filter and search expressions.
CountRequestBuilder<BusPartInvoiceItemParameters>	countBusPartInvoiceItem() Fetch the number of entries from the BusPartInvoiceItemParameters entity collection matching the filter and search expressions.
GetAllRequestBuilder<BusPartInvoiceParameters>	getAllBusPartInvoice() Fetch multiple BusPartInvoiceParameters entities.
GetAllRequestBuilder<BusPartInvoiceCorrespnc>	getAllBusPartInvoiceCorrespnc() Fetch multiple BusPartInvoiceCorrespnc entities.
GetAllRequestBuilder<BusPartInvoiceItemParameters>	getAllBusPartInvoiceItem() Fetch multiple BusPartInvoiceItemParameters entities.
GetByKeyRequestBuilder<BusPartInvoiceParameters>	getBusPartInvoiceByKey(String p_DisplayCurrency) Fetch a single BusPartInvoiceParameters entity using key fields.
GetByKeyRequestBuilder<BusPartInvoiceCorrespnc>	getBusPartInvoiceCorrespncByKey(UUID cADocumentContainerUUID, String cACorrespondenceType, String cACorrespondence, String cADocCtnCorrespncSqncNumber) Fetch a single BusPartInvoiceCorrespnc entity using key fields.
GetByKeyRequestBuilder<BusPartInvoiceItemParameters>	getBusPartInvoiceItemByKey(String p_DisplayCurrency) Fetch a single BusPartInvoiceItemParameters entity using key fields.
ContractAccountingBusinessPartnerInvoiceService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

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
ContractAccountingBusinessPartnerInvoiceService 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.

batch

@Nonnull
BatchRequestBuilder batch()

Creates a batch request builder object.

Returns:

A request builder to handle batch operation on this service. To perform execution, call the execute method on the request builder object.

getAllBusPartInvoice

@Nonnull
GetAllRequestBuilder<BusPartInvoiceParameters> getAllBusPartInvoice()

Fetch multiple BusPartInvoiceParameters entities.

Returns:

A request builder to fetch multiple BusPartInvoiceParameters entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

countBusPartInvoice

@Nonnull
CountRequestBuilder<BusPartInvoiceParameters> countBusPartInvoice()

Fetch the number of entries from the BusPartInvoiceParameters entity collection matching the filter and search expressions.

Returns:

A request builder to fetch the count of BusPartInvoiceParameters entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getBusPartInvoiceByKey

@Nonnull
GetByKeyRequestBuilder<BusPartInvoiceParameters> getBusPartInvoiceByKey(@Nonnull
                                                                                 String p_DisplayCurrency)

Fetch a single BusPartInvoiceParameters entity using key fields.

Parameters:

p_DisplayCurrency - Currency Key

Constraints: Not nullable, Maximum length: 5

Returns:

A request builder to fetch a single BusPartInvoiceParameters entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getAllBusPartInvoiceCorrespnc

@Nonnull
GetAllRequestBuilder<BusPartInvoiceCorrespnc> getAllBusPartInvoiceCorrespnc()

Fetch multiple BusPartInvoiceCorrespnc entities.

Returns:

A request builder to fetch multiple BusPartInvoiceCorrespnc entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

countBusPartInvoiceCorrespnc

@Nonnull
CountRequestBuilder<BusPartInvoiceCorrespnc> countBusPartInvoiceCorrespnc()

Fetch the number of entries from the BusPartInvoiceCorrespnc entity collection matching the filter and search expressions.

Returns:

A request builder to fetch the count of BusPartInvoiceCorrespnc entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getBusPartInvoiceCorrespncByKey

@Nonnull
GetByKeyRequestBuilder<BusPartInvoiceCorrespnc> getBusPartInvoiceCorrespncByKey(@Nonnull
                                                                                         UUID cADocumentContainerUUID,
                                                                                         @Nonnull
                                                                                         String cACorrespondenceType,
                                                                                         @Nonnull
                                                                                         String cACorrespondence,
                                                                                         @Nonnull
                                                                                         String cADocCtnCorrespncSqncNumber)

Fetch a single BusPartInvoiceCorrespnc entity using key fields.

Parameters:

cADocumentContainerUUID - Document Container ID

Constraints: Not nullable

cACorrespondenceType - Correspondence Type

Constraints: Not nullable, Maximum length: 4

cACorrespondence - Correspondence key

Constraints: Not nullable, Maximum length: 36

cADocCtnCorrespncSqncNumber - Sequence Number

Constraints: Not nullable, Maximum length: 6

Returns:

A request builder to fetch a single BusPartInvoiceCorrespnc entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getAllBusPartInvoiceItem

@Nonnull
GetAllRequestBuilder<BusPartInvoiceItemParameters> getAllBusPartInvoiceItem()

Fetch multiple BusPartInvoiceItemParameters entities.

Returns:

A request builder to fetch multiple BusPartInvoiceItemParameters entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

countBusPartInvoiceItem

@Nonnull
CountRequestBuilder<BusPartInvoiceItemParameters> countBusPartInvoiceItem()

Fetch the number of entries from the BusPartInvoiceItemParameters entity collection matching the filter and search expressions.

Returns:

A request builder to fetch the count of BusPartInvoiceItemParameters entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getBusPartInvoiceItemByKey

@Nonnull
GetByKeyRequestBuilder<BusPartInvoiceItemParameters> getBusPartInvoiceItemByKey(@Nonnull
                                                                                         String p_DisplayCurrency)

Fetch a single BusPartInvoiceItemParameters entity using key fields.

Parameters:

p_DisplayCurrency - Currency Key

Constraints: Not nullable, Maximum length: 5

Returns:

A request builder to fetch a single BusPartInvoiceItemParameters entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.