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

Review comments addressed

Browse Source
This commit is contained in:
VenuShyam
2015-09-03 19:51:07 +05:30
parent 5a990af553
commit 670b6eef19
10 changed files with 1153 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api-docs/apiLive.htm
+820
View File
@@ -381,6 +381,64 @@
<td></td>
<td></td>
</tr>
<tr>
<td><a href="#client_charge">Client Charge</a></td>
<td>clients/{clientId}/charges</td>
<td><a href="#add_clientCharge">Add Client Charge</a></td>
<td><a href="#list_clientCharges">List Client Charges</a></td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td></td>
<td>clients/{clientId}</td>
<td></td>
<td></td>
<td></td>
<td><a href="#delete_clientCharge">Delete Client Charge</a></td>
<td></td>
<td></td>
</tr>
<tr>
<td></td>
<td>clients/{clientId}/charges/{chargeid}?command=pay</td>
<td><a href="#pay_clientCharge">Pay Client Charge</a></td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td></td>
<td>clients/{clientId}/charges/{chargeid}?command=waive</td>
<td><a href="#waive_clientCharge">Waive Client Charge</a></td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td ><a href="#client_transactions">Client Ttransactions</td>
<td>clients/{clientId}/transactions/{transactionId}?command=undo</td>
<td><a href="#revert_clientCharge">Revert Client Charge Transaction</a></td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td ></td>
<td>clients/{clientId}/transactions</td>
<td><a href="#list_clientTransactions">List Client Charge Transactions</a></td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
</div>
</div>
@@ -35558,7 +35616,769 @@ Request Body:
</code>
</div>
</div>
<!----------------Client charge API starts ------------>
<a id="client_charge" name="client_charge" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h3>Client Charge</h3>
<p>Client Charge is a type of charge which is directlly applied on client.One client can have more than one client charge and client charge is created with charge time type as specified due date and calculation type as flat.
</p>
<table class=matrixHeading>
<tr class="matrixHeadingBG">
<td><div class="mifosXHeading2">Field Descriptions</div></td>
</tr>
<tr class=alt>
<td>chargeId</td>
</tr>
<tr>
<td class=fielddesc>This ia an unique Id associate with client charge.
</td>
</tr>
<tr class=alt>
<td>name</td>
</tr>
<tr>
<td class=fielddesc>Name given to the client charge.</td>
</tr>
<tr class=alt>
<td>active</td>
</tr>
<tr>
<td class=fielddesc>Indicates whether this charge is to be created as active</b>. If active=true, then <b>activationDate</b> must be provided. If active=false, then the charge is created as <b>pending</b>.
</td>
</tr>
<tr class=alt>
<td>amountPaid</td>
</tr>
<tr>
<td class=fielddesc>amount paid as client charge</b>.
</td>
</tr>
<tr class=alt>
<td>amountWaived</td>
</tr>
<tr>
<td class=fielddesc>amount waive from client charge</td>
</tr>
<tr class=alt>
<td>amountOutstanding</td>
</tr>
<tr>
<td class=fielddesc>The left over amount to pay .</td>
</tr>
<tr class=alt>
<td>dueDate</td>
</tr>
<tr>
<td class=fielddesc>it specifies the due date</td>
</tr>
</table>
</div>
</div>
<a id="client_transaction" name="client_transaction" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h3>Client Transaction</h3>
<p>Client Charge transactions are get created when a client pays/waives off client charge.this client charge transaction shows
<br>the unit of amount paid as client charge.
</p>
<table class=matrixHeading>
<tr class="matrixHeadingBG">
<td><div class="mifosXHeading2">Field Descriptions</div></td>
</tr>
<tr class=alt>
<td>transactionId</td>
</tr>
<tr>
<td class=fielddesc>This ia an unique Id associate with client charge Transaction.
</td>
</tr>
<tr class=alt>
<td>clientId</td>
</tr>
<tr>
<td class=fielddesc>clientId on which client transaction got created</td>
</tr>
<tr class=alt>
<td>isReverse</td>
</tr>
<tr>
<td class=fielddesc>Indicates whether this client charge transaction is reversed or not.
</td>
</tr>
<tr class=alt>
<td>amountPaid</td>
</tr>
<tr>
<td class=fielddesc>amount paid as client charge</b>.
</td>
</tr>
<tr class=alt>
<td>currency code</td>
</tr>
<tr>
<td class=fielddesc>currency type</td>
</tr>
<tr class=alt>
<td>transaction date</td>
</tr>
<tr>
<td class=fielddesc>date on which transaction happened</td>
</tr>
</table>
</div>
</div>
<a id="list_clientTransactions" name="list_clientTransactions" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h4>List client Transactions</h4>
<p>The <i>list</i> capability of client charge transaction can support <b>pagination</b> and <b>sorting</b>.</p>
<h5>Mandatory Arguments</h5>
<dl class="argument-list">
<dt>offset</dt>
<dd>
Integer <span>Mandatory</span>, defaults to 0
</dd>
<dd>Indicates the result from which pagination starts</dd>
<dt>limit</dt>
<dd>
Integer <span>Mandatory</span>, defaults to 200
</dd>
<dd>Restricts the size of results returned. To override the default and return all entries you must explicitly pass a non-positive integer value for limit e.g. limit=0, or limit=-1</dd>
</dl>
</dl>
<p>Example Requests:</p>
<div class=apiClick>clients/189/transactions</div>
<div class=apiClick>clients/189/transactions?offset=10&limit=50</div>
</div>
<div class="method-example">
<code class="method-declaration">
GET https://DomainName/api/v1/clients/{clientId}/transactions?limit=5&offset=0
</code>
<code class="method-request">
GET clients/226/transactions?limit=5&offset=0
Content-Type: application/json
Request Body:
{
chargeId="226"
}
</code>
<code class="method-response">
{
"totalFilteredRecords": 20,
"pageItems": [
{
"id": 226,
"officeId": 1,
"officeName": "Head Office",
"type": {
"id": 1,
"code": "clientTransactionType.payCharge",
"value": "PAY_CHARGE"
},
"date": [
2015,
9,
2
],
"currency": {
"code": "USD",
"name": "US Dollar",
"decimalPlaces": 2,
"displaySymbol": "$",
"nameCode": "currency.USD",
"displayLabel": "US Dollar ($)"
},
"amount": 22,
"submittedOnDate": [
2015,
9,
2
],
"reversed": false
},
{
"id": 208,
"officeId": 1,
"officeName": "Head Office",
"type": {
"id": 1,
"code": "clientTransactionType.payCharge",
"value": "PAY_CHARGE"
},
"date": [
2015,
8,
28
],
"currency": {
"code": "USD",
"name": "US Dollar",
"decimalPlaces": 2,
"displaySymbol": "$",
"nameCode": "currency.USD",
"displayLabel": "US Dollar ($)"
},
"amount": 3,
"submittedOnDate": [
2015,
8,
28
],
"reversed": false
},
{
"id": 207,
"officeId": 1,
"officeName": "Head Office",
"type": {
"id": 1,
"code": "clientTransactionType.payCharge",
"value": "PAY_CHARGE"
},
"date": [
2015,
8,
28
],
"currency": {
"code": "USD",
"name": "US Dollar",
"decimalPlaces": 2,
"displaySymbol": "$",
"nameCode": "currency.USD",
"displayLabel": "US Dollar ($)"
},
"amount": 5,
"submittedOnDate": [
2015,
8,
28
],
"reversed": false
},
{
"id": 206,
"officeId": 1,
"officeName": "Head Office",
"type": {
"id": 1,
"code": "clientTransactionType.payCharge",
"value": "PAY_CHARGE"
},
"date": [
2015,
8,
28
],
"currency": {
"code": "USD",
"name": "US Dollar",
"decimalPlaces": 2,
"displaySymbol": "$",
"nameCode": "currency.USD",
"displayLabel": "US Dollar ($)"
},
"amount": 5,
"submittedOnDate": [
2015,
8,
28
],
"reversed": false
},
{
"id": 205,
"officeId": 1,
"officeName": "Head Office",
"type": {
"id": 1,
"code": "clientTransactionType.payCharge",
"value": "PAY_CHARGE"
},
"date": [
2015,
8,
28
],
"currency": {
"code": "USD",
"name": "US Dollar",
"decimalPlaces": 2,
"displaySymbol": "$",
"nameCode": "currency.USD",
"displayLabel": "US Dollar ($)"
},
"amount": 5,
"submittedOnDate": [
2015,
8,
28
],
"reversed": false
}
]
}
</code>
</div>
</div>
<a id="add_clientCharge" name="add_clientCharge" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h4>Add Client Charge</h4>
<p>
It is one among the charges.It is created chargeTime type as specified due date and calculation type as flat and it can only be applied client.This API enables to add client charge to client.
</p>
<table class=matrixHeading>
<tr class="matrixHeadingBG">
<td><div class="mifosXHeading2">Mandatory Fields</div></td>
</tr>
<tr class=alt>
<td>clientId,chargeId and activationDate </td>
</tr>
</table>
<br />
<table class=matrixHeading>
<tr class="matrixHeadingBG">
<td><div class="mifosXHeading2">Optional Fields</div></td>
</tr>
<tr class=alt>
<td>externalId, accountNo,genderId, clientTypeId, clientClassificationId</td>
</tr>
</table>
</div>
<div class="method-example">
<code class="method-declaration">
POST https://DomainName/api/v1/clients/{clientId}/charges
</code>
<code class="method-request">
POST clients/226/charges
Content-Type: application/json
Request Body:
{
"amount"="100"
chargeId="226"
dateFormat="dd MMMM yyyy"
dueDate="01 September 2015"
locale="en"
}
</code>
<code class="method-response">
{
"officeId": 1,
"clientId": 189,
"resourceId":164
}
</code>
</div>
</div>
<a id="list_clientCharges" name="list_clientCharges" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h4>List Client Charges</h4>
<p>The <i>list</i> capability of client charges can support <b>pagination</b> and <b>sorting</b>.</p>
<h5>Mandatory Arguments</h5>
<dl class="argument-list">
<dt>offset</dt>
<dd>
Integer <span>Mandatory</span>, defaults to 0
</dd>
<dd>Indicates the result from which pagination starts</dd>
<dt>limit</dt>
<dd>
Integer <span>Mandatory</span>, defaults to 200
</dd>
<dd>Restricts the size of results returned. To override the default and return all entries you must explicitly pass a non-positive integer value for limit e.g. limit=0, or limit=-1</dd>
</dl>
</dl>
<p>Example Requests:</p>
<div class=apiClick>clients/189/charges</div>
<div class=apiClick>clients/189/charges?offset=0&limit=5</div>
</div>
<div class="method-example">
<code class="method-declaration">
GET https://DomainName/api/v1/clients/{clientId}/charges?limit=5&offset=0
</code>
<code class="method-request">
GET https://localhost:8443/mifosng-provider/api/v1/clients/189/charges?limit=5&offset=0
GET clients/189/charges?limit=5&offset=0
Content-Type: application/json
Request Body:
{
"clientId":189
}
</code>
<code class="method-response">
{
"id": 151,
"clientId": 182,
"chargeId": 228,
"name": "Charge_client_1WA4XRZ1",
"chargeTimeType": {
"id": 2,
"code": "chargeTimeType.specifiedDueDate",
"value": "Specified due date"
},
"dueDate": [
2011,
10,
29
],
"chargeCalculationType": {
"id": 1,
"code": "chargeCalculationType.flat",
"value": "Flat"
},
"currency": {
"code": "USD",
"name": "US Dollar",
"decimalPlaces": 2,
"displaySymbol": "$",
"nameCode": "currency.USD",
"displayLabel": "US Dollar ($)"
},
"amount": 200,
"amountPaid": 183,
"amountWaived": 0,
"amountWrittenOff": 0,
"amountOutstanding": 17,
"penalty": false,
"isActive": true,
"isPaid": false
},
{
"id": 160,
"clientId": 182,
"chargeId": 239,
"name": "Charge_client_09UC3HYL",
"chargeTimeType": {
"id": 2,
"code": "chargeTimeType.specifiedDueDate",
"value": "Specified due date"
},
"dueDate": [
2015,
8,
14
],
"chargeCalculationType": {
"id": 1,
"code": "chargeCalculationType.flat",
"value": "Flat"
},
"currency": {
"code": "USD",
"name": "US Dollar",
"decimalPlaces": 2,
"displaySymbol": "$",
"nameCode": "currency.USD",
"displayLabel": "US Dollar ($)"
},
"amount": 100,
"amountPaid": 0,
"amountWaived": 0,
"amountWrittenOff": 0,
"amountOutstanding": 100,
"penalty": false,
"isActive": true,
"isPaid": false
},
{
"id": 163,
"clientId": 182,
"chargeId": 161,
"name": "Charge_client_12J3LSPO",
"chargeTimeType": {
"id": 2,
"code": "chargeTimeType.specifiedDueDate",
"value": "Specified due date"
},
"dueDate": [
2015,
9,
1
],
"chargeCalculationType": {
"id": 1,
"code": "chargeCalculationType.flat",
"value": "Flat"
},
"currency": {
"code": "USD",
"name": "US Dollar",
"decimalPlaces": 2,
"displaySymbol": "$",
"nameCode": "currency.USD",
"displayLabel": "US Dollar ($)"
},
"amount": 100,
"amountPaid": 0,
"amountWaived": 0,
"amountWrittenOff": 0,
"amountOutstanding": 100,
"penalty": false,
"isActive": true,
"isPaid": false
}
</code>
</div>
</div>
<a id="delete_clientCharge" name="delete_clientCharge" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h4>Delete Client Charge</h4>
<p>
<br>A client can be associated with more than one client charge and this API enables to delete a charge from client.
</p>
<table class=matrixHeading>
<tr class="matrixHeadingBG">
<td><div class="mifosXHeading2">Mandatory Fields</div></td>
</tr>
<tr class=alt>
<td>chargeId
</td>
</tr>
</table>
</div>
<div class="method-example">
<code class="method-declaration">
DELETE https://localhost:8443/mifosng-provider/api/v1/clients/189/charges?command=delete
POST clients/189/charges/164?command=delete
Content-Type: application/json
No Request Body
</code>
<code class="method-response">
{
"officeId": 1,
"clientId": 189,
"resourceId":164
}
</code>
</div>
</div>
<a id="pay_clientCharge" name="pay_clientCharge" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h4>Pay Client Charge</h4>
<p>
<br>Total or Some amount of the client charge can be paid by specifying transaction date and which should not be below or above the specifed due date.
</p>
<table class=matrixHeading>
<tr class="matrixHeadingBG">
<td><div class="mifosXHeading2">Mandatory Fields</div></td>
</tr>
<tr >
<td>
<br>transactionDate and amount<br>
</td>
</tr>
</table>
<br />
</div>
<div class="method-example">
<code class="method-declaration">
POST https://localhost:8443/mifosng-provider/api/v1/clients/189/charges/157?command=paycharge
</code>
<code class="method-request">
POST clients/189/charges/157?command=paycharge
Content-Type: application/json
Request Body:
{
"amount":200,
"locale":"en",
"dateFormat":"dd MMMM yyyy",
"transactionDate":"01 September 2015"
}
</code>
<code class="method-response">
{
"officeId":1,
"clientId":189,
"resourceId":157,
"transactionId":"221"
}
</code>
</div>
</div>
<a id="waive_clientCharge" name="waive_clientCharge" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h4>Waive Client Charge</h4>
<p>
<br>This API provieds the facility of waiving off the client charge of a client.
</p>
<table class=matrixHeading>
<tr class="matrixHeadingBG">
<td><div class="mifosXHeading2">Mandatory Fields</div></td>
</tr>
<tr class=alt>
<td>clientId and chargeId
</td>
</tr>
</table>
<br />
</div>
<div class="method-example">
<code class="method-declaration">
POST https://localhost:8443/mifosng-provider/api/v1/clients/189/charges/157?command=waive
</code>
<code class="method-request">
POST clients/189/charges/157?command=waive
Content-Type: application/json
Request Body:
{
"clientId"="189"
"resourceType"="164"
}
</code>
<code class="method-response">
{
"clientId":"189",
"resourceType":"164"
}
</code>
</div>
</div>
<a id="revert_clientCharge" name="revert_clientCharge" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h4>Revert Client Charge Transaction</h4>
<p>
<br>This API exists to revert the client transactions which have got created after paying the client charge
<br>or after waiving off the client charge.
</p>
<table class=matrixHeading>
<tr class="matrixHeadingBG">
<td><div class="mifosXHeading2">Mandatory Fields</div></td>
</tr>
<tr class=alt>
<td>clientId ,chargeId and transactionId
</td>
</tr>
</table>
<br />
</div>
<div class="method-example">
<code class="method-declaration">
POST https://localhost:8443/mifosng-provider/api/v1/clients/189/charges/157?command=undo
</code>
<code class="method-request">
POST clients/189/transactions/222
Content-Type: application/json
Request Body:
{
clientId="189"
transactionId=222
}
</code>
<code class="method-response">
{
"officeId":1,
"clientId":189,
"resourceId":222
}
GET https://localhost:8443/mifosng-provider/api/v1/clients/189/charges/164?associations=all
Content-Type: application/json
Resonse Body:
{
"id": 164,
"clientId": 189,
"chargeId": 226,
"name": "Charge_client_0RC9TLF4",
"chargeTimeType": {
"id": 2,
"code": "chargeTimeType.specifiedDueDate",
"value": "Specified due date"
},
"dueDate": [
2015,
9,
1
],
"chargeCalculationType": {
"id": 1,
"code": "chargeCalculationType.flat",
"value": "Flat"
},
"currency": {
"code": "USD",
"name": "US Dollar",
"decimalPlaces": 2,
"displaySymbol": "$",
"nameCode": "currency.USD",
"displayLabel": "US Dollar ($)"
},
"amount": 100,
"amountPaid": 0,
"amountWaived": 0,
"amountWrittenOff": 0,
"amountOutstanding": 100,
"penalty": false,
"isActive": true,
"isPaid": false,
"clientTransactionDatas": [
{
"id": 222,
"officeId": 1,
"officeName": "Head Office",
"type": {
"id": 2,
"code": "clientTransactionType.waiveCharge",
"value": "WAIVE_CHARGE"
},
"date": [
2015,
9,
1
],
"currency": {
"code": "USD",
"name": "US Dollar",
"decimalPlaces": 2,
"displaySymbol": "$",
"nameCode": "currency.USD",
"displayLabel": "US Dollar ($)"
},
"amount": 100,
"submittedOnDate": [
2015,
9,
1
],
"reversed": true
}
]
}
</code>
</div>
</div>
<a id="resources_deletetemplate" name="resources_deletetemplate"
class="old-syle-anchor">&nbsp;</a>
<div class="method-section">