diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm
index 97c85677c..d6e70d6c5 100644
--- a/api-docs/apiLive.htm
+++ b/api-docs/apiLive.htm
@@ -1030,25 +1030,46 @@
|
- | FIXED DEPOSITS |
+ FIXED DEPOSITS |
depositaccounts |
- Create a New Deposit
+ | Create a New Deposit
Application |
- List Deposit Applications |
+ |
|
|
|
depositaccounts/{accountId} |
- Approve, Undo Approve,
+ | Approve, Undo Approve,
Interest withdraw, Reject a Deposit Application or Withdraw a
Deposit Application |
- Retrieve a Deposit
+ | Retrieve a Deposit
Application |
- Update a Deposit
+ | |
+ Delete a Deposit
Application |
- Delete a Deposit
+ |
+
+
+ | SAVING ACCOUNTS |
+ savingaccounts |
+ Create a New Saving
+ Application |
+ |
+ |
+ |
+
+
+ |
+ savingaccounts/{accountId} |
+ Approve, Undo Approve,
+ Interest withdraw, Reject a Saving Application or Withdraw a
+ Saving Application |
+ Retrieve a Saving
+ Application |
+ |
+ Delete a Saving
Application |
@@ -2776,6 +2797,802 @@ Request Body:
+
+
+
+
+
+
Fixed Deposits :
+
+ Field Descriptions |
+ | deposit : |
+ | The amount to be deposit in the fixeddeposit. |
+ | externalId : |
+ A place to put an external reference for this fixeddeposit. e.g. The ID another system uses.
+ If provided, it must be unique. |
+
+ | tenureInMonths : |
+ | denotes the tenure period of depsoit account. |
+
+ | renewalAllowed : |
+ Whether the deposit account is eligible for renew after maturity.
+ If 'true' : renewalAllowed otherwise renewal not allowed. |
+
+ | isInterestWithdrawable : |
+ denotes whether for this deposit account interest is withdrawable or not
+ If true interest is withdrawable and 'interestCompoundingAllowed' is must be false. |
+
+ | interestCompoundingAllowed : |
+ denotes interestCompounding is allowed or not for a deposit account
+ If 'false' on simple interest basis the interest is calculated |
+
+ | maturityInterestRate : |
+ Interest rate applicable on deposit amount upto maturity date,
+ after maturrity if the account is not closed 'preClosureInterestRate' is applicable on deposit amount |
+
+ | preClosureInterestRate : |
+ Interest rate applicable on deposit amount if the account is closed before maturity date,
+ and after maturity of account if it is not closed or renewed this interest rate is applicable. |
+
+ | interestCompoundedEvery : |
+ | Interest is calculated on deposit account for every interestCompoundedEvery period |
+
+ | lockinPeriod : |
+ | With in a lockinperiod, the deposit account cannot be preclosed |
+
+
+
+
+
+
+
Retrieve Fixeddeposit Details Template :
+
This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of:
+
+ - Field Defaults
+ - Allowed Value Lists
+
+
+
Arguments
+
+ - clientId
+ - Integer mandatory
+ - productId
+ - Integer optional
+ - If entered, productId, productName and selectedProduct fields are returned.
+
+
Example Requests:
+
depositaccounts/template?clientId=17&productId=1
+
+
depositaccounts/template?clientId=17
+
+
+ GET https://Domain Name/api/v1/depositaccounts/template
+{
+ "clientId": 17,
+ "clientName": "Agri",
+ "productId": 1,
+ "productName": "Micro Savings",
+ "currency": {
+ "code": "INR",
+ "name": "",
+ "decimalPlaces": 2,
+ "displaySymbol": "",
+ "nameCode": "",
+ "displayLabel": " [INR]"
+ },
+ "deposit": 200.000000,
+ "maturityInterestRate": 12.000000,
+ "tenureInMonths": 0,
+ "projectedCommencementDate": [2013,
+ 1,
+ 30],
+ "interestCompoundedEvery": 6,
+ "interestCompoundedEveryPeriodType": {
+ "id": 2,
+ "code": "deposit.interest.compounding.period.periodFrequencyType.months",
+ "value": "Months"
+ },
+ "renewalAllowed": true,
+ "preClosureAllowed": true,
+ "preClosureInterestRate": 5.000000,
+ "isInterestWithdrawable": false,
+ "interestCompoundingAllowed": false,
+ "interestCompoundedEveryPeriodTypeOptions": [{
+ "id": 2,
+ "code": "deposit.interest.compounding.period.periodFrequencyType.months",
+ "value": "Months"
+ }],
+ "productOptions": [{
+ "id": 5,
+ "name": "fgretgr"
+ },
+ {
+ "id": 1,
+ "name": "Micro Savings"
+ },
+ {
+ "id": 4,
+ "name": "PlusOne Deposit"
+ }],
+ "availableInterestForWithdrawal": 0,
+ "availableWithdrawalAmount": 0,
+ "todaysDate": [2013,
+ 1,
+ 30],
+ "isLockinPeriodAllowed": true,
+ "lockinPeriod": 0,
+ "lockinPeriodType": {
+ "id": 2,
+ "code": "deposit.interest.compounding.period.periodFrequencyType.months",
+ "value": "Months"
+ },
+ "availableInterest": 0,
+ "interestPostedAmount": 0
+}
+
+
+
+
+
Retrieve a fixeddeposit:
+
+
Arguments
+
+ - associations
+ - optional, 'all' deposit associations are itemised below
+
Associations are just extra pieces of data that you might or might not want to retrieve.
- 'all': Gets all association data.
+ - 'permissions': Data that describes what things can happen to the deposit in its current state.
+ Very specific to the needs of the current Individual Lending client application.
+
+
Example Requests:
+
depositaccounts/1
+
+
depositaccounts/1?associations=all
+
+
+ GET https://DomainName/api/v1/depositaccounts/{depositaccountId}
+ {
+{
+ "id": 5,
+ "status": {
+ "id": 100,
+ "code": "depositStatusType.submitted.and.pending.approval",
+ "value": "Submitted and pending approval"
+ },
+ "clientId": 17,
+ "clientName": "Agri",
+ "productId": 1,
+ "productName": "Micro Savings",
+ "currency": {
+ "code": "INR",
+ "name": "Indian Rupee",
+ "decimalPlaces": 2,
+ "nameCode": "currency.INR",
+ "displayLabel": "Indian Rupee [INR]"
+ },
+ "deposit": 200.000000,
+ "maturityInterestRate": 12.000000,
+ "tenureInMonths": 12,
+ "projectedCommencementDate": [2012, 12, 16],
+ "maturedOn": [2013, 12, 15],
+ "projectedInterestAccrued": 24.000000,
+ "projectedMaturityAmount": 224.000000,
+ "interestCompoundedEvery": 6,
+ "interestCompoundedEveryPeriodType": {
+ "id": 2,
+ "code": "deposit.interest.compounding.period.periodFrequencyType.months",
+ "value": "Months"
+ },
+ "renewalAllowed": true,
+ "preClosureAllowed": true,
+ "preClosureInterestRate": 5.000000,
+ "isInterestWithdrawable": true,
+ "interestPaid": 0.000000,
+ "interestCompoundingAllowed": false,
+ "permissions": {
+ "rejectAllowed": true,
+ "withdrawnByApplicantAllowed": true,
+ "undoApprovalAllowed": false,
+ "pendingApproval": true,
+ "isInterestWithdrawalAllowed": true,
+ "renewelAllowed": false,
+ "isMaturedDepositAccount": false,
+ "anyActionOnAccountAllowed": true
+ },
+ "availableInterestForWithdrawal": 0,
+ "availableWithdrawalAmount": 200.000000,
+ "todaysDate": [2013, 1, 30],
+ "isLockinPeriodAllowed": true,
+ "lockinPeriod": 0,
+ "lockinPeriodType": {
+ "id": 2,
+ "code": "deposit.interest.compounding.period.periodFrequencyType.months",
+ "value": "Months"
+ },
+ "availableInterest": 0.000000,
+ "interestPostedAmount": 0.000000,
+ "imageKey": "/root/.mifosx/DefaultDemoTenant/images/clients/33/places.png"
+}
+}
+
+
+
+
+
Create a New DepositAccount / Submit a DepositAccount Application
+
Arguments
+
+ - command
+ - String Optional, case-insensitive
+ - The default action is to Submit a New DepositAccount Application ("Submitted and awaiting approval" status).
+
+
+
+ Mandatory Fields |
+ | clientId, productId, deposit, maturityInterestRate, commencementDate |
+
+
+
+ POST https://Domain Name/api/v1/depositaccounts
+ POST depositaccount
+Content-Type: application/json
+Request Body:
+{
+ "clientId": "17",
+ "dateFormat": "dd MMMM yyyy",
+ "locale": "en",
+ "productId": "1",
+ "commencementDate": "25 January 2013",
+ "externalId": "123",
+ "deposit": "20000",
+ "tenureInMonths": "3",
+ "renewalAllowed": "true",
+ "preClosureAllowed": "true",
+ "interestCompoundingAllowed": "false",
+ "isInterestWithdrawable": "true",
+ "isLockinPeriodAllowed": "true",
+ "maturityInterestRate": "12",
+ "preClosureInterestRate": "5",
+ "interestCompoundedEvery": "6",
+ "interestCompoundedEveryPeriodType": "2",
+ "lockinPeriod": "1",
+ "lockinPeriodType": "2"
+}
+
+
+ {
+ "resourceId": 42
+}
+
+
+
+
+
Approval, Reject or Withdraw a DepositAccount Application
+
Arguments
+
+ - command
+ - String Mandatory, case-insensitive
+ - 'approve' : Approve DepositAccount
+ - 'reject' : Reject DepositAccount
+ - 'withdrewbyclient' : Client Withdrew DepositAccount Application
+ - Deposit amount
+ - IntegerMandatory
+ - Deposit interest rate
+ - IntegerMandatory
+ - Tenure month
+ - IntegerMandatory
+ - Interest posted every
+ - IntegerMandatory
+
+
+
+ Mandatory Fields |
+ | eventDate |
+
+
+
+ POST https://DomainName/api/v1/depositaccounts/{depositaccountId}
+ POST depositaccounts/1?command=reject
+Content-Type: application/json
+Request Body:
+{
+ "dateFormat": "dd MMMM yyyy",
+ "eventDate": "07 May 2012",
+ "note": "and event note is added"
+}
+
+{
+"resourceId": 37
+}
+
+
+
+
+
Delete a DepositAccount
+
+ Note: depositaccount is deleted.
+
+
+
+ DELETE https://Domain Name/api/v1/depositaccounts/{depositaccountsId}
+ DELETE depositaccounts/1
+Content-Type: application/json
+No Request Body:
+
+ {
+"resourceId": 1
+}
+
+
+
+
+
Saving Account :
+
+ Field Descriptions |
+ | savingsDepositAmountPerPeriod : |
+ The amount to be depositd in the savingaccount for every period.
+ If the account is regular account enter what ever the amount you want to deposit |
+ | externalId : |
+ A place to put an external reference for this savingaccount. e.g. The ID another system uses.
+ If provided, it must be unique. |
+
+ | tenure : |
+ | denotes the tenure period of savings account |
+
+ | depositEvery : |
+ | For every 'depositEvery' period the client has to deposit 'savingsDepositAmountPerPeriod' amount |
+
+ | interestCalculationMethod: |
+ denotes on what basis the interest is calculated
+ e.g. AverageBal,Monthly Collection etc |
+
+ | recurringInterestRate : |
+ | The interest rate applicable on recurring deposit savingaccounts |
+
+ | savingInterestRate : |
+ | The interest rate applicable on regular savingaccounts |
+
+ | interestPostEvery: |
+ | Denotes for how many months the interest is posted for recurring/regular saving accounts |
+
+ | lockinPeriod : |
+ | With in a lockin period you cannot withdraw whole money(cannot Preclose) |
+
+
+
+
+
+
Retrieve SavingAccount Details Template :
+
This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of:
+
+ - Field Defaults
+ - Allowed Value Lists
+
+
+
Arguments
+
+ - clientId
+ - Integer mandatory
+ - productId
+ - Integer optional
+ - If entered, productId, productName and selectedProduct fields are returned.
+
+
Example Requests:
+
savingaccounts/template?clientId=25&productId=5
+
+
savingaccounts/template?clientId=25
+
+
+ GET https://Domain Name/api/v1/savingaccounts/template
+{
+ "clientId": 25,
+ "clientName": "Clark Kent",
+ "productId": 5,
+ "productName": "Shares",
+ "productType": {
+ "id": 2,
+ "code": "savings.product.savingProductType.regular",
+ "value": "Regular"
+ },
+ "currencyData": {
+ "code": "ZAR",
+ "name": "South African Rand",
+ "decimalPlaces": 2,
+ "displaySymbol": "R",
+ "nameCode": "currency.ZAR",
+ "displayLabel": "South African Rand (R)"
+ },
+ "savingsDepositAmountPerPeriod": 500.000000,
+ "savingsFrequencyType": {
+ "id": 2,
+ "code": "saving.product.frequency.period.savingFrequencyType.monthly",
+ "value": "Months"
+ },
+ "recurringInterestRate": 12.000000,
+ "savingInterestRate": 12.000000,
+ "interestType": {
+ "id": 2,
+ "code": "savings.interest.type.savingsInterestType.compounding",
+ "value": "Compounding"
+ },
+ "interestCalculationMethod": {
+ "id": 1,
+ "code": "savings.interestCalculation.method.savinginterest.calculation.method.averagebal",
+ "value": "AverageBalance"
+ },
+ "tenure": 12,
+ "tenureType": {
+ "id": 1,
+ "code": "savings.tenure.tenureTypeEnum.fixedPeriod",
+ "value": "FixedPeriod"
+ },
+ "projectedCommencementDate": [2013,
+ 2,
+ 1],
+ "preClosureAllowed": true,
+ "isLockinPeriodAllowed": false,
+ "lockinPeriod": 0,
+ "lockinPeriodType": {
+ "id": 2,
+ "code": "deposit.interest.compounding.period.periodFrequencyType.months",
+ "value": "Months"
+ },
+ "depositEvery": 1,
+ "productOptions": [{
+ "id": 4,
+ "name": "sb01"
+ },
+ {
+ "id": 5,
+ "name": "Shares"
+ }],
+ "currencyOptions": [{
+ "code": "ZAR",
+ "name": "South African Rand",
+ "decimalPlaces": 2,
+ "displaySymbol": "R",
+ "nameCode": "currency.ZAR",
+ "displayLabel": "South African Rand (R)"
+ },
+ {
+ "code": "VND",
+ "name": "Vietnamese Dong",
+ "decimalPlaces": 2,
+ "nameCode": "currency.VND",
+ "displayLabel": "Vietnamese Dong [VND]"
+ }],
+ "savingsProductTypeOptions": [{
+ "id": 1,
+ "code": "savings.product.savingProductType.reccuring",
+ "value": "Recurring"
+ },
+ {
+ "id": 2,
+ "code": "savings.product.savingProductType.regular",
+ "value": "Regular"
+ }],
+ "tenureTypeOptions": [{
+ "id": 1,
+ "code": "savings.tenure.tenureTypeEnum.fixedPeriod",
+ "value": "FixedPeriod"
+ },
+ {
+ "id": 2,
+ "code": "savings.tenure.tenureTypeEnum.perpetual",
+ "value": "Perpetual"
+ }],
+ "savingFrequencyOptions": [{
+ "id": 2,
+ "code": "saving.product.frequency.period.savingFrequencyType.monthly",
+ "value": "Months"
+ }],
+ "savingsInterestTypeOptions": [{
+ "id": 1,
+ "code": "savings.interest.type.savingsInterestType.simple",
+ "value": "Simple"
+ },
+ {
+ "id": 2,
+ "code": "savings.interest.type.savingsInterestType.compounding",
+ "value": "Compounding"
+ }],
+ "lockinPeriodTypeOptions": [{
+ "id": 2,
+ "code": "savings.product.lockin.period.type.months",
+ "value": "Months"
+ }],
+ "interestCalculationOptions": [{
+ "id": 1,
+ "code": "savings.interestCalculation.method.savinginterest.calculation.method.averagebal",
+ "value": "AverageBalance"
+ },
+ {
+ "id": 3,
+ "code": "savings.interestCalculation.method.savinginterest.calculation.method.monthlycllection",
+ "value": "MonthlyCollection"
+ }],
+ "outstandingAmount": 0,
+ "dueAmount": 0,
+ "interestPostEvery": 3,
+ "interestPostFrequency": {
+ "id": 2,
+ "code": "saving.product.frequency.period.savingFrequencyType.monthly",
+ "value": "Months"
+ }
+}
+
+
+
+
+
+
Retrieve a SavingAccount :
+
+ Note: template=true parameter doesn't apply to this resource.
+
+
Arguments
+
+ - associations
+ - optional, Either 'all' or a comma separated list of savings 'associations' (itemised below).
+
Associations are just extra pieces of data that you might or might not want to retrieve.
- 'all': Gets all association data.
+ - 'permissions': Data that describes what things can happen to the saving account in its current state.
+ Very specific to the needs of the current Individual Lending client application.
+ - 'savingScheduleData': Some derived data that
+ - 'transactions' : Some data
+
+
Example Requests :
+
savingaccounts/15
+
+
savingaccounts/15?associations=all
+
+
+ GET https://DomainName/api/v1/savingaccounts/{savingaccountId}
+ {
+ "id": 15,
+ "status": {
+ "id": 100,
+ "code": "depositStatusType.submitted.and.pending.approval",
+ "value": "Submitted and pending approval"
+ },
+ "externalId": "23",
+ "clientId": 50,
+ "clientName": "Brendan Fahy",
+ "productId": 4,
+ "productName": "sb01",
+ "productType": {
+ "id": 2,
+ "code": "savings.product.savingProductType.regular",
+ "value": "Regular"
+ },
+ "currencyData": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "savingsDepositAmountPerPeriod": 200.000000,
+ "savingsFrequencyType": {
+ "id": 2,
+ "code": "saving.product.frequency.period.savingFrequencyType.monthly",
+ "value": "Months"
+ },
+ "totalDepositAmount": 0.000000,
+ "recurringInterestRate": 4.000000,
+ "savingInterestRate": 4.000000,
+ "interestType": {
+ "id": 1,
+ "code": "savings.interest.type.savingsInterestType.simple",
+ "value": "Simple"
+ },
+ "interestCalculationMethod": {
+ "id": 1,
+ "code": "savings.interestCalculation.method.savinginterest.calculation.method.averagebal",
+ "value": "AverageBalance"
+ },
+ "tenure": 12,
+ "tenureType": {
+ "id": 1,
+ "code": "savings.tenure.tenureTypeEnum.fixedPeriod",
+ "value": "FixedPeriod"
+ },
+ "projectedCommencementDate": [2013,
+ 2,
+ 1],
+ "projectedInterestAccuredOnMaturity": 0.000000,
+ "actualInterestAccured": 0.000000,
+ "projectedMaturityAmount": 200.000000,
+ "actualMaturityAmount": 0.000000,
+ "preClosureAllowed": false,
+ "preClosureInterestRate": 0.000000,
+ "isLockinPeriodAllowed": false,
+ "lockinPeriod": 0,
+ "lockinPeriodType": {
+ "id": 2,
+ "code": "savings.product.lockin.period.type.months",
+ "value": "Months"
+ },
+ "depositEvery": 1,
+ "permissions": {
+ "rejectAllowed": true,
+ "withdrawnByApplicantAllowed": true,
+ "undoApprovalAllowed": false,
+ "pendingApproval": true,
+ "renewelAllowed": false,
+ "isMaturedDepositAccount": false,
+ "anyActionOnAccountAllowed": true
+ },
+ "outstandingAmount": 0.000000,
+ "savingScheduleData": {
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "cumulativeDepositDue": 200.0000,
+ "cumulativeDepositPaid": 0.0000,
+ "cummulativeInterestAccured": 0.0000,
+ "periods": [{
+ "period": 1,
+ "dueDate": [2013,
+ 3,
+ 1],
+ "depositDue": 200.0000,
+ "depositPaid": 0.0000,
+ "interestAccured": 0.0000
+ }]
+ },
+ "transactions": [],
+ "interestPostEvery": 3,
+ "interestPostFrequency": {
+ "id": 2,
+ "code": "saving.product.frequency.period.savingFrequencyType.monthly",
+ "value": "Months"
+ }
+}
+
+
+
+
+
Create a New SavingAccount / Submit a SavingAccount Application
+
Arguments
+
+ - command
+ - String Optional, case-insensitive
+ - The default action is to Submit a New SavingAccount Application ("Submitted and awaiting approval" status).
+
+
+
+ Mandatory Fields |
+ | clientId, productId, savingsDepositAmountPerPeriod, tenureMonths, depositEvery, interestCalculationMethod, recurringInterestRate, commencementDate, interestPostEvery |
+
+
+
+ POST https://Domain Name/api/v1/savingaccounts
+ POST savingaccount
+Content-Type: application/json
+Request Body:
+{
+ "clientId": "17",
+ "dateFormat": "dd MMMM yyyy",
+ "locale": "en",
+ "currencyCode": "ZAR",
+ "digitsAfterDecimal": "2",
+ "productId": "5",
+ "commencementDate": "05 February 2013",
+ "externalId": "",
+ "savingsDepositAmountPerPeriod": "500",
+ "minimumBalanceForWithdrawal": "100",
+ "tenure": "12",
+ "tenureType": "1",
+ "depositEvery": "1",
+ "frequency": "2",
+ "isLockinPeriodAllowed": "false",
+ "isPartialDepositAllowed": "false",
+ "interestCalculationMethod": "1",
+ "recurringInterestRate": "12",
+ "interestType": "2",
+ "savingInterestRate": "12",
+ "interestPostEvery": "3",
+ "interestPostFrequency": "2",
+ "lockinPeriod": "0",
+ "lockinPeriodType": "2"
+}
+ {
+ "resourceId": 42
+}
+
+
+
+
+
Approval, Reject or Withdraw a SavingAccount Application
+
Arguments
+
+ - command
+ - String Mandatory, case-insensitive
+ - 'approve' : Approve SavingAccount
+ - 'reject' : Reject SavingAccount
+ - 'withdrewbyclient' : Client Withdrew SavingAccount Application
+
+
+
+ Mandatory Fields |
+ | eventDate |
+
+
+
+ POST https://Domain Name/api/v1/savingaccounts/{savingaccountId}
+ POST savingaccounts/1?command=reject
+Content-Type: application/json
+Request Body:
+{
+ "dateFormat": "dd MMMM yyyy",
+ "eventDate": "07 May 2012",
+ "note": "and event note is added"
+}
+
+{
+"resourceId": 37
+}
+
+
+
+
+
Delete a SavingAccount
+
+ Note: savingaccount is deleted.
+
+
+
+ DELETE https://Domain Name/api/v1/savingaccounts/{savingaccountsId}
+ DELETE savingaccounts/1
+Content-Type: application/json
+No Request Body:
+
+ {
+"resourceId": 1
+}
+
+
+