REST API Reference
Clients
getClientByNumber
SINCE | Mifos 2.2.1 |
TYPE | GET |
URL | BASE_URL/client/num-{globalCustNum}.json |
PATH ARGUMENTS | globalCustNum |
REQUEST PARAMS | Â |
RETURNS | org.mifos.dto.screen.ClientInformationDto |
EXAMPLE RESPONSE | { "address": { "state": "", "country": "", "displayAddress": null, "city": "", "zip": "", "phoneNumber": "" }, "customerMeeting": { "meetingSchedule": "Recur every 1 Week(s) on Monday", "meetingPlace": "rest" }, "customerFlags": [], "clientPerformanceHistory": { "loanCycleNumber": 0, "lastLoanAmount": "0.0", "noOfActiveLoans": 2, "delinquentPortfolioAmount": "0.0", "totalSavingsAmount": "105.0", "meetingsAttended": 0, "meetingsMissed": 0, "loanCycleCounters": [ { "counter": 1, "offeringName": "REST Loan Product A" }, { "counter": 1, "offeringName": "REST Loan Product B" } ] }, "recentCustomerNotes": [ { "comment": "Active", "commentDate": "2011-09-12", "personnelName": "mifos" } ], "activeSurveys": false, "customerAccountSummary": { "globalAccountNum": "000100000000003", "nextDueAmount": "0.0" }, "savingsAccountsInUse": [ { "globalAccountNum": "000100000000006", "prdOfferingId": null, "prdOfferingName": "Savings A", "accountStateName": "Active", "accountStateId": 16, "savingsBalance": "10.0" }, { "globalAccountNum": "000100000000007", "prdOfferingId": null, "prdOfferingName": "Savings B", "accountStateName": "Active", "accountStateId": 16, "savingsBalance": "95.0" } ], "customerSurveys": [], "loanAccountsInUse": [ { "globalAccountNum": "000100000000004", "prdOfferingName": "REST Loan Product A", "outstandingBalance": "101.0", "totalAmountDue": "10.0", "accountStateName": "Active in Good Standing", "accountStateId": 5 }, { "globalAccountNum": "000100000000005", "prdOfferingName": "REST Loan Product B", "outstandingBalance": "1032.0", "totalAmountDue": "103.0", "accountStateName": "Active in Good Standing", "accountStateId": 5 } ], "clientDisplay": { "displayName": "Client REST API", "branchId": 2, "customerId": 3, "loanOfficerId": 2, "dateOfBirth": "1986-06-06", "governmentId": "", "maritalStatus": null, "globalCustNum": "0002-000000003", "externalId": "", "customerActivationDate": "2011-09-12", "customerLevelId": 1, "customerStatusName": "Active", "spouseFatherName": "first last", "trainedDate": null, "familyDetails": null, "age": 25, "businessActivities": null, "citizenship": null, "educationLevel": null, "handicapped": null, "numChildren": null, "povertyStatus": "Very poor", "customerStatusId": 3, "loanOfficerName": "loan officer", "parentCustomerDisplayName": "Group-REST", "customerFormedByDisplayName": "loan officer", "blackListed": false, "branchName": "Branch Office", "clientUnderGroup": true, "ethnicity": null, "areFamilyDetailsRequired": false, "spouseFatherValue": "Spouse" }, "closedLoanAccounts":[], "closedSavingsAccounts":[] } |
getClientChargesByNumber
SINCE | Mifos 2.2.2 |
TYPE | GET |
URL | BASE_URL/client/num-{globalCustNum}/charges.json |
PATH ARGUMENTS | globalCustNum |
REQUEST PARAMS | Â |
RETURNS | org.mifos.dto.domain.CustomerChargesDetailsDto |
EXAMPLE RESPONSE | { "accountFees" : [ ], "nextDueAmount" : "0.0", "recentActivities" : [ ], "totalAmountDue" : "0.0", "totalAmountInArrears" : "0.0", "upcomingChargesDate" : "2011-09-19", "upcomingInstallment" : { "feesActionDetails" : [ ], "miscFee" : "0.0", "miscFeePaid" : "0.0", "miscPenalty" : "0.0", "miscPenaltyPaid" : "0.0" } } |
createClient
SINCE | Mifos 2.5 |
TYPE | POST |
URL | BASE_URL/client/create.json |
POST DATA | { "officeId" : 2, "loanOfficerId" : 1, "formedBy" : 1, "groupFlag" : 1, "parentGroupId" : "2", "externalId" : "externalId", "governmentId" : "governmentId", "trained" : true, "trainedDate" : [2012,07,20], "dateOfBirth" : [1980,6,11], "activationDate" : [2012,07,20], "mfiJoiningDate" : [2012,07,20], "customerStatus" : 2, "clientNameDetail" : { "salutation" : 1, "firstName" : "firstN", "middleName" : "middleN", "lastName" : "lastN", "secondLastName" : "" }, "personalDetail" : { "ethnicity" : 132, "citizenship" : 130, "handicapped" : 138, "businessActivities" : 136, "maritalStatus" : 66, "educationLevel" : 135, "numberOfChildren" : 2, "gender" : 49, "povertyStatus" : 41 }, "address" : { "address1" : "address1", "address2" : "address2", "address3" : "address3", "city" : "city", "state" : "state", "country" : "country", "zip" : "zip-zip", "phoneNumber" : "+99 999999999" }, "accountFees" : [], "meeting" : { "meetingStartDate" : [2012,07,23], "meetingPlace" : "meting place", "recurrenceType" : 1, "dayNumber" : 2, "weekDay" : "", "rankOfDay" : "", "recurAfter" : 2 } } |
RETURNS | Map * phone |
EXAMPLE RESPONSE | { "phone":"+99 999999999", "dispalyName":"firstN middleN lastN", "externalId":"externalId", "address":"address1, address2, address3", "status":"success", "state":"state", "accountNum":"000100000000073", "globalCustNum":"0002-000000042", "loanOfficer":"loan officer", "postal code":"zip-zip", "country":"country", "city":"city" } |
Groups
getGroupByNumber
SINCE | Mifos 2.2.2 |
TYPE | GET |
URL | BASE_URL/group/num-{globalCustNum}.json |
PATH ARGUMENTS | globalCustNum |
REQUEST PARAMS | Â |
RETURNS | org.mifos.dto.screen.GroupInformationDto |
EXAMPLE RESPONSE | { "address":{ "state":"", "country":"", "displayAddress":null, "city":"", "zip":"", "phoneNumber":"" }, "customFields":[ ], "customerMeeting":{ "meetingSchedule":"Recur every 1 Week(s) on Monday", "meetingPlace":"rest" }, "customerPositions":null, "groupPerformanceHistory":{ "lastGroupLoanAmount":"0.0", "portfolioAtRisk":"0.0", "totalSavingsAmount":"105.0", "avgLoanAmountForMember":"550.0", "activeClientCount":"1", "totalOutStandingLoanAmount":"1100.0", "loanCycleCounters":[ ] }, "customerFlags":[ ], "recentCustomerNotes":[ { "comment":"Active", "commentDate":"2011-09-12", "personnelName":"mifos" } ], "activeSurveys":false, "customerAccountSummary":{ "globalAccountNum":"000100000000002", "nextDueAmount":"0.0" }, "savingsAccountsInUse":null, "customerSurveys":[ ], "groupDisplay":{ "displayName":"Group-REST", "branchId":2, "customerId":2, "loanOfficerId":2, "globalCustNum":"0002-000000002", "externalId":"", "customerActivationDate":"2011-09-12", "customerLevelId":2, "customerStatusName":"Active", "trainedDate":null, "customerStatusId":9, "loanOfficerName":"loan officer", "parentCustomerDisplayName":"Client-REST", "customerFormedByDisplayName":"loan officer", "trained":false, "blackListed":false }, "clientsOtherThanClosedAndCancelled":[ { "address":null, "displayName":"Client REST API", "customerId":3, "searchId":"1.1.1.1", "loanOfficerId":null, "globalCustNum":"0002-000000003", "externalId":null, "loanOfficerIdAsString":null } ], "loanAccountsInUse":[ ], "closedLoanAccounts":[], "closedSavingsAccounts":[] } |
getGroupChargesByNumber
SINCE | Mifos 2.2.3 |
TYPE | GET |
URL | BASE_URL/group/num-{globalCustNum}/charges.json |
PATH ARGUMENTS | globalCustNum |
REQUEST PARAMS | Â |
RETURNS | org.mifos.dto.domain.CustomerChargesDetailsDto |
EXAMPLE RESPONSE | { "accountFees" : [ ], "nextDueAmount" : "0.0", "recentActivities" : [ ], "totalAmountDue" : "0.0", "totalAmountInArrears" : "0.0", "upcomingChargesDate" : "2011-09-19", "upcomingInstallment" : { "feesActionDetails" : [ ], "miscFee" : "0.0", "miscFeePaid" : "0.0", "miscPenalty" : "0.0", "miscPenaltyPaid" : "0.0" } } |
createGroup
SINCE | Mifos 2.5 |
TYPE | POST |
URL | BASE_URL/group/create.json |
POST DATA | { "centerId" : 1, "officeId" : 2, "displayName" : "RestCreateGroup", "loanOfficerId" : 1, "externalId" : "11aaxx", "trained" : true, "trainedDate" : "2012-07-20", "activationDate" : "2012-07-20", "mfiJoiningDate" : "2012-07-20", "customerStatus" : 8, "parentSystemId" : "0002-000000001", "address" : { "address1" : "address1", "address2" : "address2", "address3" : "address3", "city" : "city", "state" : "state", "country" : "country", "zip" : "zip-zip", "phoneNumber" : "+99 999999999" }, "accountFees" : [], "meeting" : { "meetingStartDate" : "2012-07-23", "meetingPlace" : "meting place", "recurrenceType" : 1, "dayNumber" : 2, "weekDay" : "", "rankOfDay" : "", "recurAfter" : 2 } } |
RETURNS | Map * phone |
EXAMPLE RESPONSE | { "phone":"+99 999999999", "dispalyName":"RestCreateGroup", "externalId":"11aaxx", "address":"address1, address2, address3", "status":"success", "state":"state", "accountNum":"000100000000074", "globalCusNum":"0002-000000043", "loanOfficer":"loan officer", "postal code":"zip-zip", "country":"country", "city":"city" } |
Centers
getCenterByNumber
SINCE | Mifos 2.2.2 |
TYPE | GET |
URL | BASE_URL/center/num-{globalCustNum}.json |
PATH ARGUMENTS | globalCustNum |
REQUEST PARAMS | Â |
RETURNS | org.mifos.dto.domain.CenterInformationDto |
EXAMPLE RESPONSE | { "address":{ "state":"", "country":"", "displayAddress":null, "city":"", "zip":"", "phoneNumber":"" }, "centerPerformanceHistory":{ "numberOfGroups":1, "portfolioAtRisk":"0.2", "totalSavings":"105.0", "totalOutstandingPortfolio":"1100.0", "numberOfClients":1 }, "customFields":[ ], "customerMeeting":{ "meetingSchedule":"Recur every 1 Week(s) on Monday", "meetingPlace":"rest" }, "customerPositions":null, "recentCustomerNotes":null, "activeSurveys":false, "centerDisplay":{ "displayName":"Client-REST", "branchId":2, "customerId":1, "loanOfficerId":2, "globalCustNum":"0002-000000001", "externalId":"", "createdDate":"2011-09-12", "customerLevelId":3, "versionNo":15, "mfiJoiningDate":"2011-09-12", "customerStatusName":"Active", "customerStatusId":13, "loanOfficerName":"loan officer" }, "customerAccountSummary":{ "globalAccountNum":"000100000000001", "nextDueAmount":"0.0" }, "groupsOtherThanClosedAndCancelled":[ { "address":null, "displayName":"Group-REST", "customerId":2, "searchId":"1.1.1", "loanOfficerId":null, "globalCustNum":"0002-000000002", "externalId":null, "loanOfficerIdAsString":null } ], "savingsAccountsInUse":null, "customerSurveys":[ ], "closedSavingsAccounts":[] } |
getCenterChargesByNumber
SINCE | Mifos 2.2.3 |
TYPE | GET |
URL | BASE_URL/center/num-{globalCustNum}/charges.json |
PATH ARGUMENTS | globalCustNum |
REQUEST PARAMS | Â |
RETURNS | org.mifos.dto.domain.CustomerChargesDetailsDto |
EXAMPLE RESPONSE | { "accountFees" : [ ], "nextDueAmount" : "0.0", "recentActivities" : [ ], "totalAmountDue" : "0.0", "totalAmountInArrears" : "0.0", "upcomingChargesDate" : "2011-09-19", "upcomingInstallment" : { "feesActionDetails" : [ ], "miscFee" : "0.0", "miscFeePaid" : "0.0", "miscPenalty" : "0.0", "miscPenaltyPaid" : "0.0" } } |
createCenter
SINCE | Mifos 2.5 |
TYPE | POST |
URL | BASE_URL/center/create.json |
POST DATA | { "mfiJoiningDate": [2012,07,23], "displayName" : "NewRestCenter", "externalId" : "1234", "loanOfficerId" : 1, "officeId" : 2, "address" : { "address1" : "address1", "address2" : "address2", "address3" : "address3", "city" : "city", "state" : "state", "country" : "country", "zip" : "zip-zip", "phoneNumber" : "+99 999999999" }, "accountFees" : [], "meeting" : { "meetingStartDate" : [2012,07,23], "meetingPlace" : "meting place", "recurrenceType" : 1, "dayNumber" : 2, "weekDay" : "", "rankOfDay" : "", "recurAfter" : 2 } } |
RETURNS | Map * phone |
EXAMPLE RESPONSE | { "phone":"+99 999999999", "address":"address1, address2, address3", "status":"success", "name":"NewRestCenter", "state":"state", "mfiDate":"2012-07-23", "accountNum":"000100000000071", "globalCustNum":"0002-000000041", "externalId":"1234", "postal code":"zip-zip", "country":"country", "city":"city" } |
Offices
getOfficeById
SINCE | Mifos 2.2.3 |
TYPE | GET |
URL | BASE_URL/office/id-{officeId}.json |
PATH ARGUMENTS | officeId |
REQUEST PARAMS | Â |
RETURNS | org.mifos.dto.domain.OfficeDto |
EXAMPLE RESPONSE | { "address":null, "name":"Mifos HO", "id":1, "displayName":"Head Office(Mifos HO )", "text":"Mifos HO", "levelId":1, "searchId":"1.1.", "officeId":1, "customFields":[ ], "globalNum":"0001", "lookupNameKey":"", "parentId":null, "officeShortName":"MIF1", "versionNum":1, "statusId":1, "parentOfficeName":null, "officeStatusName":"Active", "officeLevelName":"Head Office" } |
Customers
applyCharge (customer)
SINCE | Mifos 2.2.3 |
TYPE | POST |
URL | BASE_URL/customer/num-{globalCustNum}/charge.json |
PATH ARGUMENTS | globalCustNum |
REQUEST PARAMS | amount, feeId |
RETURNS | Map: |
EXAMPLE REQUEST | BASE_URL/customer/num-0002-000000001/charge.json?amount=5&feeId=-1 |
EXAMPLE RESPONSE | { "chargeAmount": "5.0", "chargeTime": "13:06:54.436", "status": "success", "clientName": "Client-REST", "chargeMadeBy": "mifos", "totalDueBeforeCharge": "0.0", "chargeDate": "2011-09-13", "clientNumber": "0002-000000001", "totalDueAfterCharge": "5.0" } |
getApplicableFees (customer)
SINCE | Mifos 2.2.3 |
TYPE | GET |
URL | BASE_URL/customer/num-{globalAccountNum}/fees.json |
PATH ARGUMENTS | globalAccountNum |
RETURNS | Map: |
EXAMPLE REQUEST | BASE_URL/customer/num-0002-000000003/fees.json |
EXAMPLE RESPONSE | { "Misc Fees":{ "feeId":"-1", "paymentType":null, "periodicity":null, "amountOrRate":null, "isRateType":"0", "formula":null }, "Misc Penalty":{ "feeId":"-2", "paymentType":null, "periodicity":null, "amountOrRate":null, "isRateType":"0", "formula":null } } |
Personnel
getCurrentPersonnel
SINCE | Mifos 2.2.1 |
TYPE | GET |
URL | BASE_URL/personnel/id-current.json |
PATH ARGUMENTS | Â |
REQUEST PARAMS | Â |
RETURNS | org.mifos.dto.screen.PersonnelInformationDto |
EXAMPLE RESPONSE | { "id":1, "displayName":"mifos", "status":{ "name":"Active", "id":1 }, "userName":"mifos", "title":1, "locked":false, "levelId":2, "personnelId":1, "officeId":1, "personnelRoles":[{ "name":"Admin", "id":1 } ], "officeName":"Mifos HO ", "personnelDetails":{ "address":{ "state":"Bangalore", "country":"Bangalore", "displayAddress":"Bangalore", "city":"Bangalore", "zip":"", "phoneNumber":"", "line1":"Bangalore", "line2":"", "line3":"" }, "governmentIdNumber":"123", "dob":313801200000, "maritalStatus":null, "gender":50, "dateOfJoiningMFI":1315864800000, "dateOfJoiningBranch":1315864800000, "dateOfLeavingBranch":1315864800000, "firstName":"Mifos", "middleName":null, "secondLastName":null, "lastName":"MFI" }, "emailId":null, "customFields":[], "personnelNotes":[], "globalPersonnelNum":"1", "age":"31", "recentPersonnelNotes":[], "preferredLocaleLanguageName":"English - (English) : United Kingdom [en_GB]", "preferredLanguageId":1 } |
getCustomersUnderPersonnel
SINCE | Mifos 2.2.2 |
TYPE | GET |
URL | BASE_URL/personnel/id-current/clients.json |
PATH ARGUMENTS | Â |
REQUEST PARAMS | Â |
RETURNS | Map: |
EXAMPLE RESPONSE | { "groups":[ ], "centers":[ { "id":1, "displayName":"Tramkna", "searchId":"1.1", "globalCustNum":"0002-000000001", "groups":[ { "id":2, "displayName":"Tanung", "searchId":"1.1.1", "globalCustNum":"0002-000000002", "clients":[ { "id":3, "displayName":"San So", "searchId":"1.1.1.1", "globalCustNum":"0002-000000003" } ] } ] } ], "clients":[ ] } |
getCustomersUnderPersonnelForSpecifiedDay
SINCE | Mifos 2.2.2 |
TYPE | GET |
URL | BASE_URL/personnel/id-current/meetings-{day}.json |
PATH ARGUMENTS | day in format dd-MM-yyyy |
REQUEST PARAMS | Â |
RETURNS | Map: |
EXAMPLE RESPONSE | { "centers":[ { "id":27, "displayName":"branch1 center", "searchId":"1.27", "globalCustNum":"0003-000000027", "groups":[ { "id":32, "displayName":"GroupInBranch1", "searchId":"1.27.1", "globalCustNum":"0003-000000032", "clients":[ { "id":33, "displayName":"ClientInBranch1 ClientInBranch1", "searchId":"1.27.1.1", "globalCustNum":"0003-000000033" } ] } ] } ], "clients":[ ], "groups":[ ] } |
Admin
getSystemInformation
SINCE | Mifos 2.2.2 |
TYPE | GET |
URL | BASE_URL/admin/system/id-information.json |
PATH ARGUMENTS | Â |
REQUEST PARAMS | Â |
RETURNS | org.mifos.application.admin.servicefacade.SystemInformationDto |
EXAMPLE RESPONSE | { "osArch":"i386", "osName":"Linux", "osVersion":"3.0.0-12-generic", "applicationServerInfo":"jetty/7.3.1.v20110307", "applicationVersion":"Developer Schema", "buildDate":"Mon Oct 31 17:11:00 CET 2011", "buildNumber":"DEVELOPMENT", "commitIdentifier":"943cc94ee69a9e48400042a7e00eca17881afe53", "databaseName":"mifos", "databasePort":"3306", "databaseServer":"localhost", "databaseUser":"mifos@localhost", "databaseVendor":"MySQL", "databaseVersion":"5.1.58-1ubuntu1", "dateTimeString":"01/11/11 11:29", "dateTimeStringIso8601":"2011-11-01T11:29:51.988+01:00", "infoSource":"admin.unableToDetermineConfigurationSource", "infoURL":"mysql://localhost:3306/mifos?useUnicode=true&characterEncoding=UTF-8", "javaVendor":"Sun Microsystems Inc.", "javaVersion":"1.6.0_26", "osUser":"hudson", "releaseName":"${current.release.name}", "customReportsDirectory":"/home/hudson/.mifos/uploads/report", "databaseDriverName":"MySQL-AB JDBC Driver", "databaseDriverVersion":"mysql-connector-java-5.1.13 ( Revision: ${bzr.revision-id} )" } |
getAcceptedPaymentTypes
SINCE | Mifos 2.2.3 |
TYPE | GET |
URL | BASE_URL/admin/payment-types/state-accepted.json |
PATH ARGUMENTS | Â |
REQUEST PARAMS | Â |
RETURNS | org.mifos.dto.domain.AcceptedPaymentTypeDto |
EXAMPLE RESPONSE | { "outFeeList":[ { "name":"Cash", "id":1, "acceptedPaymentTypeId":5 } ], "outDisbursementList":[ { "name":"Cash", "id":1, "acceptedPaymentTypeId":1 } ], "outRepaymentList":[ { "name":"Cash", "id":1, "acceptedPaymentTypeId":2 } ], "outDepositList":[ { "name":"Cash", "id":1, "acceptedPaymentTypeId":3 } ], "outWithdrawalList":[ { "name":"Cash", "id":1, "acceptedPaymentTypeId":4 } ], "inFeeList":[ { "name":"Voucher", "id":2, "acceptedPaymentTypeId":null }, { "name":"Cheque", "id":3, "acceptedPaymentTypeId":null } ], "inDisbursementList":[ { "name":"Voucher", "id":2, "acceptedPaymentTypeId":null }, { "name":"Cheque", "id":3, "acceptedPaymentTypeId":null } ], "inRepaymentList":[ { "name":"Voucher", "id":2, "acceptedPaymentTypeId":null }, { "name":"Cheque", "id":3, "acceptedPaymentTypeId":null } ], "inWithdrawalList":[ { "name":"Voucher", "id":2, "acceptedPaymentTypeId":null }, { "name":"Cheque", "id":3, "acceptedPaymentTypeId":null } ], "inDepositList":[ { "name":"Voucher", "id":2, "acceptedPaymentTypeId":null }, { "name":"Cheque", "id":3, "acceptedPaymentTypeId":null } ] } |
Accounts
getAccountTransactionHistoryByNumber
SINCE | Mifos 2.2.2 |
TYPE | GET |
URL | BASE_URL/account/num-{globalAccountNum}/trxnhistory.json |
PATH ARGUMENTS | globalAccountNum |
REQUEST PARAMS | Â |
RETURNS | List<org.mifos.dto.screen.TransactionHistoryDto> |
EXAMPLE RESPONSE | [ { "type":"Loan Disbursement", "locale":null, "transactionDate":1315778400000, "glcode":"11201", "notes":"-", "clientName":"Client REST API", "paymentId":1, "accountTrxnId":2, "balance":"100.0", "postedDate":1315778400000, "userPrefferedTransactionDate":"12/09/2011", "postedBy":"mifos", "credit":"100.0", "debit":"-", "userPrefferedPostedDate":"12/09/2011" }, { "type":"Loan Disbursement", "locale":null, "transactionDate":1315778400000, "glcode":"1503", "notes":"-", "clientName":"Client REST API", "paymentId":1, "accountTrxnId":1, "balance":"100.0", "postedDate":1315778400000, "userPrefferedTransactionDate":"12/09/2011", "postedBy":"mifos", "credit":"-", "debit":"100.0", "userPrefferedPostedDate":"12/09/2011" } ] |
Loans
getLoanByNumber
SINCE | Mifos 2.2.2 |
TYPE | GET |
URL | BASE_URL/account/loan/num-{globalAccountNum}.json |
PATH ARGUMENTS | globalAccountNum |
REQUEST PARAMS | Â |
RETURNS | org.mifos.dto.screen.LoanInformationDto |
EXAMPLE RESPONSE | { "accountFees" : [ ], "accountFlagNames" : [ ], "accountId" : 4, "accountStateId" : 5, "accountStateName" : "AccountState-ActiveInGoodStanding", "accountSurveys" : null, "accountTypeId" : 1, "activeSurveys" : false, "businessActivityId" : null, "collateralNote" : "", "collateralTypeId" : null, "createdDate" : 1315778400000, "customerId" : 3, "customerName" : "Client REST API", "disbursed" : true, "disbursementDate" : 1315778400000, "externalId" : "", "fundName" : null, "globalAccountNum" : "000100000000004", "globalCustNum" : "0002-000000003", "gracePeriodDuration" : 0, "gracePeriodTypeName" : "GracePeriodTypes-None", "group" : false, "interestDeductedAtDisbursement" : false, "interestRate" : 1, "interestTypeName" : "InterestTypes-Flat", "loanActivityDetails" : true, "loanSummary" : { "feesDue" : "0.0", "feesPaid" : "0.0", "interestDue" : "1.0", "interestPaid" : "0.0", "originalFees" : "0.0", "originalInterest" : "1.0", "originalPenalty" : "0.0", "originalPrincipal" : "100.0", "penaltyDue" : "0.0", "penaltyPaid" : "0.0", "principalDue" : "100.0", "principalPaid" : "0.0", "totalAmntDue" : "101.0", "totalAmntPaid" : "0.0", "totalLoanAmnt" : "101.0" }, "maxNoOfInstall" : 10, "minNoOfInstall" : 1, "nextMeetingDate" : "2011-09-19", "noOfInstallments" : 10, "officeId" : 2, "officeName" : "Branch Office", "performanceHistory" : { "daysInArrears" : 0, "loanMaturityDate" : "2011-11-21", "noOfPayments" : 0, "totalNoOfMissedPayments" : 0 }, "personnelId" : 2, "prdOfferingName" : "REST Loan Product A", "prinDueLastInst" : false, "recentAccountActivity" : [ { "actionDate" : 1315778400000, "activity" : "Loan Disbursal", "fees" : "0.0", "id" : 4, "interest" : "0.0", "locale" : null, "penalty" : "0.0", "principal" : "100.0", "runningBalanceFees" : "0.0", "runningBalanceInterest" : "1.0", "runningBalancePenalty" : "0.0", "runningBalancePrinciple" : "100.0", "runningBalancePrincipleWithInterestAndFees" : "101.0", "timeStamp" : 1315778400000, "total" : "100.0", "totalValue" : 100 } ], "recentNoteDtos" : [ { "comment" : "Approved", "commentDate" : "2011-09-12", "personnelName" : "mifos" } ], "recurAfter" : 1, "recurrenceId" : 1, "redone" : false, "totalAmountDue" : "10.0", "totalAmountInArrears" : "0.0" } |
getLoanInstallmentByNumber
SINCE | Mifos 2.2.2 |
TYPE | GET |
URL | BASE_URL/account/loan/num-{globalAccountNum}/installment.json |
PATH ARGUMENTS | globalAccountNum |
REQUEST PARAMS | Â |
RETURNS | org.mifos.dto.domain.LoanInstallmentDetailsDto |
EXAMPLE RESPONSE | { "nextMeetingDate" : "2011-09-19", "overDueInstallmentDetails" : { "fees" : "0.0", "interest" : "0.0", "penalty" : "0.0", "principal" : "0.0", "subTotal" : "0.0" }, "totalAmountDue" : "10.0", "upcomingInstallmentDetails" : { "fees" : "0.0", "interest" : "0.0", "penalty" : "0.0", "principal" : "10.0", "subTotal" : "10.0" } } |
getLoanRepaymentScheduleByNumber
SINCE | Mifos 2.2.2 |
TYPE | GET |
URL | BASE_URL/account/loan/num-{globalAccountNum}/schedule.json |
PATH ARGUMENTS | globalAccountNum |
REQUEST PARAMS | Â |
RETURNS | List<org.mifos.dto.domain.LoanRepaymentScheduleItemDto> |
EXAMPLE RESPONSE | [ { "dueDate" : "2011-09-19", "extraInterest" : "0.0", "extraInterestPaid" : "0.0", "feesActionDetails" : [ ], "installmentNumber" : 1, "interest" : "0.0", "interestPaid" : "0.0", "miscFee" : "0.0", "miscFeePaid" : "0.0", "miscPenalty" : "0.0", "miscPenaltyPaid" : "0.0", "paymentDate" : null, "paymentStatus" : 0, "penalty" : "0.0", "penaltyPaid" : "0.0", "principal" : "10.0", "principalPaid" : "0.0" }, { "dueDate" : "2011-09-26", "extraInterest" : "0.0", "extraInterestPaid" : "0.0", "feesActionDetails" : [ ], "installmentNumber" : 2, "interest" : "0.0", "interestPaid" : "0.0", "miscFee" : "0.0", "miscFeePaid" : "0.0", "miscPenalty" : "0.0", "miscPenaltyPaid" : "0.0", "paymentDate" : null, "paymentStatus" : 0, "penalty" : "0.0", "penaltyPaid" : "0.0", "principal" : "10.0", "principalPaid" : "0.0" }, { "dueDate" : "2011-10-03", "extraInterest" : "0.0", "extraInterestPaid" : "0.0", "feesActionDetails" : [ ], "installmentNumber" : 3, "interest" : "0.0", "interestPaid" : "0.0", "miscFee" : "0.0", "miscFeePaid" : "0.0", "miscPenalty" : "0.0", "miscPenaltyPaid" : "0.0", "paymentDate" : null, "paymentStatus" : 0, "penalty" : "0.0", "penaltyPaid" : "0.0", "principal" : "10.0", "principalPaid" : "0.0" }, { "dueDate" : "2011-10-10", "extraInterest" : "0.0", "extraInterestPaid" : "0.0", "feesActionDetails" : [ ], "installmentNumber" : 4, "interest" : "0.0", "interestPaid" : "0.0", "miscFee" : "0.0", "miscFeePaid" : "0.0", "miscPenalty" : "0.0", "miscPenaltyPaid" : "0.0", "paymentDate" : null, "paymentStatus" : 0, "penalty" : "0.0", "penaltyPaid" : "0.0", "principal" : "10.0", "principalPaid" : "0.0" }, { "dueDate" : "2011-10-17", "extraInterest" : "0.0", "extraInterestPaid" : "0.0", "feesActionDetails" : [ ], "installmentNumber" : 5, "interest" : "0.0", "interestPaid" : "0.0", "miscFee" : "0.0", "miscFeePaid" : "0.0", "miscPenalty" : "0.0", "miscPenaltyPaid" : "0.0", "paymentDate" : null, "paymentStatus" : 0, "penalty" : "0.0", "penaltyPaid" : "0.0", "principal" : "10.0", "principalPaid" : "0.0" }, { "dueDate" : "2011-10-24", "extraInterest" : "0.0", "extraInterestPaid" : "0.0", "feesActionDetails" : [ ], "installmentNumber" : 6, "interest" : "0.0", "interestPaid" : "0.0", "miscFee" : "0.0", "miscFeePaid" : "0.0", "miscPenalty" : "0.0", "miscPenaltyPaid" : "0.0", "paymentDate" : null, "paymentStatus" : 0, "penalty" : "0.0", "penaltyPaid" : "0.0", "principal" : "10.0", "principalPaid" : "0.0" }, { "dueDate" : "2011-10-31", "extraInterest" : "0.0", "extraInterestPaid" : "0.0", "feesActionDetails" : [ ], "installmentNumber" : 7, "interest" : "0.0", "interestPaid" : "0.0", "miscFee" : "0.0", "miscFeePaid" : "0.0", "miscPenalty" : "0.0", "miscPenaltyPaid" : "0.0", "paymentDate" : null, "paymentStatus" : 0, "penalty" : "0.0", "penaltyPaid" : "0.0", "principal" : "10.0", "principalPaid" : "0.0" }, { "dueDate" : "2011-11-07", "extraInterest" : "0.0", "extraInterestPaid" : "0.0", "feesActionDetails" : [ ], "installmentNumber" : 8, "interest" : "0.0", "interestPaid" : "0.0", "miscFee" : "0.0", "miscFeePaid" : "0.0", "miscPenalty" : "0.0", "miscPenaltyPaid" : "0.0", "paymentDate" : null, "paymentStatus" : 0, "penalty" : "0.0", "penaltyPaid" : "0.0", "principal" : "10.0", "principalPaid" : "0.0" }, { "dueDate" : "2011-11-14", "extraInterest" : "0.0", "extraInterestPaid" : "0.0", "feesActionDetails" : [ ], "installmentNumber" : 9, "interest" : "0.0", "interestPaid" : "0.0", "miscFee" : "0.0", "miscFeePaid" : "0.0", "miscPenalty" : "0.0", "miscPenaltyPaid" : "0.0", "paymentDate" : null, "paymentStatus" : 0, "penalty" : "0.0", "penaltyPaid" : "0.0", "principal" : "10.0", "principalPaid" : "0.0" }, { "dueDate" : "2011-11-21", "extraInterest" : "0.0", "extraInterestPaid" : "0.0", "feesActionDetails" : [ ], "installmentNumber" : 10, "interest" : "1.0", "interestPaid" : "0.0", "miscFee" : "0.0", "miscFeePaid" : "0.0", "miscPenalty" : "0.0", "miscPenaltyPaid" : "0.0", "paymentDate" : null, "paymentStatus" : 0, "penalty" : "0.0", "penaltyPaid" : "0.0", "principal" : "10.0", "principalPaid" : "0.0" } ] |
repay
SINCE | Mifos 2.2.1 |
TYPE | POST |
URL | BASE_URL/account/loan/num-{globalAccountNum}/repay.json |
PATH ARGUMENTS | globalAccountNum |
MANDATORY REQUEST PARAMS | amount |
OPTIONAL REQUEST PARAMS | paymentDate (dd-MM-yyyy), receiptId, receiptDate (dd-MM-yyyy), paymentModeId |
RETURNS | Map: |
EXAMPLE RESPONSE | { "outstandingAfterPayment": "1.0", "paymentAmount": "100.0", "paymentDate": "2011-09-13", "status": "success", "paymentTime": "23:24:00.013", "clientName": "Client REST API", "paymentMadeBy": "mifos", "outstandingBeforePayment": "101.0", "loanDisplayName": "REST Loan Product A", "clientNumber": "0002-000000003" } |
fullRepay
SINCE | Mifos 2.2.3 |
TYPE | POST |
URL | BASE_URL/account/loan/num-{globalAccountNum}/fullrepay.json |
PATH ARGUMENTS | globalAccountNum |
MANDATORY REQUEST PARAMS | waiveInterest |
OPTIONAL REQUEST PARAMS | paymentDate (dd-MM-yyyy), receiptId, receiptDate (dd-MM-yyyy), paymentModeId |
RETURNS | Map: |
EXAMPLE REQUEST | BASE_URL/account/loan/num-000100000000074/fullrepay.json?waiveInterest=true |
EXAMPLE RESPONSE | { "outstandingAfterPayment": "0.0", "paymentAmount": "1004.0", "paymentDate": "2011-12-02", "status": "success", "paymentTime": "09:26:25.709", "clientName": "ClientWithLoan 20110221", "paymentMadeBy": "mifos", "outstandingBeforePayment": "0.0", "loanDisplayName": "InterestWaiverLoan", "clientNumber": "0002-000000010" } |
disburseLoan
SINCE | Mifos 2.2.3 |
TYPE | POST |
URL | BASE_URL/account/loan/num-{globalAccountNum}/disburse.json |
PATH ARGUMENTS | globalAccountNum |
MANDATORY REQUEST PARAMS | disbursalDate (dd-MM-yyyy), disbursePaymentTypeId |
OPTIONAL REQUEST PARAMS | receiptId, receiptDate (dd-MM-yyyy), paymentModeOfPayment |
RETURNS | Map: |
EXAMPLE RESPONSE | { "outstandingBeforeDisbursement": "10461.0", "disbursementDate": "2011-12-05", "outstandingAfterDisbursement": "10461.0", "disbursementMadeBy": "mifos", "disbursementAmount": "10000.0", "status": "success", "clientName": "Stu1233171716380 Client1233171716380", "disbursementTime": "09:23:44.074", "loanDisplayName": "WeeklyClientFlatLoanWithNoFee", "clientNumber": "0002-000000006" } |
applyAdjustment (loan account)
SINCE | Mifos 2.2.3 |
TYPE | POST |
URL | BASE_URL/account/loan/num-{globalAccountNum}/adjustment.json |
PATH ARGUMENTS | globalAccountNum |
REQUEST PARAMS | note |
RETURNS | Map: |
EXAMPLE REQUEST | BASE_URL/account/loan/num-000100000000004/adjustment.json?note=Adjustment applied |
EXAMPLE RESPONSE | { "status": "success", "clientName": "Client REST API", "adjustmentMadeBy": "mifos", "adjustmentDate": "2011-09-13", "outstandingBeforeAdjustment": "1.0", "loanDisplayName": "REST Loan Product A", "clientNumber": "0002-000000003", "outstandingAfterAdjustment": "101.0", "adjustmentAmount": "100.0", "note": "Adjustment applied", "adjustmentTime": "13:06:55.461" } |
applyCharge (loan account)
SINCE | Mifos 2.2.3 |
TYPE | POST |
URL | BASE_URL/account/loan/num-{globalAccountNum}/charge.json |
PATH ARGUMENTS | globalAccountNum |
REQUEST PARAMS | amount, feeId |
RETURNS | Map: |
EXAMPLE REQUEST | BASE_URL/account/loan/num-000100000000008/charge.json?amount=5&feeId=-1 |
EXAMPLE RESPONSE | { "chargeAmount": "5.0", "chargeTime": "13:06:22.395", "outstandingBeforeCharge": "101.0", "status": "success", "clientName": "Client REST API", "outstandingAfterCharge": "106.0", "chargeMadeBy": "mifos", "chargeDate": "2011-09-13", "loanDisplayName": "REST Loan Product A", "clientNumber": "0002-000000003" } |
getApplicableFees (loan account)
SINCE | Mifos 2.2.3 |
TYPE | GET |
URL | BASE_URL/account/loan/num-{globalAccountNum}/fees.json |
PATH ARGUMENTS | globalAccountNum |
RETURNS | Map: |
EXAMPLE REQUEST | BASE_URL/account/loan/num-000100000000004/fees.json |
EXAMPLE RESPONSE | { "Misc Fees":{ "feeId":"-1", "paymentType":null, "periodicity":null, "amountOrRate":null, "isRateType":"0", "formula":null }, "Misc Penalty":{ "feeId":"-2", "paymentType":null, "periodicity":null, "amountOrRate":null, "isRateType":"0", "formula":null } } |
isLoanInterestWaivable
SINCE | Mifos 2.2.3 |
TYPE | GET |
URL | BASE_URL/account/loan/num-{globalAccountNum}/interestWaivable.json |
PATH ARGUMENTS | globalAccountNum |
RETURNS | Map: |
EXAMPLE REQUEST | BASE_URL/account/loan/num-000100000000004/interestWaivable.json |
EXAMPLE RESPONSE | { "isInterestWaivable": "false", "defaultValue": "false" } |
createLoanAccount
SINCE | Mifos 2.5 |
TYPE | POST |
URL | BASE_URL/account/loan/create.json |
PATH ARGUMENTS | Â |
RETURNS | Map: |
EXAMPLE REQUEST | BASE_URL/account/loan/create.json |
POST DATA | { "customerId" : 9, "productId" : 2, "accountState" : 2, "loanAmount" : 10000.0, "interestRate" : 13, "disbursementDate" : [2012,7,16], "disbursalPaymentTypeId" : 1, "numberOfInstallments" : 10, "graceDuration" : 10, "sourceOfFundId" : 2, "loanPurposeId" : 10, "collateralTypeId" : 1, "collateralNotes" : "", "externalId" : "", "glim" : true, "accountFees" : [ { "feeId" : 1, "amount" : "10" }], "accountPenalties" : [ { "penaltyId" : 1, "amount" : "10" }], "minNumOfInstallments" : 5, "maxNumOfInstallments" : 20, "minAllowedLoanAmount" : 1000.0, "maxAllowedLoanAmount" : 100000.0, "predefinedAccountNumber" : "", "flagId" : "2", "glimAccounts" : [ { "globalId" : "0002-000000010", "loanAmount" : 5000.0, "loanPurposeId" : 3 }, { "globalId" : "0002-000000041", "loanAmount" : 5000.0, "loanPurposeId" : 3 } ] } |
EXAMPLE RESPONSE | { "status":"success", "individualCustomer[0]":"Stu1233266043526 Client1233266043526", "individualAccount[0]":"000100000000211", "individualAmmount[0]":"5000.0", "individualCustomer[1]":"Stu1233266033986 Client1233266033986", "individualAccount[1]":"000100000000212" "individualAmmount[1]":"5000.0", "accountNum":"000100000000210", "customer":"MyGroup1233266031669", "GLIM":"true", "externalId":"", "noOfInstallments":"10", "loanAmmount":"10000.0", } |
Savings
getSavingsByNumber
SINCE | Mifos 2.2.2 |
TYPE | GET |
URL | BASE_URL/account/savings/num-{globalAccountNum}.json |
PATH ARGUMENTS | globalAccountNum |
REQUEST PARAMS | Â |
RETURNS | org.mifos.dto.domain.SavingsAccountDetailDto |
EXAMPLE RESPONSE | { "accountBalance" : "10.0", "accountStateName" : "SAVINGS_ACTIVE", "depositTypeName" : "VOLUNTARY", "dueDate" : "2011-09-19", "globalAccountNum" : "000100000000006", "performanceHistory" : { "missedDeposits" : "0", "openedDate" : 1315778400000, "totalDeposits" : "10.0", "totalInterestEarned" : "0.0", "totalWithdrawals" : "0.0" }, "productDetails" : { "amountForDeposit" : 100.0, "depositGlCode" : 36, "depositGlCodeValue" : "24101", "depositType" : 2, "groupMandatorySavingsAccount" : false, "groupMandatorySavingsType" : 0, "interestCalculationFrequency" : 1, "interestCalculationFrequencyPeriod" : 2, "interestCalculationType" : 1, "interestGlCode" : 56, "interestGlCodeValue" : "41102", "interestPostingMonthlyFrequency" : 3, "interestRate" : 5.0, "maxWithdrawal" : 1000.0, "minBalanceForInterestCalculation" : 0.0, "openSavingsAccountsExist" : true, "productDetails" : { "applicableFor" : 1, "category" : 2, "categoryName" : "Other", "createdDate" : 1315778400000, "createdDateFormatted" : "12/09/2011", "description" : "", "endDate" : null, "endDateFormatted" : "", "globalNumber" : "1-003", "id" : 3, "name" : "Savings A", "shortName" : "SA", "startDate" : 1315778400000, "startDateFormatted" : "12/09/2011", "status" : 2 } }, "recentActivity" : [ { "accountTrxnId" : 1, "actionDate" : 1315778400000, "activity" : "Deposit", "amount" : "10.0", "locale" : null, "runningBalance" : "10.0", "userPrefferedDate" : "12/09/2011" } ], "recentNoteDtos" : [ { "comment" : "Active", "commentDate" : "2011-09-12", "personnelName" : "mifos" } ], "recommendedOrMandatoryAmount" : "100.0", "totalAmountDue" : "100.0" } |
getSavingsDepositDueDetailsByNumber
SINCE | Mifos 2.2.2 |
TYPE | GET |
URL | BASE_URL/account/savings/num-{globalAccountNum}/due.json |
PATH ARGUMENTS | globalAccountNum |
REQUEST PARAMS | Â |
RETURNS | org.mifos.dto.screen.SavingsAccountDepositDueDto |
EXAMPLE RESPONSE | { "nextDueDetail":{ "dueDate":"2011-09-19", "dueAmount":"100.0" }, "previousDueDetails":[ { "dueDate":"2011-09-12", "dueAmount":"5.0" } ], "stateId":16, "stateName":"Active" } |
deposit
SINCE | Mifos 2.2.1 |
TYPE | POST |
URL | BASE_URL/account/savings/num-{globalAccountNum}/deposit.json |
PATH ARGUMENTS | globalAccountNum |
MANDATORY REQUEST PARAMS | amount, trxnDate (dd-MM-yyyy), paymentTypeId |
OPTIONAL REQUEST PARAMS | receiptId, receiptDate (dd-MM-yyyy) |
RETURNS | Map: |
EXAMPLE RESPONSE | { "savingsDisplayName": "Savings A", "balanceBeforePayment": "10.0", "paymentAmount": "100.0", "paymentDate": "2011-09-13", "balanceAfterPayment": "110.0", "status": "success", "paymentTime": "23:25:25.064", "clientName": "Client REST API", "paymentMadeBy": "mifos", "clientNumber": "0002-000000003" } |
withdraw
SINCE | Mifos 2.2.2 |
TYPE | POST |
URL | BASE_URL/account/savings/num-{globalAccountNum}/withdraw.json |
PATH ARGUMENTS | globalAccountNum |
MANDATORY REQUEST PARAMS | amount, trxnDate (dd-MM-yyyy), paymentTypeId |
OPTIONAL REQUEST PARAMS | receiptId, receiptDate (dd-MM-yyyy) |
RETURNS | Map: |
EXAMPLE RESPONSE | { "savingsDisplayName": "Savings A", "balanceBeforePayment": "110.0", "paymentAmount": "69.0", "paymentDate": "2011-09-13", "balanceAfterPayment": "41.0", "status": "success", "paymentTime": "23:27:25.064", "clientName": "Client REST API", "paymentMadeBy": "mifos", "clientNumber": "0002-000000003" } |
applyAdjustment (savings account)
SINCE | Mifos 2.2.3 |
TYPE | POST |
URL | BASE_URL/account/savings/num-{globalAccountNum}/adjustment.json |
PATH ARGUMENTS | globalAccountNum |
REQUEST PARAMS | amount, note |
RETURNS | Map: |
EXAMPLE REQUEST | BASE_URL/account/savings/num-000100000000006/adjustment.json?amount=60¬e=Adjustment applied |
EXAMPLE RESPONSE | { "savingsDisplayName": "Savings A", "balanceAfterAdjustment": "50.0", "status": "success", "clientName": "Client REST API", "adjustmentMadeBy": "mifos", "adjustmentDate": "2011-09-13", "clientNumber": "0002-000000003", "adjustmentAmount": "60.0", "note": "Adjustment applied", "adjustmentTime": "14:03:53.797", "balanceBeforeAdjustment": "41.0" } |
createSavingsAccount
SINCE | Mifos 2.5 |
TYPE | POST |
URL | BASE_URL/account/savings/create.json |
PATH ARGUMENTS | globalCustomerNum |
RETURNS | Map: |
EXAMPLE REQUEST | BASE_URL/account/savings/create.json?globalCustomerNum=0002-000000003&productId=2 |
EXAMPLE RESPONSE | { "customerName":"Stu1232993852651 Client1232993852651", "recommendedAmount":"0", "interestRatePeriod":"3", "productName":"MySavingsProduct1233265923516", "interesRate":"8.0" } |
Collectionsheet
getCollectionSheet
SINCE | Mifos 2.2.2 |
TYPE | GET |
URL | BASE_URL/collectionsheet/customer/id-{customerId}.json |
PATH ARGUMENTS | customerId |
REQUEST PARAMS | Â |
RETURNS | org.mifos.application.servicefacade.CollectionSheetDto |
EXAMPLE | { "date": [ 2011, 4, 22 ], "collectionSheetCustomer": [ { "name": "Default Center", "levelId": 3, "branchId": 2, "customerId": 1, "searchId": "1.1", "parentCustomerId": null, "attendanceId": null, "collectionSheetCustomerSaving": [ { "customerId": 1, "accountId": 2, "currencyId": 2, "productId": 1, "productShortName": "s1", "recommendedAmountUnitId": 1, "totalDepositAmount": 0, "depositDue": 0, "depositPaid": 0 } ], "collectionSheetCustomerLoan": [], "collectionSheetCustomerAccount": { "accountId": 1, "currencyId": 2, "totalCustomerAccountCollectionFee": 0 }, "individualSavingAccounts": [] }, { "name": "group1", "levelId": 2, "branchId": 2, "customerId": 4, "searchId": "1.1.1", "parentCustomerId": 1, "attendanceId": null, "collectionSheetCustomerSaving": [], "collectionSheetCustomerLoan": [ { "customerId": 4, "accountId": 42, "payInterestAtDisbursement": 0, "currencyId": 2, "productId": 7, "accountStateId": 5, "productShortName": "wgff", "totalDisbursement": 0, "totalRepaymentDue": 1029, "amountDueAtDisbursement": 0, "disbursalAccount": false }, { "customerId": 4, "accountId": 11, "payInterestAtDisbursement": 0, "currencyId": 2, "productId": 6, "accountStateId": 3, "productShortName": "GEL", "totalDisbursement": 1000, "totalRepaymentDue": 0, "amountDueAtDisbursement": 0, "disbursalAccount": true } ], "collectionSheetCustomerAccount": { "accountId": 5, "currencyId": 2, "totalCustomerAccountCollectionFee": 0 }, "individualSavingAccounts": [] }, { "name": "client1 lastname", "levelId": 1, "branchId": 2, "customerId": 5, "searchId": "1.1.1.1", "parentCustomerId": 4, "attendanceId": null, "collectionSheetCustomerSaving": [], "collectionSheetCustomerLoan": [ { "customerId": 5, "accountId": 10, "payInterestAtDisbursement": 0, "currencyId": 2, "productId": 5, "accountStateId": 5, "productShortName": "EL", "totalDisbursement": 0, "totalRepaymentDue": 900, "amountDueAtDisbursement": 0, "disbursalAccount": false } ], "collectionSheetCustomerAccount": { "accountId": 6, "currencyId": 2, "totalCustomerAccountCollectionFee": 0 }, "individualSavingAccounts": [ { "customerId": 5, "accountId": 2, "currencyId": null, "productId": 1, "productShortName": "s1", "recommendedAmountUnitId": null, "totalDepositAmount": 10, "depositDue": 10, "depositPaid": 0 } ] }, { "name": "groupWithoutLoan", "levelId": 2, "branchId": 2, "customerId": 9, "searchId": "1.1.2", "parentCustomerId": 1, "attendanceId": null, "collectionSheetCustomerSaving": [], "collectionSheetCustomerLoan": [], "collectionSheetCustomerAccount": { "accountId": 13, "currencyId": 2, "totalCustomerAccountCollectionFee": 0 }, "individualSavingAccounts": [] }, { "name": "ClientWithLoan 20110221", "levelId": 1, "branchId": 2, "customerId": 10, "searchId": "1.1.2.1", "parentCustomerId": 9, "attendanceId": null, "collectionSheetCustomerSaving": [ { "customerId": 10, "accountId": 59, "currencyId": 2, "productId": 1, "productShortName": "s1", "recommendedAmountUnitId": 2, "totalDepositAmount": 100, "depositDue": 100, "depositPaid": 0 } ], "collectionSheetCustomerLoan": [ { "customerId": 10, "accountId": 15, "payInterestAtDisbursement": 0, "currencyId": 2, "productId": 5, "accountStateId": 5, "productShortName": "EL", "totalDisbursement": 0, "totalRepaymentDue": 900, "amountDueAtDisbursement": 0, "disbursalAccount": false } ], "collectionSheetCustomerAccount": { "accountId": 14, "currencyId": 2, "totalCustomerAccountCollectionFee": 0 }, "individualSavingAccounts": [ { "customerId": 10, "accountId": 2, "currencyId": null, "productId": 1, "productShortName": "s1", "recommendedAmountUnitId": null, "totalDepositAmount": 10, "depositDue": 10, "depositPaid": 0 } ] }, { "name": "Default Group", "levelId": 2, "branchId": 2, "customerId": 11, "searchId": "1.1.3", "parentCustomerId": 1, "attendanceId": null, "collectionSheetCustomerSaving": [], "collectionSheetCustomerLoan": [], "collectionSheetCustomerAccount": { "accountId": 16, "currencyId": 2, "totalCustomerAccountCollectionFee": 0 }, "individualSavingAccounts": [] }, { "name": "Stu1233266299995 Client1233266299995", "levelId": 1, "branchId": 2, "customerId": 12, "searchId": "1.1.3.1", "parentCustomerId": 11, "attendanceId": null, "collectionSheetCustomerSaving": [], "collectionSheetCustomerLoan": [], "collectionSheetCustomerAccount": { "accountId": 17, "currencyId": 2, "totalCustomerAccountCollectionFee": 0 }, "individualSavingAccounts": [ { "customerId": 1, "accountId": 2, "currencyId": 2, "productId": 1, "productShortName": "s1", "recommendedAmountUnitId": 1, "totalDepositAmount": 0, "depositDue": 0, "depositPaid": 0 } ] }, { "name": "Stu1233266309851 Client1233266309851", "levelId": 1, "branchId": 2, "customerId": 13, "searchId": "1.1.3.2", "parentCustomerId": 11, "attendanceId": null, "collectionSheetCustomerSaving": [], "collectionSheetCustomerLoan": [], "collectionSheetCustomerAccount": { "accountId": 18, "currencyId": 2, "totalCustomerAccountCollectionFee": 0 }, "individualSavingAccounts": [ { "customerId": 1, "accountId": 2, "currencyId": 2, "productId": 1, "productShortName": "s1", "recommendedAmountUnitId": 1, "totalDepositAmount": 0, "depositDue": 0, "depositPaid": 0 } ] }, { "name": "Stu1233266319760 Client1233266319760", "levelId": 1, "branchId": 2, "customerId": 14, "searchId": "1.1.3.3", "parentCustomerId": 11, "attendanceId": null, "collectionSheetCustomerSaving": [], "collectionSheetCustomerLoan": [], "collectionSheetCustomerAccount": { "accountId": 19, "currencyId": 2, "totalCustomerAccountCollectionFee": 0 }, "individualSavingAccounts": [ { "customerId": 1, "accountId": 2, "currencyId": 2, "productId": 1, "productShortName": "s1", "recommendedAmountUnitId": 1, "totalDepositAmount": 0, "depositDue": 0, "depositPaid": 0 } ] }, { "name": "Holiday TestClient", "levelId": 1, "branchId": 2, "customerId": 23, "searchId": "1.1.3.4", "parentCustomerId": 11, "attendanceId": null, "collectionSheetCustomerSaving": [], "collectionSheetCustomerLoan": [], "collectionSheetCustomerAccount": { "accountId": -1, "currencyId": 1, "totalCustomerAccountCollectionFee": 0 }, "individualSavingAccounts": [ { "customerId": 1, "accountId": 2, "currencyId": 2, "productId": 1, "productShortName": "s1", "recommendedAmountUnitId": 1, "totalDepositAmount": 0, "depositDue": 0, "depositPaid": 0 } ] }, { "name": "UpdateCustomPropertiesTestGroup", "levelId": 2, "branchId": 2, "customerId": 16, "searchId": "1.1.4", "parentCustomerId": 1, "attendanceId": null, "collectionSheetCustomerSaving": [], "collectionSheetCustomerLoan": [], "collectionSheetCustomerAccount": { "accountId": 22, "currencyId": 2, "totalCustomerAccountCollectionFee": 0 }, "individualSavingAccounts": [] }, { "name": "UpdateCustomProperties TestClient", "levelId": 1, "branchId": 2, "customerId": 17, "searchId": "1.1.4.1", "parentCustomerId": 16, "attendanceId": null, "collectionSheetCustomerSaving": [], "collectionSheetCustomerLoan": [], "collectionSheetCustomerAccount": { "accountId": 23, "currencyId": 2, "totalCustomerAccountCollectionFee": 0 }, "individualSavingAccounts": [ { "customerId": 17, "accountId": 2, "currencyId": null, "productId": 1, "productShortName": "s1", "recommendedAmountUnitId": null, "totalDepositAmount": 10, "depositDue": 10, "depositPaid": 0 } ] } ] } |
saveCollectionSheet
SINCE | Mifos 2.2.2 |
TYPE | POST |
URL | BASE_URL/collectionsheet/save.json |
PATH ARGUMENTS | Â |
POST DATA | { json : "JSON string of SaveCollectionSheetDto" } { "json": "{\"userId\":1,\"transactionDate\":[2011,10,10],\"paymentType\":1,\"receiptId\":\" \",\"receiptDate\":null,\"saveCollectionSheetCustomers\":[{\"customerId\":1, \"parentCustomerId\":null,\"attendanceId\":null,\"saveCollectionSheetCustomerSavings \":[],\"saveCollectionSheetCustomerIndividualSavings\":[],\"saveCollectionSheetCustomerLoans \":[],\"saveCollectionSheetCustomerAccount\":{\"accountId\":1,\"currencyId\":2, \"totalCustomerAccountCollectionFee\":\"0\"}},{\"customerId\":2,\"parentCustomerId\":1, \"attendanceId\":null,\"saveCollectionSheetCustomerSavings\":[], \"saveCollectionSheetCustomerIndividualSavings\":[],\"saveCollectionSheetCustomerLoans \":[],\"saveCollectionSheetCustomerAccount\":{\"accountId\":2,\"currencyId\":2, \"totalCustomerAccountCollectionFee\":\"0\"}},{\"customerId\":3,\"parentCustomerId\":2, \"attendanceId\":1,\"saveCollectionSheetCustomerSavings\":[{\"accountId\":7,\"currencyId\":2, \"totalDeposit\":\"500\",\"totalWithdrawal\":\"0\"},{\"accountId\":6,\"currencyId\":2, \"totalDeposit\":\"100\",\"totalWithdrawal\":\"0\"}], \"saveCollectionSheetCustomerIndividualSavings\":[],\"saveCollectionSheetCustomerLoans \":[{\"accountId\":4,\"currencyId\":2,\"totalDisbursement\":0,\"totalLoanPayment\":\"40\"},{ \"accountId\":5,\"currencyId\":2,\"totalDisbursement\":0,\"totalLoanPayment\":\"412\"}], \"saveCollectionSheetCustomerAccount\":{\"accountId\":3,\"currencyId\":2, \"totalCustomerAccountCollectionFee\":\"0\"}}]}"} |
RETURNS |
|
EXAMPLE | { "userId": 1, "transactionDate": [ 2011, 10, 10 ], "paymentType": 1, "receiptId": "", "receiptDate": null, "saveCollectionSheetCustomers": [ { "customerId": 1, "parentCustomerId": null, "attendanceId": null, "saveCollectionSheetCustomerSavings": [ { "accountId": 72, "currencyId": 2, "totalDeposit": "0", "totalWithdrawal": "" } ], "saveCollectionSheetCustomerIndividualSavings": [], "saveCollectionSheetCustomerLoans": [], "saveCollectionSheetCustomerAccount": { "accountId": 1, "currencyId": 2, "totalCustomerAccountCollectionFee": "400" } }, { "customerId": 2, "parentCustomerId": 1, "attendanceId": null, "saveCollectionSheetCustomerSavings": [ { "accountId": 73, "currencyId": 2, "totalDeposit": "0", "totalWithdrawal": "" } ], "saveCollectionSheetCustomerIndividualSavings": [], "saveCollectionSheetCustomerLoans": [ { "accountId": 71, "currencyId": 2, "totalDisbursement": 0, "totalLoanPayment": "3651" } ], "saveCollectionSheetCustomerAccount": { "accountId": 2, "currencyId": 2, "totalCustomerAccountCollectionFee": "400" } }, { "customerId": 3, "parentCustomerId": 2, "attendanceId": 1, "saveCollectionSheetCustomerSavings": [ { "accountId": 7, "currencyId": 2, "totalDeposit": "500", "totalWithdrawal": "" }, { "accountId": 6, "currencyId": 2, "totalDeposit": "100", "totalWithdrawal": "" } ], "saveCollectionSheetCustomerIndividualSavings": [ { "accountId": 72, "currencyId": 2, "totalDeposit": "120", "totalWithdrawal": "" }, { "accountId": 73, "currencyId": 2, "totalDeposit": "80", "totalWithdrawal": "" } ], "saveCollectionSheetCustomerLoans": [ { "accountId": 4, "currencyId": 2, "totalDisbursement": 0, "totalLoanPayment": "40" }, { "accountId": 5, "currencyId": 2, "totalDisbursement": 0, "totalLoanPayment": "412" } ], "saveCollectionSheetCustomerAccount": { "accountId": 3, "currencyId": 2, "totalCustomerAccountCollectionFee": "400" } }, { "customerId": 41, "parentCustomerId": 2, "attendanceId": 1, "saveCollectionSheetCustomerSavings": [], "saveCollectionSheetCustomerIndividualSavings": [ { "accountId": 72, "currencyId": 2, "totalDeposit": "30", "totalWithdrawal": "" }, { "accountId": 73, "currencyId": 2, "totalDeposit": "20", "totalWithdrawal": "" } ], "saveCollectionSheetCustomerLoans": [ { "accountId": 75, "currencyId": 2, "totalDisbursement": 100, "totalLoanPayment": "100" } ], "saveCollectionSheetCustomerAccount": { "accountId": 74, "currencyId": 2, "totalCustomerAccountCollectionFee": "0" } } ] } |