From 36197b4fe3a352a084e1fa3e337c8b469e4684a5 Mon Sep 17 00:00:00 2001 From: Keith Woodlock Date: Wed, 6 Feb 2013 00:09:27 +0000 Subject: [PATCH] fix up formating on api-docs. --- api-docs/apiLive.htm | 2458 +++++++++++++++++++++++++++++++++--------- 1 file changed, 1972 insertions(+), 486 deletions(-) diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index 11ef3c69c..97c85677c 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -2471,19 +2471,39 @@ GET https://DomainName/api/v1/loans/{loanId} POST https://DomainName/api/v1/loans - POST loans Content-Type: - application/json Request Body: { "dateFormat": "dd MMMM yyyy", - "locale": "en_GB", "clientId": 1, "productId": 1, "principal": - "100,000.00", "loanTermFrequency": 12, "loanTermFrequencyType": 2, - "numberOfRepayments": 12, "repaymentEvery": 1, - "repaymentFrequencyType": 2, "interestRatePerPeriod": 2, - "interestRateFrequencyType": 2, "amortizationType": 1, - "interestType": 0, "interestCalculationPeriodType": 1, - "expectedDisbursementDate": "20 September 2011", - "submittedOnDate": "20 September 2011", - "transactionProcessingStrategyId": 1 } - { "officeId": 1, "clientId": - 1, "loanId": 1, "resourceId": 1 } + +POST loans +Content-Type: application/json +Request Body: +{ + "dateFormat": "dd MMMM yyyy", + "locale": "en_GB", + "clientId": 1, + "productId": 1, + "principal": "100,000.00", + "loanTermFrequency": 12, + "loanTermFrequencyType": 2, + "numberOfRepayments": 12, + "repaymentEvery": 1, + "repaymentFrequencyType": 2, + "interestRatePerPeriod": 2, + "interestRateFrequencyType": 2, + "amortizationType": 1, + "interestType": 0, + "interestCalculationPeriodType": 1, + "expectedDisbursementDate": "20 September 2011", + "submittedOnDate": "20 September 2011", + "transactionProcessingStrategyId": 1 +} + + +{ + "officeId": 1, + "clientId": 1, + "loanId": 1, + "resourceId": 1 +} + @@ -2520,15 +2540,36 @@ POST https://DomainName/api/v1/loans POST https://DomainName/api/v1/loans/{loanId} - POST loans/1?command=approve - Content-Type: application/json Request Body: { "locale": "en", - "dateFormat": "dd MMMM yyyy", "eventDate": "20 September 2011", - "note": "and event note is added" } - { "officeId": 1, "clientId": - 1, "loanId": 2, "resourceId": 2, "changes": { "status": { "id": - 200, "code": "loanStatusType.approved", "value": "Approved" }, - "locale": "en", "dateFormat": "dd MMMM yyyy", "approvedOnDate": - "20 September 2011", "note": "and event note is added" } } + +POST loans/1?command=approve +Content-Type: application/json +Request Body: +{ + "locale": "en", + "dateFormat": "dd MMMM yyyy", + "eventDate": "20 September 2011", + "note": "and event note is added" +} + + +{ + "officeId": 1, + "clientId": 1, + "loanId": 2, + "resourceId": 2, + "changes": { + "status": { + "id": 200, + "code": "loanStatusType.approved", + "value": "Approved" + }, + "locale": "en", + "dateFormat": "dd MMMM yyyy", + "approvedOnDate": "20 September 2011", + "note": "and event note is added" + } +} +   @@ -2544,10 +2585,19 @@ POST https://DomainName/api/v1/loans/{loanId} DELETE https://DomainName/api/v1/loans/{loanId} - DELETE loans/1 Content-Type: - application/json No Request Body: - { "officeId": 1, "clientId": - 1, "loanId": 1, "resourceId": 1 } + +DELETE loans/1 +Content-Type: application/json +No Request Body: + + +{ + "officeId": 1, + "clientId": 1, + "loanId": 1, + "resourceId": 1 +} + @@ -2584,19 +2634,37 @@ DELETE https://DomainName/api/v1/loans/{loanId}

Example Request:

-
loans/10/transactions/template?command=repayment
+
loans/1/transactions/template?command=repayment
GET https://DomainName/api/v1/loans/{loanId}/transactions/template" - { "transactionType" : { "id" : - 2, "code" : "loanTransactionType.repayment", "value" : "Repayment" - }, "date" : [ 2009, 8, 1 ], "total" : { "currencyCode" : "XOF", - "digitsAfterDecimal" : 0, "amount" : 471, "defaultName" : "CFA - Franc BCEAO", "nameCode" : "currency.XOF", "displaySymbol" : - "CFA", "zero" : false, "greaterThanZero" : true, - "displaySymbolValue" : "471 CFA" } } + +{ + "transactionType": { + "id": 2, + "code": "loanTransactionType.repayment", + "value": "Repayment" + }, + "date": [ + 2009, + 8, + 1 + ], + "total": { + "currencyCode": "XOF", + "digitsAfterDecimal": 0, + "amount": 471, + "defaultName": "CFA Franc BCEAO", + "nameCode": "currency.XOF", + "displaySymbol": "CFA", + "zero": false, + "greaterThanZero": true, + "displaySymbolValue": "471 CFA" + } +} +
POST https://DomainName/api/v1/loans/{loanId}/transactions - POST - loans/37/transactions?command=repayment Content-Type: - application/json Request Body: { "locale": "en_GB", "dateFormat": - "dd MMMM yyyy", "transactionDate": "14 May 2012", - "transactionAmount": "559.88", "note": "Repayment at branch" } + +POST loans/1/transactions?command=repayment +Content-Type: application/json +Request Body: +{ + "locale": "en_GB", + "dateFormat": "dd MMMM yyyy", + "transactionDate": "14 May 2012", + "transactionAmount": "559.88", + "note": "Repayment at branch" +} + { "resourceId": 37 } @@ -2632,18 +2707,34 @@ POST https://DomainName/api/v1/loans/{loanId}/transactions

Retrieve a Repayment or Waiver Details

Example Request:

-
loans/10/transactions/20
+
loans/1/transactions/2
GET https://DomainName/api/v1/loans/{loanId}/transactions/{transactionId} - { "id" : 10, "date" : [ 2009, - 1, 29 ], "total" : { "currencyCode" : "XOF", "digitsAfterDecimal" - : 0, "amount" : 300000, "defaultName" : "CFA Franc BCEAO", - "nameCode" : "currency.XOF", "displaySymbol" : "CFA", "zero" : - false, "greaterThanZero" : true, "displaySymbolValue" : "300000 - CFA" }, "transactionOffsetFromToday" : -1218 } + +{ + "id": 10, + "date": [ + 2009, + 1, + 29 + ], + "total": { + "currencyCode": "XOF", + "digitsAfterDecimal": 0, + "amount": 300000, + "defaultName": "CFA Franc BCEAO", + "nameCode": "currency.XOF", + "displaySymbol": "CFA", + "zero": false, + "greaterThanZero": true, + "displaySymbolValue": "300000 CFA" + }, + "transactionOffsetFromToday": -1218 +} +
POST https://DomainName/api/v1/loans/{loanId}/transactions/{transactionId} - POST loans/16/transactions/32 - Content-Type: application/json Request Body: { "locale": "en_GB", - "dateFormat": "dd MMMM yyyy", "transactionDate": "25 May 2012", - "transactionAmount": "50,000.00", "note": "adj note" } - { "resourceId": 16 } + +POST loans/1/transactions/2 +Content-Type: application/json +Request Body: +{ + "locale": "en_GB", + "dateFormat": "dd MMMM yyyy", + "transactionDate": "25 May 2012", + "transactionAmount": "50,000.00", + "note": "adj note" +} + + + { "resourceId": 16 } + @@ -2735,9 +2836,22 @@ POST https://DomainName/api/v1/loans/{loanId}/transactions/{transactionId} GET https://DomainName/api/v1/offices - [ { "id": 1, "name": "Head - Office", "nameDecorated": "Head Office", "externalId": "1", - "openingDate": [ 2009, 1, 1 ], "hierarchy": "." } ] + +[ + { + "id": 1, + "name": "Head Office", + "nameDecorated": "Head Office", + "externalId": "1", + "openingDate": [ + 2009, + 1, + 1 + ], + "hierarchy": "." + } +] + @@ -2762,9 +2876,22 @@ GET https://DomainName/api/v1/offices GET https://DomainName/api/v1/offices/template - { "openingDate": [2013,2,4], - "allowedParents": [ { "id": 1, "name": "Head Office", - "nameDecorated": "Head Office" } ] } + +{ + "openingDate": [ + 2013, + 2, + 4 + ], + "allowedParents": [ + { + "id": 1, + "name": "Head Office", + "nameDecorated": "Head Office" + } + ] +} + @@ -2786,9 +2913,20 @@ GET https://DomainName/api/v1/offices/template GET https://DomainName/api/v1/offices/1 - { "id": 1, "name": "Head - Office", "nameDecorated": "Head Office", "externalId": "1", - "openingDate": [2009,1,1], "hierarchy": "." } + +{ + "id": 1, + "name": "Head Office", + "nameDecorated": "Head Office", + "externalId": "1", + "openingDate": [ + 2009, + 1, + 1 + ], + "hierarchy": "." +} + @@ -2809,12 +2947,25 @@ GET https://DomainName/api/v1/offices/1 POST https://DomainName/api/v1/offices - POST offices Content-Type: - application/json Request Body: { "name": "Example New Branch", - "dateFormat": "dd MMMM yyyy", "locale": "en", "openingDate": "01 - July 2007", "parentId": 2, "externalId": "SYS54-88" } - { "officeId": 3, "resourceId": - 3 } + +POST offices +Content-Type: application/json +Request Body: +{ + "name": "Example New Branch", + "dateFormat": "dd MMMM yyyy", + "locale": "en", + "openingDate": "01 July 2007", + "parentId": 2, + "externalId": "SYS54-88" +} + + +{ + "officeId": 3, + "resourceId": 3 +} + @@ -2827,17 +2978,28 @@ POST https://DomainName/api/v1/offices PUT https://DomainName/api/v1/offices/{officeId} - PUT offices/1 Content-Type: - application/json Request Body: { "name": "Name is updated" } - { "officeId": 1, "resourceId": - 1, "changes": { "name": "Name is updated" } + +PUT offices/1 +Content-Type: application/json +Request Body: +{ + "name": "Name is updated" +} + + +{ + "officeId": 1, + "resourceId": 1, + "changes": { + "name": "Name is updated" + } +} + - -  
@@ -2988,27 +3150,61 @@ PUT https://DomainName/api/v1/offices/{officeId} GET https://DomainName/api/v1/loanproducts - [ { "id": 1, "name": "A new - loan product for me", "currency": { "code": "USD", "name": "US - Dollar", "decimalPlaces": 2, "displaySymbol": "$", "nameCode": - "currency.USD", "displayLabel": "US Dollar ($)" }, "principal": - 100000, "numberOfRepayments": 12, "loanTermFrequency": 12, - "repaymentEvery": 1, "loanTermFrequencyType": { "id": 2, "code": - "loanTermFrequency.periodFrequencyType.months", "value": "Months" - }, "repaymentFrequencyType": { "id": 2, "code": - "repaymentFrequency.periodFrequencyType.months", "value": "Months" - }, "transactionProcessingStrategyId": 1, - "transactionProcessingStrategyName": "Mifos style", - "interestRatePerPeriod": 1.75, "interestRateFrequencyType": { - "id": 2, "code": - "interestRateFrequency.periodFrequencyType.months", "value": "Per - month" }, "annualInterestRate": 21, "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" }, "accountingType": 1 } ] + +[ + { + "id": 1, + "name": "A new loan product for me", + "currency": { + "code": "USD", + "name": "US Dollar", + "decimalPlaces": 2, + "displaySymbol": "$", + "nameCode": "currency.USD", + "displayLabel": "US Dollar ($)" + }, + "principal": 100000, + "numberOfRepayments": 12, + "loanTermFrequency": 12, + "repaymentEvery": 1, + "loanTermFrequencyType": { + "id": 2, + "code": "loanTermFrequency.periodFrequencyType.months", + "value": "Months" + }, + "repaymentFrequencyType": { + "id": 2, + "code": "repaymentFrequency.periodFrequencyType.months", + "value": "Months" + }, + "transactionProcessingStrategyId": 1, + "transactionProcessingStrategyName": "Mifos style", + "interestRatePerPeriod": 1.75, + "interestRateFrequencyType": { + "id": 2, + "code": "interestRateFrequency.periodFrequencyType.months", + "value": "Per month" + }, + "annualInterestRate": 21, + "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" + }, + "accountingType": 1 + } +] +
@@ -3033,59 +3229,207 @@ GET https://DomainName/api/v1/loanproducts GET https://DomainName/api/v1/loanproducts/template - { "currency": { "code": "USD", - "name": "US Dollar", "decimalPlaces": 2, "displaySymbol": "$", - "nameCode": "currency.USD", "displayLabel": "US Dollar ($)" }, - "loanTermFrequencyType": { "id": 2, "code": - "loanTermFrequency.periodFrequencyType.months", "value": "Months" - }, "repaymentFrequencyType": { "id": 2, "code": - "repaymentFrequency.periodFrequencyType.months", "value": "Months" - }, "interestRateFrequencyType": { "id": 2, "code": - "interestRateFrequency.periodFrequencyType.months", "value": "Per - month" }, "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" }, "accountingType": 1, - "currencyOptions": [ { "code": "USD", "name": "US Dollar", - "decimalPlaces": 2, "displaySymbol": "$", "nameCode": - "currency.USD", "displayLabel": "US Dollar ($)" } ], - "transactionProcessingStrategyOptions": [ { "id": 1, "code": - "mifos-standard-strategy", "name": "Mifos style" }, { "id": 2, - "code": "heavensfamily-strategy", "name": "Heavensfamily" }, { - "id": 3, "code": "creocore-strategy", "name": "Creocore" }, { - "id": 4, "code": "rbi-india-strategy", "name": "RBI (India)" } ], - "amortizationTypeOptions": [ { "id": 1, "code": - "amortizationType.equal.installments", "value": "Equal - installments" }, { "id": 0, "code": - "amortizationType.equal.principal", "value": "Equal principle - payments" } ], "interestTypeOptions": [ { "id": 1, "code": - "interestType.flat", "value": "Flat" }, { "id": 0, "code": - "interestType.declining.balance", "value": "Declining Balance" } - ], "interestCalculationPeriodTypeOptions": [ { "id": 0, "code": - "interestCalculationPeriodType.daily", "value": "Daily" }, { "id": - 1, "code": - "interestCalculationPeriodType.same.as.repayment.period", "value": - "Same as repayment period" } ], "repaymentFrequencyTypeOptions": [ - { "id": 0, "code": "repaymentFrequency.periodFrequencyType.days", - "value": "Days" }, { "id": 1, "code": - "repaymentFrequency.periodFrequencyType.weeks", "value": "Weeks" - }, { "id": 2, "code": - "repaymentFrequency.periodFrequencyType.months", "value": "Months" - } ], "interestRateFrequencyTypeOptions": [ { "id": 2, "code": - "interestRateFrequency.periodFrequencyType.months", "value": "Per - month" }, { "id": 3, "code": - "interestRateFrequency.periodFrequencyType.years", "value": "Per - year" } ], "loanTermFrequencyTypeOptions": [ { "id": 0, "code": - "loanTermFrequency.periodFrequencyType.days", "value": "Days" }, { - "id": 1, "code": "loanTermFrequency.periodFrequencyType.weeks", - "value": "Weeks" }, { "id": 2, "code": - "loanTermFrequency.periodFrequencyType.months", "value": "Months" - }, { "id": 3, "code": - "loanTermFrequency.periodFrequencyType.years", "value": "Years" } - ], "accountingMappings": {} } + +{ + "currency": { + "code": "USD", + "name": "US Dollar", + "decimalPlaces": 2, + "displaySymbol": "$", + "nameCode": "currency.USD", + "displayLabel": "US Dollar ($)" + }, + "loanTermFrequencyType": { + "id": 2, + "code": "loanTermFrequency.periodFrequencyType.months", + "value": "Months" + }, + "repaymentFrequencyType": { + "id": 2, + "code": "repaymentFrequency.periodFrequencyType.months", + "value": "Months" + }, + "interestRateFrequencyType": { + "id": 2, + "code": "interestRateFrequency.periodFrequencyType.months", + "value": "Per month" + }, + "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" + }, + "accountingType": 1, + "currencyOptions": [ + { + "code": "USD", + "name": "US Dollar", + "decimalPlaces": 2, + "displaySymbol": "$", + "nameCode": "currency.USD", + "displayLabel": "US Dollar ($)" + } + ], + "fundOptions": [ + { + "id": 1, + "name": "EU Agri Fund" + } + ], + "transactionProcessingStrategyOptions": [ + { + "id": 1, + "code": "mifos-standard-strategy", + "name": "Mifos style" + }, + { + "id": 2, + "code": "heavensfamily-strategy", + "name": "Heavensfamily" + }, + { + "id": 3, + "code": "creocore-strategy", + "name": "Creocore" + }, + { + "id": 4, + "code": "rbi-india-strategy", + "name": "RBI (India)" + } + ], + "amortizationTypeOptions": [ + { + "id": 1, + "code": "amortizationType.equal.installments", + "value": "Equal installments" + }, + { + "id": 0, + "code": "amortizationType.equal.principal", + "value": "Equal principle payments" + } + ], + "interestTypeOptions": [ + { + "id": 1, + "code": "interestType.flat", + "value": "Flat" + }, + { + "id": 0, + "code": "interestType.declining.balance", + "value": "Declining Balance" + } + ], + "interestCalculationPeriodTypeOptions": [ + { + "id": 0, + "code": "interestCalculationPeriodType.daily", + "value": "Daily" + }, + { + "id": 1, + "code": "interestCalculationPeriodType.same.as.repayment.period", + "value": "Same as repayment period" + } + ], + "repaymentFrequencyTypeOptions": [ + { + "id": 0, + "code": "repaymentFrequency.periodFrequencyType.days", + "value": "Days" + }, + { + "id": 1, + "code": "repaymentFrequency.periodFrequencyType.weeks", + "value": "Weeks" + }, + { + "id": 2, + "code": "repaymentFrequency.periodFrequencyType.months", + "value": "Months" + } + ], + "interestRateFrequencyTypeOptions": [ + { + "id": 2, + "code": "interestRateFrequency.periodFrequencyType.months", + "value": "Per month" + }, + { + "id": 3, + "code": "interestRateFrequency.periodFrequencyType.years", + "value": "Per year" + } + ], + "loanTermFrequencyTypeOptions": [ + { + "id": 0, + "code": "loanTermFrequency.periodFrequencyType.days", + "value": "Days" + }, + { + "id": 1, + "code": "loanTermFrequency.periodFrequencyType.weeks", + "value": "Weeks" + }, + { + "id": 2, + "code": "loanTermFrequency.periodFrequencyType.months", + "value": "Months" + }, + { + "id": 3, + "code": "loanTermFrequency.periodFrequencyType.years", + "value": "Years" + } + ], + "chargeOptions": [ + { + "id": 1, + "name": "Loan service fee", + "active": true, + "penalty": false, + "currency": { + "code": "USD", + "name": "US Dollar", + "decimalPlaces": 2, + "displaySymbol": "$", + "nameCode": "currency.USD", + "displayLabel": "US Dollar ($)" + }, + "amount": 230.56, + "chargeTimeType": { + "id": 1, + "code": "chargeTimeType.disbursement", + "value": "Disbursement" + }, + "chargeAppliesTo": { + "id": 1, + "code": "chargeAppliesTo.loan", + "value": "Loan" + }, + "chargeCalculationType": { + "id": 1, + "code": "chargeCalculationType.flat", + "value": "Flat" + } + } + ], + "accountingMappings": {} +} + @@ -3107,27 +3451,59 @@ GET https://DomainName/api/v1/loanproducts/template GET https://DomainName/api/v1/loanproducts/{productId} - { "id": 1, "name": "A new loan - product for me", "currency": { "code": "USD", "name": "US Dollar", - "decimalPlaces": 2, "displaySymbol": "$", "nameCode": - "currency.USD", "displayLabel": "US Dollar ($)" }, "principal": - 100000, "numberOfRepayments": 12, "loanTermFrequency": 12, - "repaymentEvery": 1, "loanTermFrequencyType": { "id": 2, "code": - "loanTermFrequency.periodFrequencyType.months", "value": "Months" - }, "repaymentFrequencyType": { "id": 2, "code": - "repaymentFrequency.periodFrequencyType.months", "value": "Months" - }, "transactionProcessingStrategyId": 1, - "transactionProcessingStrategyName": "Mifos style", - "interestRatePerPeriod": 1.75, "interestRateFrequencyType": { - "id": 2, "code": - "interestRateFrequency.periodFrequencyType.months", "value": "Per - month" }, "annualInterestRate": 21, "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" }, "accountingType": 1, "charges": [] } + +{ + "id": 1, + "name": "A new loan product for me", + "currency": { + "code": "USD", + "name": "US Dollar", + "decimalPlaces": 2, + "displaySymbol": "$", + "nameCode": "currency.USD", + "displayLabel": "US Dollar ($)" + }, + "principal": 100000, + "numberOfRepayments": 12, + "loanTermFrequency": 12, + "repaymentEvery": 1, + "loanTermFrequencyType": { + "id": 2, + "code": "loanTermFrequency.periodFrequencyType.months", + "value": "Months" + }, + "repaymentFrequencyType": { + "id": 2, + "code": "repaymentFrequency.periodFrequencyType.months", + "value": "Months" + }, + "transactionProcessingStrategyId": 1, + "transactionProcessingStrategyName": "Mifos style", + "interestRatePerPeriod": 1.75, + "interestRateFrequencyType": { + "id": 2, + "code": "interestRateFrequency.periodFrequencyType.months", + "value": "Per month" + }, + "annualInterestRate": 21, + "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" + }, + "accountingType": 1, + "charges": [] +} @@ -3154,16 +3530,33 @@ GET https://DomainName/api/v1/loanproducts/{productId} POST https://DomainName/api/v1/loanproducts - POST loanproducts Content-Type: - application/json Request Body: { "name": "A new loan product for - me", "currencyCode": "USD", "locale": "en_GB", - "digitsAfterDecimal": "2", "principal": "100,000.00", - "numberOfRepayments": "12", "repaymentEvery": "1", - "repaymentFrequencyType": 2, "transactionProcessingStrategyId": 1, - "interestRatePerPeriod": "1.75", "interestRateFrequencyType": 2, - "amortizationType": 1, "interestType": 0, - "interestCalculationPeriodType": 1, "accountingType": 1 } - { "resourceId": 1 } + +POST loanproducts +Content-Type: application/json +Request Body: +{ + "name": "A new loan product for me", + "currencyCode": "USD", + "locale": "en_GB", + "digitsAfterDecimal": "2", + "principal": "100,000.00", + "numberOfRepayments": "12", + "repaymentEvery": "1", + "repaymentFrequencyType": 2, + "transactionProcessingStrategyId": 1, + "interestRatePerPeriod": "1.75", + "interestRateFrequencyType": 2, + "amortizationType": 1, + "interestType": 0, + "interestCalculationPeriodType": 1, + "accountingType": 1 +} + + +{ + "resourceId": 1 +} + @@ -3177,11 +3570,24 @@ POST https://DomainName/api/v1/loanproducts PUT https://DomainName/api/v1/loanproducts/{loanId} - PUT loanproducts/1 - Content-Type: application/json Request Body: { "locale": "en_GB", - "principal": "70,000.00" } - { "resourceId": 1, "changes": - { "principal": 70000, "locale": "en_GB" } } + +PUT loanproducts/1 +Content-Type: application/json +Request Body: +{ + "locale": "en_GB", + "principal": "70,000.00" +} + + +{ + "resourceId": 1, + "changes": { + "principal": 70000, + "locale": "en_GB" + } +} + @@ -3213,17 +3619,43 @@ PUT https://DomainName/api/v1/loanproducts/{loanId} GET https://DomainName/api/v1/currencies - { "selectedCurrencyOptions": [ - { "code": "USD", "name": "US Dollar", "decimalPlaces": 2, - "displaySymbol": "$", "nameCode": "currency.USD", "displayLabel": - "US Dollar ($)" } ], "currencyOptions": [ { "code": "AFN", "name": - "Afghanistan Afghani", "decimalPlaces": 2, "nameCode": - "currency.AFN", "displayLabel": "Afghanistan Afghani [AFN]" }, { - "code": "ALL", "name": "Albanian Lek", "decimalPlaces": 2, - "nameCode": "currency.ALL", "displayLabel": "Albanian Lek [ALL]" - }, { "code": "ZWD", "name": "Zimbabwe Dollar", "decimalPlaces": 2, - "nameCode": "currency.ZWD", "displayLabel": "Zimbabwe Dollar - [ZWD]" } ] } + +{ + "selectedCurrencyOptions": [ + { + "code": "USD", + "name": "US Dollar", + "decimalPlaces": 2, + "displaySymbol": "$", + "nameCode": "currency.USD", + "displayLabel": "US Dollar ($)" + } + ], + "currencyOptions": [ + { + "code": "AFN", + "name": "Afghanistan Afghani", + "decimalPlaces": 2, + "nameCode": "currency.AFN", + "displayLabel": "Afghanistan Afghani [AFN]" + }, + { + "code": "ALL", + "name": "Albanian Lek", + "decimalPlaces": 2, + "nameCode": "currency.ALL", + "displayLabel": "Albanian Lek [ALL]" + }, + { + "code": "ZWD", + "name": "Zimbabwe Dollar", + "decimalPlaces": 2, + "nameCode": "currency.ZWD", + "displayLabel": "Zimbabwe Dollar [ZWD]" + } + ] +} + @@ -3238,11 +3670,37 @@ GET https://DomainName/api/v1/currencies PUT https://DomainName/api/v1/currencies - PUT currencies Content-Type: - application/json Request Body: { "currencies": ["KES", "BND", - "LBP", "GHC", "USD", "XOF", "AED", "AMD"] } - { "currencies": [ "KES", - "BND", "LBP", "GHC", "USD", "XOF", "AED", "AMD" ] } + +PUT currencies +Content-Type: application/json +Request Body: +{ + "currencies": [ + "KES", + "BND", + "LBP", + "GHC", + "USD", + "XOF", + "AED", + "AMD" + ] +} + + +{ + "currencies": [ + "KES", + "BND", + "LBP", + "GHC", + "USD", + "XOF", + "AED", + "AMD" + ] +} + @@ -3268,13 +3726,20 @@ PUT https://DomainName/api/v1/currencies GET https://DomainName/api/v1/configurations - { "globalConfiguration": [ { - "name": "maker-checker", "enabled": false } ] } + +{ + "globalConfiguration": [ + { + "name": "maker-checker", + "enabled": false + } + ] +} + -   +  

Update Global Configuration

@@ -3284,8 +3749,11 @@ GET https://DomainName/api/v1/configurations PUT https://DomainName/api/v1/configurations?maker-checker=false - PUT configurations - Content-Type: application/json Request Body: { } + +PUT configurations +Content-Type: application/json +Request Body: { } + { "changes": {} }
@@ -3317,9 +3785,19 @@ PUT https://DomainName/api/v1/configurations?maker-checker=false POST https://DomainName/api/v1/codes - POST codes Content-Type: - application/json Request Body: { "name": "MyNewCode" } - { "resourceId": 4 } + +POST codes +Content-Type: application/json +Request Body: +{ + "name": "MyNewCode" +} + + +{ + "resourceId": 4 +} + @@ -3336,10 +3814,25 @@ POST https://DomainName/api/v1/codes GET https://DomainName/api/v1/codes - [ { "id": 1, "name": "Customer - Identifier", "systemDefined": true }, { "id": 2, "name": "Gender", - "systemDefined": true },{ "id": 3, "name": "Education", - "systemDefined": true } ] + +[ + { + "id": 1, + "name": "Customer Identifier", + "systemDefined": true + }, + { + "id": 2, + "name": "Gender", + "systemDefined": true + }, + { + "id": 3, + "name": "Education", + "systemDefined": true + } +] + @@ -3356,8 +3849,13 @@ GET https://DomainName/api/v1/codes GET https://DomainName/api/v1/codes/{codeId} - { "id": 1, "name": "Customer - Identifier", "systemDefined": true } + +{ + "id": 1, + "name": "Customer Identifier", + "systemDefined": true +} + @@ -3372,10 +3870,22 @@ GET https://DomainName/api/v1/codes/{codeId} PUT https://DomainName/api/v1/codes/{codeId} - PUT codes/4 Content-Type: - application/json Request Body: { "name": "MyNewCode(changed)" } - { "resourceId": 4, "changes": - { "name": "MyNewCode(changed)" } } + +PUT codes/4 +Content-Type: application/json +Request Body: +{ + "name": "MyNewCode(changed)" +} + + +{ + "resourceId": 4, + "changes": { + "name": "MyNewCode(changed)" + } +} + @@ -3390,9 +3900,15 @@ PUT https://DomainName/api/v1/codes/{codeId} DELETE https://DomainName/api/v1/codes/{codeId} - DELETE codes/4 Content-Type: - application/json - { "resourceId": 4 } + +DELETE codes/4 +Content-Type: application/json + + +{ + "resourceId": 4 +} + @@ -3417,9 +3933,19 @@ DELETE https://DomainName/api/v1/codes/{codeId} POST https://DomainName/api/v1/funds - POST funds Content-Type: - application/json Request Body: { "name": "EU Agri Fund" } - { "resourceId": 1 } + +POST funds +Content-Type: application/json +Request Body: +{ + "name": "EU Agri Fund" +} + + +{ + "resourceId": 1 +} + @@ -3435,8 +3961,14 @@ POST https://DomainName/api/v1/funds GET https://DomainName/api/v1/funds - [ { "id": 1, "name": "EU Agri - Fund" } ] + +[ + { + "id": 1, + "name": "EU Agri Fund" + } +] + @@ -3452,8 +3984,12 @@ GET https://DomainName/api/v1/funds GET https://DomainName/api/v1/funds/{fundId} - { "id": 1, "name": "EU Agri - Fund" } + +{ + "id": 1, + "name": "EU Agri Fund" +} + @@ -3467,11 +4003,22 @@ GET https://DomainName/api/v1/funds/{fundId} PUT https://DomainName/api/v1/funds/{fundId} - PUT funds/1 Content-Type: - application/json Request Body: { "name": "EU Agri Fund - (2010-2020)" } - { "resourceId": 1, "changes": - { "name": "EU Agri Fund (2010-2020)" } } + +PUT funds/1 +Content-Type: application/json +Request Body: +{ + "name": "EU Agri Fund (2010-2020)" +} + + +{ + "resourceId": 1, + "changes": { + "name": "EU Agri Fund (2010-2020)" + } +} + @@ -3496,11 +4043,23 @@ PUT https://DomainName/api/v1/funds/{fundId} POST https://DomainName/api/v1/staff - POST staff Content-Type: - application/json Request Body: { "officeId": 1, "firstname": - "John", "lastname": "Doe", "isLoanOfficer": "true" } - { "officeId": 1, "resourceId": - 1 } + +POST staff +Content-Type: application/json +Request Body: +{ + "officeId": 1, + "firstname": "John", + "lastname": "Doe", + "isLoanOfficer": "true" +} + + +{ + "officeId": 1, + "resourceId": 1 +} + @@ -3516,9 +4075,19 @@ POST https://DomainName/api/v1/staff GET https://DomainName/api/v1/staff - [ { "id": 1, "firstname": - "John", "lastname": "Doe", "displayName": "Doe, John", "officeId": - 1, "officeName": "Head Office", "isLoanOfficer": true } ] + +[ + { + "id": 1, + "firstname": "John", + "lastname": "Doe", + "displayName": "Doe, John", + "officeId": 1, + "officeName": "Head Office", + "isLoanOfficer": true + } +] + @@ -3531,12 +4100,18 @@ GET https://DomainName/api/v1/staff
staff/1
- GET https://Domain - Name/api/v1/staff/{staffId} + GET https://DomainName/api/v1/staff/{staffId} + +{ + "id": 1, + "firstname": "John", + "lastname": "Doe", + "displayName": "Doe, John", + "officeId": 1, + "officeName": "Head Office", + "isLoanOfficer": true +} - { "id": 1, "firstname": - "John", "lastname": "Doe", "displayName": "Doe, John", "officeId": - 1, "officeName": "Head Office", "isLoanOfficer": true }
@@ -3550,10 +4125,23 @@ GET https://DomainName/api/v1/staff PUT https://DomainName/api/v1/staff/{staffId} - PUT staff/1 Content-Type: - application/json Request Body: { "isLoanOfficer": "false" } - { "officeId": 1, "resourceId": - 1, "changes": { "isLoanOfficer": false } } + +PUT staff/1 +Content-Type: application/json +Request Body: +{ + "isLoanOfficer": "false" +} + + +{ + "officeId": 1, + "resourceId": 1, + "changes": { + "isLoanOfficer": false + } +} + @@ -3582,12 +4170,21 @@ PUT https://DomainName/api/v1/staff/{staffId} POST https://DomainName/api/v1/charges - POST charges Content-Type: - application/json Request Body: { "name": "Loan service fee", - "chargeAppliesTo": 1, "currencyCode": "USD", "locale": "en", - "amount": "230.56", "chargeTimeType": "1", - "chargeCalculationType": "1" } - { "resourceId": 1 } + +POST charges +Content-Type: application/json +Request Body: +{ + "name": "Loan service fee", + "chargeAppliesTo": 1, + "currencyCode": "USD", + "locale": "en", + "amount": "230.56", + "chargeTimeType": "1", + "chargeCalculationType": "1" +} + + { "resourceId": 1 } @@ -3603,15 +4200,40 @@ POST https://DomainName/api/v1/charges GET https://DomainName/api/v1/charges - [ { "id": 1, "name": "Loan - service fee", "active": true, "penalty": false, "currency": { - "code": "USD", "name": "US Dollar", "decimalPlaces": 2, - "displaySymbol": "$", "nameCode": "currency.USD", "displayLabel": - "US Dollar ($)" }, "amount": 230.560000, "chargeTimeType": { "id": - 1, "code": "chargeTimeType.disbursement", "value": "Disbursement" - }, "chargeAppliesTo": { "id": 1, "code": "chargeAppliesTo.loan", - "value": "Loan" }, "chargeCalculationType": { "id": 1, "code": - "chargeCalculationType.flat", "value": "Flat" } } ] + +[ + { + "id": 1, + "name": "Loan service fee", + "active": true, + "penalty": false, + "currency": { + "code": "USD", + "name": "US Dollar", + "decimalPlaces": 2, + "displaySymbol": "$", + "nameCode": "currency.USD", + "displayLabel": "US Dollar ($)" + }, + "amount": 230.56, + "chargeTimeType": { + "id": 1, + "code": "chargeTimeType.disbursement", + "value": "Disbursement" + }, + "chargeAppliesTo": { + "id": 1, + "code": "chargeAppliesTo.loan", + "value": "Loan" + }, + "chargeCalculationType": { + "id": 1, + "code": "chargeCalculationType.flat", + "value": "Flat" + } + } +] + @@ -3628,15 +4250,38 @@ GET https://DomainName/api/v1/charges GET https://DomainName/api/v1/charges/{chargeId} - { "id": 1, "name": "Loan - service fee", "active": true, "penalty": false, "currency": { - "code": "USD", "name": "US Dollar", "decimalPlaces": 2, - "displaySymbol": "$", "nameCode": "currency.USD", "displayLabel": - "US Dollar ($)" }, "amount": 230.560000, "chargeTimeType": { "id": - 1, "code": "chargeTimeType.disbursement", "value": "Disbursement" - }, "chargeAppliesTo": { "id": 1, "code": "chargeAppliesTo.loan", - "value": "Loan" }, "chargeCalculationType": { "id": 1, "code": - "chargeCalculationType.flat", "value": "Flat" } } + +{ + "id": 1, + "name": "Loan service fee", + "active": true, + "penalty": false, + "currency": { + "code": "USD", + "name": "US Dollar", + "decimalPlaces": 2, + "displaySymbol": "$", + "nameCode": "currency.USD", + "displayLabel": "US Dollar ($)" + }, + "amount": 230.56, + "chargeTimeType": { + "id": 1, + "code": "chargeTimeType.disbursement", + "value": "Disbursement" + }, + "chargeAppliesTo": { + "id": 1, + "code": "chargeAppliesTo.loan", + "value": "Loan" + }, + "chargeCalculationType": { + "id": 1, + "code": "chargeCalculationType.flat", + "value": "Flat" + } +} + @@ -3650,11 +4295,22 @@ GET https://DomainName/api/v1/charges/{chargeId} PUT https://DomainName/api/v1/charges/{chargeId} - PUT charges/1 Content-Type: - application/json Request Body: { "name": "Loan service - fee(changed)" } - { "resourceId": 1, "changes": - { "name": "Loan service fee(changed)" } } + +PUT charges/1 +Content-Type: application/json +Request Body: +{ + "name": "Loan service fee(changed)" +} + + +{ + "resourceId": 1, + "changes": { + "name": "Loan service fee(changed)" + } +} + @@ -3668,8 +4324,10 @@ PUT https://DomainName/api/v1/charges/{chargeId} DELETE https://DomainName/api/v1/charges/{chargeId} - DELETE charges/1 Content-Type: - application/json + +DELETE charges/1 +Content-Type: application/json + { "resourceId": 1 } @@ -4070,56 +4728,730 @@ Request Body: GET https://DomainName/api/v1/reports - { "columnHeaders" : [ { - "columnName" : "report_id", "columnType" : "INT", "columnLength" : - null, "columnDisplayType" : null, "columnValues" : [ ] }, { - "columnName" : "report_name", "columnType" : "VARCHAR", - "columnLength" : null, "columnDisplayType" : null, "columnValues" - : [ ] }, { "columnName" : "report_type", "columnType" : "VARCHAR", - "columnLength" : null, "columnDisplayType" : null, "columnValues" - : [ ] }, { "columnName" : "report_subtype", "columnType" : - "VARCHAR", "columnLength" : null, "columnDisplayType" : null, - "columnValues" : [ ] }, { "columnName" : "report_category", - "columnType" : "VARCHAR", "columnLength" : null, - "columnDisplayType" : null, "columnValues" : [ ] }, { "columnName" - : "parameter_id", "columnType" : "INT", "columnLength" : null, - "columnDisplayType" : null, "columnValues" : [ ] }, { "columnName" - : "report_parameter_name", "columnType" : "VARCHAR", - "columnLength" : null, "columnDisplayType" : null, "columnValues" - : [ ] }, { "columnName" : "parameter_name", "columnType" : - "VARCHAR", "columnLength" : null, "columnDisplayType" : null, - "columnValues" : [ ] } ], "data" : [ { "row" : [ "29", "Client - Listing", "Table", null, null, "5", null, "selectOfficeId" ] }, { - "row" : [ "42", "Client Listing - Additional and Unlikely", - "Table", null, null, "5", null, "selectOfficeId" ] }, { "row" : [ - "30", "Client Loans Listing", "Table", null, null, "5", null, - "selectOfficeId" ] }, { "row" : [ "43", "Client Loans Listing - - Additional", "Table", null, null, "5", null, "selectOfficeId" ] }, - { "row" : [ "41", "Clients by Surname (a bit silly)", "Chart", - "Pie", null, "5", null, "selectOfficeId" ] }, { "row" : [ "39", - "Loan Disbursals in Previous Year", "Chart", "Bar", null, "5", - null, "selectOfficeId" ] }, { "row" : [ "39", "Loan Disbursals in - Previous Year", "Chart", "Bar", null, "7", null, - "currencyIdSelectOne" ] }, { "row" : [ "40", "Loan Repayments in - Previous Year", "Chart", "Bar", null, "5", null, "selectOfficeId" - ] }, { "row" : [ "40", "Loan Repayments in Previous Year", - "Chart", "Bar", null, "7", null, "currencyIdSelectOne" ] }, { - "row" : [ "34", "Loans - Active Loans Portfolio Status", "Table", - null, null, "5", null, "selectOfficeId" ] }, { "row" : [ "34", - "Loans - Active Loans Portfolio Status", "Table", null, null, "6", - null, "currencyIdSelectAll" ] }, { "row" : [ "31", "Loans Awaiting - Disbursal", "Table", null, null, "5", null, "selectOfficeId" ] }, - { "row" : [ "35", "Portfolio at Risk", "Table", null, null, "5", - null, "selectOfficeId" ] }, { "row" : [ "35", "Portfolio at Risk", - "Table", null, null, "6", null, "currencyIdSelectAll" ] }, { "row" - : [ "32", "Upcoming Repayments", "Table", null, null, "5", null, - "selectOfficeId" ] }, { "row" : [ "32", "Upcoming Repayments", - "Table", null, null, "6", null, "currencyIdSelectAll" ] }, { "row" - : [ "38", "Upcoming Repayments Summary By Month, Currency and Loan - Risk", "Table", null, null, "5", null, "selectOfficeId" ] }, { - "row" : [ "38", "Upcoming Repayments Summary By Month, Currency - and Loan Risk", "Table", null, null, "6", null, - "currencyIdSelectAll" ] } ] } + +{ + "columnHeaders": [ + { + "columnName": "report_id", + "columnType": "INT", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [] + }, + { + "columnName": "report_name", + "columnType": "VARCHAR", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [] + }, + { + "columnName": "report_type", + "columnType": "VARCHAR", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [] + }, + { + "columnName": "report_subtype", + "columnType": "VARCHAR", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [] + }, + { + "columnName": "report_category", + "columnType": "VARCHAR", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [] + }, + { + "columnName": "parameter_id", + "columnType": "INT", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [] + }, + { + "columnName": "report_parameter_name", + "columnType": "VARCHAR", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [] + }, + { + "columnName": "parameter_name", + "columnType": "VARCHAR", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [] + } + ], + "data": [ + { + "row": [ + "10", + "Active Loans Portfolio Status", + "Table", + null, + "Loan", + "5", + null, + "OfficeIdSelectOne" + ] + }, + { + "row": [ + "10", + "Active Loans Portfolio Status", + "Table", + null, + "Loan", + "6", + null, + "loanOfficerIdSelectAll" + ] + }, + { + "row": [ + "10", + "Active Loans Portfolio Status", + "Table", + null, + "Loan", + "10", + null, + "currencyIdSelectAll" + ] + }, + { + "row": [ + "10", + "Active Loans Portfolio Status", + "Table", + null, + "Loan", + "20", + null, + "fundIdSelectAll" + ] + }, + { + "row": [ + "10", + "Active Loans Portfolio Status", + "Table", + null, + "Loan", + "25", + null, + "loanProductIdSelectAll" + ] + }, + { + "row": [ + "11", + "Active Loans Summary per Branch", + "Table", + null, + "Loan Portfolio", + "5", + null, + "OfficeIdSelectOne" + ] + }, + { + "row": [ + "11", + "Active Loans Summary per Branch", + "Table", + null, + "Loan Portfolio", + "10", + null, + "currencyIdSelectAll" + ] + }, + { + "row": [ + "48", + "Balance Sheet", + "Pentaho", + null, + "Accounting", + "5", + "branch", + "OfficeIdSelectOne" + ] + }, + { + "row": [ + "48", + "Balance Sheet", + "Pentaho", + null, + "Accounting", + "41", + "date", + "endDateSelect" + ] + }, + { + "row": [ + "1", + "Client Listing", + "Table", + null, + "Client", + "5", + null, + "OfficeIdSelectOne" + ] + }, + { + "row": [ + "2", + "Client Loans Listing", + "Table", + null, + "Client", + "5", + null, + "OfficeIdSelectOne" + ] + }, + { + "row": [ + "2", + "Client Loans Listing", + "Table", + null, + "Client", + "6", + null, + "loanOfficerIdSelectAll" + ] + }, + { + "row": [ + "2", + "Client Loans Listing", + "Table", + null, + "Client", + "10", + null, + "currencyIdSelectAll" + ] + }, + { + "row": [ + "2", + "Client Loans Listing", + "Table", + null, + "Client", + "20", + null, + "fundIdSelectAll" + ] + }, + { + "row": [ + "2", + "Client Loans Listing", + "Table", + null, + "Client", + "25", + null, + "loanProductIdSelectAll" + ] + }, + { + "row": [ + "20", + "Funds Disbursed Between Dates Summary", + "Table", + null, + "Fund", + "10", + null, + "currencyIdSelectAll" + ] + }, + { + "row": [ + "20", + "Funds Disbursed Between Dates Summary", + "Table", + null, + "Fund", + "20", + null, + "fundIdSelectAll" + ] + }, + { + "row": [ + "20", + "Funds Disbursed Between Dates Summary", + "Table", + null, + "Fund", + "40", + null, + "startDateSelect" + ] + }, + { + "row": [ + "20", + "Funds Disbursed Between Dates Summary", + "Table", + null, + "Fund", + "41", + null, + "endDateSelect" + ] + }, + { + "row": [ + "21", + "Funds Disbursed Between Dates Summary by Office", + "Table", + null, + "Fund", + "5", + null, + "OfficeIdSelectOne" + ] + }, + { + "row": [ + "21", + "Funds Disbursed Between Dates Summary by Office", + "Table", + null, + "Fund", + "10", + null, + "currencyIdSelectAll" + ] + }, + { + "row": [ + "21", + "Funds Disbursed Between Dates Summary by Office", + "Table", + null, + "Fund", + "20", + null, + "fundIdSelectAll" + ] + }, + { + "row": [ + "21", + "Funds Disbursed Between Dates Summary by Office", + "Table", + null, + "Fund", + "40", + null, + "startDateSelect" + ] + }, + { + "row": [ + "21", + "Funds Disbursed Between Dates Summary by Office", + "Table", + null, + "Fund", + "41", + null, + "endDateSelect" + ] + }, + { + "row": [ + "49", + "Income Statement", + "Pentaho", + null, + "Accounting", + "5", + "branch", + "OfficeIdSelectOne" + ] + }, + { + "row": [ + "49", + "Income Statement", + "Pentaho", + null, + "Accounting", + "40", + "fromDate", + "startDateSelect" + ] + }, + { + "row": [ + "49", + "Income Statement", + "Pentaho", + null, + "Accounting", + "41", + "toDate", + "endDateSelect" + ] + }, + { + "row": [ + "5", + "Loans Awaiting Disbursal", + "Table", + null, + "Loan Portfolio", + "5", + null, + "OfficeIdSelectOne" + ] + }, + { + "row": [ + "5", + "Loans Awaiting Disbursal", + "Table", + null, + "Loan Portfolio", + "6", + null, + "loanOfficerIdSelectAll" + ] + }, + { + "row": [ + "5", + "Loans Awaiting Disbursal", + "Table", + null, + "Loan Portfolio", + "10", + null, + "currencyIdSelectAll" + ] + }, + { + "row": [ + "5", + "Loans Awaiting Disbursal", + "Table", + null, + "Loan Portfolio", + "20", + null, + "fundIdSelectAll" + ] + }, + { + "row": [ + "5", + "Loans Awaiting Disbursal", + "Table", + null, + "Loan Portfolio", + "25", + null, + "loanProductIdSelectAll" + ] + }, + { + "row": [ + "6", + "Loans Awaiting Disbursal Summary", + "Table", + null, + "Loan Portfolio", + "5", + null, + "OfficeIdSelectOne" + ] + }, + { + "row": [ + "6", + "Loans Awaiting Disbursal Summary", + "Table", + null, + "Loan Portfolio", + "6", + null, + "loanOfficerIdSelectAll" + ] + }, + { + "row": [ + "6", + "Loans Awaiting Disbursal Summary", + "Table", + null, + "Loan Portfolio", + "10", + null, + "currencyIdSelectAll" + ] + }, + { + "row": [ + "6", + "Loans Awaiting Disbursal Summary", + "Table", + null, + "Loan Portfolio", + "20", + null, + "fundIdSelectAll" + ] + }, + { + "row": [ + "6", + "Loans Awaiting Disbursal Summary", + "Table", + null, + "Loan Portfolio", + "25", + null, + "loanProductIdSelectAll" + ] + }, + { + "row": [ + "7", + "Loans Awaiting Disbursal Summary by Month", + "Table", + null, + "Loan Portfolio", + "5", + null, + "OfficeIdSelectOne" + ] + }, + { + "row": [ + "7", + "Loans Awaiting Disbursal Summary by Month", + "Table", + null, + "Loan Portfolio", + "6", + null, + "loanOfficerIdSelectAll" + ] + }, + { + "row": [ + "7", + "Loans Awaiting Disbursal Summary by Month", + "Table", + null, + "Loan Portfolio", + "10", + null, + "currencyIdSelectAll" + ] + }, + { + "row": [ + "7", + "Loans Awaiting Disbursal Summary by Month", + "Table", + null, + "Loan Portfolio", + "20", + null, + "fundIdSelectAll" + ] + }, + { + "row": [ + "7", + "Loans Awaiting Disbursal Summary by Month", + "Table", + null, + "Loan Portfolio", + "25", + null, + "loanProductIdSelectAll" + ] + }, + { + "row": [ + "15", + "Portfolio at Risk", + "Table", + null, + "Loan Portfolio", + "5", + null, + "OfficeIdSelectOne" + ] + }, + { + "row": [ + "15", + "Portfolio at Risk", + "Table", + null, + "Loan Portfolio", + "6", + null, + "loanOfficerIdSelectAll" + ] + }, + { + "row": [ + "15", + "Portfolio at Risk", + "Table", + null, + "Loan Portfolio", + "10", + null, + "currencyIdSelectAll" + ] + }, + { + "row": [ + "15", + "Portfolio at Risk", + "Table", + null, + "Loan Portfolio", + "20", + null, + "fundIdSelectAll" + ] + }, + { + "row": [ + "15", + "Portfolio at Risk", + "Table", + null, + "Loan Portfolio", + "25", + null, + "loanProductIdSelectAll" + ] + }, + { + "row": [ + "16", + "Portfolio at Risk by Branch", + "Table", + null, + "Loan Portfolio", + "5", + null, + "OfficeIdSelectOne" + ] + }, + { + "row": [ + "16", + "Portfolio at Risk by Branch", + "Table", + null, + "Loan Portfolio", + "6", + null, + "loanOfficerIdSelectAll" + ] + }, + { + "row": [ + "16", + "Portfolio at Risk by Branch", + "Table", + null, + "Loan Portfolio", + "10", + null, + "currencyIdSelectAll" + ] + }, + { + "row": [ + "16", + "Portfolio at Risk by Branch", + "Table", + null, + "Loan Portfolio", + "20", + null, + "fundIdSelectAll" + ] + }, + { + "row": [ + "16", + "Portfolio at Risk by Branch", + "Table", + null, + "Loan Portfolio", + "25", + null, + "loanProductIdSelectAll" + ] + }, + { + "row": [ + "50", + "Trial Balance", + "Pentaho", + null, + "Accounting", + "5", + "branch", + "OfficeIdSelectOne" + ] + }, + { + "row": [ + "50", + "Trial Balance", + "Pentaho", + null, + "Accounting", + "40", + "fromDate", + "startDateSelect" + ] + }, + { + "row": [ + "50", + "Trial Balance", + "Pentaho", + null, + "Accounting", + "41", + "toDate", + "endDateSelect" + ] + } + ] +} + @@ -4193,41 +5525,76 @@ GET https://DomainName/api/v1/reports GET https://DomainName/api/v1/reports/{reportName} - { "columnHeaders" : [ { - "columnName" : "Office/Branch", "columnType" : "VARCHAR", - "columnLength" : null, "columnDisplayType" : null, "columnValues" - : [ ] }, { "columnName" : "Name", "columnType" : "VARCHAR", - "columnLength" : null, "columnDisplayType" : null, "columnValues" - : [ ] }, { "columnName" : "Joining Date", "columnType" : "DATE", - "columnLength" : null, "columnDisplayType" : null, "columnValues" - : [ ] } ], "data" : [ { "row" : [ "Demo MFI Head Office", - "O'Meara, Patrick", "2009-01-04" ] }, { "row" : [ "Demo MFI Head - Office", "O'Meara, Dennis", "2009-01-04" ] }, { "row" : [ "Demo - MFI Head Office", "Smith, John", "2009-01-11" ] }, { "row" : [ - "Demo MFI Head Office", "O'Meara, Jimmy", "2009-01-11" ] }, { - "row" : [ "Demo MFI Head Office", "Sunnyville vegetable growers - Ltd", "2009-01-24" ] }, { "row" : [ "Demo MFI Head Office", - "Traoré, Kalilou", "2009-02-04" ] }, { "row" : [ "Demo MFI Head - Office", "Koné, Sidi", "2009-02-11" ] }, { "row" : [ "Demo MFI - Head Office", "Yattabaré, Moustapha", "2009-02-18" ] }, { "row" : - [ "Demo MFI Head Office", "Mali fruit sales ltd.", "2009-02-18" ] - }, { "row" : [ "Demo MFI Head Office", "Djenne co-op group", - "2009-02-25" ] }, { "row" : [ "Demo MFI Head Office", "test, - test", "2012-04-19" ] }, { "row" : [ "Demo MFI Head Office", - "Ziffle, Fred", "2012-04-21" ] }, { "row" : [ "Demo MFI Head - Office", "omara, safik", "2012-04-24" ] }, { "row" : [ "Demo MFI - Head Office", "HF Test", "2012-04-24" ] }, { "row" : [ "Demo MFI - Head Office", "HF Test 2", "2012-04-24" ] }, { "row" : [ "Demo MFI - Head Office", "Kumar, Shiva", "2011-10-01" ] }, { "row" : [ "Demo - MFI Head Office", "Yton, Petra", "2006-06-09" ] }, { "row" : [ - "Demo MFI Head Office", "Yton, Petra", "2006-06-09" ] }, { "row" : - [ "sub branch 1", "Lee, Jacques", "2012-04-03" ] }, { "row" : [ - "sub branch 1", "Asare-Frimpong, Patrick", "2012-04-18" ] }, { - "row" : [ "sub branch 2", "t, test", "2012-04-18" ] }, { "row" : [ - "Majmoua", "client, firstMajmoua", "2011-12-01" ] }, { "row" : [ - "Intrasoft Technologies", "Said, Zayyad", "2012-04-02" ] }, { - "row" : [ "Hugo technologies", "typical individual lending - client", "2010-06-02" ] } ] } + +{ + "columnHeaders": [ + { + "columnName": "Office/Branch", + "columnType": "VARCHAR", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [] + }, + { + "columnName": "Client Account No.", + "columnType": "VARCHAR", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [] + }, + { + "columnName": "Name", + "columnType": "VARCHAR", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [] + }, + { + "columnName": "Joined", + "columnType": "DATE", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [] + }, + { + "columnName": "External Id", + "columnType": "VARCHAR", + "isColumnNullable": false, + "isColumnPrimaryKey": false, + "columnValues": [] + } + ], + "data": [ + { + "row": [ + "Head Office", + "000000001", + "Petra Yton", + "2009-03-04", + "786YYH7" + ] + }, + { + "row": [ + "Head Office", + "000000002", + "Keith(changed) Yton", + "2009-03-04", + null + ] + }, + { + "row": [ + "Head Office", + "000000003", + "Jorge lastname", + "2013-02-05", + null + ] + } + ] +} + @@ -4268,24 +5635,37 @@ GET https://DomainName/api/v1/reports/{reportName} POST https://DomainName/api/v1/authentication?username={username}&password={password} - POST - authentication?username=mifos&password=password Content-Type: - application/json No Request Body - { "username": "mifos", - "userId": 1, "base64EncodedAuthenticationKey": - "bWlmb3M6cGFzc3dvcmQ=", "authenticated": true, "permissions": [ - "ALL_FUNCTIONS" ] } - - POST - authentication?username=mifos&password=fail Content-Type: - application/json No Request Body - { "developerMessage": "Invalid - authentication details were passed in api request.", - "developerDocLink": - "https://github.com/keithwoodlock/mifosx/wiki/HTTP-API-Error-codes", - "httpStatusCode": "401", "defaultUserMessage": "Unauthenticated. - Please login.", "userMessageGlobalisationCode": - "error.msg.not.authenticated", "errors": [] } + +POST authentication?username=mifos&password=password +Content-Type: application/json +No Request Body + + +{ + "username": "mifos", + "userId": 1, + "base64EncodedAuthenticationKey": "bWlmb3M6cGFzc3dvcmQ=", + "authenticated": true, + "permissions": [ + "ALL_FUNCTIONS" + ] +} + + +POST authentication?username=mifos&password=fail +Content-Type: application/json +No Request Body + + +{ + "developerMessage": "Invalid authentication details were passed in api request.", + "developerDocLink": "https://github.com/keithwoodlock/mifosx/wiki/HTTP-API-Error-codes", + "httpStatusCode": "401", + "defaultUserMessage": "Unauthenticated. Please login.", + "userMessageGlobalisationCode": "error.msg.not.authenticated", + "errors": [] +} + @@ -4294,8 +5674,7 @@ POST https://DomainName/api/v1/authentication?username={username}&password={pass

Users

-

An API capability to support administration of application - users.

+

An API capability to support administration of application users.

@@ -4313,13 +5692,19 @@ POST https://DomainName/api/v1/authentication?username={username}&password={pass GET https://DomainName/api/v1/users - [ { "id" : 6, "officeId" : 1, - "officeName" : "change super user", "username" : "committee1", - "firstname" : "Committee", "lastname" : "Member", "email" : - "fake@email.com" }, { "id" : 5, "officeId" : 1, "officeName" : - "change super user", "username" : "dataentry1", "firstname" : - "Data Entry", "lastname" : "User", "email" : "fake@email.com" - }...] + +[ + { + "id": 1, + "username": "mifos", + "officeId": 1, + "officeName": "Head Office", + "firstname": "App", + "lastname": "Administrator", + "email": "demomfi@mifos.org" + } +] + @@ -4343,18 +5728,24 @@ GET https://DomainName/api/v1/users GET https://DomainName/api/v1/users/template - { "allowedOffices": [ { "id": - 1, "name": "Head Office", "nameDecorated": "Head Office" }, { - "id": 10, "name": "Myanmar Regional Office", "nameDecorated": - "....Myanmar Regional Office" }, { "id": 7, "name": "Myanmar 1", - "nameDecorated": "........Myanmar 1" },... ], "availableRoles": [ - { "id": 1, "name": "Super user", "description": "This role - provides all application permissions." }, { "id": 2, "name": - "Field officer", "description": "A field officer role allows the - user to add client and loans and view reports but nothing else." - }, { "id": 3, "name": "Data Entry (Portfolio only)", - "description": "This role allows a user full permissions around - client and loan functionality but nothing else." },... ] } + +{ + "allowedOffices": [ + { + "id": 1, + "name": "Head Office", + "nameDecorated": "Head Office" + } + ], + "availableRoles": [ + { + "id": 1, + "name": "Super user", + "description": "This role provides all application permissions." + } + ] +} + @@ -4375,21 +5766,28 @@ GET https://DomainName/api/v1/users/template GET https://DomainName/api/v1/users/{userId} - { "id": 1, "username": - "mifos", "officeId": 1, "officeName": "Head Office", "firstname": - "App(test)", "lastname": "Administrator", "email": - "demomfi@mifos.org", "availableRoles": [ { "id": 2, "name": "Field - officer", "description": "A field officer role allows the user to - add client and loans and view reports but nothing else." }, { - "id": 3, "name": "Data Entry (Portfolio only)", "description": - "This role allows a user full permissions around client and loan - functionality but nothing else." },... ], "selectedRoles": [ { - "id": 1, "name": "Super user", "description": "This role provides - all application permissions." } ] } + +{ + "id": 1, + "username": "mifos", + "officeId": 1, + "officeName": "Head Office", + "firstname": "App", + "lastname": "Administrator", + "email": "demomfi@mifos.org", + "availableRoles": [], + "selectedRoles": [ + { + "id": 1, + "name": "Super user", + "description": "This role provides all application permissions." + } + ] +} + -  
@@ -4414,12 +5812,25 @@ GET https://DomainName/api/v1/users/{userId} POST https://DomainName/api/v1/users - POST users Content-Type: - application/json Request body: { "username": "Another New User - zll", "firstname": "Test", "lastname": "User", "email": - "whatever@mifos.org", "officeId": 1, "roles": [2,3] } - { "officeId": 1, - "resourceId": 11 } + +POST users +Content-Type: application/json +Request body: +{ + "username": "newuser", + "firstname": "Test", + "lastname": "User", + "email": "whatever@mifos.org", + "officeId": 1, + "roles": [2,3] +} + + +{ + "officeId": 1, + "resourceId": 11 +} +
@@ -4436,14 +5847,26 @@ POST https://DomainName/api/v1/users PUT https://DomainName/api/v1/users/{userId) - PUT users/3 Content-Type: - application/json Request body: { "firstname": "Test", "password": - "window75", "repeatPassword": "window75" } - { "officeId": 1, - "resourceId": 3, "changes": { "firstname": "Test", - "passwordEncoded": - "abc3326b1bb376351c7baeb4175f5e0504e33aadf6a158474a6d71de1befae51" - } } + +PUT users/3 +Content-Type: application/json +Request body: +{ + "firstname": "Test", + "password": "window75", + "repeatPassword": "window75" +} + + +{ + "officeId": 1, + "resourceId": 3, + "changes": { + "firstname": "Test", + "passwordEncoded": "abc3326b1bb376351c7baeb4175f5e0504e33aadf6a158474a6d71de1befae51" + } +} + @@ -4457,22 +5880,28 @@ PUT https://DomainName/api/v1/users/{userId) DELETE https://DomainName/api/v1/users/{userId} - DELETE users/20 Content-Type: - application/json No Request Body - { "officeId": 1, "resourceId": - 20, "changes": {} } + +DELETE users/20 +Content-Type: application/json +No Request Body + + +{ + "officeId": 1, + "resourceId": 20, + "changes": {} +} + -  

Roles

-

An API capability to support management of application roles - for user administration.

+

An API capability to support management of application roles for user administration.

@@ -4490,19 +5919,15 @@ DELETE https://DomainName/api/v1/users/{userId} GET https://DomainName/api/v1/roles - [ { "id" : 1, "name" : "Super - user", "description" : "This role provides all application - permissions." }, { "id" : 2, "name" : "Field officer", - "description" : "A field officer role allows the user to add - client and loans and view reports but nothing else." }, { "id" : - 3, "name" : "Data Entry (Portfolio only)", "description" : "This - role allows a user full permissions around client and loan - functionality but nothing else." }, { "id" : 4, "name" : "Credit - Committe Member", "description" : "This role allows a user to - approve reject or withdraw loans (with reporting)." }, { "id" : 5, - "name" : "Manager", "description" : "This role allows a manager to - do anything related to portfolio management and also view all - reports." } ] + +[ + { + "id": 1, + "name": "Super user", + "description": "This role provides all application permissions." + } +] + @@ -4520,9 +5945,13 @@ GET https://DomainName/api/v1/roles GET https://DomainName/api/v1/roles/{roleId} - { "id" : 1, "name" : "Super - user", "description" : "This role provides all application - permissions." } + +{ + "id": 1, + "name": "Super user", + "description": "This role provides all application permissions." +} + @@ -4543,11 +5972,16 @@ GET https://DomainName/api/v1/roles/{roleId} POST https://DomainName/api/v1/roles - POST roles Content-Type: - application/json Request body: { "name": "Another Role Name", - "description": "A description outlining the purpose of this role - in relation to the application." } - { "resourceId": 8 } + +POST roles +Content-Type: application/json +Request body: +{ + "name": "Another Role Name", + "description": "A description outlining the purpose of this role in relation to the application." +} + + { "resourceId": 2} @@ -4560,11 +5994,22 @@ POST https://DomainName/api/v1/roles PUT https://DomainName/api/v1/roles/{roleId} - PUT roles/8 Content-Type: - application/json Request body: { "description": "some - description(changed)" } - { "resourceId": 8, "changes": - { "description": "some description(changed)" } } + +PUT roles/1 +Content-Type: application/json +Request body: +{ + "description": "some description(changed)" +} + + +{ + "resourceId": 1, + "changes": { + "description": "some description(changed)" + } +} + @@ -4580,15 +6025,30 @@ PUT https://DomainName/api/v1/roles/{roleId} GET https://DomainName/api/v1/roles/{roleId}/permissions - { "id": 1, "name": "Super - user", "description": "This role provides all application - permissions.", "permissionUsageData": [ { "grouping": - "authorisation", "code": "READ_PERMISSION", "entityName": - "PERMISSION", "actionName": "READ", "selected": false }, { - "grouping": "authorisation", "code": "CREATE_ROLE", "entityName": - "ROLE", "actionName": "CREATE", "selected": false, }, { - "grouping": "authorisation", "code": "DELETE_ROLE", "entityName": - "ROLE", "actionName": "DELETE", "selected": false },...] } + +{ + "id": 1, + "name": "Super user", + "description": "This role provides all application permissions.", + "permissionUsageData": [ + { + "grouping": "authorisation", + "code": "READ_PERMISSION", + "entityName": "PERMISSION", + "actionName": "READ", + "selected": false + }, + ... + { + "grouping": "transaction_loan", + "code": "WRITEOFF_LOAN_CHECKER", + "entityName": "LOAN", + "actionName": "WRITEOFF", + "selected": false + } + ] +} + @@ -4602,11 +6062,26 @@ GET https://DomainName/api/v1/roles/{roleId}/permissions PUT https://DomainName/api/v1/roles/{roleId}/permissions - PUT roles/8 Content-Type: - application/json Request body: { "permissions": - {"ALL_FUNCTIONS_READ": "true"} } - { "resourceId": 8, "changes": - { "permissions": { "ALL_FUNCTIONS_READ": true } } } + +PUT roles/8 +Content-Type: application/json +Request body: +{ + "permissions": { + "ALL_FUNCTIONS_READ": "true" + } +} + + +{ + "resourceId": 8, + "changes": { + "permissions": { + "ALL_FUNCTIONS_READ": true + } + } +} + @@ -4615,8 +6090,7 @@ PUT https://DomainName/api/v1/roles/{roleId}/permissions

Permissions

-

An API capability to support management of application - permissions for user administration.

+

An API capability to support management of application permissions for user administration.

@@ -4635,13 +6109,25 @@ PUT https://DomainName/api/v1/roles/{roleId}/permissions GET https://DomainName/api/v1/permissions - [ { "grouping": - "authorisation", "code": "READ_PERMISSION", "entityName": - "PERMISSION", "actionName": "READ", "selected": true }, { - "grouping": "authorisation", "code": "CREATE_ROLE", "entityName": - "ROLE", "actionName": "CREATE", "selected": true }, { "grouping": - "authorisation", "code": "DELETE_ROLE", "entityName": "ROLE", - "actionName": "DELETE", "selected": true }, ... ] + +[ + { + "grouping": "authorisation", + "code": "READ_PERMISSION", + "entityName": "PERMISSION", + "actionName": "READ", + "selected": true + }, + .... + { + "grouping": "transaction_loan", + "code": "WRITEOFF_LOAN", + "entityName": "LOAN", + "actionName": "WRITEOFF", + "selected": true + } +] +