diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm
index 551de5b13..c6bc62b4c 100644
--- a/api-docs/apiLive.htm
+++ b/api-docs/apiLive.htm
@@ -111,6 +111,7 @@
Full API Matrix
Beta API Matrix
Payment Application Logic / Transaction Processing Strategies
+ Self Service API
@@ -3005,6 +3006,219 @@
+
+
+
+
+
+
@@ -3763,7 +3977,28 @@ Successful transaction response:
+
+
+
+
Self Service API Overview
+
+ Self Service APIs are a set of APIs with restricted data scope. Functional specifications and design can be viewed
+ here.
+
+
+ While creating an user, user can be tagged as self service user. Also you can associate
+ clients that this user has access to. Data scope is restricted to these linked clients.
+
+
+ A self service user shall have access to only self service APIs. Self service APIs cannot be accessed by non-self service user. Vice-versa is also true.
+
+
+
+
+
+
@@ -31382,7 +31617,7 @@ GET https://DomainName/api/v1/users/{userId}
Optional Fields |
- | staffId,passwordNeverExpires |
+ staffId,passwordNeverExpires,isSelfServiceUser,clients |
+POST https://DomainName/api/v1/users
+
+
+POST users
+Content-Type: application/json
+Request body:
+{
+ "username": "newuser",
+ "firstname": "Test",
+ "lastname": "User",
+ "email": "whatever@mifos.org",
+ "officeId": 1,
+ "staffId": 1,
+ "roles": [2,3],
+ "sendPasswordToEmail": true,
+ "isSelfServiceUser": true,
+ "clients": [1,2,3]
+}
+
+
+{
+ "officeId": 1,
+ "resourceId": 11
}
@@ -38077,6 +38338,1778 @@ No Request Body
+
+
+
+
+
Self Service APIs
+
+
+
+
Verify authentication
+
Authenticates the credentials provided and returns the set roles and permissions allowed.
+
+
+
+POST https://DomainName/api/v1/self/authentication?username={username}&password={password}
+
+
+POST self/authentication?username=mifos&password=password
+Content-Type: application/json
+No Request Body
+
+
Example response of autentication for user
+
+{
+ "username": "mifos",
+ "userId": 1,
+ "base64EncodedAuthenticationKey": "bWlmb3M6cGFzc3dvcmQ=",
+ "authenticated": true,
+ "officeId": 1,
+ "officeName": "Head Office",
+ "staffId": 1,
+ "staffDisplayName": "Director, Program",
+ "organisationalRole": {
+ "id": 100,
+ "code": "staffOrganisationalRoleType.programDirector",
+ "value": "Program Director"
+ },
+ "roles": [
+ {
+ "id": 1,
+ "name": "Super user",
+ "description": "This role provides all application permissions."
+ }
+ ],
+ "permissions": [
+ "ALL_FUNCTIONS"
+ ],
+ "isSelfServiceUser": true,
+ "clients": [1,2,3]
+}
+
+
+
+POST self/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/openMF/mifosx/wiki/HTTP-API-Error-codes",
+ "httpStatusCode": "401",
+ "defaultUserMessage": "Unauthenticated. Please login.",
+ "userMessageGlobalisationCode": "error.msg.not.authenticated",
+ "errors": []
+}
+
+
+
+
+
Fetch authenticated user details
+
checks the Authentication and returns the set roles and permissions allowed.
+
+
+
+POST https://DomainName/api/v1/userdetails?access_token={access_token}
+
+
+POST userdetails?access_token=bWlmb3M6cGFzc3dvcmQ=
+Content-Type: application/json
+No Request Body
+
+
Example response of authenticated user.
+
+{
+ "username": "mifos",
+ "userId": 1,
+ "base64EncodedAuthenticationKey": "bWlmb3M6cGFzc3dvcmQ=",
+ "authenticated": true,
+ "officeId": 1,
+ "officeName": "Head Office",
+ "staffId": 1,
+ "staffDisplayName": "Director, Program",
+ "organisationalRole": {
+ "id": 100,
+ "code": "staffOrganisationalRoleType.programDirector",
+ "value": "Program Director"
+ },
+ "roles": [
+ {
+ "id": 1,
+ "name": "Super user",
+ "description": "This role provides all application permissions."
+ }
+ ],
+ "permissions": [
+ "ALL_FUNCTIONS"
+ ],
+ "isSelfServiceUser": true,
+ "clients": [1,2,3]
+}
+
+
+
+POST api/oauth/token?username=mifos&password=password&client_id=community-app&grant_type=password&client_secret=123
+Content-Type: application/json
+No Request Body
+
+
+{
+ "developerMessage": "Invalid authentication details were passed in api request.",
+ "developerDocLink": "https://github.com/openMF/mifosx/wiki/HTTP-API-Error-codes",
+ "httpStatusCode": "401",
+ "defaultUserMessage": "Unauthenticated. Please login.",
+ "userMessageGlobalisationCode": "error.msg.not.authenticated",
+ "errors": []
+}
+
+
+
+
+
List Clients associated to the user
+
The list capability of clients can support pagination and sorting.
+
Optional Arguments
+
+ - offset
+ -
+ Integer optional, defaults to 0
+
+ - Indicates the result from which pagination starts
+
+ - limit
+ -
+ Integer optional, defaults to 200
+
+ - 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
+
+ - orderBy
+ -
+ String optional, one of displayName, accountNo, officeId, officeName
+
+ - Orders results by the indicated field.
+
+ - sortBy
+ -
+ String optional, one of ASC, DESC
+
+ - Indicates what way to order results if orderBy is used.
+
+ - displayName
+ -
+ String optional
+
+ - Use displayName of clients to restrict results.
+
+ - firstName
+ -
+ String optional
+
+ - Use firstName of clients to restrict results.
+
+ - lastName
+ -
+ String optional
+
+ - Use lastName of clients to restrict results.
+
+
+
Example Requests:
+
self/clients
+
+
self/clients?fields=displayName,officeName
+
+
self/clients?offset=10&limit=50
+
+
self/clients?orderBy=displayName&sortOrder=DESC
+
+
+
+GET https://DomainName/api/v1/self/clients
+
+
+{
+ "totalFilteredRecords": 2,
+ "pageItems": [
+ {
+ "id": 1,
+ "accountNo": "000000001",
+ "status": {
+ "id": 300,
+ "code": "clientStatusType.active",
+ "value": "Active"
+ },
+ "active": true,
+ "activationDate": [
+ 2013,
+ 3,
+ 1
+ ],
+ "fullname": "Small shop",
+ "displayName": "Small shop",
+ "officeId": 1,
+ "officeName": "Head Office"
+ },
+ {
+ "id": 2,
+ "accountNo": "000000002",
+ "status": {
+ "id": 100,
+ "code": "clientStatusType.pending",
+ "value": "Pending"
+ },
+ "active": false,
+ "fullname": "Home Farm Produce",
+ "displayName": "Home Farm Produce",
+ "officeId": 1,
+ "officeName": "Head Office"
+ }
+ ]
+}
+
+
+
+
+
Retrieve a Client
+
Example Requests:
+
self/clients/1
+
+
self/clients/1?fields=id,displayName,officeName
+
+
+
+GET https://DomainName/api/v1/self/clients/{clientId}
+
+
+{
+ "id": 27,
+ "accountNo": "000000027",
+ "status": {
+ "id": 300,
+ "code": "clientStatusType.active",
+ "value": "Active"
+ },
+ "active": true,
+ "activationDate": [
+ 2013,
+ 1,
+ 1
+ ],
+ "firstname": "savings",
+ "lastname": "test",
+ "displayName": "savings test",
+ "officeId": 1,
+ "officeName": "Head Office",
+ "timeline": {
+ "submittedOnDate": [
+ 2013,
+ 1,
+ 1
+ ],
+ "submittedByUsername": "mifos",
+ "submittedByFirstname": "App",
+ "submittedByLastname": "Administrator",
+ "activatedOnDate": [
+ 2013,
+ 1,
+ 1
+ ],
+ "activatedByUsername": "mifos",
+ "activatedByFirstname": "App",
+ "activatedByLastname": "Administrator"
+ },
+ "savingsProductId": 4,
+ "savingsProductName": "account overdraft",
+ "groups": []
+}
+
+
+
+
+
Retrieve client accounts overview
+
+ An example of how a loan portfolio summary can be provided. This
+ is requested in a specific use case of the community application.
It is quite reasonable to add resources like this to simplify User Interface development.
+
+
Example Requests:
+
self/clients/1/accounts
+
+
+
self/clients/1/accounts?fields=loanAccounts,savingsAccounts
+
+
+
+GET https://DomainName/api/v1/self/clients/{clientId}/accounts
+
+
+{
+ "loanAccounts": [
+ {
+ "id": 1,
+ "accountNo": "000000001",
+ "externalId": "456",
+ "productId": 1,
+ "productName": "TestOne",
+ "status": {
+ "id": 300,
+ "code": "loanStatusType.active",
+ "value": "Active",
+ "pendingApproval": false,
+ "waitingForDisbursal": false,
+ "active": true,
+ "closedObligationsMet": false,
+ "closedWrittenOff": false,
+ "closedRescheduled": false,
+ "closed": false,
+ "overpaid": false
+ },
+ "loanType": {
+ "id": 1,
+ "code": "loanType.individual",
+ "value": "Individual"
+ },
+ "loanCycle": 1
+ }
+ ],
+ "savingsAccounts": [
+ {
+ "id": 7,
+ "accountNo": "000000007",
+ "productId": 2,
+ "productName": "Other product",
+ "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 ($)"
+ }
+ },
+ {
+ "id": 6,
+ "accountNo": "000000006",
+ "productId": 1,
+ "productName": "Passbook Savings",
+ "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 ($)"
+ },
+ "accountBalance": 1828.03
+ },
+ {
+ "id": 5,
+ "accountNo": "000000005",
+ "productId": 1,
+ "productName": "Passbook Savings",
+ "status": {
+ "id": 400,
+ "code": "savingsAccountStatusType.withdrawn.by.applicant",
+ "value": "Withdrawn by applicant",
+ "submittedAndPendingApproval": false,
+ "approved": false,
+ "rejected": false,
+ "withdrawnByApplicant": true,
+ "active": false,
+ "closed": true
+ },
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ }
+ }
+ ]
+}
+
+
+
+
+
+
+GET https://DomainName/api/v1/self/clients/{clientId}/images
+Accept: text/plain
+
+
+
+data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJ
+bWFnZVJlYWR5ccllPAAAAJ1JREFUeNpi+P//PwMIA4E9EG8E4idQDGLbw+WhiiqA+D8OXAFVAzbp
+DxBvB2JLIGaGYkuoGEjOhhFIHAbij0BdPgxYACMj42ogJQpifwBiXSDeC8JIbt4LxSC5DyxQjTeB
++BeaYb+Q5EBOAVutCzMJHUNNPADzzDokiYdAfAmJvwLkGeTgWQfyKZICS6hYBTwc0QL8ORSjBDhA
+gAEAOg13B6R/SAgAAAAASUVORK5CYII=
+
+
+
+
+
List Client Charges
+
+
The list capability of client charges supports pagination.
+
Optional Arguments
+
+ - offset
+ -
+ Integer Mandatory, defaults to 0
+
+ - Indicates the result from which pagination starts
+
+ - limit
+ -
+ Integer Mandatory, defaults to 200
+
+ - 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
+
+ - pendingPayment
+ -
+ String optional
+
+ - Filters charges that are pending payment (neither paid or waived).
+
+ - chargeStatus
+ -
+ String optional
+
+ - Filters charges according to the status.
+
+
Example Requests:
+
self/clients/1/charges
+
self/clients/1/charges?offset=0&limit=5
+
+
+
+GET https://DomainName/api/v1/self/clients/{clientId}/charges?limit=5&offset=0
+
+
+GET self/clients/1/charges?limit=5&offset=0
+Content-Type: application/json
+No Request Body
+
+
+{
+ "totalFilteredRecords": 4,
+ "pageItems": [
+ {
+ "id": 5,
+ "clientId": 1,
+ "chargeId": 6,
+ "name": "Client Fees 2",
+ "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": 550.000000,
+ "amountPaid": 0.000000,
+ "amountWaived": 0.000000,
+ "amountWrittenOff": 0,
+ "amountOutstanding": 550.000000,
+ "penalty": false,
+ "isActive": true,
+ "isPaid": false,
+ "isWaived": false
+ },
+ {
+ "id": 4,
+ "clientId": 1,
+ "chargeId": 5,
+ "name": "Client Fee 1",
+ "chargeTimeType": {
+ "id": 2,
+ "code": "chargeTimeType.specifiedDueDate",
+ "value": "Specified due date"
+ },
+ "dueDate": [
+ 2015,
+ 8,
+ 31
+ ],
+ "chargeCalculationType": {
+ "id": 1,
+ "code": "chargeCalculationType.flat",
+ "value": "Flat"
+ },
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "amount": 120.000000,
+ "amountPaid": 0.000000,
+ "amountWaived": 120.000000,
+ "amountWrittenOff": 0,
+ "amountOutstanding": 120.000000,
+ "penalty": true,
+ "isActive": true,
+ "isPaid": false,
+ "isWaived": true
+ },
+ {
+ "id": 3,
+ "clientId": 1,
+ "chargeId": 5,
+ "name": "Client Fee 1",
+ "chargeTimeType": {
+ "id": 2,
+ "code": "chargeTimeType.specifiedDueDate",
+ "value": "Specified due date"
+ },
+ "dueDate": [
+ 2015,
+ 8,
+ 17
+ ],
+ "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.000000,
+ "amountPaid": 0.000000,
+ "amountWaived": 100.000000,
+ "amountWrittenOff": 0,
+ "amountOutstanding": 0.000000,
+ "penalty": true,
+ "isActive": true,
+ "isPaid": false,
+ "isWaived": true
+ },
+ {
+ "id": 2,
+ "clientId": 1,
+ "chargeId": 2,
+ "name": "Recurring savings Charge",
+ "chargeTimeType": {
+ "id": 7,
+ "code": "chargeTimeType.monthlyFee",
+ "value": "Monthly Fee"
+ },
+ "dueDate": [
+ 2015,
+ 8,
+ 17
+ ],
+ "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.000000,
+ "amountPaid": 0,
+ "amountWaived": 100.000000,
+ "amountWrittenOff": 0,
+ "amountOutstanding": 0.000000,
+ "penalty": false,
+ "isActive": true,
+ "isPaid": false,
+ "isWaived": true
+ }
+ ]
+}
+
+
+
+
+
+
Retrieve a Client Charge
+
Arguments
+
+ - associations
+ -
+ optional, a comma separated list of
+ 'associations' (itemised below).
+
+ -
+
Associations are just extra pieces of data that you
+ might or might not want to retrieve.
+
+
+ -
+ 'transactions': Retrieves all transactions made on this client charge.
+
+
+
Example Requests:
+
self/clients/1/charges/1
+
+
+
self/clients/1/charges/1?fields=name,id
+
+
+
+GET https://DomainName/api/v1/self/clients/{clientId}/charges/{clientChargeId}
+
+
+{
+ "id": 3,
+ "clientId": 1,
+ "chargeId": 5,
+ "name": "Client Fee 1",
+ "chargeTimeType": {
+ "id": 2,
+ "code": "chargeTimeType.specifiedDueDate",
+ "value": "Specified due date"
+ },
+ "dueDate": [
+ 2015,
+ 8,
+ 17
+ ],
+ "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.000000,
+ "amountPaid": 0.000000,
+ "amountWaived": 100.000000,
+ "amountWrittenOff": 0,
+ "amountOutstanding": 0.000000,
+ "penalty": true,
+ "isActive": true,
+ "isPaid": false,
+ "isWaived": true
+}
+
+
+
+
+
List Client Transactions
+
The list capability of client transaction can support pagination.
+
Mandatory Arguments
+
+ - offset
+ -
+ Integer Mandatory, defaults to 0
+
+ - Indicates the result from which pagination starts
+
+ - limit
+ -
+ Integer Mandatory, defaults to 200
+
+ - 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
+
+
Example Requests:
+
self/clients/189/transactions
+
self/clients/189/transactions?offset=10&limit=50
+
+
+
+GET https://DomainName/api/v1/self/clients/{clientId}/transactions?limit=5&offset=0
+
+
+GET self/clients/226/transactions?limit=5&offset=0
+Content-Type: application/json
+No Request Body:
+
+
+
+{
+ "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
+ }
+ ]
+}
+
+
+
+
+
Retrieve a Client Transaction
+
Example Requests:
+
self/clients/1/transactions/1
+
+
+
self/clients/1/transactions/1?fields=id,officeName
+
+
+
+GET https://DomainName/api/v1/self/clients/{clientId}/transaction/{transactionId}
+
+
+{
+ "id": 1,
+ "officeId": 1,
+ "officeName": "Head Office",
+ "type": {
+ "id": 1,
+ "code": "clientTransactionType.payCharge",
+ "value": "PAY_CHARGE"
+ },
+ "date": [
+ 2015,
+ 8,
+ 17
+ ],
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "amount": 60.000000,
+ "submittedOnDate": [
+ 2015,
+ 8,
+ 19
+ ],
+ "reversed": true
+}
+
+
+
+
+
Retrieve a Loan
+
Arguments
+
+ - associations
+ -
+ optional, a comma separated list of
+ loan 'associations' (itemised below).
+
+ -
+
Associations are just extra pieces of data that you
+ might or might not want to retrieve.
+
+
+ -
+ 'repaymentSchedule': Loan schedule data.
+
+ -
+ 'originalSchedule': Loan schedule data without interest recalculations.
+
+ -
+ 'futureSchedule': Loan schedule data from today date(will be displayed only for interest first repayment strategy processors)
+
+ -
+ 'transactions': Loan transactions data.
+
+ -
+ 'charges': Loan charges data.
+
+ -
+ 'guarantors': Loan guarantors data.
+
+ -
+ 'collateral': Loan collateral data.
+
+ -
+ 'linkedAccount': Account linked to loan.
+
+ -
+ 'multiDisburseDetails': Loan multi-disbursement details.
+
+
+
Example Requests:
+
self/loans/1
+
+
+
self/loans/1?fields=id,principal,annualInterestRate
+
+
+
self/loans/1?fields=id,principal,annualInterestRate&associations=repaymentSchedule,transactions
+
+
+
+GET https://DomainName/api/v1/self/loans/{loanId}
+
+
+{
+ "id": 1,
+ "accountNo": "000000001",
+ "status": {
+ "id": 300,
+ "code": "loanStatusType.active",
+ "value": "Active",
+ "pendingApproval": false,
+ "waitingForDisbursal": false,
+ "active": true,
+ "closedObligationsMet": false,
+ "closedWrittenOff": false,
+ "closedRescheduled": false,
+ "closed": false,
+ "overpaid": false
+ },
+ "clientId": 1,
+ "clientName": "Kampala first Client",
+ "clientOfficeId": 2,
+ "loanProductId": 1,
+ "loanProductName": "Kampala Product (with cash accounting)",
+ "loanProductDescription": "Typical Kampala loan product with cash accounting enabled for testing.",
+ "loanPurposeId": 22,
+ "loanPurposeName": "option.HousingImprovement",
+ "loanOfficerId": 2,
+ "loanOfficerName": "LoanOfficer, Kampala",
+ "loanType": {
+ "id": 1,
+ "code": "loanType.individual",
+ "value": "Individual"
+ },
+ "currency": {
+ "code": "UGX",
+ "name": "Uganda Shilling",
+ "decimalPlaces": 2,
+ "displaySymbol": "USh",
+ "nameCode": "currency.UGX",
+ "displayLabel": "Uganda Shilling (USh)"
+ },
+ "principal": 1000000,
+ "termFrequency": 12,
+ "termPeriodFrequencyType": {
+ "id": 2,
+ "code": "termFrequency.periodFrequencyType.months",
+ "value": "Months"
+ },
+ "numberOfRepayments": 12,
+ "repaymentEvery": 1,
+ "repaymentFrequencyType": {
+ "id": 2,
+ "code": "repaymentFrequency.periodFrequencyType.months",
+ "value": "Months"
+ },
+ "interestRatePerPeriod": 24,
+ "interestRateFrequencyType": {
+ "id": 3,
+ "code": "interestRateFrequency.periodFrequencyType.years",
+ "value": "Per year"
+ },
+ "annualInterestRate": 24,
+ "amortizationType": {
+ "id": 1,
+ "code": "amortizationType.equal.installments",
+ "value": "Equal installments"
+ },
+ "interestType": {
+ "id": 1,
+ "code": "interestType.flat",
+ "value": "Flat"
+ },
+ "interestCalculationPeriodType": {
+ "id": 1,
+ "code": "interestCalculationPeriodType.same.as.repayment.period",
+ "value": "Same as repayment period"
+ },
+ "transactionProcessingStrategyId": 2,
+ "timeline": {
+ "submittedOnDate": [
+ 2012,
+ 4,
+ 3
+ ],
+ "submittedByUsername": "admin",
+ "submittedByFirstname": "App",
+ "submittedByLastname": "Administrator",
+ "approvedOnDate": [
+ 2012,
+ 4,
+ 3
+ ],
+ "approvedByUsername": "admin",
+ "approvedByFirstname": "App",
+ "approvedByLastname": "Administrator",
+ "expectedDisbursementDate": [
+ 2012,
+ 4,
+ 10
+ ],
+ "actualDisbursementDate": [
+ 2012,
+ 4,
+ 10
+ ],
+ "disbursedByUsername": "admin",
+ "disbursedByFirstname": "App",
+ "disbursedByLastname": "Administrator",
+ "expectedMaturityDate": [
+ 2013,
+ 4,
+ 10
+ ]
+ },
+ "summary": {
+ "currency": {
+ "code": "UGX",
+ "name": "Uganda Shilling",
+ "decimalPlaces": 2,
+ "displaySymbol": "USh",
+ "nameCode": "currency.UGX",
+ "displayLabel": "Uganda Shilling (USh)"
+ },
+ "principalDisbursed": 1000000,
+ "principalPaid": 0,
+ "principalWrittenOff": 0,
+ "principalOutstanding": 1000000,
+ "principalOverdue": 833333.3,
+ "interestCharged": 240000,
+ "interestPaid": 0,
+ "interestWaived": 0,
+ "interestWrittenOff": 0,
+ "interestOutstanding": 240000,
+ "interestOverdue": 200000,
+ "feeChargesCharged": 18000,
+ "feeChargesDueAtDisbursementCharged": 0,
+ "feeChargesPaid": 0,
+ "feeChargesWaived": 0,
+ "feeChargesWrittenOff": 0,
+ "feeChargesOutstanding": 18000,
+ "feeChargesOverdue": 15000,
+ "penaltyChargesCharged": 0,
+ "penaltyChargesPaid": 0,
+ "penaltyChargesWaived": 0,
+ "penaltyChargesWrittenOff": 0,
+ "penaltyChargesOutstanding": 0,
+ "penaltyChargesOverdue": 0,
+ "totalExpectedRepayment": 1258000,
+ "totalRepayment": 0,
+ "totalExpectedCostOfLoan": 258000,
+ "totalCostOfLoan": 0,
+ "totalWaived": 0,
+ "totalWrittenOff": 0,
+ "totalOutstanding": 1258000,
+ "totalOverdue": 1048333.3,
+ "overdueSinceDate": [
+ 2012,
+ 5,
+ 10
+ ],
+ "linkedAccount":{
+ "id":1,
+ "accountNo":"000000001"
+ },
+ "disbursementDetails":[{"id":71,"expectedDisbursementDate":[2013,11,1],"principal":22000.000000,"approvedPrincipal":22000.000000}],
+ "fixedEmiAmount":1100.000000,
+ "maxOutstandingLoanBalance":35000,
+ "canDisburse":false,
+ "emiAmountVariations": [],
+ "inArrears": true,
+ "isNPA":false,
+ "overdueCharges": [
+ {
+ "id": 20,
+ "name": "overdraft penality",
+ "active": true,
+ "penalty": true,
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "amount": 3.000000,
+ "chargeTimeType": {
+ "id": 9,
+ "code": "chargeTimeType.overdueInstallment",
+ "value": "overdue fees"
+ },
+ "chargeAppliesTo": {
+ "id": 1,
+ "code": "chargeAppliesTo.loan",
+ "value": "Loan"
+ },
+ "chargeCalculationType": {
+ "id": 2,
+ "code": "chargeCalculationType.percent.of.amount",
+ "value": "% Amount"
+ },
+ "chargePaymentMode": {
+ "id": 0,
+ "code": "chargepaymentmode.regular",
+ "value": "Regular"
+ },
+ "feeInterval": 2,
+ "feeFrequency": {
+ "id": 1,
+ "code": "feeFrequencyperiodFrequencyType.weeks",
+ "value": "Weeks"
+ }
+ }
+ ]
+ }
+}
+
+
+
+
+
Retrieve a Loan Transaction Details
+
Example Request:
+
self/loans/5/transactions/3
+
+
+
+GET https://DomainName/api/v1/self/loans/{loanId}/transactions/{transactionId}
+
+
+{
+ "id": 3,
+ "type": {
+ "id": 2,
+ "code": "loanTransactionType.repayment",
+ "value": "Repayment",
+ "disbursement": false,
+ "repaymentAtDisbursement": false,
+ "repayment": true,
+ "contra": false,
+ "waiveInterest": false,
+ "waiveCharges": false,
+ "writeOff": false,
+ "recoveryRepayment": false
+ },
+ "date": [
+ 2012,
+ 5,
+ 14
+ ],
+ "manuallyReversed": false,
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "amount": 559.88,
+ "interestPortion": 559.88
+}
+
+
+
+
+
List Loan Charges
+
Example Requests:
+
self/loans/1/charges
+
+
+
self/loans/1/charges?fields=name,amountOrPercentage
+
+
+
+GET https://DomainName/api/v1/self/loans/{loanId}/charges
+
+
+[
+ {
+ "id": 1,
+ "chargeId": 1,
+ "name": "Loan Processing fee",
+ "chargeTimeType": {
+ "id": 1,
+ "code": "chargeTimeType.disbursement",
+ "value": "Disbursement"
+ },
+ "chargeCalculationType": {
+ "id": 1,
+ "code": "chargeCalculationType.flat",
+ "value": "Flat"
+ },
+ "percentage": 0,
+ "amountPercentageAppliedTo": 0,
+ "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,
+ "amountOrPercentage": 100,
+ "penalty": false
+ },
+ {
+ "id": 7,
+ "chargeId": 2,
+ "name": "Collection Fee",
+ "chargeTimeType": {
+ "id": 2,
+ "code": "chargeTimeType.specifiedDueDate",
+ "value": "Specified due date"
+ },
+ "dueDate": [
+ 2013,
+ 3,
+ 29
+ ],
+ "chargeCalculationType": {
+ "id": 1,
+ "code": "chargeCalculationType.flat",
+ "value": "Flat"
+ },
+ "percentage": 0,
+ "amountPercentageAppliedTo": 0,
+ "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,
+ "amountOrPercentage": 100,
+ "penalty": false
+ }
+]
+
+
+
+
+
Retrieve a Loan Charge
+
Example Requests:
+
self/loans/1/charges/1
+
+
+
self/loans/1/charges/1?fields=name,amountOrPercentage
+
+
+
+GET https://DomainName/api/v1/self/loans/{loanId}/charges/{chargeId}
+
+
+{
+ "id": 1,
+ "chargeId": 1,
+ "name": "Loan Processing fee",
+ "chargeTimeType": {
+ "id": 1,
+ "code": "chargeTimeType.disbursement",
+ "value": "Disbursement"
+ },
+ "chargeCalculationType": {
+ "id": 1,
+ "code": "chargeCalculationType.flat",
+ "value": "Flat"
+ },
+ "percentage": 0,
+ "amountPercentageAppliedTo": 0,
+ "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,
+ "amountOrPercentage": 100,
+ "penalty": false
+}
+
+
+
+
Retrieve a savings account:
+
Arguments
+
+ - associations
+ - optional, a comma separated list of savings 'associations' (itemized below).
+
Associations are just extra pieces of data that you might or might not want to retrieve.
- 'transactions': Gets data related to transactions on the account e.g. ?associations=transactions
+ - 'charges':Savings Account charges data.
+
+
Example Requests :
+
self/savingsaccounts/1
+
+
self/savingsaccounts/1?associations=transactions
+
+
+ GET https://DomainName/api/v1/self/savingsaccounts/{accountId}
+
+{
+ "id": 1,
+ "accountNo": "000000001",
+ "clientId": 1,
+ "clientName": "small business",
+ "savingsProductId": 1,
+ "savingsProductName": "Passbook Savings",
+ "fieldOfficerId": 0,
+ "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
+ },
+ "timeline": {
+ "submittedOnDate": [
+ 2013,
+ 3,
+ 1
+ ]
+ },
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "nominalAnnualInterestRate": 5,
+ "interestCompoundingPeriodType": {
+ "id": 1,
+ "code": "savings.interest.period.savingsCompoundingInterestPeriodType.daily",
+ "value": "Daily"
+ },
+ "interestPostingPeriodType": {
+ "id": 4,
+ "code": "savings.interest.posting.period.savingsPostingInterestPeriodType.monthly",
+ "value": "Monthly"
+ },
+ "interestCalculationType": {
+ "id": 1,
+ "code": "savingsInterestCalculationType.dailybalance",
+ "value": "Daily Balance"
+ },
+ "interestCalculationDaysInYearType": {
+ "id": 365,
+ "code": "savingsInterestCalculationDaysInYearType.days365",
+ "value": "365 Days"
+ },
+ "summary": {
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "accountBalance": 0
+ }
+}
+
+
+
+
+
Retrieve Savings Account Transaction:
+
Example Requests:
+
self/savingsaccounts/1/transactions/1
+
+
+
+ GET https://DomainName/api/v1/self/savingsaccounts/{accountId}/transactions/{transactionId}
+
+
+{
+ "id": 1,
+ "transactionType": {
+ "id": 2,
+ "code": "savingsAccountTransactionType.withdrawal",
+ "value": "Withdrawal",
+ "deposit": false,
+ "withdrawal": true,
+ "interestPosting": false,
+ "feeDeduction": false
+ },
+ "accountId": 1,
+ "accountNo": "000000001",
+ "date": [
+ 2013,
+ 8,
+ 7
+ ],
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "inMultiplesOf": 0,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "paymentDetailData": {
+ "id": 62,
+ "paymentType": {
+ "id": 11,
+ "name": "cash"
+ },
+ "accountNumber": "",
+ "checkNumber": "",
+ "routingCode": "",
+ "receiptNumber": "",
+ "bankNumber": ""
+ },
+ "amount": 5000,
+ "runningBalance": 0,
+ "reversed": true
+}
+
+
+
+
+
List Savings Charges
+
Example Requests:
+
self/savingsaccounts/1/charges
+
+
self/savingsaccounts/1/charges?chargeStatus=inactive
+
+
self/savingsaccounts/1/charges?fields=name,amountOrPercentage
+
+
+
+GET https://DomainName/api/v1/self/savingsaccounts/{accountId}/charges
+
+
+[
+ {
+ "id": 1,
+ "chargeId": 3,
+ "accountId": 57,
+ "name": "Savings account maintenance fee",
+ "chargeTimeType": {
+ "id": 1,
+ "code": "chargeTimeType.specifiedDueDate",
+ "value": "Specified due date"
+ },
+ "chargeCalculationType": {
+ "id": 1,
+ "code": "chargeCalculationType.flat",
+ "value": "Flat"
+ },
+ "percentage": 0,
+ "amountPercentageAppliedTo": 0,
+ "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,
+ "amountOrPercentage": 100,
+ "penalty": false
+ },
+ {
+ "id": 2,
+ "chargeId": 4,
+ "accountId": 57,
+ "name": "Pass book Fee",
+ "chargeTimeType": {
+ "id": 2,
+ "code": "chargeTimeType.specifiedDueDate",
+ "value": "Specified due date"
+ },
+ "dueDate": [
+ 2013,
+ 3,
+ 29
+ ],
+ "chargeCalculationType": {
+ "id": 1,
+ "code": "chargeCalculationType.flat",
+ "value": "Flat"
+ },
+ "percentage": 0,
+ "amountPercentageAppliedTo": 0,
+ "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,
+ "amountOrPercentage": 100,
+ "penalty": false
+ },
+ {
+ "id": 9,
+ "chargeId": 4,
+ "accountId": 57,
+ "name": "Withdrawal fee percentage",
+ "chargeTimeType": {
+ "id": 5,
+ "code": "chargeTimeType.withdrawalFee",
+ "value": "Withdrawal Fee"
+ },
+ "chargeCalculationType": {
+ "id": 2,
+ "code": "chargeCalculationType.percent.of.amount",
+ "value": "% Amount"
+ },
+ "percentage": 0.25,
+ "amountPercentageAppliedTo": 0,
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "amount": 0,
+ "amountPaid": 0,
+ "amountWaived": 0,
+ "amountWrittenOff": 0,
+ "amountOutstanding": 0,
+ "amountOrPercentage": 0.25,
+ "penalty": false
+ },
+ {
+ "id": 10,
+ "chargeId": 6,
+ "accountId": 57,
+ "name": "Annual fee - INR",
+ "chargeTimeType": {
+ "id": 6,
+ "code": "chargeTimeType.annualFee",
+ "value": "Annual Fee"
+ },
+ "feeOnMonthDay": [
+ 10,
+ 9
+ ],
+ "chargeCalculationType": {
+ "id": 1,
+ "code": "chargeCalculationType.flat",
+ "value": "Flat"
+ },
+ "percentage": 0,
+ "amountPercentageAppliedTo": 0,
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "amount": 50,
+ "amountPaid": 0,
+ "amountWaived": 0,
+ "amountWrittenOff": 0,
+ "amountOutstanding": 50,
+ "amountOrPercentage": 50,
+ "penalty": false
+ }
+]
+
+
+
+
+
Retrieve a Savings account Charge
+
Example Requests:
+
self/savingsaccounts/1/charges/5
+
+
+
self/savingsaccounts/1/charges/5?fields=name,amountOrPercentage
+
+
+
+GET https://DomainName/api/v1/self/savingsaccounts/{accountId}/charges/{savingsAccountChargeId}
+
+
+{
+ "id": 1,
+ "chargeId": 1,
+ "name": "Passbook fee",
+ "chargeTimeType": {
+ "id": 1,
+ "code": "chargeTimeType.specifiedDueDate",
+ "value": "Specified due date"
+ },
+ "chargeCalculationType": {
+ "id": 1,
+ "code": "chargeCalculationType.flat",
+ "value": "Flat"
+ },
+ "percentage": 0,
+ "amountPercentageAppliedTo": 0,
+ "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,
+ "amountOrPercentage": 100,
+ "penalty": false
+}
+
+
+
+
Retrieve Account Transfer Template
+
Returns list of loan/savings accounts that can be used for account transfer
+
Example Requests:
+
self/accounttransfers/template
+
+
+ GET https://DomainName/api/v1/self/accounttransfers/template
+
+
+{
+ "accountOptions": [
+ {
+ "accountId": 1,
+ "accountNo": "00000001",
+ "accountType": {
+ "id": 2,
+ "code": "accountType.savings",
+ "value": "Savings Account"
+ },
+ "clientId": 1,
+ "clientName": "ABC",
+ "officeId": 1,
+ "officeName": "HEAD OFFICE"
+ },
+ {
+ "accountId": 5,
+ "accountNo": "00000005",
+ "accountType": {
+ "id": 1,
+ "code": "accountType.loan",
+ "value": "Loan Account"
+ },
+ "clientId": 2,
+ "clientName": "XYZ",
+ "officeId": 3,
+ "officeName": "REGIONAL OFFICE"
+ }
+ ]
+}
+
+
+
+
+
Create new Transfer
+
Ability to create new transfer of monetary funds from one account to another.
+
+
+ POST https://DomainName/api/v1/self/accounttransfers
+ POST self/accounttransfers/
+Content-Type: application/json
+No Request Body:
+{
+"fromOfficeId": 1,
+"fromClientId": 1,
+"fromAccountType": 2,
+"fromAccountId": 1,
+"toOfficeId": 1,
+"toClientId": 1,
+"toAccountType": 2,
+"toAccountId": 2,
+"dateFormat": "dd MMMM yyyy",
+"locale": "en",
+"transferDate": "01 August 2011",
+"transferAmount": "112.45",
+"transferDescription": "A description of the transfer"
+}
+
+
+{
+ "savingsId": 1,
+ "resourceId": 1
+}
+
+
+