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

Interface ContractAccountingDocumentManageService

All Known Implementing Classes:

DefaultContractAccountingDocumentManageService

public interface ContractAccountingDocumentManageService

Retrieve a list of documents. Read data on document header, document business partner line items and document general ledger line items. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	CADOCUMENTMANAGE_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_CADOCUMENTMANAGE
Business Object:	ContrAcctgDocument

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<BPItemLogical>	countBPItemLogical() Fetch the number of entries from the BPItemLogical entity collection matching the filter and search expressions.
CountRequestBuilder<BPItemPaytData>	countBPItemPaytData() Fetch the number of entries from the BPItemPaytData entity collection matching the filter and search expressions.
CountRequestBuilder<DocumentHeader>	countDocumentHeader() Fetch the number of entries from the DocumentHeader entity collection matching the filter and search expressions.
CountRequestBuilder<GLItem>	countGLItem() Fetch the number of entries from the GLItem entity collection matching the filter and search expressions.
CountRequestBuilder<GLItemPaytData>	countGLItemPaytData() Fetch the number of entries from the GLItemPaytData entity collection matching the filter and search expressions.
GetAllRequestBuilder<BPItemLogical>	getAllBPItemLogical() Fetch multiple BPItemLogical entities.
GetAllRequestBuilder<BPItemPaytData>	getAllBPItemPaytData() Fetch multiple BPItemPaytData entities.
GetAllRequestBuilder<DocumentHeader>	getAllDocumentHeader() Fetch multiple DocumentHeader entities.
GetAllRequestBuilder<GLItem>	getAllGLItem() Fetch multiple GLItem entities.
GetAllRequestBuilder<GLItemPaytData>	getAllGLItemPaytData() Fetch multiple GLItemPaytData entities.
GetByKeyRequestBuilder<BPItemLogical>	getBPItemLogicalByKey(String cADocumentNumber, String cARepetitionItemNumber, String cABPItemNumber, String cASubItemNumber) Fetch a single BPItemLogical entity using key fields.
GetByKeyRequestBuilder<BPItemPaytData>	getBPItemPaytDataByKey(String cADocumentNumber, String cAGroupingForPayment) Fetch a single BPItemPaytData entity using key fields.
GetByKeyRequestBuilder<DocumentHeader>	getDocumentHeaderByKey(String cADocumentNumber) Fetch a single DocumentHeader entity using key fields.
GetByKeyRequestBuilder<GLItem>	getGLItemByKey(String cADocumentNumber, String cAGLItemNumber) Fetch a single GLItem entity using key fields.
GetByKeyRequestBuilder<GLItemPaytData>	getGLItemPaytDataByKey(String cADocumentNumber, String cAGLItemNumber) Fetch a single GLItemPaytData entity using key fields.
ContractAccountingDocumentManageService	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
ContractAccountingDocumentManageService 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.

getAllBPItemLogical

@Nonnull
GetAllRequestBuilder<BPItemLogical> getAllBPItemLogical()

Fetch multiple BPItemLogical entities.

Returns:

A request builder to fetch multiple BPItemLogical 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.

countBPItemLogical

@Nonnull
CountRequestBuilder<BPItemLogical> countBPItemLogical()

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

Returns:

A request builder to fetch the count of BPItemLogical 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.

getBPItemLogicalByKey

@Nonnull
GetByKeyRequestBuilder<BPItemLogical> getBPItemLogicalByKey(@Nonnull
                                                                     String cADocumentNumber,
                                                                     @Nonnull
                                                                     String cARepetitionItemNumber,
                                                                     @Nonnull
                                                                     String cABPItemNumber,
                                                                     @Nonnull
                                                                     String cASubItemNumber)

Fetch a single BPItemLogical entity using key fields.

Parameters:

cADocumentNumber - Number of a FI-CA Document

Constraints: Not nullable, Maximum length: 12

cABPItemNumber - Item Number in FI-CA Document

Constraints: Not nullable, Maximum length: 4

cARepetitionItemNumber - Repetition Item in FI-CA Document

Constraints: Not nullable, Maximum length: 3

cASubItemNumber - Subitem for a Partial Clearing in Document

Constraints: Not nullable, Maximum length: 3

Returns:

A request builder to fetch a single BPItemLogical 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.

getAllBPItemPaytData

@Nonnull
GetAllRequestBuilder<BPItemPaytData> getAllBPItemPaytData()

Fetch multiple BPItemPaytData entities.

Returns:

A request builder to fetch multiple BPItemPaytData 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.

countBPItemPaytData

@Nonnull
CountRequestBuilder<BPItemPaytData> countBPItemPaytData()

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

Returns:

A request builder to fetch the count of BPItemPaytData 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.

getBPItemPaytDataByKey

@Nonnull
GetByKeyRequestBuilder<BPItemPaytData> getBPItemPaytDataByKey(@Nonnull
                                                                       String cADocumentNumber,
                                                                       @Nonnull
                                                                       String cAGroupingForPayment)

Fetch a single BPItemPaytData entity using key fields.

Parameters:

cADocumentNumber - Number of a FI-CA Document

Constraints: Not nullable, Maximum length: 12

cAGroupingForPayment - Grouping field for automatic payments

Constraints: Not nullable, Maximum length: 10

Returns:

A request builder to fetch a single BPItemPaytData 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.

getAllDocumentHeader

@Nonnull
GetAllRequestBuilder<DocumentHeader> getAllDocumentHeader()

Fetch multiple DocumentHeader entities.

Returns:

A request builder to fetch multiple DocumentHeader 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.

countDocumentHeader

@Nonnull
CountRequestBuilder<DocumentHeader> countDocumentHeader()

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

Returns:

A request builder to fetch the count of DocumentHeader 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.

getDocumentHeaderByKey

@Nonnull
GetByKeyRequestBuilder<DocumentHeader> getDocumentHeaderByKey(@Nonnull
                                                                       String cADocumentNumber)

Fetch a single DocumentHeader entity using key fields.

Parameters:

cADocumentNumber - Document

Constraints: Not nullable, Maximum length: 12

Returns:

A request builder to fetch a single DocumentHeader 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.

getAllGLItem

@Nonnull
GetAllRequestBuilder<GLItem> getAllGLItem()

Fetch multiple GLItem entities.

Returns:

A request builder to fetch multiple GLItem 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.

countGLItem

@Nonnull
CountRequestBuilder<GLItem> countGLItem()

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

Returns:

A request builder to fetch the count of GLItem 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.

getGLItemByKey

@Nonnull
GetByKeyRequestBuilder<GLItem> getGLItemByKey(@Nonnull
                                                       String cADocumentNumber,
                                                       @Nonnull
                                                       String cAGLItemNumber)

Fetch a single GLItem entity using key fields.

Parameters:

cADocumentNumber - Number of a FI-CA Document

Constraints: Not nullable, Maximum length: 12

cAGLItemNumber - Item Number in FI-CA Document

Constraints: Not nullable, Maximum length: 4

Returns:

A request builder to fetch a single GLItem 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.

getAllGLItemPaytData

@Nonnull
GetAllRequestBuilder<GLItemPaytData> getAllGLItemPaytData()

Fetch multiple GLItemPaytData entities.

Returns:

A request builder to fetch multiple GLItemPaytData 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.

countGLItemPaytData

@Nonnull
CountRequestBuilder<GLItemPaytData> countGLItemPaytData()

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

Returns:

A request builder to fetch the count of GLItemPaytData 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.

getGLItemPaytDataByKey

@Nonnull
GetByKeyRequestBuilder<GLItemPaytData> getGLItemPaytDataByKey(@Nonnull
                                                                       String cADocumentNumber,
                                                                       @Nonnull
                                                                       String cAGLItemNumber)

Fetch a single GLItemPaytData entity using key fields.

Parameters:

cADocumentNumber - Number of a FI-CA Document

Constraints: Not nullable, Maximum length: 12

cAGLItemNumber - Item Number in FI-CA Document

Constraints: Not nullable, Maximum length: 4

Returns:

A request builder to fetch a single GLItemPaytData 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.