Package org.apache.fineract.client.util

Class FineractClient

java.lang.Object

org.apache.fineract.client.util.FineractClient

public final class FineractClient
extends Object

Fineract Client Java SDK API entry point.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FineractClient.Builder

Field Summary

Fields

Modifier and Type	Field	Description
final AccountingRulesApi	accountingRules
final AccountNumberFormatApi	accountNumberFormats
final AccountTransfersApi	accountTransfers
final AdhocQueryApiApi	adhocQuery
final AuditsApi	audits
final AuthenticationHttpBasicApi	authentication
final BatchApiApi	batches
final BusinessDateManagementApi	businessDateManagement
final BusinessStepConfigurationApi	businessStepConfiguration
final CacheApi	caches
final CashiersApi	cashiers
final CashierJournalsApi	cashiersJournal
final CentersApi	centers
final ChargesApi	charges
final ClientsAddressApi	clientAddresses
final ClientChargesApi	clientCharges
final ClientIdentifierApi	clientIdentifiers
final ClientApi	clients
final ClientSearchV2Api	clientSearchV2
final ClientTransactionApi	clientTransactions
final CodesApi	codes
final CodeValuesApi	codeValues
final CurrencyApi	currencies
final DataTablesApi	dataTables
static final String	DATE_FORMAT	Constant to be used in requests where Fineract's API requires a dateFormat to be given.
final DelinquencyRangeAndBucketsManagementApi	delinquencyRangeAndBucketsManagement
final DocumentsApiFixed	documents
final EntityDataTableApi	entityDatatableChecks
final EntityFieldConfigurationApi	entityFieldConfigurations
final ExternalAssetOwnerLoanProductAttributesApi	externalAssetOwnerLoanProductAttributes
final ExternalAssetOwnersApi	externalAssetOwners
final ExternalEventConfigurationApi	externalEventConfigurationApi
final ExternalServicesApi	externalServices
final MappingFinancialActivitiesToAccountsApi	financialActivyAccountMappings
final FixedDepositAccountApi	fixedDepositAccounts
final FixedDepositProductApi	fixedDepositProducts
final FloatingRatesApi	floatingRates
final GeneralLedgerAccountApi	glAccounts
final AccountingClosureApi	glClosures
final GlobalConfigurationApi	globalConfigurations
final GroupsApi	groups
final HolidaysApi	holidays
final HooksApi	hooks
final ImagesApi	images
final InlineJobApi	inlineJobApi
final InterestRateSlabAKAInterestBandsApi	interestRateChartLabs
final InterestRateChartApi	interestRateCharts
final InternalCobApi	internalCob
final SchedulerJobApi	jobs
final SchedulerApi	jobsScheduler
final JournalEntriesApi	journalEntries
final DefaultApi	legacy	Deprecated.
final LoanAccountLockApi	loanAccountLockApi
final LoanBuyDownFeesApi	loanBuyDownFeesApi
final LoanCapitalizedIncomeApi	loanCapitalizedIncome
final LoanChargesApi	loanCharges
final LoanCobCatchUpApi	loanCobCatchUpApi
final LoanCollateralApi	loanCollaterals
final LoanDisbursementDetailsApi	loanDisbursementDetails
final LoanInterestPauseApi	loanInterestPauseApi
final LoanProductsApi	loanProducts
final LoansApi	loans
final LoanReschedulingApi	loanSchedules
final LoansPointInTimeApi	loansPointInTimeApi
final LoanTransactionsApi	loanTransactions
final MakerCheckerOr4EyeFunctionalityApi	makerCheckers
final MixMappingApi	mixMappings
final MixReportApi	mixReports
final MixTaxonomyApi	mixTaxonomies
final NotesApi	notes
final NotificationApi	notifications
final OfficesApi	offices
final PasswordPreferencesApi	passwordPreferences
final PaymentTypeApi	paymentTypes
final PeriodicAccrualAccountingApi	periodicAccrualAccounting
final PermissionsApi	permissions
final ProgressiveLoanApi	progressiveLoanApi
final ProvisioningCategoryApi	provisioningCategories
final ProvisioningCriteriaApi	provisioningCriterias
final ProvisioningEntriesApi	provisioningEntries
final RecurringDepositAccountApi	recurringDepositAccounts
final RecurringDepositAccountTransactionsApi	recurringDepositAccountTransactions
final RecurringDepositProductApi	recurringDepositProducts
final ReportMailingJobsApi	reportMailingJobs
final ListReportMailingJobHistoryApi	reportMailings
final ReportsApi	reports
final RunReportsApi	reportsRun
final RescheduleLoansApi	rescheduleLoans
final RolesApi	roles
final SavingsChargesApi	savingsAccountCharges
final SavingsAccountApi	savingsAccounts
final SavingsProductApi	savingsProducts
final SavingsAccountTransactionsApi	savingsTransactions
final SearchApiApi	search
final SelfAccountTransferApi	selfAccountTransfers
final SelfAuthenticationApi	selfAuthentication
final SelfClientApi	selfClients
final SelfLoanProductsApi	selfLoanProducts
final SelfLoansApi	selfLoans
final PocketApi	selfPockets
final SelfServiceRegistrationApi	selfRegistration
final SelfRunReportApi	selfReportsRun
final SelfSavingsAccountApi	selfSavingsAccounts
final SelfShareAccountsApi	selfShareAccounts
final SelfDividendApi	selfShareProducts
final SelfSpmApi	selfSurveys
final SelfScoreCardApi	selfSurveyScorecards
final SelfThirdPartyTransferApi	selfThirdPartyBeneficiaries
final SelfUserApi	selfUser
final SelfUserDetailsApi	selfUserDetails
final ShareAccountApi	shareAccounts
final StaffApi	staff
final StandingInstructionsApi	standingInstructions
final StandingInstructionsHistoryApi	standingInstructionsHistory
final SpmApiLookUpTableApi	surveyLookupTables
final SpmSurveysApi	surveys
final ScoreCardApi	surveyScorecards
final TaxComponentsApi	taxComponents
final TaxGroupApi	taxGroups
final TellerCashManagementApi	tellers
final UserGeneratedDocumentsApi	templates
final FetchAuthenticatedUserDetailsApi	userDetails
final UsersApi	users
final WorkingDaysApi	workingDays

Method Summary

Modifier and Type	Method	Description
okhttp3.HttpUrl	baseURL()
static FineractClient.Builder	builder()
<S> S	createService(Class<S> serviceClass)	Create an implementation of the API endpoints defined by the service interface, using Retrofit.create(Class).
okhttp3.OkHttpClient	okHttpClient()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DATE_FORMAT

public static final String DATE_FORMAT

Constant to be used in requests where Fineract's API requires a dateFormat to be given. This matches the format in which LocalDate instances are serialized. (BTW: In a Java client API, it seems weird to have strong LocalDate (not String) instances, and then have to specify its format, see https://issues.apache.org/jira/browse/FINERACT-1233.)

See Also:

• Constant Field Values

glClosures

public final AccountingClosureApi glClosures

accountingRules

public final AccountingRulesApi accountingRules

accountNumberFormats

public final AccountNumberFormatApi accountNumberFormats

accountTransfers

public final AccountTransfersApi accountTransfers

adhocQuery

public final AdhocQueryApiApi adhocQuery

audits

public final AuditsApi audits

authentication

public final AuthenticationHttpBasicApi authentication

batches

public final BatchApiApi batches

businessDateManagement

public final BusinessDateManagementApi businessDateManagement

businessStepConfiguration

public final BusinessStepConfigurationApi businessStepConfiguration

caches

public final CacheApi caches

cashiersJournal

public final CashierJournalsApi cashiersJournal

cashiers

public final CashiersApi cashiers

centers

public final CentersApi centers

charges

public final ChargesApi charges

clients

public final ClientApi clients

clientSearchV2

public final ClientSearchV2Api clientSearchV2

clientCharges

public final ClientChargesApi clientCharges

clientIdentifiers

public final ClientIdentifierApi clientIdentifiers

clientAddresses

public final ClientsAddressApi clientAddresses

clientTransactions

public final ClientTransactionApi clientTransactions

codes

public final CodesApi codes

codeValues

public final CodeValuesApi codeValues

currencies

public final CurrencyApi currencies

dataTables

public final DataTablesApi dataTables

legacy

@Deprecated
public final DefaultApi legacy

Deprecated.

documents

public final DocumentsApiFixed documents

delinquencyRangeAndBucketsManagement

public final DelinquencyRangeAndBucketsManagementApi delinquencyRangeAndBucketsManagement

entityDatatableChecks

public final EntityDataTableApi entityDatatableChecks

entityFieldConfigurations

public final EntityFieldConfigurationApi entityFieldConfigurations

externalEventConfigurationApi

public final ExternalEventConfigurationApi externalEventConfigurationApi

externalServices

public final ExternalServicesApi externalServices

userDetails

public final FetchAuthenticatedUserDetailsApi userDetails

fixedDepositAccounts

public final FixedDepositAccountApi fixedDepositAccounts

fixedDepositProducts

public final FixedDepositProductApi fixedDepositProducts

floatingRates

public final FloatingRatesApi floatingRates

glAccounts

public final GeneralLedgerAccountApi glAccounts

globalConfigurations

public final GlobalConfigurationApi globalConfigurations

groups

public final GroupsApi groups

holidays

public final HolidaysApi holidays

hooks

public final HooksApi hooks

images

public final ImagesApi images

internalCob

public final InternalCobApi internalCob

interestRateCharts

public final InterestRateChartApi interestRateCharts

interestRateChartLabs

public final InterestRateSlabAKAInterestBandsApi interestRateChartLabs

journalEntries

public final JournalEntriesApi journalEntries

reportMailings

public final ListReportMailingJobHistoryApi reportMailings

loanCharges

public final LoanChargesApi loanCharges

loanCobCatchUpApi

public final LoanCobCatchUpApi loanCobCatchUpApi

loanCollaterals

public final LoanCollateralApi loanCollaterals

loanCapitalizedIncome

public final LoanCapitalizedIncomeApi loanCapitalizedIncome

loanProducts

public final LoanProductsApi loanProducts

loanSchedules

public final LoanReschedulingApi loanSchedules

loansPointInTimeApi

public final LoansPointInTimeApi loansPointInTimeApi

loans

public final LoansApi loans

loanDisbursementDetails

public final LoanDisbursementDetailsApi loanDisbursementDetails

loanTransactions

public final LoanTransactionsApi loanTransactions

makerCheckers

public final MakerCheckerOr4EyeFunctionalityApi makerCheckers

financialActivyAccountMappings

public final MappingFinancialActivitiesToAccountsApi financialActivyAccountMappings

mixMappings

public final MixMappingApi mixMappings

mixReports

public final MixReportApi mixReports

mixTaxonomies

public final MixTaxonomyApi mixTaxonomies

notes

public final NotesApi notes

notifications

public final NotificationApi notifications

offices

public final OfficesApi offices

passwordPreferences

public final PasswordPreferencesApi passwordPreferences

paymentTypes

public final PaymentTypeApi paymentTypes

periodicAccrualAccounting

public final PeriodicAccrualAccountingApi periodicAccrualAccounting

permissions

public final PermissionsApi permissions

selfPockets

public final PocketApi selfPockets

provisioningCategories

public final ProvisioningCategoryApi provisioningCategories

provisioningCriterias

public final ProvisioningCriteriaApi provisioningCriterias

provisioningEntries

public final ProvisioningEntriesApi provisioningEntries

recurringDepositAccounts

public final RecurringDepositAccountApi recurringDepositAccounts

recurringDepositAccountTransactions

public final RecurringDepositAccountTransactionsApi recurringDepositAccountTransactions

recurringDepositProducts

public final RecurringDepositProductApi recurringDepositProducts

reportMailingJobs

public final ReportMailingJobsApi reportMailingJobs

reports

public final ReportsApi reports

rescheduleLoans

public final RescheduleLoansApi rescheduleLoans

roles

public final RolesApi roles

reportsRun

public final RunReportsApi reportsRun

savingsAccounts

public final SavingsAccountApi savingsAccounts

savingsAccountCharges

public final SavingsChargesApi savingsAccountCharges

savingsProducts

public final SavingsProductApi savingsProducts

savingsTransactions

public final SavingsAccountTransactionsApi savingsTransactions

jobsScheduler

public final SchedulerApi jobsScheduler

jobs

public final SchedulerJobApi jobs

surveyScorecards

public final ScoreCardApi surveyScorecards

search

public final SearchApiApi search

selfAccountTransfers

public final SelfAccountTransferApi selfAccountTransfers

selfAuthentication

public final SelfAuthenticationApi selfAuthentication

selfClients

public final SelfClientApi selfClients

selfShareProducts

public final SelfDividendApi selfShareProducts

selfLoanProducts

public final SelfLoanProductsApi selfLoanProducts

selfLoans

public final SelfLoansApi selfLoans

selfReportsRun

public final SelfRunReportApi selfReportsRun

selfSavingsAccounts

public final SelfSavingsAccountApi selfSavingsAccounts

selfSurveyScorecards

public final SelfScoreCardApi selfSurveyScorecards

selfRegistration

public final SelfServiceRegistrationApi selfRegistration

selfShareAccounts

public final SelfShareAccountsApi selfShareAccounts

selfSurveys

public final SelfSpmApi selfSurveys

selfThirdPartyBeneficiaries

public final SelfThirdPartyTransferApi selfThirdPartyBeneficiaries

selfUser

public final SelfUserApi selfUser

selfUserDetails

public final SelfUserDetailsApi selfUserDetails

shareAccounts

public final ShareAccountApi shareAccounts

surveyLookupTables

public final SpmApiLookUpTableApi surveyLookupTables

surveys

public final SpmSurveysApi surveys

staff

public final StaffApi staff

standingInstructions

public final StandingInstructionsApi standingInstructions

standingInstructionsHistory

public final StandingInstructionsHistoryApi standingInstructionsHistory

taxComponents

public final TaxComponentsApi taxComponents

taxGroups

public final TaxGroupApi taxGroups

tellers

public final TellerCashManagementApi tellers

templates

public final UserGeneratedDocumentsApi templates

users

public final UsersApi users

workingDays

public final WorkingDaysApi workingDays

loanInterestPauseApi

public final LoanInterestPauseApi loanInterestPauseApi

progressiveLoanApi

public final ProgressiveLoanApi progressiveLoanApi

externalAssetOwners

public final ExternalAssetOwnersApi externalAssetOwners

externalAssetOwnerLoanProductAttributes

public final ExternalAssetOwnerLoanProductAttributesApi externalAssetOwnerLoanProductAttributes

loanAccountLockApi

public final LoanAccountLockApi loanAccountLockApi

inlineJobApi

public final InlineJobApi inlineJobApi

loanBuyDownFeesApi

public final LoanBuyDownFeesApi loanBuyDownFeesApi

Method Details

builder

public static FineractClient.Builder builder()

okHttpClient

public okhttp3.OkHttpClient okHttpClient()

baseURL

public okhttp3.HttpUrl baseURL()

createService

public <S> S createService(Class<S> serviceClass)

Create an implementation of the API endpoints defined by the service interface, using Retrofit.create(Class). This method is typically not required to be invoked for standard API usage, but can be a handy back door for non-trivial advanced customizations of the API client if you have extended Fineract with your own REST APIs.