Jump to Content
Home
Documentation
API Reference
Changelog
Community
v1.0
v2.0
Log In
API Reference
Log In
v2.0
Home
Documentation
API Reference
Changelog
Community
Full API Matrix
Search
JUMP TO
Apache Fineract
Overview
Getting Connected
Generic Options
Creating and Updating
Updating Dates and Numbers
Field Descriptions
Authentications
Errors
Batch API
Full API Matrix
Beta API Matrix
PAL / TPS
Self Service API
Batch API
Batch requests in a single transaction
post
Client
Create a Client
post
List Clients
get
Retrieve Client Details Template
get
Retrieve a Client
get
Update a Client
put
Delete a Client
delete
Activate a Client | Close a Client | Reject a Client | Withdraw a Client | Reactivate a Client | UndoReject a Client | UndoWithdraw a Client | Assign a Staff | Unassign a Staff | Update Default Savings Account | Propose a Client Transfer | Withdraw a Client Transfer | Reject a Client Transfer | Accept a Client Transfer | Propose and Accept a Client Transfer
post
Retrieve client accounts overview
get
/clients/{clientId}/obligeedetails
get
/clients/{clientId}/transferproposaldate
get
/clients/uploadtemplate
post
/clients/downloadtemplate
get
Clients Address
Create an address for a Client
post
List all addresses for a Client
get
Update an address for a Client
put
/client/addresses/template
get
Entity Field Configuration
Retrieves the Entity Field Configuration
get
Client Identifier
Create an Identifier for a Client
post
List all Identifiers for a Client
get
Retrieve a Client Identifier
get
Update a Client Identifier
put
Delete a Client Identifier
delete
Retrieve Client Identifier Details Template
get
Standing Instructions
Create new Standing Instruction
post
List Standing Instructions
get
Retrieve Standing Instruction
get
Update Standing Instruction | Delete Standing Instruction
put
Retrieve Standing Instruction Template
get
Standing Instructions History
Standing Instructions Logged History
get
Account Transfers
Create new Transfer
post
List account transfers
get
Retrieve account transfer
get
Retrieve Refund of an Active Loan by Transfer Template
get
Refund of an Active Loan by Transfer
post
Retrieve Account Transfer Template
get
Client Charges
Add Client Charge
post
List Client Charges
get
Retrieve a Client Charge
get
Delete a Client Charge
delete
Pay a Client Charge | Waive a Client Charge
post
/clients/{clientId}/charges/template
get
Client Transaction
List Client Transactions
get
Undo a Client Transaction
post
Retrieve a Client Transaction
get
Savings Account
Submit new savings application
post
List savings applications/accounts
get
Retrieve a savings application/account
get
Modify a savings application | Modify savings account withhold tax applicability
put
Delete a savings application
delete
Approve savings application | Undo approval savings application | Assign Savings Officer | Unassign Savings Officer | Reject savings application | Withdraw savings application | Activate a savings account | Close a savings account | Calculate Interest on Savings Account | Post Interest on Savings Account | Block Savings Account | Unblock Savings Account | Block Savings Account Credit transactions | Unblock Savings Account Credit transactions | Block Savings Account Debit transactions | Unblock Savings Account debit transactions
post
Retrieve Savings Account Template
get
/savingsaccounts/downloadtemplate
get
/savingsaccounts/transactions/downloadtemplate
get
/savingsaccounts/gsimcommands/{parentAccountId}
post
/savingsaccounts/uploadtemplate
post
/savingsaccounts/transactions/uploadtemplate
post
/savingsaccounts/gsim
post
/savingsaccounts/gsim/{parentAccountId}
put
Savings Account Transactions
/savingsaccounts/{savingsId}/transactions/{transactionId}
get
/savingsaccounts/{savingsId}/transactions/template
get
/savingsaccounts/{savingsId}/transactions/{transactionId}
post
/savingsaccounts/{savingsId}/transactions
post
Savings Charges
Create a Savings account Charge
post
List Savings Charges
get
Retrieve a Savings account Charge
get
Update a Savings account Charge
put
Delete a Savings account Charge
delete
Pay a Savings account Charge | Waive off a Savings account Charge | Inactivate a Savings account Charge
post
Retrieve Savings Charges Template
get
Fixed Deposit Account
Submit new fixed deposit application
post
List Fixed deposit applications/accounts
get
Retrieve a fixed deposit application/account
get
Modify a fixed deposit application
put
Delete a fixed deposit application
delete
Approve fixed deposit application | Undo approval fixed deposit application | Reject fixed deposit application | Withdraw fixed deposit application | Activate a fixed deposit account | Close a fixed deposit account | Premature Close a fixed deposit account | Calculate Premature amount on Fixed deposit account | Calculate Interest on Fixed Deposit Account | Post Interest on Fixed Deposit Account
post
/fixeddepositaccounts/{accountId}/template
get
/fixeddepositaccounts/downloadtemplate
get
/fixeddepositaccounts/transaction/downloadtemplate
get
/fixeddepositaccounts/uploadtemplate
post
/fixeddepositaccounts/transaction/uploadtemplate
post
Retrieve Fixed Deposit Account Template
get
Recurring Deposit Account
Submit new recurring deposit application
post
List Recurring deposit applications/accounts
get
Retrieve a recurring deposit application/account
get
Modify a recurring deposit application
put
Delete a recurring deposit application
delete
Approve recurring deposit application | Undo approval recurring deposit application | Reject recurring deposit application | Withdraw recurring deposit application | Activate a recurring deposit account | Update the recommended deposit amount for a recurring deposit account | Close a recurring deposit account | Premature Close a recurring deposit account | Calculate Premature amount on Recurring deposit account | Calculate Interest on recurring Deposit Account | Post Interest on recurring Deposit Account
post
/recurringdepositaccounts/{accountId}/template
get
/recurringdepositaccounts/downloadtemplate
get
/recurringdepositaccounts/transactions/downloadtemplate
get
/recurringdepositaccounts/uploadtemplate
post
/recurringdepositaccounts/transactions/uploadtemplate
post
Retrieve recurring Deposit Account Template
get
Recurring Deposit Account Transactions
Retrieve Recurring Deposit Account Transaction
get
Adjust Transaction | Undo transaction
post
Deposit Transaction | Withdrawal Transaction
post
Retrieve Recurring Deposit Account Transaction Template
get
Share Account
Submit new share application
post
List share applications/accounts
get
Retrieve a share application/account
get
Modify a share application
put
Approve share application | Undo approval share application | Reject share application | Activate a share account | Close a share account | Apply additional shares on a share account | Approve additional shares request on a share account | Reject additional shares request on a share account | Redeem shares on a share account
post
/accounts/{type}/downloadtemplate
get
Retrieve Share Account Template
get
/accounts/{type}/uploadtemplate
post
Loans
Calculate loan repayment schedule | Submit a new Loan Application
post
List Loans
get
Retrieve a Loan
get
Modify a loan application
put
Delete a Loan Application
delete
Approve Loan Application | Recover Loan Guarantee | Undo Loan Application Approval | Assign a Loan Officer | Unassign a Loan Officer | Reject Loan Application | Applicant Withdraws from Loan Application | Disburse Loan Disburse Loan To Savings Account | Undo Loan Disbursal
post
Approve GLIM Application | Undo GLIM Application Approval | Reject GLIM Application | Disburse Loan Disburse Loan To Savings Account | Undo Loan Disbursal
post
/loans/glimAccount/{glimId}
get
/loans/repayments/downloadtemplate
get
/loans/downloadtemplate
get
/loans/{loanId}/template
get
Retrieve Loan Details Template
get
/loans/repayments/uploadtemplate
post
/loans/uploadtemplate
post
Loan Transactions
Make a Repayment | Make a Refund of an Active Loan by Cash | Foreclosure of an Active Loan | Waive Interest | Write-off Loan | Make Recovery Payment | Undo Loan Write-off Transaction
post
Retrieve a Transaction Details
get
Adjust a Transaction
post
Retrieve Loan Transaction Template
get
Loan Charges
Create a Loan Charge
post
Pay Loan Charge
post
Retrieve a Loan Charge
get
Update a Loan Charge
put
Delete a Loan Charge
delete
List Loan Charges
get
Retrieve Loan Charges Template
get
Guarantors
/loans/{loanId}/guarantors/accounts/template
get
/loans/{loanId}/guarantors
get
/loans/{loanId}/guarantors/{guarantorId}
get
/loans/{loanId}/guarantors/downloadtemplate
get
/loans/{loanId}/guarantors/template
get
/loans/{loanId}/guarantors
post
/loans/{loanId}/guarantors/uploadtemplate
post
/loans/{loanId}/guarantors/{guarantorId}
put
/loans/{loanId}/guarantors/{guarantorId}
delete
Loan Collateral
Create a Collateral
post
List Loan Collaterals
get
Retrieve a Collateral
get
Update a Collateral
put
Remove a Collateral
delete
Retrieve Collateral Details Template
get
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 variations
post
Groups
Create a Group
post
List Groups
get
Retrieve Group Template
get
Retrieve a Group
get
Update a Group
put
Delete a Group
delete
Activate a Group | Associate Clients | Disassociate Clients | Transfer Clients across groups | Generate Collection Sheet | Save Collection Sheet | Unassign a Staff | Assign a Staff | Close a Group | Unassign a Role | Update a Role
post
Retrieve Group accounts overview
get
Unassign a Staff
post
/groups/downloadtemplate
get
/groups/{groupId}/gsimaccounts
get
/groups/{groupId}/glimaccounts
get
/groups/uploadtemplate
post
Centers
Create a Center
post
List Centers
get
Retrieve a Center Template
get
Retrieve a Center
get
Update a Center
put
Delete a Center
delete
Activate a Center | Generate Collection Sheet | Save Collection Sheet | Close a Center | Associate Groups | Disassociate Groups
post
Retrieve Center accounts overview
get
/centers/downloadtemplate
get
/centers/uploadtemplate
post
Collection Sheet
Generate Individual Collection Sheet | Save Collection Sheet
post
General Ledger Account
Create a General Ledger Account
post
List General Ledger Accounts
get
Retrieve a General Ledger Account
get
Update an Accounting closure
put
Delete an accounting closure
delete
/glaccounts/downloadtemplate
get
Retrieve GL Accounts Template
get
/glaccounts/uploadtemplate
post
Accounting Closure
Create an Accounting Closure
post
List Accounting closures
get
Retrieve an Accounting Closure
get
Update an Accounting closure
put
Delete an accounting closure
delete
Journal Entries
Create "Balanced" Journal Entries
post
List Journal Entries
get
Update Running balances for Journal Entries
post
Retrieve a single Entry
get
/journalentries/downloadtemplate
get
/journalentries/provisioning
get
/journalentries/openingbalance
get
/journalentries/uploadtemplate
post
Accounting Rules
Create/Define a Accounting rule
post
Retrieve Accounting Rules
get
Retrieve a Accounting rule
get
Update a Accounting Rule
put
Delete a Accounting Rule
delete
Retrieve Accounting Rule Details Template
get
Mapping Financial Activities to Accounts
Create a new Financial Activity to Accounts Mapping
post
List Financial Activities to Accounts Mappings
get
Retrieve a Financial Activity to Account Mapping
get
Update a Financial Activity to Account Mapping
put
Delete a Financial Activity to Account Mapping
delete
/financialactivityaccounts/template
get
Periodic Accrual Accounting
Executes Periodic Accrual Accounting
post
Provisioning Entries
Create new Provisioning Entries
post
List all Provisioning Entries
get
Retrieves a Provisioning Entry
get
Recreates Provisioning Entry
post
/provisioningentries/entries
get
Offices
Create an Office
post
List Offices
get
Retrieve an Office
get
Update Office
put
/offices/downloadtemplate
get
/offices/uploadtemplate
post
Retrieve Office Details Template
get
Loan Products
Create a Loan Product
post
List Loan Products
get
Retrieve a Loan Product
get
Update a Loan Product
put
Retrieve Loan Product Details Template
get
Savings Product
Create a Savings Product
post
List Savings Products
get
Retrieve a Savings Product
get
Update a Savings Product
put
Delete a Savings Product
delete
Retrieve Savings Product Template
get
Fixed Deposit Product
Create a Fixed Deposit Product
post
List Fixed Deposit Products
get
Retrieve a Fixed Deposit Product
get
Update a Fixed Deposit Product
put
Delete a Fixed Deposit Product
delete
/fixeddepositproducts/template
get
Recurring Deposit Product
Create a Recurring Deposit Product
post
List Recuring Deposit Products
get
Retrieve a Recurring Deposit Product
get
Update a Recurring Deposit Product
put
Delete a Recurring Deposit Product
delete
/recurringdepositproducts/template
get
Products
Create a Share Product
post
List Share Products
get
Retrieve a Share Product
get
Update a Share Product
put
/products/{type}/template
get
/products/{type}/{productId}
post
/smscampaigns
Create a SMS Campaign
post
List SMS Campaigns
get
Retrieve a SMS Campaign
get
Retrieve a SMS Campaign
get
/smscampaigns/{campaignId}
Update a Campaign
put
Delete a SMS Campaign
delete
SMS Campaign
post
/smscampaigns/preview
post
post
/smscampaigns/{resourceId}
/smscampaigns/template
Entity Data Table
Create Entity-Datatable Checks
post
List Entity-Datatable Checks
get
Retrieve Entity-Datatable Checks Template
get
Delete Entity-Datatable Checks
delete
Currency
Retrieve Currency Configuration
get
Update Currency Configuration
put
Funds
Create a Fund
post
Retrieve Funds
get
Retrieve a Fund
get
Update a Fund
put
Staff
Create a staff member
post
Retrieve Staff
get
Retrieve a Staff Member
get
Update a Staff Member
put
/staff/downloadtemplate
get
/staff/uploadtemplate
post
Charges
Create/Define a Charge
post
Retrieve Charges
get
Retrieve a Charge
get
Update a Charge
put
Delete a Charge
delete
Retrieve Charge Template
get
Product Mix
/loanproducts/{productId}/productmix
get
/loanproducts/{productId}/productmix
post
/loanproducts/{productId}/productmix
put
/loanproducts/{productId}/productmix
delete
Holidays
Create a Holiday
post
List Holidays
get
Retrieve a Holiday
get
Update a Holiday
put
Delete a Holiday
delete
Activate a Holiday
post
/holidays/template
get
Working days
List Working days
get
Working Days Template
get
Update a Working Day
put
User Generated Documents
Add a UGD
post
Retrieve all UGDs
get
Retrieve a UGD
get
Update a UGD
put
Delete a UGD
delete
/templates/{templateId}/template
get
/templates/{templateId}
post
Retrieve UGD Details Template
get
Interest Rate Chart
Create a Chart
post
Retrieve all Charts
get
Retrieve a Chart
get
Update a Chart
put
Delete a Chart
delete
Retrieve Chart Details Template
get
Interest Rate Slab (A.K.A interest bands)
Create a Slab
post
Retrieve all Slabs
get
Retrieve a Slab
get
Update a Slab
put
Delete a Slab
delete
/interestratecharts/{chartId}/chartslabs/template
get
Teller Cash Management
Create teller
post
List all tellers
get
Retrieve tellers
get
Update teller
put
Create Cashiers
post
Retrieve a cashier
get
Find Cashiers
get
List Cashiers
get
Update Cashier
put
Delete Cashier
delete
Allocate Cash To Cashier
post
Settle Cash From Cashier
post
Retrieve Cashier Transaction
get
Transactions Wtih Summary For Cashier
get
Retrieve Cashier Transaction Template
get
/tellers/{tellerId}/transactions/{transactionId}
get
/tellers/{tellerId}/journals
get
/tellers/{tellerId}/transactions
get
/tellers/{tellerId}
delete
Payment Type
Create a Payment Type
post
Retrieve all Payment Types
get
Retrieve a Payment Type
get
Update a Payment Type
put
Delete a Payment Type
delete
Provisioning Criteria
Create a new Provisioning Criteria
post
Retrieves all created Provisioning Criterias
get
Retrieves a Provisioning Criteria
get
Updates a new Provisioning Criteria
put
Deletes Provisioning Criteria
delete
/provisioningcriteria/template
get
Floating Rates
Create a new Floating Rate
post
List Floating Rates
get
Retrieve Floating Rate
get
Update Floating Rate
put
Tax Components
Create a new Tax Component
post
List Tax Components
get
Retrieve Tax Component
get
Update Tax Component
put
/taxes/component/template
get
Tax Group
Create a new Tax Group
post
List Tax Group
get
Retrieve Tax Group
get
Update Tax Group
put
/taxes/group/template
get
Authentication HTTP Basic
Verify authentication
post
Users
Create a User
post
Retrieve list of users
get
Retrieve a User
get
Update a User
put
Delete a User
delete
/users/downloadtemplate
get
/users/uploadtemplate
post
Retrieve User Details Template
get
Roles
Create a New Role
post
List Roles
get
Retrieve a Role
get
Update a Role
put
Delete a Role
delete
Retrieve a Role's Permissions
get
Update a Role's Permissions
put
Enable Role | Disable Role
post
Permissions
List Application Permissions
get
Enable/Disable Permissions for Maker Checker
put
Password preferences
List Application Password validation policies
get
Update password preferences
put
/passwordpreferences
get
Global Configuration
Retrieve Global Configuration | Retrieve Global Configuration for surveys
get
Retrieve Global Configuration
get
Update Global Configuration
put
Hooks
Create a Hook
post
Retrieve Hooks
get
Retrieve a Hook
get
Update a Hook
put
Delete a Hook
delete
Retrieve Hooks Template
get
Account number format
Create an Account number format
post
List Account number formats
get
Retrieve an Account number format
get
Update an Account number format
put
Delete an Account number format
delete
Retrieve Account number format Template
get
Codes
Create a Code
post
Retrieve Codes
get
Retrieve a Code
get
Update a Code
put
Delete a Code
delete
Code Values
Create a Code description
post
List Code Values
get
Retrieve a Code description
get
Update a Code description
put
Delete a Code description
delete
Audits
List Audits
get
Retrieve an Audit Entry
get
Audit Search Template
get
Maker Checker (or 4-eye) functionality
List Maker Checker Entries
get
Delete Maker Checker Entry
delete
Approve Maker Checker Entry | Reject Maker Checker Entry
post
Maker Checker Search Template
get
MIFOSX-BATCH JOBS
Retrieve a Job
get
Update a Job
put
Run a Job
post
Retrieve Job Run History
get
Retrieve Scheduler Jobs
get
External Services
Retrieve External Services Configuration
get
Update External Service
put
Data Tables
Create Data Table
post
List Data Tables
get
Retrieve Data Table Details
get
Update Data Table
put
Delete Data Table
delete
Register Data Table
post
Deregister Data Table
post
Create Entry in Data Table
post
Retrieve Entry(s) from Data Table
get
Update Entry in Data Table (One to One)
put
Delete Entry(s) in Data Table
delete
Update Entry in Data Table (One to Many)
put
Delete Entry in Datatable (One to Many)
delete
/datatables/{datatable}/{apptableId}/{datatableId}
get
Notes
Add a Resource Note
post
Retrieve a Resource's description
get
Retrieve a Resource Note
get
Update a Resource Note
put
Delete a Resource Note
delete
Documents
Create a Document
post
List documents
get
Retrieve a Document
get
Update a Document
put
Remove a Document
delete
Retrieve Binary File associated with Document
get
Search API
Search Resources
get
Adhoc query search
post
Retrive Adhoc Search query template
get
AdhocQuery Api
/adhocquery
get
/adhocquery
post
/adhocquery/{adHocId}
get
/adhocquery/{adHocId}
put
/adhocquery/{adHocId}
delete
/adhocquery/template
get
Reports
Create a Report
post
List Reports
get
Retrieve a Report
get
Update a Report
put
Delete a Report
delete
Retrieve Report Template
get
Run Reports
Running a Report
get
Report Mailing Jobs
Create a Report Mailing Job
post
List Report Mailing Jobs
get
Retrieve a Report Mailing Job
get
Update a Report Mailing Job
put
Delete a Report Mailing Job
delete
Retrieve Report Mailing Job Details Template
get
Survey
Create an entry in the survey table
post
Retrieve surveys
get
Retrieve survey
get
/survey/{surveyName}/{clientId}/{fulfilledId}
delete
/survey/{surveyName}/{clientId}
get
/survey/{surveyName}/{clientId}/{entryId}
get
/survey/register/{surveyName}/{apptable}
put
Spm-Surveys
Create a Survey
post
List all Surveys
get
Retrieve a Survey
get
Deactivate Survey
post
/surveys/{id}
put
SPM API - LookUp Table
Create a Lookup Table entry
post
List all Lookup Table entries
get
Retrieve a Lookup Table entry
get
Score Card
Create a Scorecard entry
post
List all Scorecard entries
get
/surveys/scorecards/clients/{clientId}
get
/surveys/scorecards/{surveyId}/clients/{clientId}
get
Self Authentication
Verify authentication
post
Self User Details
Fetch authenticated user details
get
Self User
Update User
put
Self Client
List Clients associated to the user
get
Retrieve a Client
get
Retrieve client accounts overview
get
Retrieve Client Image
get
List Client Charges
get
Retrieve a Client Charge
get
List Client Transactions
get
Retrieve a Client Transaction
get
/self/clients/{clientId}/images
delete
/self/clients/{clientId}/images
post
/self/clients/{clientId}/obligeedetails
get
Self Loans
Calculate Loan Repayment Schedule | Submit a new Loan Application
post
Retrieve a Loan
get
Update a Loan Application
put
Applicant Withdraws from Loan Application
post
List Loan Charges
get
/self/loans/{loanId}/guarantors
get
Retrieve a Loan Charge
get
Retrieve a Loan Transaction Details
get
Retrieve Loan Details Template
get
Self Savings Account
Retrieve a savings account
get
/self/savingsaccounts/{accountId}
put
List Savings Charges
get
Retrieve a Savings account Charge
get
Retrieve Savings Account Transaction
get
/self/savingsaccounts
post
/self/savingsaccounts/template
get
Self Account transfer
Create new Transfer
post
Retrieve Account Transfer Template
get
Self Third Party Transfer
Get All TPT Beneficiary
get
Add TPT Beneficiary
post
Update TPT Beneficiary
put
Delete TPT Beneficiary
delete
Beneficiary Third Party Transfer Template
get
Bulk Import
/imports/downloadOutputTemplate
get
/imports
get
/imports/getOutputTemplateLocation
get
Cache
Retrieve Cache Types
get
Switch Cache
put
/email
get
get
post
post
/email/{resourceId}
get
get
put
put
delete
delete
/email/messageByStatus
get
get
/email/failedEmail
get
get
/email/pendingEmail
get
get
/email/sentEmail
get
get
/email/campaign/{resourceId}
get
get
put
put
post
post
delete
delete
/email/campaign
get
get
post
post
/email/campaign/preview
post
post
/email/campaign/template/{resourceId}
get
get
/email/campaign/template
get
get
/email/configuration
get
get
put
put
/echo
get
get
Credit Bureau Configuration
/CreditBureauConfiguration/organisationCreditBureau/{organisationCreditBureauId}
post
/CreditBureauConfiguration/configuration/{creditBureauId}
post
/CreditBureauConfiguration/mappings/{organisationCreditBureauId}
post
/CreditBureauConfiguration/loanProduct
get
/CreditBureauConfiguration/loanProduct/{loanProductId}
get
/CreditBureauConfiguration/config/{organisationCreditBureauId}
get
/CreditBureauConfiguration
get
/CreditBureauConfiguration/mappings
get
/CreditBureauConfiguration/mappings
put
/CreditBureauConfiguration/organisationCreditBureau
get
/CreditBureauConfiguration/organisationCreditBureau
put
/CreditBureauConfiguration/configuration/{configurationId}
put
/creditBureauIntegration/addCreditReport
post
post
/creditBureauIntegration/deleteCreditReport/{creditBureauId}
delete
delete
/creditBureauIntegration/creditReport
post
post
/creditBureauIntegration/creditReport/{creditBureauId}
get
get
/creditBureauIntegration/saveCreditReport
post
post
/{entity}/{entityId}/images
get
get
put
put
post
post
delete
delete
Fineract Entity
/entitytoentitymapping/{relId}
post
/entitytoentitymapping/{mapId}
get
/entitytoentitymapping/{mapId}
put
/entitytoentitymapping/{mapId}
delete
/entitytoentitymapping/{mapId}/{fromId}/{toId}
get
/entitytoentitymapping
get
Device Registration
/self/device/registration/{id}
get
/self/device/registration/{id}
put
/self/device/registration/{id}
delete
/self/device/registration
get
/self/device/registration
post
/self/device/registration/client/{clientId}
get
Scheduler
Retrieve Scheduler Status
get
Activate Scheduler Jobs | Suspend Scheduler Jobs
post
List Report Mailing Job History
List Report Mailing Job History
get
Two Factor
/twofactor
get
/twofactor
post
/twofactor/invalidate
post
/twofactor/validate
post
/twofactor/configure
get
get
put
put
Fetch authenticated user details
Fetch authenticated user details
get
SMS
/sms
get
/sms
post
/sms/{resourceId}
get
/sms/{resourceId}
put
/sms/{resourceId}
delete
/sms/{campaignId}/messageByStatus
get
Likelihood
/likelihood/{ppiName}/{likelihoodId}
get
/likelihood/{ppiName}/{likelihoodId}
put
/likelihood/{ppiName}
get
Poverty Line
/povertyLine/{ppiName}
get
/povertyLine/{ppiName}/{likelihoodId}
get
Inter Operation
Calculate Interoperation Quote
post
Allow Interoperation Transaction Request
post
Query Interoperation Account by secondary identifier
get
Interoperation Identifier registration
post
Allow Interoperation Identifier registration
delete
Query Interoperation Account by secondary identifier
get
Interoperation Identifier registration
post
Allow Interoperation Identifier registration
delete
Disburse Loan by Account Id
post
Query Interoperation Account details
get
Query Interoperation secondary identifiers by Account Id
get
Query transactions by Account Id
get
Query KYC by Account Id
get
Query Interoperation Quote
get
Query Interoperation Transaction Request
get
Query Interoperation Transfer
get
Query Interoperation Health Request
get
Prepare Interoperation Transfer
post
Mix Report
/mixreport
get
Mix Taxonomy
/mixtaxonomy
get
Mix Mapping
/mixmapping
get
/mixmapping
put
Notification
/notifications
get
/notifications
put
/officetransactions/{transactionId}
delete
delete
/officetransactions/template
get
get
/officetransactions
get
get
post
post
Provisioning Category
/provisioningcategory
get
/provisioningcategory
post
/provisioningcategory/{categoryId}
put
/provisioningcategory/{categoryId}
delete
Cashiers
/cashiers
get
Cashier Journals
/cashiersjournal
get
Calendar
/{entityType}/{entityId}/calendars
get
/{entityType}/{entityId}/calendars
post
/{entityType}/{entityId}/calendars/{calendarId}
get
/{entityType}/{entityId}/calendars/{calendarId}
put
/{entityType}/{entityId}/calendars/{calendarId}
delete
/{entityType}/{entityId}/calendars/template
get
Client Family Member
/clients/{clientId}/familymembers
get
/clients/{clientId}/familymembers
post
/clients/{clientId}/familymembers/{familyMemberId}
get
/clients/{clientId}/familymembers/{familyMemberId}
put
/clients/{clientId}/familymembers/{familyMemberId}
delete
/clients/{clientId}/familymembers/template
get
Groups Level
/grouplevels
get
Bulk Loans
/loans/loanreassignment
post
/loans/loanreassignment/template
get
Loan Disbursement Details
/loans/{loanId}/disbursements/editDisbursements
put
/loans/{loanId}/disbursements/{disbursementId}
get
/loans/{loanId}/disbursements/{disbursementId}
put
Reschedule Loans
/rescheduleloans
get
/rescheduleloans
post
/rescheduleloans/{scheduleId}
get
/rescheduleloans/{scheduleId}
post
/rescheduleloans/template
get
Meetings
/{entityType}/{entityId}/meetings
get
/{entityType}/{entityId}/meetings
post
/{entityType}/{entityId}/meetings/{meetingId}
get
/{entityType}/{entityId}/meetings/{meetingId}
put
/{entityType}/{entityId}/meetings/{meetingId}
post
/{entityType}/{entityId}/meetings/{meetingId}
delete
/{entityType}/{entityId}/meetings/template
get
Rate
/rates
get
/rates
post
/rates/{rateId}
get
/rates/{rateId}
put
Deposit Account On Hold Fund Transactions
/savingsaccounts/{savingsId}/onholdtransactions
get
Fixed Deposit Account Transactions
/fixeddepositaccounts/{fixedDepositAccountId}/transactions/{transactionId}
get
/fixeddepositaccounts/{fixedDepositAccountId}/transactions/{transactionId}
post
/fixeddepositaccounts/{fixedDepositAccountId}/transactions/template
get
/fixeddepositaccounts/{fixedDepositAccountId}/transactions
post
Pocket
Retrieve accounts linked to pocket
get
Link/delink accounts to/from pocket
post
Self Loan Products
/self/loanproducts
get
/self/loanproducts/{productId}
get
Self Savings Products
/self/savingsproducts
get
/self/savingsproducts/{productId}
get
Self Share Products
/self/products/share
get
/self/products/share/{productId}
get
Self Service Registration
/self/registration
post
/self/registration/user
post
Self Run Report
Running A Report
get
Self Share Accounts
Submit new share application
post
Retrieve a share application/account
get
Retrieve Share Account Template
get
Self Score Card
/self/surveys/scorecards/{surveyId}
post
/self/surveys/scorecards/clients/{clientId}
get
Self Spm
/self/surveys
get
Self Dividend
/shareproduct/{productId}/dividend
get
/shareproduct/{productId}/dividend
post
/shareproduct/{productId}/dividend/{dividendId}
get
/shareproduct/{productId}/dividend/{dividendId}
put
/shareproduct/{productId}/dividend/{dividendId}
delete
Powered by
Full API Matrix
https://demo.mifos.io/api-docs/apiLive.htm#fullapi_matrix
