diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index ef2dc2294..f982202d0 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -567,6 +567,15 @@
+ An example of how a loan portfolio summary can be provided. This
+ is requested in a specific use case of the reference application.
It is quite reasonable to add resources like this to simplify User Interface development.
+
Example Requests:
+
+GET https://DomainName/api/v1/groups/{groupId}/accounts
+
+
+{
+ "loanAccounts": [
+ {
+ "id": 3,
+ "accountNo": "000000003",
+ "productId": 3,
+ "productName": "daily product",
+ "status": {
+ "id": 100,
+ "code": "loanStatusType.submitted.and.pending.approval",
+ "value": "Submitted and pending approval",
+ "pendingApproval": true,
+ "waitingForDisbursal": false,
+ "active": false,
+ "closedObligationsMet": false,
+ "closedWrittenOff": false,
+ "closedRescheduled": false,
+ "closed": false,
+ "overpaid": false
+ },
+ "loanType": {
+ "id": 2,
+ "code": "accountType.group",
+ "value": "Group"
+ }
+ }
+ ],
+ "savingsAccounts": [
+ {
+ "id": 9,
+ "accountNo": "000000009",
+ "productId": 1,
+ "productName": "p_sav",
+ "status": {
+ "id": 100,
+ "code": "savingsAccountStatusType.submitted.and.pending.approval",
+ "value": "Submitted and pending approval",
+ "submittedAndPendingApproval": true,
+ "approved": false,
+ "rejected": false,
+ "withdrawnByApplicant": false,
+ "active": false,
+ "closed": false
+ },
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "accountType": {
+ "id": 2,
+ "code": "accountType.group",
+ "value": "Group"
+ }
+ },
+ {
+ "id": 4,
+ "accountNo": "000000004",
+ "productId": 1,
+ "productName": "p_sav",
+ "status": {
+ "id": 300,
+ "code": "savingsAccountStatusType.active",
+ "value": "Active",
+ "submittedAndPendingApproval": false,
+ "approved": false,
+ "rejected": false,
+ "withdrawnByApplicant": false,
+ "active": true,
+ "closed": false
+ },
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "accountType": {
+ "id": 2,
+ "code": "accountType.group",
+ "value": "Group"
+ }
+ }
+ ],
+ "memberLoanAccounts": [
+ {
+ "id": 4,
+ "accountNo": "000000004",
+ "productId": 1,
+ "productName": "testLoan",
+ "status": {
+ "id": 200,
+ "code": "loanStatusType.approved",
+ "value": "Approved",
+ "pendingApproval": false,
+ "waitingForDisbursal": true,
+ "active": false,
+ "closedObligationsMet": false,
+ "closedWrittenOff": false,
+ "closedRescheduled": false,
+ "closed": false,
+ "overpaid": false
+ },
+ "loanType": {
+ "id": 3,
+ "code": "accountType.jlg",
+ "value": "JLG"
+ }
+ },
+ {
+ "id": 7,
+ "accountNo": "000000007",
+ "productId": 2,
+ "productName": "weekly product",
+ "status": {
+ "id": 100,
+ "code": "loanStatusType.submitted.and.pending.approval",
+ "value": "Submitted and pending approval",
+ "pendingApproval": true,
+ "waitingForDisbursal": false,
+ "active": false,
+ "closedObligationsMet": false,
+ "closedWrittenOff": false,
+ "closedRescheduled": false,
+ "closed": false,
+ "overpaid": false
+ },
+ "loanType": {
+ "id": 3,
+ "code": "accountType.jlg",
+ "value": "JLG"
+ }
+ }
+ ],
+ "memberSavingsAccounts": [
+ {
+ "id": 3,
+ "accountNo": "000000003",
+ "productId": 1,
+ "productName": "p_sav",
+ "status": {
+ "id": 100,
+ "code": "savingsAccountStatusType.submitted.and.pending.approval",
+ "value": "Submitted and pending approval",
+ "submittedAndPendingApproval": true,
+ "approved": false,
+ "rejected": false,
+ "withdrawnByApplicant": false,
+ "active": false,
+ "closed": false
+ },
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "accountType": {
+ "id": 3,
+ "code": "accountType.jlg",
+ "value": "JLG"
+ }
+ },
+ {
+ "id": 10,
+ "accountNo": "000000010",
+ "productId": 1,
+ "productName": "p_sav",
+ "status": {
+ "id": 100,
+ "code": "savingsAccountStatusType.submitted.and.pending.approval",
+ "value": "Submitted and pending approval",
+ "submittedAndPendingApproval": true,
+ "approved": false,
+ "rejected": false,
+ "withdrawnByApplicant": false,
+ "active": false,
+ "closed": false
+ },
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "accountType": {
+ "id": 3,
+ "code": "accountType.jlg",
+ "value": "JLG"
+ }
+ }
+ ]
+}
+
+