fineract-client/org.mifos.fineract.client.infrastructure/FineractClient

FineractClient

class FineractClient

Fineract Client Kotlin KMP SDK API entry point.

Types

Create an implementation of the API endpoints defined by the service interface, using Ktorfit.create. 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.

object Companion

Properties

accountingClosures

val accountingClosures: AccountingClosureApi

accountingRules

val accountingRules: AccountingRulesApi

accountNumberFormats

val accountNumberFormats: AccountNumberFormatApi

accountTransfers

val accountTransfers: AccountTransfersApi

val adhocQuery: AdhocQueryApiApi

val audits: AuditsApi

val authentication: AuthenticationHTTPBasicApi

val batches: BatchAPIApi

val bulkImport: BulkImportApi

val bulkLoans: BulkLoansApi

businessDateManagement

val businessDateManagement: BusinessDateManagementApi

businessStepConfiguration

val businessStepConfiguration: BusinessStepConfigurationApi

val caches: CacheApi

val calender: CalendarApi

val cashiers: CashiersApi

cashiersJournal

val cashiersJournal: CashierJournalsApi

val centers: CentersApi

val charges: ChargesApi

clientAddresses

val clientAddresses: ClientsAddressApi

val clientCharges: ClientChargesApi

clientCollateralManagement

val clientCollateralManagement: ClientCollateralManagementApi

clientFamilyMember

val clientFamilyMember: ClientFamilyMemberApi

clientIdentifiers

val clientIdentifiers: ClientIdentifierApi

val clients: ClientApi

val clientSearch: ClientSearchV2Api

clientTransactions

val clientTransactions: ClientTransactionApi

val codes: CodesApi

val codeValues: CodeValuesApi

collateralManagement

val collateralManagement: CollateralManagementApi

collectionSheet

val collectionSheet: CollectionSheetApi

creditBureauConfiguration

val creditBureauConfiguration: CreditBureauConfigurationApi

val currencies: CurrencyApi

val dataTables: DataTablesApi

delinquencyRangeAndBucketsManagement

val delinquencyRangeAndBucketsManagement: DelinquencyRangeAndBucketsManagementApi

depositAccountOnHoldFundTransactions

val depositAccountOnHoldFundTransactions: DepositAccountOnHoldFundTransactionsApi

deviceRegistrationApi

val deviceRegistrationApi: DeviceRegistrationApi

val documents: DocumentsApi

entityDatatableChecks

val entityDatatableChecks: EntityDataTableApi

entityFieldConfigurations

val entityFieldConfigurations: EntityFieldConfigurationApi

externalAssetOwners

val externalAssetOwners: ExternalAssetOwnersApi

externalEventConfiguration

val externalEventConfiguration: ExternalEventConfigurationApi

externalServices

val externalServices: ExternalServicesApi

financialActivityAccountMappings

val financialActivityAccountMappings: MappingFinancialActivitiesToAccountsApi

val fineractEntity: FineractEntityApi

fixedDepositAccounts

val fixedDepositAccounts: FixedDepositAccountApi

fixedDepositAccountTransactions

val fixedDepositAccountTransactions: FixedDepositAccountTransactionsApi

fixedDepositProducts

val fixedDepositProducts: FixedDepositProductApi

val floatingRates: FloatingRatesApi

val funds: FundsApi

val glAccounts: GeneralLedgerAccountApi

globalConfigurations

val globalConfigurations: GlobalConfigurationApi

val groups: GroupsApi

val groupsLoans: GroupsLevelApi

val guarantors: GuarantorsApi

val holidays: HolidaysApi

val hooks: HooksApi

val inlineJob: InlineJobApi

val instanceMode: InstanceModeApi

interestRateChartLabs

val interestRateChartLabs: InterestRateSlabAKAInterestBandsApi

interestRateCharts

val interestRateCharts: InterestRateChartApi

val interOperation: InterOperationApi

val jobs: SCHEDULERJOBApi

val jobsScheduler: SchedulerApi

val journalEntries: JournalEntriesApi

val legacy: DefaultApi

val likelihood: LikelihoodApi

loanAccountLock

val loanAccountLock: LoanAccountLockApi

val loanCharges: LoanChargesApi

val loanCOBCatchUp: LoanCOBCatchUpApi

loanCollateralManagement

val loanCollateralManagement: LoanCollateralManagementApi

loanCollaterals

val loanCollaterals: LoanCollateralApi

loanDisbursementDetails

val loanDisbursementDetails: LoanDisbursementDetailsApi

val loanProducts: LoanProductsApi

val loans: LoansApi

val loanSchedules: LoanReschedulingApi

loanTransactions

val loanTransactions: LoanTransactionsApi

val makerCheckers: MakerCheckerOr4EyeFunctionalityApi

val meetings: MeetingsApi

val mixMappings: MixMappingApi

val mixReports: MixReportApi

val mixTaxonomies: MixTaxonomyApi

val notes: NotesApi

val notifications: NotificationApi

val offices: OfficesApi

passwordPreferences

val passwordPreferences: PasswordPreferencesApi

val paymentTypes: PaymentTypeApi

periodicAccrualAccounting

val periodicAccrualAccounting: PeriodicAccrualAccountingApi

val permissions: PermissionsApi

val povertyLine: PovertyLineApi

val productMix: ProductMixApi

val products: ProductsApi

provisioningCategories

val provisioningCategories: ProvisioningCategoryApi

provisioningCriterias

val provisioningCriterias: ProvisioningCriteriaApi

provisioningEntries

val provisioningEntries: ProvisioningEntriesApi

val rate: RateApi

recurringDepositAccounts

val recurringDepositAccounts: RecurringDepositAccountApi

recurringDepositAccountTransactions

val recurringDepositAccountTransactions: RecurringDepositAccountTransactionsApi

recurringDepositProducts

val recurringDepositProducts: RecurringDepositProductApi

repaymentWithPostDatedChecks

val repaymentWithPostDatedChecks: RepaymentWithPostDatedChecksApi

reportMailingJobs

val reportMailingJobs: ReportMailingJobsApi

val reportMailings: ListReportMailingJobHistoryApi

val reports: ReportsApi

val reportsRun: RunReportsApi

val rescheduling: RescheduleLoansApi

val roles: RolesApi

savingsAccountCharges

val savingsAccountCharges: SavingsChargesApi

savingsAccounts

val savingsAccounts: SavingsAccountApi

savingsProducts

val savingsProducts: SavingsProductApi

savingsTransactions

val savingsTransactions: SavingsAccountTransactionsApi

val search: SearchAPIApi

selfAccountTransfers

val selfAccountTransfers: SelfAccountTransferApi

selfAuthentication

val selfAuthentication: SelfAuthenticationApi

val selfClients: SelfClientApi

val selfDividend: SelfDividendApi

selfLoanProducts

val selfLoanProducts: SelfLoanProductsApi

val selfLoans: SelfLoansApi

val selfPockets: PocketApi

selfRegistration

val selfRegistration: SelfServiceRegistrationApi

val selfReportsRun: SelfRunReportApi

selfSavingsAccounts

val selfSavingsAccounts: SelfSavingsAccountApi

selfSavingsProducts

val selfSavingsProducts: SelfSavingsProductsApi

selfShareAccounts

val selfShareAccounts: SelfShareAccountsApi

val selfSurveys: SelfSpmApi

selfSurveyScorecards

val selfSurveyScorecards: SelfScoreCardApi

selfThirdPartyBeneficiaries

val selfThirdPartyBeneficiaries: SelfThirdPartyTransferApi

val selfUser: SelfUserApi

selfUserDetails

val selfUserDetails: SelfUserDetailsApi

val shareAccounts: ShareAccountApi

val sms: SMSApi

val spmSurveys: SpmSurveysApi

val staff: StaffApi

standingInstructions

val standingInstructions: StandingInstructionsApi

standingInstructionsHistory

val standingInstructionsHistory: StandingInstructionsHistoryApi

surveyLookupTables

val surveyLookupTables: SPMAPILookUpTableApi

val surveys: SurveyApi

surveyScorecards

val surveyScorecards: ScoreCardApi

val taxComponents: TaxComponentsApi

val taxGroups: TaxGroupApi

val tellers: TellerCashManagementApi

val templates: UserGeneratedDocumentsApi

val twoFactor: TwoFactorApi

val userDetails: FetchAuthenticatedUserDetailsApi

val users: UsersApi

val workingDays: WorkingDaysApi

Functions

fun baseURL(): String

fun httpClient(): HttpClient