THIS VERSION IS FOR HISTORICAL PURPOSES - FOR CURRENT SPECIFICATION, REFER TO:
MPESA Loan Repayments and Savings Deposits Functional Spec v2
M-PESA - Import Loan Repayments plus Savings Deposits
...
This feature is in the Admin section and will allow the User to import transactions
Use Cases
Administrator sets up order in which a transaction can applied
Actors
- Administrator
Preconditions
Basic Flow
- Administrator edits a properties file with new setting for order of products a transaction import is applied to. The products are listed with commas by short name.
Post-conditions
- All transactions imported as repayments/deposits are imported in this order unless product names are found in the import row.
Validations
- When import happens, validation will be done to try to import in this logic. If the accounts are not found, an error is thrown.
- If this property is not set, then all transaction rows with no other information on loan or savings accounts will thrown an error.
Accountant imports transactions (M-PESA) - file with no errors
...
- Accountant logs onto Mifos and navigates to the Admin section. Accountant selects Import transactions.
- Mifos displays new screen for Import Transactions.
- Accountant selects M-PESA for Import format, and selects file from their computer for import. Accountant clicks on
Continue
. - Mifos imports file and checks for any errors (see Validations below). If there are no errors, Mifos displays Review & Submit screen with "There are no errors found. Click Submit to continue with import.".
- Accountant clicks on
Submit
. Mifos displays confirmation screen that import was successful.
Post-conditions
- All data available in the file has been imported and all the correct tables and loan account data correctly populated.
...
- At step 4, Mifos determines there are errors from Validations above. Mifos displays Review & Submit screen with error messages depending on types of error.
- Accountant chooses to continue with import of the valid rows and clicks on
Submit
. Mifos displays confirmation screen that import was successful.
Post-conditions
- Valid rows are imported and invalid rows are rejected.
...
FR# | Pri | Description | Comments / Mockups |
---|---|---|---|
2.1 | P1 | Import format Field has option: MPESA |
|
2.2 | P1 | If there is no import plugin set, then the Import Format options will be blank and if the User tries to import a file and Continue, the following error message will be displayed at the top. Also if the User does not select a plugin even if there are options then the following error message will be displayed. |
|
2.3 | P1 | If there is no Mode of Payment configured in Mifos to be "MPESA/ZAP", then an error message will be thrown on the Import screen: |
|
Import File Details and Validations (M-PESA)
FR# | Pri | Description | Comments / Mockups |
---|---|---|---|
3.1 | P1 | M-PESA is an Excel format (97) |
|
3.2 | P1 | M-PESA import file first few lines contain description of file. These are to be ignored. Only data after row of column headings will be imported in the Transactions section. |
|
3.3 | P1 | Import file will have columns in below table |
|
3.4 | P1 | There will be bare basic error checking - to successfully import the data. |
|
3.5 | P1 | If a row contains a cell that's missing a required field, Mifos displays an error message for each row this occurs. |
|
3.6 | P1 | Dates are in the format YYYY-MM-DD HH:MM:ss. If any value under Date column does not start in format of YYYY-MM-DD, then Mifos displays an error message for each row this occurs. |
|
3.8 | P1 | If first value under the Transaction Party Details column does not contain an client Government ID that matches any client in Mifos and/or the next values do not correspond to a Loan Product or Savings Product in Mifos or does not match any open loan account or savings account where a payment/deposit can be applied to the client, or if the default order set in configuration cannot be applied in any way, Mifos throws an error message | See new attachment for example of import file and below for more details |
3.81 | P1 | Check that Status column says "Completed". If it has any other status, Mifos throws the following error message: |
|
3.9 | P1 | Check if the same file name has been imported. If so, then throw an error message and reject the whole import. |
|
3.10 | P1 | After clicking on Continue, Mifos will display the Review & Submit screen with the following: |
|
3.11 | P1 | User can then either
|
|
3.12 | P1 | If User clicks on Submit, Mifos imports the file and displays confirmation screen |
|
3.13 | P1 | There is no option to revert a file upload once it has been submitted. |
|
3.14 | P1 | There is no checking of duplicate rows (see 3.9) |
|
3.15 | P1 | Currency of values imported is directly inherited from the loan product that the loan account is mapped to. |
|
3.16 | P1 | If there are no rows found with import data, the following error message should be thrown: |
|
Anchor | ||||
---|---|---|---|---|
|
...
Column Name | Required | Description | Comments | Validations | Range | Example | Maps to Mifos |
---|---|---|---|---|---|---|---|
Receipt | No | Receipt ID | Receipt ID is exclusive to MPESA, we can ignore | None |
|
|
|
Date | Yes | Payment date |
| Validate date is in range (see above) | YYYY-MM-DD time | 2009-08-26 12:39:42 | Transaction Date |
Details | No | Contains information payment received from phone number, telephone number, MFI account number | Ignore |
|
|
|
|
Status | Yes | Completed | Check that Status says Completed. | Must be Completed to accept row. Other statuses throw an error | Completed, Attempted, Cancelled, Declined | Completed |
|
Withdrawn | No | Amount paid from MFI | Only use for Disbursals, Phase 2 |
|
| 00 |
|
Paid In | Yes | Transaction amount paid to MFI |
| Validate it's an amount and check same validations in Mifos against digits after decimal | Should be digits after decimal = 0 | 200 | Transaction amount |
Balance | No | Balance of MFI | Ignore |
|
| 520,499 |
|
Balance Confirmed | No | automatic check in system | Ignore |
|
| true |
|
Transaction Type | No |
| Ignore |
|
| Pay Utility |
|
Other Party Info | No | Phone number, telephone number | Ignore |
|
| 0722926212 - CYNTHIA OMONDI |
|
Transaction Party Details | Yes | "Client account number assigned by MFI" | We will use this to have Client National ID and include short names) of product(s) applied to the client's accounts if it is different than the default order set in ImportTransactionOrder | Validate that ID matches a client's in Mifos, and validate 3-4 letter codes corresponds to a loan or savings product in Mifos | Just client ID, to client ID plus product(s) | 1. 3029149635 | 1. Client's National ID |
...
FR# | Pri | Description | Comments / Mockups |
---|---|---|---|
4.1 | P1 | Assumption: All transaction detail is for loan repayments (loan fees, interest, principal) and/or savings deposits. There is no data in file for loan disbursals, savings withdrawals, client, group or center fees, or client attendance. |
|
4.2 | P1 | Date is actual repayment date recorded |
|
4.3 | P1 | For Loan Accounts: Amount that is being paid - pre-payments, partial payments, and over-payments if there are future installments are allowed. Amount in file is applied in the following order - Penalties, Fees, Interest, Principal. |
|
4.4 | P1 | Date cannot be before today in Mifos | If they have backdated transactions on, then date can be before today up til last meeting date |
4.5 | P1 | Mode of Payment must be configured in Mifos to have MPESA/ZAP, which will be the mode of payment used for all transactions in that import. |
|
4.6 | P1 | If there is an overpayment of the entire loan, Mifos should throw an error. |
|
4.7 | P1 | Default order of transactions is set in new setting in a properties file called ImportTransactionOrder. | Will the properties file reside with the plugin as a separate file or in the global properties file |
4.8 | P1 | If there is any product short name specified after the client ID, then the whole transaction amount should just be applied to that account. The product can be a loan or savings product. |
|
4.9 | P1 | Related to 4.7, it is not always necessary for the client to have accounts with all products set in the ImportTransactionOrder field. If the first account is not found, the plugin should continue to parse and skip to the next account. If NO accounts are found bearing any of the products listed in the ImportTransactionOrder , THEN an error should be thrown indicating accounts were not found. |
|
Other Assumptions
- Name payment mode = MPESA/ZAP
...
Does the user need to be in a particular user hierarchy to use this feature? | No |
Does the office hierarchy affect use of this feature? | No |
Are you using any existing permissions to control this feature? | No |
Are you adding any new permissions or changing existing permission to control this feature? | No - permission already added |
Are you using any existing activities to control this feature? | No |
Are you adding any new activities or changing existing activities to control this feature? | No |
Are there any special considerations for upgrade scenarios? What will be the default value for new permissions? | No special considerations. Default value is checked in ADMIN role and unchecked for all other roles. |
What will be the default values for default roles in a new installation? |
|
Impacts to System
Does this feature affect Bulk Loan Creation? How? | No |
Does this feature affect Collection Sheet Entry? How? | No |
Does this feature affect Redo Loans? | No |
Does this feature affect Undo Loans? | No |
|
|
Globalization/Localization
...
Will the feature be a high use-case scenario? | No |
Will the feature have potential for high concurrency? | No |
Does the feature include complex UI or data gathering logic that will be used by a significant portion of the user base? | No |
Does the feature contain risks of database connection timeout or ASP page timeout? |
|
Will the feature contain any bulk insert/update/delete transactions? |
|
Will the feature contain any caching mechanisms or cache refreshing mechanisms? | Unclear |
Could the feature result in a large amount of data being sent to the client or between the database and web server? | Yes |
Would users on a low bandwidth connection likely face issues with a part of this feature? | Depends on size of file |
Does the feature affect existing batch jobs or require adding any new batch jobs? | Unclear |
Setup and Installation
...
Open Questions and Notes
Answered
- Early payments
- Only disburse full amount - in the future hope to disburse in segments - won't have this use case this time
- Group and individual amounts
- GLIM off?
Fees
- 3 upfront 1 time fees that are assessed
o Client appraisal fixed amount, % amount, upfront insurance fee - sometimes fixed, sometimes % fee
o Legal Fee is at each account level
o Fees when clients go into default - Group fee - service charge charged at every meeting
- Disbursement will not include fees, fees are applied manually
No Excel sheet at M-PESA right now
...