diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index b5b18b1f3..8de5d816e 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -292,7 +292,7 @@
The list capability of loans can support pagination and sorting.
+Example Requests:
+
+GET https://DomainName/mifosng-provider/api/v1/loans
+
+
+{
+ "totalFilteredRecords": 1,
+ "pageItems": [
+ {
+ "id": 1,
+ "accountNo": "000000001",
+ "status": {
+ "id": 300,
+ "code": "loanStatusType.active",
+ "value": "Active",
+ "pendingApproval": false,
+ "waitingForDisbursal": false,
+ "active": true,
+ "closedObligationsMet": false,
+ "closedWrittenOff": false,
+ "closedRescheduled": false,
+ "closed": false,
+ "overpaid": false
+ },
+ "clientId": 1,
+ "clientName": "Change To IndividualName",
+ "clientOfficeId": 1,
+ "loanProductId": 1,
+ "loanProductName": "AgriCredit",
+ "loanProductDescription": "test",
+ "loanType": {
+ "id": 1,
+ "code": "loanType.individual",
+ "value": "Individual"
+ },
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "principal": 10000,
+ "termFrequency": 12,
+ "termPeriodFrequencyType": {
+ "id": 2,
+ "code": "termFrequency.periodFrequencyType.months",
+ "value": "Months"
+ },
+ "numberOfRepayments": 12,
+ "repaymentEvery": 1,
+ "repaymentFrequencyType": {
+ "id": 2,
+ "code": "repaymentFrequency.periodFrequencyType.months",
+ "value": "Months"
+ },
+ "interestRatePerPeriod": 2,
+ "interestRateFrequencyType": {
+ "id": 2,
+ "code": "interestRateFrequency.periodFrequencyType.months",
+ "value": "Per month"
+ },
+ "annualInterestRate": 24,
+ "amortizationType": {
+ "id": 1,
+ "code": "amortizationType.equal.installments",
+ "value": "Equal installments"
+ },
+ "interestType": {
+ "id": 0,
+ "code": "interestType.declining.balance",
+ "value": "Declining Balance"
+ },
+ "interestCalculationPeriodType": {
+ "id": 1,
+ "code": "interestCalculationPeriodType.same.as.repayment.period",
+ "value": "Same as repayment period"
+ },
+ "transactionProcessingStrategyId": 2,
+ "timeline": {
+ "submittedOnDate": [
+ 2012,
+ 6,
+ 1
+ ],
+ "submittedByUsername": "mifos",
+ "submittedByFirstname": "App",
+ "submittedByLastname": "Administrator",
+ "approvedOnDate": [
+ 2012,
+ 6,
+ 1
+ ],
+ "approvedByUsername": "mifos",
+ "approvedByFirstname": "App",
+ "approvedByLastname": "Administrator",
+ "expectedDisbursementDate": [
+ 2012,
+ 6,
+ 1
+ ],
+ "actualDisbursementDate": [
+ 2012,
+ 6,
+ 1
+ ],
+ "disbursedByUsername": "mifos",
+ "disbursedByFirstname": "App",
+ "disbursedByLastname": "Administrator",
+ "expectedMaturityDate": [
+ 2013,
+ 6,
+ 1
+ ]
+ },
+ "summary": {
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "principalDisbursed": 10000,
+ "principalPaid": 3073.07,
+ "principalWrittenOff": 0,
+ "principalOutstanding": 6926.93,
+ "principalOverdue": 5999.92,
+ "interestCharged": 1347.15,
+ "interestPaid": 709.33,
+ "interestWaived": 0,
+ "interestWrittenOff": 0,
+ "interestOutstanding": 637.82,
+ "interestOverdue": 619.28,
+ "feeChargesCharged": 0,
+ "feeChargesDueAtDisbursementCharged": 0,
+ "feeChargesPaid": 0,
+ "feeChargesWaived": 0,
+ "feeChargesWrittenOff": 0,
+ "feeChargesOutstanding": 0,
+ "feeChargesOverdue": 0,
+ "penaltyChargesCharged": 0,
+ "penaltyChargesPaid": 0,
+ "penaltyChargesWaived": 0,
+ "penaltyChargesWrittenOff": 0,
+ "penaltyChargesOutstanding": 0,
+ "penaltyChargesOverdue": 0,
+ "totalExpectedRepayment": 11347.15,
+ "totalRepayment": 3782.4,
+ "totalExpectedCostOfLoan": 1347.15,
+ "totalCostOfLoan": 709.33,
+ "totalWaived": 0,
+ "totalWrittenOff": 0,
+ "totalOutstanding": 7564.75,
+ "totalOverdue": 6619.2,
+ "overdueSinceDate": [
+ 2012,
+ 11,
+ 1
+ ]
+ },
+ "feeChargesAtDisbursementCharged": 0
+ }
+ ]
+}
+
+