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

api docs WIP

Browse Source
This commit is contained in:
John Woodlock
2012-05-21 17:47:43 +10:00
parent 4019a783a7
commit 5a72f687e7
1 changed files with 591 additions and 109 deletions
Download Patch File Download Diff File Expand all files Collapse all files
APIFolder/api.htm
+590 -108
View File
@@ -17,7 +17,7 @@
<div class="toc-section"> <div class="toc-section">
<ul> <ul>
<li><a href="#top">Mifos X API Documentation</a></li> <li><a href="#top">Mifos X API Documentation</a></li>
<li><a href="#authenticationoverview">Authentication Overview</a></li> <li><a href="#authentication_overview">Authentication Overview</a></li>
<li><a href="#errors">Errors</a></li> <li><a href="#errors">Errors</a></li>
</ul> </ul>
</div> </div>
@@ -25,15 +25,15 @@
<div class="toc-section"> <div class="toc-section">
<h4><a href="#clients">Clients</a></h4> <h4><a href="#clients">Clients</a></h4>
<ul> <ul>
<li><a href="#clientslist">List Clients</a></li> <li><a href="#clients_list">List Clients</a></li>
<li><a href="#clientsretrieve">Retrieve a Client</a></li> <li><a href="#clients_template">Retrieve Client Details Template</a></li>
<li><a href="#clientstemplate">Retrieve Client Details Template</a></li> <li><a href="#clients_retrieve">Retrieve a Client</a></li>
<li><a href="#clientscreate">Create a Client</a></li> <li><a href="#clients_create">Create a Client</a></li>
<li><a href="#clientsloansummary">Retrieve a Client's Loan Account Summary</a></li> <li><a href="#clients_loansummary">Retrieve a Client's Loan Account Summary</a></li>
<li><a href="#clientsnotes">Retrieve a Client's Notes</a></li> <li><a href="#clients_notes">Retrieve a Client's Notes</a></li>
<li><a href="#clientsaddnote">Add a Client Note</a></li> <li><a href="#clients_addnote">Add a Client Note</a></li>
<li><a href="#clientsretrievenote">Retrieve a Client Note</a></li> <li><a href="#clients_retrievenote">Retrieve a Client Note</a></li>
<li><a href="#clientsupdatenote">Update a Client Note</a></li> <li><a href="#clients_updatenote">Update a Client Note</a></li>
No update a client? No update a client?
</ul> </ul>
</div> </div>
@@ -43,23 +43,23 @@ No update a client?
<div class="toc-section"> <div class="toc-section">
<h4><a href="#loans">Loans</a></h4> <h4><a href="#loans">Loans</a></h4>
<ul> <ul>
<li><a href="#loansretrieve">Retrieve a Loan</a></li> <li><a href="#loans_template">Retrieve Loan Details Template</a></li>
<li><a href="#loanstemplate">Retrieve Loan Details Template</a></li> <li><a href="#loans_retrieve">Retrieve a Loan</a></li>
<li><a href="#loanscreate">Create a New Loan</a></li> <li><a href="#loans_create">Create a New Loan</a></li>
<li><a href="#loanssubmit">Submit a Loan Application</a></li> <li><a href="#loans_submit">Submit a Loan Application</a></li>
<li><a href="#loansapprove">Approve a Loan</a></li> <li><a href="#loans_approve">Approve a Loan</a></li>
<li><a href="#loansdisburse">Disburse a Loan</a></li> <li><a href="#loans_disburse">Disburse a Loan</a></li>
<li><a href="#loansreject">Reject a Loan</a></li> <li><a href="#loans_reject">Reject a Loan</a></li>
<li><a href="#loanswithdraw">Client Withdraws a Loan</a></li> <li><a href="#loans_withdraw">Client Withdraws a Loan</a></li>
<li><a href="#loansdelete">Delete a Loan</a></li> <li><a href="#loans_delete">Delete a Loan</a></li>
<li><a href="#loansundoapproval">Undo Loan Approval</a></li> <li><a href="#loans_undoapproval">Undo Loan Approval</a></li>
<li><a href="#loansundodisbursal">Undo Loan Disbursal</a></li> <li><a href="#loans_undodisbursal">Undo Loan Disbursal</a></li>
<li><a href="#loansrepaymenttemplate">Retrieve Loan Repayment Template</a></li> <li><a href="#loans_repaymenttemplate">Retrieve Loan Repayment Template</a></li>
<li><a href="#loanswaivertemplate">Retrieve Loan Waiver Template</a></li> <li><a href="#loans_waivertemplate">Retrieve Loan Waiver Template</a></li>
<li><a href="#loansrepayment">Make a Repayment</a></li> <li><a href="#loans_repayment">Make a Repayment</a></li>
<li><a href="#loanswaiver">Loan Waiver</a></li> <li><a href="#loans_waiver">Loan Waiver</a></li>
<li><a href="#loansrepaymentretrieve">Retrieve a Repayment's Details</a></li> <li><a href="#loans_repaymentretrieve">Retrieve a Repayment's Details</a></li>
<li><a href="#loansrepaymentadjust">Adjust a Repayment</a></li> <li><a href="#loans_repaymentadjust">Adjust a Repayment</a></li>
is there a retrieve waive and an Adjust Waiver as well? is there a retrieve waive and an Adjust Waiver as well?
</ul> </ul>
</div> </div>
@@ -71,58 +71,56 @@ is there a retrieve waive and an Adjust Waiver as well?
<div class="toc-section"> <div class="toc-section">
<h4><a href="#offices">Offices</a></h4> <h4><a href="#offices">Offices</a></h4>
<ul> <ul>
<li><a href="#officeslist">List Offices</a></li> <li><a href="#offices_list">List Offices</a></li>
<li><a href="#officesretrieve">Retrieve an Office</a></li> <li><a href="#offices_template">Retrieve Office Details Template</a></li>
<li><a href="#officestemplate">Retrieve Office Details Template</a></li> <li><a href="#offices_retrieve">Retrieve an Office</a></li>
<li><a href="#officescreate">Create an Office</a></li> <li><a href="#offices_create">Create an Office</a></li>
<li><a href="#officesupdate">Update an Office</a></li> <li><a href="#offices_update">Update an Office</a></li>
</ul> </ul>
</div> </div>
<div class="toc-section"> <div class="toc-section">
<h4><a href="#loanproducts">Loan Products</a></h4> <h4><a href="#loanproducts">Loan Products</a></h4>
<ul> <ul>
<li><a href="#loanproductslist">List Loan Products</a></li> <li><a href="#loanproducts_list">List Loan Products</a></li>
<li><a href="#loanproductsretrieve">Retrieve a Loan Product</a></li> <li><a href="#loanproducts_template">Retrieve Loan Product Details Template</a></li>
<li><a href="#loanproductstemplate">Retrieve Loan Product Details Template</a></li> <li><a href="#loanproducts_retrieve">Retrieve a Loan Product</a></li>
<li><a href="#loanproductscreate">Create a Loan Product</a></li> <li><a href="#loanproducts_create">Create a Loan Product</a></li>
<li><a href="#loanproductsupdate">Update a Loan Product</a></li> <li><a href="#loanproducts_update">Update a Loan Product</a></li>
</ul> </ul>
</div> </div>
<div class="toc-section"> <div class="toc-section">
<h4><a href="#configs">Configurations</a></h4> <h4><a href="#configs">Configurations</a></h4>
<ul> <ul>
<li><a href="#configscurrencyretrieve">Retrieve Currency Configuration</a></li> <li><a href="#configs_currencyretrieve">Retrieve Currency Configuration</a></li>
<li><a href="#configscurrencyupdate">Update Currency Configuration</a></li> <li><a href="#configs_currencyupdate">Update Currency Configuration</a></li>
</ul> </ul>
</div> </div>
<div class="toc-section"> <div class="toc-section">
<h4><a href="#additionalfields">Additional Fields</a></h4> <h4><a href="#additionalfields">Additional Fields</a></h4>
<ul> <ul>
<li><a href="#listadditionalfields">List Additional Fields Sets</a></li> <li><a href="#additionalfields_list">List Additional Fields Sets</a></li>
<li><a href="#retrieveadditionalfields">Retrieve Additional Fields</a></li> <li><a href="#additionalfields_retrieve">Retrieve Additional Fields</a></li>
<li><a href="#updateadditionalfields">Update Additional Fields</a></li> <li><a href="#additionalfields_update">Update Additional Fields</a></li>
</ul> </ul>
</div> </div>
<div class="toc-section"> <div class="toc-section">
<h4><a href="#reports">Reports</a></h4> <h4><a href="#reports">Reports</a></h4>
<ul> <ul>
<li><a href="#listreports">List Reports</a></li> <li><a href="#reports_list">List Reports</a></li>
<li><a href="#runreport">Run a Report</a></li> <li><a href="#report_run">Run a Report</a></li>
</ul> </ul>
</div> </div>
</div> </div>
<div class="toc-column4"> <div class="toc-column4">
<div class="toc-section"> <div class="toc-section">
<h4><a href="#authentication">Authentication</a></h4> <h4><a href="#authentication">Authentication</a></h4>
<ul> <ul>
<li><a href="#authenticationpermissions">Retrieve Authenticated Permissions</a></li> <li><a href="#authentication_permissions">Retrieve Authenticated Permissions</a></li>
</ul> </ul>
</div> </div>
@@ -150,7 +148,6 @@ is there a retrieve waive and an Adjust Waiver as well?
<li><a href="#tbd">tbd</a></li> <li><a href="#tbd">tbd</a></li>
</ul> </ul>
</div> </div>
</div> </div>
</div> </div>
@@ -163,9 +160,6 @@ is there a retrieve waive and an Adjust Waiver as well?
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h1>Mifos X API Documentation</h1> <h1>Mifos X API Documentation</h1>
<p>
Much of the presentation ideas here have been taken from the very good API reference (https://stripe.com/docs/api)
</p>
<p> <p>
The Mifox X API is organized around The Mifox X API is organized around
<a href="http://en.wikipedia.org/wiki/Representational_State_Transfer">REST</a>. <a href="http://en.wikipedia.org/wiki/Representational_State_Transfer">REST</a>.
@@ -176,7 +170,9 @@ is there a retrieve waive and an Adjust Waiver as well?
clients. <a href="http://www.json.org/">JSON</a> will be clients. <a href="http://www.json.org/">JSON</a> will be
returned in all responses from the API, including errors. returned in all responses from the API, including errors.
</p> </p>
<p>
Much of the presentation ideas here have been taken from the very good API reference (https://stripe.com/docs/api)
</p>
</div> </div>
<div class="method-example" id="api-summary-example"> <div class="method-example" id="api-summary-example">
@@ -184,59 +180,56 @@ is there a retrieve waive and an Adjust Waiver as well?
<code>https://thedomainname/</code> <code>https://thedomainname/</code>
<h6>Summary of Resource URL Patterns</h6> <h6>Summary of Resource URL Patterns</h6>
<ul> <ul>
<li>/api/v1/clients</li>
<li>/api/v1/clients/template</li>
<li>/api/v1/clients/{clientId}</li>
<li>/api/v1/clients/{clientId}/loans</li>
<li>/api/v1/clients/{clientId}/notes</li>
<li>/api/v1/clients/{clientId}/notes/{noteId}</li>
<li>/api/v1/loans</li>
<li>/api/v1/loans/template</li>
<li>/api/v1/loans/{loanId}</li>
<li>/api/v1/loans/{loanId}/undo</li>
<li>/api/v1/loans/{loanId}/transactions/template</li>
<li>/api/v1/loans/{loanId}/transactions</li>
<li>/api/v1/loans/{loanId}/transactions/{repaymentId}</li>
<li>/v1/clients</li> <li>/api/v1/offices</li>
<li>/v1/clients/template</li> <li>/api/v1/offices/template</li>
<li>/v1/clients/{clientId}</li> <li>/api/v1/offices/{officeId}</li>
<li>/v1/clients/{clientId}/loans</li>
<li>/v1/clients/{clientId}/notes</li>
<li>/v1/clients/{clientId}/notes/{noteId}</li>
<li>/v1/loans</li> <li>/api/v1/loanproducts</li>
<li>/v1/loans/template</li> <li>/api/v1/loanproducts/template</li>
<li>/v1/loans/{loanId}</li> <li>/api/v1/loanproducts/{productId}</li>
<li>/v1/loans/{loanId}/undo</li>
<li>/v1/loans/{loanId}/transactions/template</li>
<li>/v1/loans/{loanId}/transactions</li>
<li>/v1/loans/{loanId}/transactions/{repaymentId}</li>
<li>/v1/offices</li> <li>/api/v1/configurations/currency</li>
<li>/v1/offices/template</li>
<li>/v1/offices/{officeId}</li>
<li>/v1/loanproducts</li> <li>/api/v1/additionalfields</li>
<li>/v1/loanproducts/template</li> <li>/api/v1/additionalfields/{Type}/{Set}/{id}</li>
<li>/v1/loanproducts/{productId}</li>
<li>/v1/configurations/currency</li> <li>/api/v1/reports/{reportName}</li>
<li>/v1/additionalfields</li> <li>/api/v1/authentication</li>
<li>/v1/additionalfields/{Type}/{Set}/{id}</li>
<li>/v1/reports/{reportName}</li> <li>/api/v1/useraccounts/current</li>
<li>/api/v1/useraccounts/current/password</li>
<li>/api/v1/useraccounts/current/password/template</li>
<li>/v1/authentication</li> <li>/api/v1/users</li>
<li>/api/v1/users/template</li>
<li>/api/v1/users/{userId}</li>
<li>/v1/useraccounts/current</li> <li>/api/v1/roles</li>
<li>/v1/useraccounts/current/password</li> <li>/api/v1/roles/template</li>
<li>/v1/useraccounts/current/password/template</li> <li>/api/v1/roles/{roleId}</li>
<li>/v1/users</li> <li>/api/v1/permissions</li>
<li>/v1/users/template</li>
<li>/v1/users/{userId}</li>
<li>/v1/roles</li>
<li>/v1/roles/template</li>
<li>/v1/roles/{roleId}</li>
<li>/v1/permissions</li>
</ul> </ul>
</div> </div>
</div> </div>
<a id="authenticationoverview" name="authenticationoverview" class="old-syle-anchor">&nbsp;</a> <a id="authentication_overview" name="authentication_overview" class="old-syle-anchor">&nbsp;</a>
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h3>Authentication Overview</h3> <h3>Authentication Overview</h3>
@@ -268,7 +261,7 @@ is there a retrieve waive and an Adjust Waiver as well?
</p> </p>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-request"><span class="prompt curl"></span>curl https://api.stripe.com/v1/charges \ <code class="method-request"><span class="prompt curl"></span>curl https://api.stripe.com/api/v1/charges \
-u vtUQeOtUnYr7PGCLQ96Ul4zqpDUO4sOE: -u vtUQeOtUnYr7PGCLQ96Ul4zqpDUO4sOE:
</code> </code>
<p> <p>
@@ -277,12 +270,9 @@ is there a retrieve waive and an Adjust Waiver as well?
credentials (adding a colon after your API key will prevent credentials (adding a colon after your API key will prevent
it from asking you for a password). it from asking you for a password).
A sample test API key has been provided in all A sample test API key has been provided in all
the examples on the page, so you can test out any example right away. the examples on the page, so you can test out any example right away.
</p> </p>
</div> </div>
</div> </div>
@@ -428,6 +418,502 @@ error is parameter-specific. You can use this to display a message near
<a id="loanproducts" name="loanproducts" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h3>Loan Products</h3>
<p>A Loan product is a template that is used when creating a loan. Much of the template definition can be changed during loan creation.
</p>
</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>positive integer or zero <span></span>
</dd>
<dd>Amount charged in cents</dd>
<dt>
card
</dt>
<dd>
<dd><strong>hash</strong></dd>
<dd>
Hash describing the card used to make the charge
<dl class="argument-list">
<dt>
inner object
</dt>
<dd>inner string <span> inner span extra </span>
</dd>
</dl>
</dd>
<dt>
fingerprint
</dt>
<dd>string<span> or something</span>
</dd>
</dl>
</div>
</div>
<a id="loanproducts_list" name="loanproducts_list" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h4>List Loan Products</h4>
<p>Example Request:
<a style="word-wrap: break-word;" href="http://localhost:8080/mifosng-provider/api/v1/loanproducts">http://localhost:8080/mifosng-provider/api/v1/loanproducts</a>
</p>
</div>
<div class="method-example">
<code class="method-declaration">GET https://thedomainname/api/v1/loanproducts</code>
<code class="method-response"> {
"products": [
{
"id": 1,
"name": "Agricultural Loan",
"description": "An agricultural loan given to farmers to help buy crop, stock and machinery. With an arrears tolerance setting of 1,000 CFA, loans are not marked as 'in arrears' or 'in bad standing' if the amount outstanding is less than this. Interest rate is described using monthly percentage rate (MPR) even though the loan typically lasts a year and requires one repayment (typically at time when farmer sells crop)",
"principalMoney": {
"currencyCode": "XOF",
"currencyDigitsAfterDecimal": 0,
"amount": 100000,
"defaultName": "CFA Franc BCEAO",
"nameCode": "currency.XOF",
"displaySymbol": "CFA",
"zero": false,
"greaterThanZero": true,
"displaySymbolValue": "100000 CFA"
},
"interestRatePerPeriod": 1.75,
"interestRatePeriod": 2,
"annualInterestRate": 21,
"interestMethod": 0,
"interestRateCalculatedInPeriod": 0,
"numberOfInterestFreePeriods": 0,
"repaidEvery": 12,
"repaymentPeriodFrequency": 2,
"numberOfRepayments": 1,
"amortizationMethod": 1,
"inArrearsTolerance": {
"currencyCode": "XOF",
"currencyDigitsAfterDecimal": 0,
"amount": 1000,
"defaultName": "CFA Franc BCEAO",
"nameCode": "currency.XOF",
"displaySymbol": "CFA",
"zero": false,
"greaterThanZero": true,
"displaySymbolValue": "1000 CFA"
},
"createdOn": "2012-04-12T00:00:00.000+10:00",
"lastModifedOn": "2012-04-12T00:00:00.000+10:00",
"possibleCurrencies": [],
"possibleAmortizationOptions": [],
"possibleInterestOptions": [],
"possibleInterestRateCalculatedInPeriodOptions": [],
"repaymentFrequencyOptions": [],
"interestFrequencyOptions": [],
"interestRebateAllowed": false,
"flexible": false
},
{
"id": 2,
"name": "curr loan",
"description": "asdff",
"principalMoney": {
"currencyCode": "ETB",
"currencyDigitsAfterDecimal": 2,
"amount": 100000,
"defaultName": "Ethiopian Birr",
"nameCode": "currency.ETB",
"displaySymbol": null,
"zero": false,
"greaterThanZero": true,
"displaySymbolValue": "100000.00 null"
},
"interestRatePerPeriod": 0,
"interestRatePeriod": 2,
"annualInterestRate": 0,
"interestMethod": 0,
"interestRateCalculatedInPeriod": 0,
"numberOfInterestFreePeriods": 0,
"repaidEvery": 1,
"repaymentPeriodFrequency": 2,
"numberOfRepayments": 5,
"amortizationMethod": 1,
"inArrearsTolerance": {
"currencyCode": "ETB",
"currencyDigitsAfterDecimal": 2,
"amount": 0,
"defaultName": "Ethiopian Birr",
"nameCode": "currency.ETB",
"displaySymbol": null,
"zero": true,
"greaterThanZero": false,
"displaySymbolValue": "0.00 null"
},
"createdOn": "2012-04-15T00:00:00.000+10:00",
"lastModifedOn": "2012-04-15T00:00:00.000+10:00",
"possibleCurrencies": [],
"possibleAmortizationOptions": [],
"possibleInterestOptions": [],
"possibleInterestRateCalculatedInPeriodOptions": [],
"repaymentFrequencyOptions": [],
"interestFrequencyOptions": [],
"interestRebateAllowed": false,
"flexible": false
}
]
}
</code>
</div>
</div>
<a id="loanproducts_template" name="loanproducts_template" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h4>Retrieve Loan Product Details Template</h4>
<p>Returns a template that contains the loan product fields and allowed value lists. This helps build a maintenance User Interface.
</p>
<p>Example Request:
<a style="word-wrap: break-word;" href="http://localhost:8080/mifosng-provider/api/v1/loanproducts/template">http://localhost:8080/mifosng-provider/api/v1/loanproducts/template</a>
</p>
</div>
<div class="method-example">
<code class="method-declaration">GET https://thedomainname/api/v1/loanproducts/template</code>
<code class="method-response"> {
"id": null,
"name": null,
"description": null,
"principalMoney": {
"currencyCode": "XOF",
"currencyDigitsAfterDecimal": 0,
"amount": 0,
"defaultName": "CFA Franc BCEAO",
"nameCode": "currency.XOF",
"displaySymbol": "CFA",
"zero": true,
"greaterThanZero": false,
"displaySymbolValue": "0 CFA"
},
"interestRatePerPeriod": 0,
"interestRatePeriod": 2,
"annualInterestRate": 0,
"interestMethod": 0,
"interestRateCalculatedInPeriod": 1,
"numberOfInterestFreePeriods": 0,
"repaidEvery": 1,
"repaymentPeriodFrequency": 2,
"numberOfRepayments": 0,
"amortizationMethod": 1,
"inArrearsTolerance": {
"currencyCode": "XOF",
"currencyDigitsAfterDecimal": 0,
"amount": 0,
"defaultName": "CFA Franc BCEAO",
"nameCode": "currency.XOF",
"displaySymbol": "CFA",
"zero": true,
"greaterThanZero": false,
"displaySymbolValue": "0 CFA"
},
"createdOn": null,
"lastModifedOn": null,
"possibleCurrencies": [
{
"code": "XOF",
"name": "CFA Franc BCEAO",
"decimalPlaces": 0,
"displaySymbol": "CFA",
"nameCode": "currency.XOF",
"displayLabel": "CFA Franc BCEAO (CFA)"
},
{
"code": "ETB",
"name": "Ethiopian Birr",
"decimalPlaces": 2,
"displaySymbol": null,
"nameCode": "currency.ETB",
"displayLabel": "Ethiopian Birr [ETB]"
}
],
"possibleAmortizationOptions": [
{
"id": 1,
"value": "Equal installments"
},
{
"id": 0,
"value": "Equal principle payments"
}
],
"possibleInterestOptions": [
{
"id": 0,
"value": "Declining Balance"
},
{
"id": 1,
"value": "Flat"
}
],
"possibleInterestRateCalculatedInPeriodOptions": [
{
"id": 0,
"value": "Daily"
},
{
"id": 1,
"value": "Same as repayment period"
}
],
"repaymentFrequencyOptions": [
{
"id": 0,
"value": "Days"
},
{
"id": 1,
"value": "Weeks"
},
{
"id": 2,
"value": "Months"
}
],
"interestFrequencyOptions": [
{
"id": 2,
"value": "Per month"
},
{
"id": 3,
"value": "Per year"
}
],
"interestRebateAllowed": false,
"flexible": false
}
</code>
</div>
</div>
<a id="loanproducts_retrieve" name="loanproducts_retrieve" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h4>Retrieve a Loan Product</h4>
<p>Returns loan product fields. It also returns allowed value lists which help build a maintenance User Interface.
JPW - includes validation values (might be ok or option), enum?
</p>
<p>Example Request:
<a style="word-wrap: break-word;" href="http://localhost:8080/mifosng-provider/api/v1/loanproducts/1">http://localhost:8080/mifosng-provider/api/v1/loanproducts/1</a>
</p>
</div>
<div class="method-example">
<code class="method-declaration">GET https://thedomainname/api/v1/loanproducts/{productId}</code>
<code class="method-response"> {
"id": 1,
"name": "Agricultural Loan",
"description": "An agricultural loan given to farmers to help buy crop, stock and machinery. With an arrears tolerance setting of 1,000 CFA, loans are not marked as 'in arrears' or 'in bad standing' if the amount outstanding is less than this. Interest rate is described using monthly percentage rate (MPR) even though the loan typically lasts a year and requires one repayment (typically at time when farmer sells crop)",
"principalMoney": {
"currencyCode": "XOF",
"currencyDigitsAfterDecimal": 0,
"amount": 100000,
"defaultName": "CFA Franc BCEAO",
"nameCode": "currency.XOF",
"displaySymbol": "CFA",
"zero": false,
"greaterThanZero": true,
"displaySymbolValue": "100000 CFA"
},
"interestRatePerPeriod": 1.75,
"interestRatePeriod": 2,
"annualInterestRate": 21,
"interestMethod": 0,
"interestRateCalculatedInPeriod": 0,
"numberOfInterestFreePeriods": 0,
"repaidEvery": 12,
"repaymentPeriodFrequency": 2,
"numberOfRepayments": 1,
"amortizationMethod": 1,
"inArrearsTolerance": {
"currencyCode": "XOF",
"currencyDigitsAfterDecimal": 0,
"amount": 1000,
"defaultName": "CFA Franc BCEAO",
"nameCode": "currency.XOF",
"displaySymbol": "CFA",
"zero": false,
"greaterThanZero": true,
"displaySymbolValue": "1000 CFA"
},
"createdOn": "2012-04-12T00:00:00.000+10:00",
"lastModifedOn": "2012-04-12T00:00:00.000+10:00",
"possibleCurrencies": [
{
"code": "XOF",
"name": "CFA Franc BCEAO",
"decimalPlaces": 0,
"displaySymbol": "CFA",
"nameCode": "currency.XOF",
"displayLabel": "CFA Franc BCEAO (CFA)"
},
{
"code": "ETB",
"name": "Ethiopian Birr",
"decimalPlaces": 2,
"displaySymbol": null,
"nameCode": "currency.ETB",
"displayLabel": "Ethiopian Birr [ETB]"
}
],
"possibleAmortizationOptions": [
{
"id": 1,
"value": "Equal installments"
},
{
"id": 0,
"value": "Equal principle payments"
}
],
"possibleInterestOptions": [
{
"id": 0,
"value": "Declining Balance"
},
{
"id": 1,
"value": "Flat"
}
],
"possibleInterestRateCalculatedInPeriodOptions": [
{
"id": 0,
"value": "Daily"
},
{
"id": 1,
"value": "Same as repayment period"
}
],
"repaymentFrequencyOptions": [
{
"id": 0,
"value": "Days"
},
{
"id": 1,
"value": "Weeks"
},
{
"id": 2,
"value": "Months"
}
],
"interestFrequencyOptions": [
{
"id": 2,
"value": "Per month"
},
{
"id": 3,
"value": "Per year"
}
],
"interestRebateAllowed": false,
"flexible": false
}
</code>
</div>
</div>
<a id="loanproducts_create" name="loanproducts_create" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h4>Create a Loan Product</h4>
</div>
<div class="method-example">
<code class="method-declaration">POST https://thedomainname/api/v1/loanproducts</code>
<code class="method-request">http://localhost:8080/mifosng-provider/api/v1/loanproducts
Content-Type: application/json
Request Body:
new loan product json here
</code>
</div>
</div>
<a id="loanproducts_update" name="loanproducts_update" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h4>Update a Loan Product</h4>
</div>
<div class="method-example">
<code class="method-declaration">POST https://thedomainname/api/v1/loanproducts/{loanId}</code>
<code class="method-request">http://localhost:8080/mifosng-provider/api/v1/loanproducts/1
Content-Type: application/json
Request Body:
update loan product json here
</code>
</div>
</div>
<a id="additionalfields" name="additionalfields" class="old-syle-anchor">&nbsp;</a> <a id="additionalfields" name="additionalfields" class="old-syle-anchor">&nbsp;</a>
@@ -451,7 +937,7 @@ The Mifos X Individual Lending client application uses a JQuery plugin called st
</div> </div>
<a id="listadditionalfields" name="listadditionalfields" class="old-syle-anchor">&nbsp;</a> <a id="additionalfields_list" name="additionalfields_list" class="old-syle-anchor">&nbsp;</a>
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h4>List Additional Fields Sets</h4> <h4>List Additional Fields Sets</h4>
@@ -473,7 +959,7 @@ The Mifos X Individual Lending client application uses a JQuery plugin called st
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://thedomainname/v1/additionalfields</code> <code class="method-declaration">GET https://thedomainname/api/v1/additionalfields</code>
<code class="method-response">{ <code class="method-response">{
"additionalFieldsSets": [ "additionalFieldsSets": [
{ {
@@ -493,15 +979,13 @@ The Mifos X Individual Lending client application uses a JQuery plugin called st
</div> </div>
<a id="retrieveadditionalfields" name="retrieveadditionalfields" class="old-syle-anchor">&nbsp;</a> <a id="additionalfields_retrieve" name="additionalfields_retrieve" class="old-syle-anchor">&nbsp;</a>
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h4>Retrieve Additional Fields</h4> <h4>Retrieve Additional Fields</h4>
<p> <p>
Returns the Set of Additional Fields data for the ID provided. The ID is the id field of the Type table e.g. portfolio_client might have an id value of 4. The output is a JSON formatted "Generic Resultset". The Generic Resultset contains Column Heading as well as Data information. The Column Heading information may include allowed values (columnValues array). Returns the Set of Additional Fields data for the ID provided. The ID is the id field of the Type table e.g. portfolio_client might have an id value of 4. The output is a JSON formatted "Generic Resultset". The Generic Resultset contains Column Heading as well as Data information. The Column Heading information may include allowed values (columnValues array).
</p> </p>
<h5>Arguments</h5>
<span>None</span>
<p>Example Request: <p>Example Request:
<a style="word-wrap: break-word;" href="http://localhost:8080/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2">http://localhost:8080/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2</a> <a style="word-wrap: break-word;" href="http://localhost:8080/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2">http://localhost:8080/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2</a>
@@ -510,7 +994,7 @@ Returns the Set of Additional Fields data for the ID provided. The ID is the id
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://thedomainname/v1/additionalfields/{type}/{set}/{id}</code> <code class="method-declaration">GET https://thedomainname/api/v1/additionalfields/{type}/{set}/{id}</code>
<code class="method-response">{ <code class="method-response">{
"columnHeaders": [ "columnHeaders": [
{ {
@@ -631,20 +1115,18 @@ Returns the Set of Additional Fields data for the ID provided. The ID is the id
<a id="updateadditionalfields" name="updateadditionalfields" class="old-syle-anchor">&nbsp;</a> <a id="additionalfields_update" name="additionalfields_update" class="old-syle-anchor">&nbsp;</a>
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h4>Update Additional Fields</h4> <h4>Update Additional Fields</h4>
<p> <p>
Updates (or creates) the Set of Additional Fields data for the ID provided. The ID is the id field of the Type table e.g. portfolio_client might have an id value of 4. Updates (or creates) the Set of Additional Fields data for the ID provided. The ID is the id field of the Type table e.g. portfolio_client might have an id value of 4.
</p> </p>
<h5>Arguments</h5>
<span>None</span>
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">POST https://thedomainname/v1/additionalfields/{type}/{set}/{id}</code> <code class="method-declaration">POST https://thedomainname/api/v1/additionalfields/{type}/{set}/{id}</code>
<code class="method-request">http://localhost:8080/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2 <code class="method-request">http://localhost:8080/mifosng-provider/api/v1/additionalfields/portfolio_client/Additional Information/2
@@ -698,7 +1180,7 @@ The Mifos X Individual Lending client application uses a JQuery plugin called st
<a id="listreports" name="listreports" class="old-syle-anchor">&nbsp;</a> <a id="reports_list" name="reports_list" class="old-syle-anchor">&nbsp;</a>
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h4>List Reports</h4> <h4>List Reports</h4>
@@ -719,7 +1201,7 @@ The Mifos X Individual Lending client application uses a JQuery plugin called st
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://thedomainname/v1/reports</code> <code class="method-declaration">GET https://thedomainname/api/v1/reports</code>
<code class="method-response">{ <code class="method-response">{
"columnHeaders": [ "columnHeaders": [
{ {
@@ -790,7 +1272,7 @@ The Mifos X Individual Lending client application uses a JQuery plugin called st
<a id="runreport" name="runreport" class="old-syle-anchor">&nbsp;</a> <a id="report_run" name="report_run" class="old-syle-anchor">&nbsp;</a>
<div class="method-section"> <div class="method-section">
<div class="method-description"> <div class="method-description">
<h4>Running a Report</h4> <h4>Running a Report</h4>
@@ -818,7 +1300,7 @@ The Mifos X Individual Lending client application uses a JQuery plugin called st
</div> </div>
<div class="method-example"> <div class="method-example">
<code class="method-declaration">GET https://thedomainname/v1/reports/{reportName}</code> <code class="method-declaration">GET https://thedomainname/api/v1/reports/{reportName}</code>
<code class="method-response">{ <code class="method-response">{
"columnHeaders": [ "columnHeaders": [
{ {