Jump to Content

Home Documentation API Reference Changelog Community

API Reference

Home Documentation API Reference Changelog Community

Apache Fineract

Overview
Batch API
- Batch requests in a single transactionpost
Client
Clients Address
Entity Field Configuration
- Retrieves the Entity Field Configurationget
Client Identifier
Standing Instructions
Standing Instructions History
- Standing Instructions Logged Historyget
Account Transfers
Client Charges
Client Transaction
Savings Account
Savings Account Transactions
Savings Charges
Fixed Deposit Account
Recurring Deposit Account
Recurring Deposit Account Transactions
Share Account
Loans
Loan Transactions
Loan Charges
Guarantors
Loan Collateral
Loan Rescheduling
- Calculate loan repayment schedule based on Loan term variations | Updates loan repayment schedule based on Loan term variations | Updates loan repayment schedule by removing Loan term variationspost
Groups
Centers
Collection Sheet
- Generate Individual Collection Sheet | Save Collection Sheetpost
General Ledger Account
Accounting Closure
Journal Entries
Accounting Rules
Mapping Financial Activities to Accounts
Periodic Accrual Accounting
- Executes Periodic Accrual Accountingpost
Provisioning Entries
Offices
Loan Products
Savings Product
Fixed Deposit Product
Recurring Deposit Product
Products
/smscampaigns
/smscampaigns/{campaignId}
/smscampaigns/preview
- postpost
/smscampaigns/{resourceId}
/smscampaigns/template
Entity Data Table
Currency
- Retrieve Currency Configurationget
- Update Currency Configurationput
Funds
Staff
Charges
Product Mix
Holidays
Working days
User Generated Documents
Interest Rate Chart
Interest Rate Slab (A.K.A interest bands)
Teller Cash Management
Payment Type
Provisioning Criteria
Floating Rates
Tax Components
Tax Group
Authentication HTTP Basic
- Verify authenticationpost
Users
Roles
Permissions
- List Application Permissionsget
- Enable/Disable Permissions for Maker Checkerput
Password preferences
Global Configuration
Hooks
Account number format
Codes
Code Values
Audits
Maker Checker (or 4-eye) functionality
MIFOSX-BATCH JOBS
External Services
- Retrieve External Services Configurationget
- Update External Serviceput
Data Tables
Notes
Documents
Search API
AdhocQuery Api
Reports
Run Reports
- Running a Reportget
Report Mailing Jobs
Survey
Spm-Surveys
SPM API - LookUp Table
Score Card
Self Authentication
- Verify authenticationpost
Self User Details
- Fetch authenticated user detailsget
Self User
- Update Userput
Self Client
Self Loans
Self Savings Account
Self Account transfer
- Create new Transferpost
- Retrieve Account Transfer Templateget
Self Third Party Transfer
Bulk Import
Cache
- Retrieve Cache Typesget
- Switch Cacheput
/email
- getget
- postpost
/email/{resourceId}
/email/messageByStatus
- getget
/email/failedEmail
- getget
/email/pendingEmail
- getget
/email/sentEmail
- getget
/email/campaign/{resourceId}
/email/campaign
- getget
- postpost
/email/campaign/preview
- postpost
/email/campaign/template/{resourceId}
- getget
/email/campaign/template
- getget
/email/configuration
- getget
- putput
/echo
- getget
Credit Bureau Configuration
/creditBureauIntegration/addCreditReport
- postpost
/creditBureauIntegration/deleteCreditReport/{creditBureauId}
- deletedel
/creditBureauIntegration/creditReport
- postpost
/creditBureauIntegration/creditReport/{creditBureauId}
- getget
/creditBureauIntegration/saveCreditReport
- postpost
/{entity}/{entityId}/images
Fineract Entity
Device Registration
Scheduler
- Retrieve Scheduler Statusget
- Activate Scheduler Jobs | Suspend Scheduler Jobspost
List Report Mailing Job History
- List Report Mailing Job Historyget
Two Factor
/twofactor/configure
- getget
- putput
Fetch authenticated user details
- Fetch authenticated user detailsget
SMS
Likelihood
Poverty Line
- /povertyLine/{ppiName}get
- /povertyLine/{ppiName}/{likelihoodId}get
Inter Operation
Mix Report
- /mixreportget
Mix Taxonomy
- /mixtaxonomyget
Mix Mapping
- /mixmappingget
- /mixmappingput
Notification
- /notificationsget
- /notificationsput
/officetransactions/{transactionId}
- deletedel
/officetransactions/template
- getget
/officetransactions
- getget
- postpost
Provisioning Category
Cashiers
- /cashiersget
Cashier Journals
- /cashiersjournalget
Calendar
Client Family Member
Groups Level
- /grouplevelsget
Bulk Loans
- /loans/loanreassignmentpost
- /loans/loanreassignment/templateget
Loan Disbursement Details
Reschedule Loans
Meetings
Rate
Deposit Account On Hold Fund Transactions
- /savingsaccounts/{savingsId}/onholdtransactionsget
Fixed Deposit Account Transactions
Pocket
- Retrieve accounts linked to pocketget
- Link/delink accounts to/from pocketpost
Self Loan Products
- /self/loanproductsget
- /self/loanproducts/{productId}get
Self Savings Products
- /self/savingsproductsget
- /self/savingsproducts/{productId}get
Self Share Products
- /self/products/shareget
- /self/products/share/{productId}get
Self Service Registration
- /self/registrationpost
- /self/registration/userpost
Self Run Report
- Running A Reportget
Self Share Accounts
Self Score Card
- /self/surveys/scorecards/{surveyId}post
- /self/surveys/scorecards/clients/{clientId}get
Self Spm
- /self/surveysget
Self Dividend

Powered by

Field Descriptions

Most fields are self-explanatory. Fields that aren't are described under the relevant resource heading e.g. AUTHENTICATION

Updated over 4 years ago

Updated over 4 years ago