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

Interface BankReconciliationStatementService

All Superinterfaces:

BatchService<BankReconciliationStatementServiceBatch>

All Known Implementing Classes:

DefaultBankReconciliationStatementService

public interface BankReconciliationStatementService
extends BatchService<BankReconciliationStatementServiceBatch>

The service contains bank reconciliation items, bank reconciliation statements, journal entry items and bank statement items. The bank reconciliation items provide the G/L account balance, bank account balance and reconciliation status of all house bank accounts. The “StartReconcile” operation can start automatic reconciliation and generate bank reconciliation statement in the backend. If there are any issues when the bank reconciliation statement is created, the system displays error messages in the response. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_CN_BANK_RECONCILIAITON_SRV
API Version:	1
Communication Scenario:	Finance - Bank Reconciliation Integration (SAP_COM_0388)
Scope Items:	Bank Integration with File Interface (1EG)
Authentication Methods:	Basic, x509
Business Object:	BankAccount

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
BankReconciliationItemFluentHelper	getAllBankReconciliationItem() Fetch multiple BankReconciliationItem entities.
BankReconciliationStatementFluentHelper	getAllBankReconciliationStatement() Fetch multiple BankReconciliationStatement entities.
BankStatementItemFluentHelper	getAllBankStatementItem() Fetch multiple BankStatementItem entities.
JournalEntryItemFluentHelper	getAllJournalEntryItem() Fetch multiple JournalEntryItem entities.
BankReconciliationItemByKeyFluentHelper	getBankReconciliationItemByKey(String companyCode, String houseBank, String houseBankAccount, LocalDateTime bankReconciliationDate) Fetch a single BankReconciliationItem entity using key fields.
BankReconciliationStatementByKeyFluentHelper	getBankReconciliationStatementByKey(String companyCode, String houseBank, String houseBankAccount, LocalDateTime bankReconciliationDate) Fetch a single BankReconciliationStatement entity using key fields.
BankStatementItemByKeyFluentHelper	getBankStatementItemByKey(String companyCode, String houseBank, String houseBankAccount, LocalDateTime bankReconciliationDate, String bankStatementShortID, String bankStatementItem) Fetch a single BankStatementItem entity using key fields.
JournalEntryItemByKeyFluentHelper	getJournalEntryItemByKey(String companyCode, String houseBank, String houseBankAccount, LocalDateTime bankReconciliationDate, String fiscalYear, String accountingDocument, String accountingDocumentItem) Fetch a single JournalEntryItem entity using key fields.
StartReconcileFluentHelper	startReconcile(String companyCode, String houseBank, String houseBankAccount, LocalDateTime bankReconciliationDate) Creates a fluent helper for the StartReconcile OData function import.
BankReconciliationStatementService	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
BankReconciliationStatementService 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.

getAllBankStatementItem

@Nonnull
BankStatementItemFluentHelper getAllBankStatementItem()

Fetch multiple BankStatementItem entities.

Returns:

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

getBankStatementItemByKey

@Nonnull
BankStatementItemByKeyFluentHelper getBankStatementItemByKey(String companyCode,
                                                                      String houseBank,
                                                                      String houseBankAccount,
                                                                      LocalDateTime bankReconciliationDate,
                                                                      String bankStatementShortID,
                                                                      String bankStatementItem)

Fetch a single BankStatementItem entity using key fields.

Parameters:

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

Constraints: Not nullable, Maximum length: 4

houseBankAccount - This ID together with the ID for the house bank uniquely defines a bank account.

Constraints: Not nullable, Maximum length: 5

bankReconciliationDate - Reconciliation Date

Constraints: Not nullable, Precision: 0

bankStatementShortID - Short Key (Surrogate)

Constraints: Not nullable, Maximum length: 8

houseBank - All bank data is determined using this key.

Constraints: Not nullable, Maximum length: 5

bankStatementItem - Memo Record Number (Line Item Number in Bank Statement)

Constraints: Not nullable, Maximum length: 5

Returns:

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

getAllBankReconciliationItem

@Nonnull
BankReconciliationItemFluentHelper getAllBankReconciliationItem()

Fetch multiple BankReconciliationItem entities.

Returns:

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

getBankReconciliationItemByKey

@Nonnull
BankReconciliationItemByKeyFluentHelper getBankReconciliationItemByKey(String companyCode,
                                                                                String houseBank,
                                                                                String houseBankAccount,
                                                                                LocalDateTime bankReconciliationDate)

Fetch a single BankReconciliationItem entity using key fields.

Parameters:

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

Constraints: Not nullable, Maximum length: 4

houseBankAccount - This ID together with the ID for the house bank uniquely defines a bank account.

Constraints: Not nullable, Maximum length: 5

bankReconciliationDate - Reconciliation Date

Constraints: Not nullable, Precision: 0

houseBank - All bank data is determined using this key.

Constraints: Not nullable, Maximum length: 5

Returns:

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

getAllBankReconciliationStatement

@Nonnull
BankReconciliationStatementFluentHelper getAllBankReconciliationStatement()

Fetch multiple BankReconciliationStatement entities.

Returns:

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

getBankReconciliationStatementByKey

@Nonnull
BankReconciliationStatementByKeyFluentHelper getBankReconciliationStatementByKey(String companyCode,
                                                                                          String houseBank,
                                                                                          String houseBankAccount,
                                                                                          LocalDateTime bankReconciliationDate)

Fetch a single BankReconciliationStatement entity using key fields.

Parameters:

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

Constraints: Not nullable, Maximum length: 4

houseBankAccount - This ID together with the ID for the house bank uniquely defines a bank account.

Constraints: Not nullable, Maximum length: 5

bankReconciliationDate - Reconciliation Date

Constraints: Not nullable, Precision: 0

houseBank - All bank data is determined using this key.

Constraints: Not nullable, Maximum length: 5

Returns:

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

getAllJournalEntryItem

@Nonnull
JournalEntryItemFluentHelper getAllJournalEntryItem()

Fetch multiple JournalEntryItem entities.

Returns:

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

getJournalEntryItemByKey

@Nonnull
JournalEntryItemByKeyFluentHelper getJournalEntryItemByKey(String companyCode,
                                                                    String houseBank,
                                                                    String houseBankAccount,
                                                                    LocalDateTime bankReconciliationDate,
                                                                    String fiscalYear,
                                                                    String accountingDocument,
                                                                    String accountingDocumentItem)

Fetch a single JournalEntryItem entity using key fields.

Parameters:

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

Constraints: Not nullable, Maximum length: 4

houseBankAccount - This ID together with the ID for the house bank uniquely defines a bank account.

Constraints: Not nullable, Maximum length: 5

bankReconciliationDate - Reconciliation Date

Constraints: Not nullable, Precision: 0

accountingDocumentItem - All the items in an accounting document contain a number by which they may be uniquely identified. The system assigns the numbers continuously during document entry.

Constraints: Not nullable, Maximum length: 6

houseBank - All bank data is determined using this key.

Constraints: Not nullable, Maximum length: 5

accountingDocument - The document number is the key the system uses to access the accounting document.

Constraints: Not nullable, Maximum length: 10

fiscalYear - Period, 12 months as a rule, for which the company is to create its inventory and balance sheet. The fiscal year can be the same as the calendar year, but does not have to be.

Constraints: Not nullable, Maximum length: 4

Returns:

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

startReconcile

@Nonnull
StartReconcileFluentHelper startReconcile(@Nonnull
                                                   String companyCode,
                                                   @Nonnull
                                                   String houseBank,
                                                   @Nonnull
                                                   String houseBankAccount,
                                                   @Nonnull
                                                   LocalDateTime bankReconciliationDate)

Creates a fluent helper for the StartReconcile OData function import.

Parameters:

companyCode - Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: CompanyCode

houseBankAccount - Constraints: Not nullable, Maximum length: 5

Original parameter name from the Odata EDM: HouseBankAccount

bankReconciliationDate - Time Stamp

Constraints: Not nullable, Precision: 0

Original parameter name from the Odata EDM: BankReconciliationDate

houseBank - Constraints: Not nullable, Maximum length: 5

Original parameter name from the Odata EDM: HouseBank

Returns:

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