Clients can be created in a Pending state. This API exists to enable client activation (for when a client becomes approved member of microfinance institue).
-If the client happens to be alrady active this API will result in an error.
+Clients can be created in a Pending state. This API exists to enable client activation (for when a client becomes an approved member of the financial Institution).
+If the client happens to be already active this API will result in an error.
POST https://Domain Name/api/v1/clients/{clientId}?command=activate
@@ -3469,8 +3469,8 @@ Request Body:
Clients can be closed if they dont have any non-closed loans/savingsAccount. This API exists to close a client .
-If the client have any corresponding active loans/savingsAccount this API will result in an error.
+Clients can be closed if they do not have any non-closed loans/savingsAccount. This API exists to close a client .
+If the client have any active loans/savingsAccount this API will result in an error.
POST https://Domain Name/api/v1/clients/{clientId}?command=close
@@ -3497,8 +3497,9 @@ Request Body:
Allows you to assign Staff for existed Client.
-The selected Staff member should be belongs to the client's office.
+Allows you to assign a Staff for existed Client.
+The selected Staff should belong to the same office (or an officer higher up in the hierarchy) + as the Client he manages.
POST https://Domain Name/api/v1/clients/{clientId}?command=assignStaff
@@ -3524,7 +3525,7 @@ Request Body:
Allows you to unassign the Staff.
+Allows you to unassign the Staff assigned to a Client.
POST https://Domain Name/api/v1/clients/{clientId}?command=unassignStaff
@@ -3550,8 +3551,8 @@ Request Body:
Allows you to modify or assign default overdraft savings account for existed Client.
-The selected savings account should be belongs to the client's.
+Allows you to modify or assign a default savings account for an existing Client.
+The selected savings account should be one among the existing savings account for a particular customer.
POST https://Domain Name/api/v1/clients/{clientId}?command=updateSavingsAccount
@@ -3579,7 +3580,7 @@ Request Body:
Allows you to propose the transfer of a Client to a different Offices.
+Allows you to propose the transfer of a Client to a different Office.
POST https://Domain Name/api/v1/clients/{clientId}?command=proposeTransfer
@@ -3606,7 +3607,7 @@ Request Body:
Allows you to withdraw the proposed the transfer of a Client to a different Offices.
+Allows you to withdraw the proposed transfer of a Client to a different Office.
Withdrawal can happen only if the destination Branch (to which the transfer was proposed) has not already accepted the transfer proposal
@@ -3793,7 +3794,7 @@ GET https://DomainName/api/v1/clients/{clientId}Note:You can update any of the basic attributes of a client using this API but not its associations.
-Chaning the relationship between a client and its office is not supported through this API. An API specific to handling transfers of clients between offices will be introduced for this.
+Note:You can update any of the basic attributes of a client (but not its associations) using this API.
+Changing the relationship between a client and its office is not supported through this API. An API specific to handling transfers of clients between offices is available for the same.
The relationship between a client and a group must be removed through the Groups API.
If a client is in Pending state you are allowed to Delete it. The delete is a 'hard delete' and cannot be recovered from. Once clients become active or have loans or savings associated with it, you cannot delete the client but you may Close the client if they have died or exited the program.
+If a client is in Pending state, you are allowed to Delete it. The delete is a 'hard delete' and cannot be recovered from. Once clients become active or have loans or savings associated with them, you cannot delete the client but you may Close the client if they have left the program.
@@ -3976,7 +3977,7 @@ Request Body:
Retrieve client accounts overview
An example of how a loan portfolio summary can be provided. This
- is requested in a specific use case of the reference application.
It is quite reasonable to add resources like this to simplify User Interface development.
+ is requested in a specific use case of the community application.
It is quite reasonable to add resources like this to simplify User Interface development.
Example Requests:
clients/1/accounts
@@ -4175,7 +4176,7 @@ GET https://DomainName/api/v1/clients/{clientId}/identifiers
Retrieve Client Identifier Details Template
- This is a convenience resource. It can be useful when
+
This is a convenience resource useful for
building maintenance user interface screens for client
applications. The template data returned consists of any or all
of:
@@ -4604,7 +4605,7 @@ No Request Body:
Centers
- Centers along with Groups are used to provided a distinctive banking distribution channel used in microfinance. Its common in areas such as India to use Centers and Group administrative units in grameen style lending. Typically groups will contain one to five people and centers themselves will be made of anywhere between 2-7 groups.
+
Centers along with Groups are used to provided a distinctive banking distribution channel used in microfinance. Its common in areas such as Southern Asia to use Centers and Group as administrative units in grameen style lending. Typically groups will contain one to five people and centers themselves will be made of anywhere between 2-10 groups.
@@ -4782,7 +4783,7 @@ GET https://DomainName/mifosng-provider/api/v1/centers/template?officeId=2
- Creater a center as pending with no association to groupMembers.
+ Create a center as pending with no association to groupMembers.
POST https://DomainName/mifosng-provider/api/v1/centers
@@ -4805,7 +4806,7 @@ Content-Type: application/json Request Body:
- Creater a center as active with no association to groupMembers.
+ Create a center as active with no association to groupMembers.
POST https://DomainName/mifosng-provider/api/v1/centers
@@ -4837,7 +4838,7 @@ Content-Type: application/json Request Body:
Activate a Center
Centers can be created in a Pending state. This API exists to enable center activation.
- If the center happens to be already active this API will result in an error.
+ If the center happens to be already active, this API will result in an error.
POST https://Domain Name/api/v1/centers/{centerId}?command=activate
@@ -4864,8 +4865,8 @@ Request Body:
Close a Center
- Centers can be closed if they don't have any non-closed groups/savings.
- If the group have any corresponding active groups/savingsAccount this API will result in an error.
+ Centers can be closed if they don't have any non-closed groups or saving accounts.
+ If the Center has any active groups or savings accounts, this API will result in an error.
POST https://Domain Name/api/v1/centers/{centerId}?command=close
@@ -4891,9 +4892,9 @@ Request Body:
Associate Groups
- This API allows to associate existing groups to a center.
+ This API allows associating existing groups to a center.
The groups are listed from the office to which the center is associated.
- If group(s) is already associated with center then API will result in an error.
+ If group(s) is already associated with a center, this API will result in an error.
@@ -4948,7 +4949,7 @@ Request Body:
Retrieve Center accounts overview
- An example of how a savings summary can be provided. This
+ An example of how a savings summary for a Center can be provided. This
is requested in a specific use case of the reference application.
It is quite reasonable to add resources like this to simplify User Interface development.
Example Requests:
@@ -5014,7 +5015,7 @@ GET https://DomainName/api/v1/centers/{centerId}/accounts
Generate Collection Sheet
- This api retrieves repayment details of all jlg loans under a center on a specified meeting date.
+ This Api retrieves repayment details of all jlg loans under a center as on a specified meeting date.
POST https://Domain Name/api/v1/centers/{centerId}?command=generateCollectionSheet
@@ -5121,7 +5122,7 @@ Request Body:
Save Collection Sheet
- This api allows the loan officer to perform bulk repayments of JLG loans for a center on its meeting date.
+ This Api allows the loan officer to perform bulk repayments of JLG loans for a center on a given meeting date.
POST https://Domain Name/api/v1/centers/{centerId}?command=saveCollectionSheet
@@ -5192,7 +5193,7 @@ Request Body:
Delete a Center
- A center can be delete if it is in pending state and has nothing associated with it - groups, loans, savings etc
+ A Center can be deleted if it is in pending state and has no association - groups, loans or savings
@@ -5241,9 +5242,9 @@ GET https://DomainName/mifosng-provider/api/v1/centers/8
- Retrieve an existing center with no groups information.
+ Retrieve an existing center without the details of group associations.
-GET https://DomainName/mifosng-provider/api/v1/centers/9?associations=groupMembers
+GET https://DomainName/mifosng-provider/api/v1/centers/9
{
@@ -5262,16 +5263,7 @@ GET https://DomainName/mifosng-provider/api/v1/centers/9?associations=groupMembe
"name": "centerwithgroup",
"officeId": 1,
"officeName": "Head Office",
- "hierarchy": ".9.",
- "groupMembers": [
- {
- "id": 7,
- "name": "Othergroup",
- "officeId": 1,
- "officeName": "Head Office",
- "hierarchy": ".7."
- }
- ]
+ "hierarchy": ".9."
}
@@ -5281,7 +5273,7 @@ GET https://DomainName/mifosng-provider/api/v1/centers/9?associations=groupMembe
List Centers
- The default implementation of list results into 200 entries with optional support for pagination and sorting. The parameter limit with value -1 will return all entries.
+ The default implementation supports pagination and sorting with the default pagination size set to 200 records. The parameter limit with value -1 will return all entries.
Optional Arguments
- paged
@@ -5397,7 +5389,7 @@ GET https://DomainName/mifosng-provider/api/v1/centers?paged=true
Groups
- Groups are used to provide a distinctive banking distribution channel used in microfinance throughout the world. The Group is an administrative unit. It can contain as few as 5 people or as many as 40 depending on how its used.
+ Groups are used to provide a distinctive banking distribution channel used in microfinances throughout the world. The Group is an administrative unit. It can contain as few as 5 people or as many as 40 depending on how its used.
Different styles of group lending - Joint-Liability Group, Grameen Model (Center-Group), Self-Help Groups, Village/Communal Banks)
@@ -5709,7 +5701,7 @@ Request Body:
Disassociate Clients
This API allows to disassociate clients from a group.
- Disassociating a client with group loans results in an error.
+ Disassociating a client with active joint liability group loans results in an error.
@@ -5985,8 +5977,8 @@ Request Body:
Assign a Staff
- Allows you to assign Staff for existed Group.
- The selected Staff member should be belongs to the group's office.
+ Allows you to assign Staff to an existing Group.
+ The selected Staff should be belong to the same office (or an office higher up in the hierarchy) as this group
POST https://Domain Name/api/v1/groups/{groupId}?command=assignStaff
@@ -6012,8 +6004,8 @@ Request Body:
Close a Group
- Groups can be closed if they don't have any non-closed clients/loans/savingsAccounts and This API exists to close a group.
- If the group have any corresponding active clients/loans/savingsAccount this API will result in an error.
+ This API exists to close a group. Groups can be closed if they don't have any non-closed clients/loans/savingsAccounts.
+ If the group has any active clients/loans/savingsAccount, this API will result in an error.
POST https://Domain Name/api/v1/groups/{groupId}?command=close
@@ -6040,8 +6032,8 @@ Request Body:
Assign a Role
- Allows you to assign Role for existed member of group.
- We can define member roles by adding code values to GROUPROLE code. Example:Group leader etc.
+ Allows you to assign a Role to an existing member of a group.
+ We can define the different roles applicable to group members by adding code values to the pre-defined system code GROUPROLE. Example:Group leader etc.
POST https://Domain Name/api/v1/groups/{groupId}?command=assignRole
@@ -6067,7 +6059,7 @@ Request Body:
Unassign a Role
- Allows you to unassign the member Role.
+ Allows you to unassign Roles associated tp Group members.
POST https://Domain Name/api/v1/groups/{groupId}?command=unassignRole&roleId=1
@@ -6111,33 +6103,6 @@ Request Body:
-
-
- Close a Client
- Clients can be closed if they dont have any non-closed loans/savingsAccount. This API exists to close a client .
- If the client have any corresponding active loans/savingsAccount this API will result in an error.
-
-
- POST https://Domain Name/api/v1/clients/{clientId}?command=close
- POST clients/1?command=close
- Content-Type: application/json
- Request Body:
- {
- "dateFormat":"dd MMMM yyyy",
- "locale":"en",
- "closureDate":"25 June 2013",
- "closureReasonId":"11"
- }
-
-
- {
- "clientId":15,
- "resourceId":15
- }
-
-
-
-
@@ -6148,7 +6113,7 @@ Request Body:
groups/1?associations=clientMembers
- Group with no clientMembers information requested.
+ Group without details of Client associations.
GET https://DomainName/mifosng-provider/api/v1/groups/1
@@ -6174,7 +6139,7 @@ GET https://DomainName/mifosng-provider/api/v1/groups/1
- Group with clientMembers.
+ Group along with all its Clients.
GET https://DomainName/mifosng-provider/api/v1/groups/1?associations=clientMembers
@@ -6224,8 +6189,7 @@ GET https://DomainName/mifosng-provider/api/v1/groups/1?associations=clientMembe
Retrieve Group accounts overview
- An example of how a loan portfolio summary can be provided. This
- is requested in a specific use case of the reference application.
It is quite reasonable to add resources like this to simplify User Interface development.
+ Retrieves details of all Loan and Savings accounts associated with this group.
Example Requests:
groups/1/accounts
@@ -6479,7 +6443,7 @@ Request Body:
Delete a Group
- A group can be deleted if it is in pending state and has nothing associated with it - groups, loans, savings etc
+ A group can be deleted if it is in pending state and has no associations - clients, loans or savings
@@ -6502,7 +6466,7 @@ DELETE groups/2
List Groups
- The default implementation of list results into 200 entries with optional support for pagination and sorting. The parameter limit with value -1 will return all entries.
+ The default implementation of listing Groups returns 200 entries with support for pagination and sorting. Using the parameter limit with value -1 returns all entries.
Optional Arguments
- paged
@@ -6806,13 +6770,13 @@ GET https://DomainName/mifosng-provider/api/v1/groups?paged=true
An enumeration that indicates the type of transaction processing strategy to be used. This relates to functionality that is also known as Payment Application Logic.
-A number of out of the box appraches exist, some are custom to specific MFIs, some are more general and indicate the order in which payments are processed.
+A number of out of the box approaches exist, some are custom to specific MFIs, some are more general and indicate the order in which payments are processed.
Refer to the Payment Application Logic / Transaction Processing Strategy section in the appendix for more detailed overview of each available payment application logic provided out of the box.
List of current approaches:
- - 1 = Mifos style (Similiar to Old Mifos)
+ - 1 = Mifos style (Similar to Old Mifos)
- 2 = Heavensfamily (Custom MFI approach)
- 3 = Creocore (Custom MFI approach)
- 4 = RBI (India)
@@ -8522,7 +8486,7 @@ No Request Body:
Loan Transactions
- Capabilities include loan repayment's, interest waivers and the ability to 'adjust' an existing transaction. An 'adjust'ment of a transaction is really a 'reversal' of existing transaction followed by creation of a new transaction with the provided details.
+ Capabilities include loan repayment's, interest waivers and the ability to 'adjust' an existing transaction. An 'adjustment' of a transaction is really a 'reversal' of existing transaction followed by creation of a new transaction with the provided details.
Field Descriptions
@@ -8758,7 +8722,7 @@ Request Body:
Make Recovery Payment
- only applies to written-off loans
+ This API allows collecting recovery payments for written-off loans
@@ -9993,7 +9957,7 @@ No Request Body:
Loan Rescheduling
- Loan rescheduling provides the ability to give a client extra grace periods, extend loan term by adding extra installments and adjust the interest rate of a loan.
+ Loan rescheduling provides the ability to give clients extra grace periods, extend loan term by adding extra installments and adjust the interest rate of a loan.
Field Descriptions
@@ -10369,7 +10333,7 @@ Request Body:
Offices
- Offices are used to model an MFIs structure. A hierarchial
+
Offices are used to model an MFIs structure. A hierarchical
representation of offices is supported. There will always be at
least one office (which represents the MFI or an MFIs head
office). All subsequent offices added must have a parent office.
@@ -10608,7 +10572,7 @@ Request Body:
shortName
- Shortname associated with a loan product.
+ Short name associated with a loan product.
An abbreviated version of the name, used in reports or menus where space is limited, such as Collection Sheets.