CBSNexora/cbsnexora-backend
4
0
Fork 0
Code Issues Pull Requests Actions 64 Packages Projects Releases Wiki Activity

api docs and notes

Browse Source
This commit is contained in:
John Woodlock
2012-05-30 18:06:10 +10:00
parent 284d05528b
commit 92ea057615
3 changed files with 409 additions and 392 deletions
Download Patch File Download Diff File Expand all files Collapse all files
APIFolder/api.htm
+368 -392
View File
@@ -860,33 +860,11 @@ Request Body:
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h3>Loans</h3> <h3>Loans</h3>
<p>Loan stuff. <p>
</p> </p>
</div> </div>
</div> </div>
<div class="method-section">
<div class="method-description">
<h5>Attributes</h5>
<dl class="argument-list">
<dt>
id
</dt>
<dd>
string <span>jpw ipsum as an example of showing the (at least important) columns</span>
</dd>
<dt>
amount
</dt>
<dd>blah <span></span>
</dd>
<dd>blah</dd>
<dt>
card
</dt>
</dl>
</div>
</div>
<a id="loans_template" name="loans_template" class="old-syle-anchor">&nbsp;</a> <a id="loans_template" name="loans_template" class="old-syle-anchor">&nbsp;</a>
<div class="method-section"> <div class="method-section">
@@ -1383,397 +1361,395 @@ Request Body:
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h4>Retrieve a Loan</h4> <h4>Retrieve a Loan</h4>
<p>Returns loan fields. <p>
</p> <b>Note:</b> template=true parameter doesn't apply to this resource.
<p>Example Request:
<a style="word-wrap: break-word;" href="https://localhost:8443/mifosng-provider/api/v1/loans/1">https://localhost:8443/mifosng-provider/api/v1/loans/1</a>
</p> </p>
<p>Example Requests: </p>
<a style="word-wrap: break-word;" href="https://localhost:8443/mifosng-provider/api/v1/loans/1?pretty=true">https://localhost:8443/mifosng-provider/api/v1/loans/1?pretty=true</a>
<br><br>
<a style="word-wrap: break-word;" href="https://localhost:8443/mifosng-provider/api/v1/loans/1?pretty=true&fields=id,principal,interestRatePerYear">https://localhost:8443/mifosng-provider/api/v1/loans/1?pretty=true&fields=id,principal,interestRatePerYear</a>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://thedomainname/api/v1/loans/{loanId}</code> <code class="method-declaration">GET https://thedomainname/api/v1/loans/{loanId}</code>
<code class="method-response">{ <code class="method-response">{
"open": false, "open" : false,
"openWithRepaymentMade": false, "openWithRepaymentMade" : false,
"closed": true, "closed" : true,
"interestRebateOutstanding": false, "interestRebateOutstanding" : false,
"pendingApproval": false, "pendingApproval" : false,
"waitingForDisbursal": false, "waitingForDisbursal" : false,
"lifeCycleStatusText": "Closed", "lifeCycleStatusText" : "Closed",
"lifeCycleStatusDate": "2009-11-13", "lifeCycleStatusDate" : [ 2009, 11, 13 ],
"id": 1, "id" : 1,
"externalId": null, "externalId" : null,
"loanProductName": "Agricultural Loan", "loanProductName" : "Agricultural Loan",
"submittedOnDate": "2009-01-05", "submittedOnDate" : [ 2009, 1, 5 ],
"approvedOnDate": "2009-01-08", "approvedOnDate" : [ 2009, 1, 8 ],
"expectedDisbursementDate": "2009-01-15", "expectedDisbursementDate" : [ 2009, 1, 15 ],
"actualDisbursementDate": "2009-01-15", "actualDisbursementDate" : [ 2009, 1, 15 ],
"undoDisbursalAllowed": false, "undoDisbursalAllowed" : false,
"expectedFirstRepaymentOnDate": null, "expectedFirstRepaymentOnDate" : null,
"interestCalculatedFromDate": null, "interestCalculatedFromDate" : null,
"closedOnDate": "2009-11-13", "closedOnDate" : [ 2009, 11, 13 ],
"expectedMaturityDate": "2009-11-15", "expectedMaturityDate" : [ 2009, 11, 15 ],
"principal": { "principal" : {
"currencyCode": "XOF", "currencyCode" : "XOF",
"currencyDigitsAfterDecimal": 0, "currencyDigitsAfterDecimal" : 0,
"amount": 100000, "amount" : 100000,
"defaultName": "CFA Franc BCEAO", "defaultName" : "CFA Franc BCEAO",
"nameCode": "currency.XOF", "nameCode" : "currency.XOF",
"displaySymbol": "CFA", "displaySymbol" : "CFA",
"zero": false, "zero" : false,
"greaterThanZero": true, "greaterThanZero" : true,
"displaySymbolValue": "100000 CFA" "displaySymbolValue" : "100000 CFA"
}, },
"interestRatePerYear": 21, "interestRatePerYear" : 21.0,
"interestRatePerPeriod": 1.75, "interestRatePerPeriod" : 1.75,
"interestPeriodFrequencyType": 2, "interestPeriodFrequencyType" : 2,
"interestPeriodFrequencyText": "MONTHS", "interestPeriodFrequencyText" : "MONTHS",
"interestMethodType": 0, "interestMethodType" : 0,
"interestMethodText": "DECLINING_BALANCE", "interestMethodText" : "DECLINING_BALANCE",
"amortizationMethodValue": 1, "amortizationMethodValue" : 1,
"amortizationMethodText": "EQUAL_INSTALLMENTS", "amortizationMethodText" : "EQUAL_INSTALLMENTS",
"numberOfRepayments": 1, "numberOfRepayments" : 1,
"repaymentFrequencyNumber": 10, "repaymentFrequencyNumber" : 10,
"repaymentFrequencyTypeEnumOrdinal": 2, "repaymentFrequencyTypeEnumOrdinal" : 2,
"repaymentFrequencyTypeText": "MONTHS", "repaymentFrequencyTypeText" : "MONTHS",
"interestRebateOwed": { "interestRebateOwed" : {
"currencyCode": "XOF", "currencyCode" : "XOF",
"currencyDigitsAfterDecimal": 0, "currencyDigitsAfterDecimal" : 0,
"amount": 0, "amount" : 0,
"defaultName": "CFA Franc BCEAO", "defaultName" : "CFA Franc BCEAO",
"nameCode": "currency.XOF", "nameCode" : "currency.XOF",
"displaySymbol": "CFA", "displaySymbol" : "CFA",
"zero": true, "zero" : true,
"greaterThanZero": false, "greaterThanZero" : false,
"displaySymbolValue": "0 CFA" "displaySymbolValue" : "0 CFA"
}, },
"loanData": { "loanData" : {
"repaymentSchedule": { "repaymentSchedule" : {
"periods": [ "periods" : [ {
{ "period" : 1,
"period": 1, "date" : [ 2009, 11, 15 ],
"date": "2009-11-15", "disbursed" : {
"disbursed": { "currencyCode" : "XOF",
"currencyCode": "XOF", "currencyDigitsAfterDecimal" : 0,
"currencyDigitsAfterDecimal": 0, "amount" : 0,
"amount": 0, "defaultName" : "CFA Franc BCEAO",
"defaultName": "CFA Franc BCEAO", "nameCode" : "currency.XOF",
"nameCode": "currency.XOF", "displaySymbol" : "CFA",
"displaySymbol": "CFA", "zero" : true,
"zero": true, "greaterThanZero" : false,
"greaterThanZero": false, "displaySymbolValue" : "0 CFA"
"displaySymbolValue": "0 CFA" },
}, "principal" : {
"principal": { "currencyCode" : "XOF",
"currencyCode": "XOF", "currencyDigitsAfterDecimal" : 0,
"currencyDigitsAfterDecimal": 0, "amount" : 100000,
"amount": 100000, "defaultName" : "CFA Franc BCEAO",
"defaultName": "CFA Franc BCEAO", "nameCode" : "currency.XOF",
"nameCode": "currency.XOF", "displaySymbol" : "CFA",
"displaySymbol": "CFA", "zero" : false,
"zero": false, "greaterThanZero" : true,
"greaterThanZero": true, "displaySymbolValue" : "100000 CFA"
"displaySymbolValue": "100000 CFA" },
}, "principalPaid" : {
"principalPaid": { "currencyCode" : "XOF",
"currencyCode": "XOF", "currencyDigitsAfterDecimal" : 0,
"currencyDigitsAfterDecimal": 0, "amount" : 100000,
"amount": 100000, "defaultName" : "CFA Franc BCEAO",
"defaultName": "CFA Franc BCEAO", "nameCode" : "currency.XOF",
"nameCode": "currency.XOF", "displaySymbol" : "CFA",
"displaySymbol": "CFA", "zero" : false,
"zero": false, "greaterThanZero" : true,
"greaterThanZero": true, "displaySymbolValue" : "100000 CFA"
"displaySymbolValue": "100000 CFA" },
}, "principalOutstanding" : {
"principalOutstanding": { "currencyCode" : "XOF",
"currencyCode": "XOF", "currencyDigitsAfterDecimal" : 0,
"currencyDigitsAfterDecimal": 0, "amount" : 0,
"amount": 0, "defaultName" : "CFA Franc BCEAO",
"defaultName": "CFA Franc BCEAO", "nameCode" : "currency.XOF",
"nameCode": "currency.XOF", "displaySymbol" : "CFA",
"displaySymbol": "CFA", "zero" : true,
"zero": true, "greaterThanZero" : false,
"greaterThanZero": false, "displaySymbolValue" : "0 CFA"
"displaySymbolValue": "0 CFA" },
}, "interest" : {
"interest": { "currencyCode" : "XOF",
"currencyCode": "XOF", "currencyDigitsAfterDecimal" : 0,
"currencyDigitsAfterDecimal": 0, "amount" : 17500,
"amount": 17500, "defaultName" : "CFA Franc BCEAO",
"defaultName": "CFA Franc BCEAO", "nameCode" : "currency.XOF",
"nameCode": "currency.XOF", "displaySymbol" : "CFA",
"displaySymbol": "CFA", "zero" : false,
"zero": false, "greaterThanZero" : true,
"greaterThanZero": true, "displaySymbolValue" : "17500 CFA"
"displaySymbolValue": "17500 CFA" },
}, "interestPaid" : {
"interestPaid": { "currencyCode" : "XOF",
"currencyCode": "XOF", "currencyDigitsAfterDecimal" : 0,
"currencyDigitsAfterDecimal": 0, "amount" : 17500,
"amount": 17500, "defaultName" : "CFA Franc BCEAO",
"defaultName": "CFA Franc BCEAO", "nameCode" : "currency.XOF",
"nameCode": "currency.XOF", "displaySymbol" : "CFA",
"displaySymbol": "CFA", "zero" : false,
"zero": false, "greaterThanZero" : true,
"greaterThanZero": true, "displaySymbolValue" : "17500 CFA"
"displaySymbolValue": "17500 CFA" },
}, "interestOutstanding" : {
"interestOutstanding": { "currencyCode" : "XOF",
"currencyCode": "XOF", "currencyDigitsAfterDecimal" : 0,
"currencyDigitsAfterDecimal": 0, "amount" : 0,
"amount": 0, "defaultName" : "CFA Franc BCEAO",
"defaultName": "CFA Franc BCEAO", "nameCode" : "currency.XOF",
"nameCode": "currency.XOF", "displaySymbol" : "CFA",
"displaySymbol": "CFA", "zero" : true,
"zero": true, "greaterThanZero" : false,
"greaterThanZero": false, "displaySymbolValue" : "0 CFA"
"displaySymbolValue": "0 CFA" },
}, "total" : {
"total": { "currencyCode" : "XOF",
"currencyCode": "XOF", "currencyDigitsAfterDecimal" : 0,
"currencyDigitsAfterDecimal": 0, "amount" : 117500,
"amount": 117500, "defaultName" : "CFA Franc BCEAO",
"defaultName": "CFA Franc BCEAO", "nameCode" : "currency.XOF",
"nameCode": "currency.XOF", "displaySymbol" : "CFA",
"displaySymbol": "CFA", "zero" : false,
"zero": false, "greaterThanZero" : true,
"greaterThanZero": true, "displaySymbolValue" : "117500 CFA"
"displaySymbolValue": "117500 CFA" },
}, "totalPaid" : {
"totalPaid": { "currencyCode" : "XOF",
"currencyCode": "XOF", "currencyDigitsAfterDecimal" : 0,
"currencyDigitsAfterDecimal": 0, "amount" : 117500,
"amount": 117500, "defaultName" : "CFA Franc BCEAO",
"defaultName": "CFA Franc BCEAO", "nameCode" : "currency.XOF",
"nameCode": "currency.XOF", "displaySymbol" : "CFA",
"displaySymbol": "CFA", "zero" : false,
"zero": false, "greaterThanZero" : true,
"greaterThanZero": true, "displaySymbolValue" : "117500 CFA"
"displaySymbolValue": "117500 CFA" },
}, "totalOutstanding" : {
"totalOutstanding": { "currencyCode" : "XOF",
"currencyCode": "XOF", "currencyDigitsAfterDecimal" : 0,
"currencyDigitsAfterDecimal": 0, "amount" : 0,
"amount": 0, "defaultName" : "CFA Franc BCEAO",
"defaultName": "CFA Franc BCEAO", "nameCode" : "currency.XOF",
"nameCode": "currency.XOF", "displaySymbol" : "CFA",
"displaySymbol": "CFA", "zero" : true,
"zero": true, "greaterThanZero" : false,
"greaterThanZero": false, "displaySymbolValue" : "0 CFA"
"displaySymbolValue": "0 CFA" },
}, "totalWaived" : null,
"totalWaived": null, "totalArrears" : {
"totalArrears": { "currencyCode" : "XOF",
"currencyCode": "XOF", "currencyDigitsAfterDecimal" : 0,
"currencyDigitsAfterDecimal": 0, "amount" : 0,
"amount": 0, "defaultName" : "CFA Franc BCEAO",
"defaultName": "CFA Franc BCEAO", "nameCode" : "currency.XOF",
"nameCode": "currency.XOF", "displaySymbol" : "CFA",
"displaySymbol": "CFA", "zero" : true,
"zero": true, "greaterThanZero" : false,
"greaterThanZero": false, "displaySymbolValue" : "0 CFA"
"displaySymbolValue": "0 CFA" },
}, "arrearsFrom" : null,
"arrearsFrom": null, "arrearsTo" : null,
"arrearsTo": null, "paidInFullOn" : [ 2009, 11, 13 ],
"paidInFullOn": "2009-11-13", "lastAffectingPaymentOn" : [ 2009, 11, 13 ],
"lastAffectingPaymentOn": "2009-11-13", "fullyPaid" : true
"fullyPaid": true } ]
}
]
}, },
"summary": { "summary" : {
"originalPrincipal": { "originalPrincipal" : {
"currencyCode": "XOF", "currencyCode" : "XOF",
"currencyDigitsAfterDecimal": 0, "currencyDigitsAfterDecimal" : 0,
"amount": 100000, "amount" : 100000,
"defaultName": "CFA Franc BCEAO", "defaultName" : "CFA Franc BCEAO",
"nameCode": "currency.XOF", "nameCode" : "currency.XOF",
"displaySymbol": "CFA", "displaySymbol" : "CFA",
"zero": false, "zero" : false,
"greaterThanZero": true, "greaterThanZero" : true,
"displaySymbolValue": "100000 CFA" "displaySymbolValue" : "100000 CFA"
}, },
"originalInterest": { "originalInterest" : {
"currencyCode": "XOF", "currencyCode" : "XOF",
"currencyDigitsAfterDecimal": 0, "currencyDigitsAfterDecimal" : 0,
"amount": 17500, "amount" : 17500,
"defaultName": "CFA Franc BCEAO", "defaultName" : "CFA Franc BCEAO",
"nameCode": "currency.XOF", "nameCode" : "currency.XOF",
"displaySymbol": "CFA", "displaySymbol" : "CFA",
"zero": false, "zero" : false,
"greaterThanZero": true, "greaterThanZero" : true,
"displaySymbolValue": "17500 CFA" "displaySymbolValue" : "17500 CFA"
}, },
"originalTotal": { "originalTotal" : {
"currencyCode": "XOF", "currencyCode" : "XOF",
"currencyDigitsAfterDecimal": 0, "currencyDigitsAfterDecimal" : 0,
"amount": 117500, "amount" : 117500,
"defaultName": "CFA Franc BCEAO", "defaultName" : "CFA Franc BCEAO",
"nameCode": "currency.XOF", "nameCode" : "currency.XOF",
"displaySymbol": "CFA", "displaySymbol" : "CFA",
"zero": false, "zero" : false,
"greaterThanZero": true, "greaterThanZero" : true,
"displaySymbolValue": "117500 CFA" "displaySymbolValue" : "117500 CFA"
}, },
"principalPaid": { "principalPaid" : {
"currencyCode": "XOF", "currencyCode" : "XOF",
"currencyDigitsAfterDecimal": 0, "currencyDigitsAfterDecimal" : 0,
"amount": 100000, "amount" : 100000,
"defaultName": "CFA Franc BCEAO", "defaultName" : "CFA Franc BCEAO",
"nameCode": "currency.XOF", "nameCode" : "currency.XOF",
"displaySymbol": "CFA", "displaySymbol" : "CFA",
"zero": false, "zero" : false,
"greaterThanZero": true, "greaterThanZero" : true,
"displaySymbolValue": "100000 CFA" "displaySymbolValue" : "100000 CFA"
}, },
"principalOutstanding": { "principalOutstanding" : {
"currencyCode": "XOF", "currencyCode" : "XOF",
"currencyDigitsAfterDecimal": 0, "currencyDigitsAfterDecimal" : 0,
"amount": 0, "amount" : 0,
"defaultName": "CFA Franc BCEAO", "defaultName" : "CFA Franc BCEAO",
"nameCode": "currency.XOF", "nameCode" : "currency.XOF",
"displaySymbol": "CFA", "displaySymbol" : "CFA",
"zero": true, "zero" : true,
"greaterThanZero": false, "greaterThanZero" : false,
"displaySymbolValue": "0 CFA" "displaySymbolValue" : "0 CFA"
}, },
"interestPaid": { "interestPaid" : {
"currencyCode": "XOF", "currencyCode" : "XOF",
"currencyDigitsAfterDecimal": 0, "currencyDigitsAfterDecimal" : 0,
"amount": 17500, "amount" : 17500,
"defaultName": "CFA Franc BCEAO", "defaultName" : "CFA Franc BCEAO",
"nameCode": "currency.XOF", "nameCode" : "currency.XOF",
"displaySymbol": "CFA", "displaySymbol" : "CFA",
"zero": false, "zero" : false,
"greaterThanZero": true, "greaterThanZero" : true,
"displaySymbolValue": "17500 CFA" "displaySymbolValue" : "17500 CFA"
}, },
"interestOutstanding": { "interestOutstanding" : {
"currencyCode": "XOF", "currencyCode" : "XOF",
"currencyDigitsAfterDecimal": 0, "currencyDigitsAfterDecimal" : 0,
"amount": 0, "amount" : 0,
"defaultName": "CFA Franc BCEAO", "defaultName" : "CFA Franc BCEAO",
"nameCode": "currency.XOF", "nameCode" : "currency.XOF",
"displaySymbol": "CFA", "displaySymbol" : "CFA",
"zero": true, "zero" : true,
"greaterThanZero": false, "greaterThanZero" : false,
"displaySymbolValue": "0 CFA" "displaySymbolValue" : "0 CFA"
}, },
"totalPaid": { "totalPaid" : {
"currencyCode": "XOF", "currencyCode" : "XOF",
"currencyDigitsAfterDecimal": 0, "currencyDigitsAfterDecimal" : 0,
"amount": 117500, "amount" : 117500,
"defaultName": "CFA Franc BCEAO", "defaultName" : "CFA Franc BCEAO",
"nameCode": "currency.XOF", "nameCode" : "currency.XOF",
"displaySymbol": "CFA", "displaySymbol" : "CFA",
"zero": false, "zero" : false,
"greaterThanZero": true, "greaterThanZero" : true,
"displaySymbolValue": "117500 CFA" "displaySymbolValue" : "117500 CFA"
}, },
"totalOutstanding": { "totalOutstanding" : {
"currencyCode": "XOF", "currencyCode" : "XOF",
"currencyDigitsAfterDecimal": 0, "currencyDigitsAfterDecimal" : 0,
"amount": 0, "amount" : 0,
"defaultName": "CFA Franc BCEAO", "defaultName" : "CFA Franc BCEAO",
"nameCode": "currency.XOF", "nameCode" : "currency.XOF",
"displaySymbol": "CFA", "displaySymbol" : "CFA",
"zero": true, "zero" : true,
"greaterThanZero": false, "greaterThanZero" : false,
"displaySymbolValue": "0 CFA" "displaySymbolValue" : "0 CFA"
}, },
"totalInArrears": { "totalInArrears" : {
"currencyCode": "XOF", "currencyCode" : "XOF",
"currencyDigitsAfterDecimal": 0, "currencyDigitsAfterDecimal" : 0,
"amount": 0, "amount" : 0,
"defaultName": "CFA Franc BCEAO", "defaultName" : "CFA Franc BCEAO",
"nameCode": "currency.XOF", "nameCode" : "currency.XOF",
"displaySymbol": "CFA", "displaySymbol" : "CFA",
"zero": true, "zero" : true,
"greaterThanZero": false, "greaterThanZero" : false,
"displaySymbolValue": "0 CFA" "displaySymbolValue" : "0 CFA"
}, },
"totalWaived": { "totalWaived" : {
"currencyCode": "XOF", "currencyCode" : "XOF",
"currencyDigitsAfterDecimal": 0, "currencyDigitsAfterDecimal" : 0,
"amount": 0, "amount" : 0,
"defaultName": "CFA Franc BCEAO", "defaultName" : "CFA Franc BCEAO",
"nameCode": "currency.XOF", "nameCode" : "currency.XOF",
"displaySymbol": "CFA", "displaySymbol" : "CFA",
"zero": true, "zero" : true,
"greaterThanZero": false, "greaterThanZero" : false,
"displaySymbolValue": "0 CFA" "displaySymbolValue" : "0 CFA"
} }
}, },
"loanRepayments": [ "loanRepayments" : [ {
{ "id" : 2,
"id": 2, "date" : [ 2009, 11, 13 ],
"date": "2009-11-13", "principal" : {
"principal": { "currencyCode" : "XOF",
"currencyCode": "XOF", "currencyDigitsAfterDecimal" : 0,
"currencyDigitsAfterDecimal": 0, "amount" : 100000,
"amount": 100000, "defaultName" : "CFA Franc BCEAO",
"defaultName": "CFA Franc BCEAO", "nameCode" : "currency.XOF",
"nameCode": "currency.XOF", "displaySymbol" : "CFA",
"displaySymbol": "CFA", "zero" : false,
"zero": false, "greaterThanZero" : true,
"greaterThanZero": true, "displaySymbolValue" : "100000 CFA"
"displaySymbolValue": "100000 CFA" },
}, "interest" : {
"interest": { "currencyCode" : "XOF",
"currencyCode": "XOF", "currencyDigitsAfterDecimal" : 0,
"currencyDigitsAfterDecimal": 0, "amount" : 17500,
"amount": 17500, "defaultName" : "CFA Franc BCEAO",
"defaultName": "CFA Franc BCEAO", "nameCode" : "currency.XOF",
"nameCode": "currency.XOF", "displaySymbol" : "CFA",
"displaySymbol": "CFA", "zero" : false,
"zero": false, "greaterThanZero" : true,
"greaterThanZero": true, "displaySymbolValue" : "17500 CFA"
"displaySymbolValue": "17500 CFA" },
}, "total" : {
"total": { "currencyCode" : "XOF",
"currencyCode": "XOF", "currencyDigitsAfterDecimal" : 0,
"currencyDigitsAfterDecimal": 0, "amount" : 117500,
"amount": 117500, "defaultName" : "CFA Franc BCEAO",
"defaultName": "CFA Franc BCEAO", "nameCode" : "currency.XOF",
"nameCode": "currency.XOF", "displaySymbol" : "CFA",
"displaySymbol": "CFA", "zero" : false,
"zero": false, "greaterThanZero" : true,
"greaterThanZero": true, "displaySymbolValue" : "117500 CFA"
"displaySymbolValue": "117500 CFA" },
}, "totalWaived" : null,
"totalWaived": null, "overpaid" : null,
"overpaid": null, "transactionOffsetFromToday" : -929
"transactionOffsetFromToday": -921 } ]
}
]
}, },
"arrearsTolerance": { "arrearsTolerance" : {
"currencyCode": "XOF", "currencyCode" : "XOF",
"currencyDigitsAfterDecimal": 0, "currencyDigitsAfterDecimal" : 0,
"amount": 1000, "amount" : 1000,
"defaultName": "CFA Franc BCEAO", "defaultName" : "CFA Franc BCEAO",
"nameCode": "currency.XOF", "nameCode" : "currency.XOF",
"displaySymbol": "CFA", "displaySymbol" : "CFA",
"zero": false, "zero" : false,
"greaterThanZero": true, "greaterThanZero" : true,
"displaySymbolValue": "1000 CFA" "displaySymbolValue" : "1000 CFA"
}, },
"waiveAllowed": false, "waiveAllowed" : false,
"makeRepaymentAllowed": false, "makeRepaymentAllowed" : false,
"rejectAllowed": false, "rejectAllowed" : false,
"withdrawnByApplicantAllowed": false, "withdrawnByApplicantAllowed" : false,
"undoApprovalAllowed": false, "undoApprovalAllowed" : false,
"disbursalAllowed": false, "disbursalAllowed" : false,
"anyActionOnLoanAllowed": false, "anyActionOnLoanAllowed" : false,
"maxSubmittedOnOffsetFromToday": -1233, "maxSubmittedOnOffsetFromToday" : -1241,
"maxApprovedOnOffsetFromToday": -1230, "maxApprovedOnOffsetFromToday" : -1238,
"maxDisbursedOnOffsetFromToday": -1223, "maxDisbursedOnOffsetFromToday" : -1231,
"actualLoanTermInDays": 302, "actualLoanTermInDays" : 302,
"actualLoanTermInMonths": 9, "actualLoanTermInMonths" : 9,
"loanTermInDays": 304, "loanTermInDays" : 304,
"loanTermInMonths": 10 "loanTermInMonths" : 10
} }
</code> </code>
</div> </div>
</div> </div>
APIFolder/docUpdateComments.txt
+18
View File
@@ -27,12 +27,30 @@ Type fields rename and with associated text?
allowedProduct should maybe just be id & name allowedProduct should maybe just be id & name
which fields have defaults as not all on NewLoanWorkflowStepOneData dto seem to be default. which fields have defaults as not all on NewLoanWorkflowStepOneData dto seem to be default.
loan retrieve
break up data into categories.. e.g.
Basic - lifeCycleStatusText thru
Convenience - open thru waitingForDisbursal then maxSubmittedOnOffsetFromToday, maxApprovedOnOffsetFromToday , maxDisbursedOnOffsetFromToday, actualLoanTermInDays, actualLoanTermInMonths, loanTermInDays, loanTermInMonths
Permission - undoDisbursalAllowed, waiveAllowed, makeRepaymentAllowed, rejectAllowed, withdrawnByApplicantAllowed, undoApprovalAllowed, disbursalAllowed, anyActionOnLoanAllowed
flatten loadData
repaymentSchedule
summary
loanRepayments
Additional Fields Additional Fields
put right message for parameter not recognized etc.(plus tht 9 other jpwwrongmsg items) put right message for parameter not recognized etc.(plus tht 9 other jpwwrongmsg items)
Loans - what does Keith think about a description
Identify Fields that need explaining Identify Fields that need explaining
Clients Clients
displayName, externalId, maxJoinedOnOffsetFromToday displayName, externalId, maxJoinedOnOffsetFromToday
APIFolder/exampleArgList.txt
+23
View File
@@ -0,0 +1,23 @@
<div class="method-section">
<div class="method-description">
<h5>Attributes</h5>
<dl class="argument-list">
<dt>
id
</dt>
<dd>
string <span>jpw ipsum as an example of showing the (at least important) columns</span>
</dd>
<dt>
amount
</dt>
<dd>blah <span></span>
</dd>
<dd>blah</dd>
<dt>
card
</dt>
</dl>
</div>
</div>