Ability to be able to transfer monetary funds from one account to another.
+Note: At present only savings account to savings account transfers are supported.
+Mandatory Parameters |
| fromOfficeId |
| The id of the office/branch from which the transfer is made. |
| fromClientId |
| The id of the client from which the transfer is made. |
| fromAccountType |
| The type of account from which the transfer is made. 1=Loan Account, 2=Savings Account |
| fromAccountId |
| The id of the account from which the transfer is made. |
| toOfficeId |
| The id of the office/branch to which the transfer is made. |
| toClientId |
| The id of the client to which the transfer is made. |
| toAccountType |
| The type of account to which the transfer is made. 1=Loan Account, 2=Savings Account |
| toAccountId |
| The id of the account to which the transfer is made. |
| transferDate |
| The date of the transfer. Requires dateFormat and locale parameters. |
| transferAmount |
| The amount of the transfer. Requires locale parameter. |
| transferDescription |
| Description of the transfer itself. |
This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: +
Example Requests:
+GET https://Domain Name/api/v1/accounttransfers/template?fromAccountType=2&fromOfficeId=1
+
+
+{
+ "transferAmount": 0,
+ "transferDate": [
+ 2013,
+ 8,
+ 7
+ ],
+ "fromOffice": {
+ "id": 1,
+ "name": "HO",
+ "nameDecorated": "HO",
+ "externalId": "1",
+ "openingDate": [
+ 2009,
+ 1,
+ 1
+ ],
+ "hierarchy": "."
+ },
+ "toOffice": {
+ "id": 1,
+ "name": "HO",
+ "nameDecorated": "HO",
+ "externalId": "1",
+ "openingDate": [
+ 2009,
+ 1,
+ 1
+ ],
+ "hierarchy": "."
+ },
+ "fromOfficeOptions": [
+ {
+ "id": 1,
+ "name": "HO",
+ "nameDecorated": "HO"
+ },
+ {
+ "id": 3,
+ "name": "branch 1",
+ "nameDecorated": "....branch 1"
+ }
+ ],
+ "fromClientOptions": [
+ {
+ "id": 2,
+ "displayName": "headoffice-business",
+ "officeId": 1,
+ "officeName": "HO",
+ "imagePresent": false
+ }
+ ],
+ "toOfficeOptions": [
+ {
+ "id": 1,
+ "name": "HO",
+ "nameDecorated": "HO"
+ },
+ {
+ "id": 3,
+ "name": "branch 1",
+ "nameDecorated": "....branch 1"
+ }
+ ],
+ "toClientOptions": [
+ {
+ "id": 2,
+ "displayName": "headoffice-business",
+ "officeId": 1,
+ "officeName": "HO",
+ "imagePresent": false
+ }
+ ]
+}
+
+ GET https://Domain Name/api/v1/accounttransfers/template?fromAccountType=2&fromOfficeId=1&fromClientId=1
+
+
+{
+ "transferAmount": 0,
+ "transferDate": [
+ 2013,
+ 8,
+ 7
+ ],
+ "fromOffice": {
+ "id": 3,
+ "name": "branch 1",
+ "nameDecorated": "....branch 1",
+ "externalId": "2",
+ "openingDate": [
+ 2011,
+ 7,
+ 1
+ ],
+ "hierarchy": ".3.",
+ "parentId": 1,
+ "parentName": "HO"
+ },
+ "fromClient": {
+ "id": 1,
+ "accountNo": "000000001",
+ "status": {
+ "id": 300,
+ "code": "clientStatusType.active",
+ "value": "Active"
+ },
+ "active": true,
+ "activationDate": [
+ 2012,
+ 3,
+ 1
+ ],
+ "fullname": "Small shop",
+ "displayName": "Small shop",
+ "officeId": 3,
+ "officeName": "branch 1",
+ "imagePresent": false,
+ "groups": []
+ },
+ "toOffice": {
+ "id": 3,
+ "name": "branch 1",
+ "nameDecorated": "....branch 1",
+ "externalId": "2",
+ "openingDate": [
+ 2011,
+ 7,
+ 1
+ ],
+ "hierarchy": ".3.",
+ "parentId": 1,
+ "parentName": "HO"
+ },
+ "toClient": {
+ "id": 1,
+ "accountNo": "000000001",
+ "status": {
+ "id": 300,
+ "code": "clientStatusType.active",
+ "value": "Active"
+ },
+ "active": true,
+ "activationDate": [
+ 2012,
+ 3,
+ 1
+ ],
+ "fullname": "Small shop",
+ "displayName": "Small shop",
+ "officeId": 3,
+ "officeName": "branch 1",
+ "imagePresent": false,
+ "groups": []
+ },
+ "fromOfficeOptions": [
+ {
+ "id": 1,
+ "name": "HO",
+ "nameDecorated": "HO"
+ },
+ {
+ "id": 3,
+ "name": "branch 1",
+ "nameDecorated": "....branch 1"
+ }
+ ],
+ "fromClientOptions": [
+ {
+ "id": 1,
+ "displayName": "Small shop",
+ "officeId": 3,
+ "officeName": "branch 1",
+ "imagePresent": false
+ }
+ ],
+ "fromAccountOptions": [
+ {
+ "id": 1,
+ "accountNo": "000000001",
+ "clientId": 1,
+ "clientName": "Small shop",
+ "savingsProductId": 1,
+ "savingsProductName": "Passbook",
+ "fieldOfficerId": 2,
+ "fieldOfficerName": "Clare, Claire",
+ "status": {
+ "id": 300,
+ "code": "savingsAccountStatusType.active",
+ "value": "Active",
+ "submittedAndPendingApproval": false,
+ "approved": false,
+ "rejected": false,
+ "withdrawnByApplicant": false,
+ "active": true,
+ "closed": false
+ },
+ "timeline": {
+ "submittedOnDate": [
+ 2013,
+ 3,
+ 1
+ ],
+ "approvedOnDate": [
+ 2013,
+ 3,
+ 1
+ ],
+ "approvedByUsername": "mifos",
+ "approvedByFirstname": "App",
+ "approvedByLastname": "Administrator",
+ "activatedOnDate": [
+ 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 ($)"
+ },
+ "totalDeposits": 1242,
+ "totalWithdrawals": 101,
+ "totalInterestEarned": 26.03,
+ "accountBalance": 1141
+ }
+ },
+ {
+ "id": 2,
+ "accountNo": "000000002",
+ "clientId": 1,
+ "clientName": "Small shop",
+ "savingsProductId": 1,
+ "savingsProductName": "Passbook",
+ "fieldOfficerId": 3,
+ "fieldOfficerName": "George, John",
+ "status": {
+ "id": 300,
+ "code": "savingsAccountStatusType.active",
+ "value": "Active",
+ "submittedAndPendingApproval": false,
+ "approved": false,
+ "rejected": false,
+ "withdrawnByApplicant": false,
+ "active": true,
+ "closed": false
+ },
+ "timeline": {
+ "submittedOnDate": [
+ 2013,
+ 6,
+ 1
+ ],
+ "approvedOnDate": [
+ 2013,
+ 6,
+ 1
+ ],
+ "approvedByUsername": "mifos",
+ "approvedByFirstname": "App",
+ "approvedByLastname": "Administrator",
+ "activatedOnDate": [
+ 2013,
+ 6,
+ 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 ($)"
+ },
+ "totalDeposits": 101,
+ "totalWithdrawals": 42,
+ "totalInterestEarned": 0.58,
+ "accountBalance": 59
+ }
+ }
+ ],
+ "toOfficeOptions": [
+ {
+ "id": 1,
+ "name": "HO",
+ "nameDecorated": "HO"
+ },
+ {
+ "id": 3,
+ "name": "branch 1",
+ "nameDecorated": "....branch 1"
+ }
+ ],
+ "toClientOptions": [
+ {
+ "id": 1,
+ "displayName": "Small shop",
+ "officeId": 3,
+ "officeName": "branch 1",
+ "imagePresent": false
+ }
+ ],
+ "toAccountOptions": [
+ {
+ "id": 1,
+ "accountNo": "000000001",
+ "clientId": 1,
+ "clientName": "Small shop",
+ "savingsProductId": 1,
+ "savingsProductName": "Passbook",
+ "fieldOfficerId": 2,
+ "fieldOfficerName": "Clare, Claire",
+ "status": {
+ "id": 300,
+ "code": "savingsAccountStatusType.active",
+ "value": "Active",
+ "submittedAndPendingApproval": false,
+ "approved": false,
+ "rejected": false,
+ "withdrawnByApplicant": false,
+ "active": true,
+ "closed": false
+ },
+ "timeline": {
+ "submittedOnDate": [
+ 2013,
+ 3,
+ 1
+ ],
+ "approvedOnDate": [
+ 2013,
+ 3,
+ 1
+ ],
+ "approvedByUsername": "mifos",
+ "approvedByFirstname": "App",
+ "approvedByLastname": "Administrator",
+ "activatedOnDate": [
+ 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 ($)"
+ },
+ "totalDeposits": 1242,
+ "totalWithdrawals": 101,
+ "totalInterestEarned": 26.03,
+ "accountBalance": 1141
+ }
+ },
+ {
+ "id": 2,
+ "accountNo": "000000002",
+ "clientId": 1,
+ "clientName": "Small shop",
+ "savingsProductId": 1,
+ "savingsProductName": "Passbook",
+ "fieldOfficerId": 3,
+ "fieldOfficerName": "George, John",
+ "status": {
+ "id": 300,
+ "code": "savingsAccountStatusType.active",
+ "value": "Active",
+ "submittedAndPendingApproval": false,
+ "approved": false,
+ "rejected": false,
+ "withdrawnByApplicant": false,
+ "active": true,
+ "closed": false
+ },
+ "timeline": {
+ "submittedOnDate": [
+ 2013,
+ 6,
+ 1
+ ],
+ "approvedOnDate": [
+ 2013,
+ 6,
+ 1
+ ],
+ "approvedByUsername": "mifos",
+ "approvedByFirstname": "App",
+ "approvedByLastname": "Administrator",
+ "activatedOnDate": [
+ 2013,
+ 6,
+ 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 ($)"
+ },
+ "totalDeposits": 101,
+ "totalWithdrawals": 42,
+ "totalInterestEarned": 0.58,
+ "accountBalance": 59
+ }
+ }
+ ]
+}
+
+ GET https://Domain Name/api/v1/accounttransfers/template?fromClientId=1&fromAccountType=2&fromAccountId=1
+
+
+{
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "transferAmount": 0,
+ "transferDate": [
+ 2013,
+ 8,
+ 7
+ ],
+ "fromOffice": {
+ "id": 3,
+ "name": "branch 1",
+ "nameDecorated": "....branch 1",
+ "externalId": "2",
+ "openingDate": [
+ 2011,
+ 7,
+ 1
+ ],
+ "hierarchy": ".3.",
+ "parentId": 1,
+ "parentName": "HO"
+ },
+ "fromClient": {
+ "id": 1,
+ "accountNo": "000000001",
+ "status": {
+ "id": 300,
+ "code": "clientStatusType.active",
+ "value": "Active"
+ },
+ "active": true,
+ "activationDate": [
+ 2012,
+ 3,
+ 1
+ ],
+ "fullname": "Small shop",
+ "displayName": "Small shop",
+ "officeId": 3,
+ "officeName": "branch 1",
+ "imagePresent": false,
+ "groups": []
+ },
+ "fromAccount": {
+ "id": 1,
+ "accountNo": "000000001",
+ "clientId": 1,
+ "clientName": "Small shop",
+ "savingsProductId": 1,
+ "savingsProductName": "Passbook",
+ "fieldOfficerId": 2,
+ "fieldOfficerName": "Clare, Claire",
+ "status": {
+ "id": 300,
+ "code": "savingsAccountStatusType.active",
+ "value": "Active",
+ "submittedAndPendingApproval": false,
+ "approved": false,
+ "rejected": false,
+ "withdrawnByApplicant": false,
+ "active": true,
+ "closed": false
+ },
+ "timeline": {
+ "submittedOnDate": [
+ 2013,
+ 3,
+ 1
+ ],
+ "approvedOnDate": [
+ 2013,
+ 3,
+ 1
+ ],
+ "approvedByUsername": "mifos",
+ "approvedByFirstname": "App",
+ "approvedByLastname": "Administrator",
+ "activatedOnDate": [
+ 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 ($)"
+ },
+ "totalDeposits": 1242,
+ "totalWithdrawals": 101,
+ "totalInterestEarned": 26.03,
+ "accountBalance": 1141
+ }
+ },
+ "toOffice": {
+ "id": 3,
+ "name": "branch 1",
+ "nameDecorated": "....branch 1",
+ "externalId": "2",
+ "openingDate": [
+ 2011,
+ 7,
+ 1
+ ],
+ "hierarchy": ".3.",
+ "parentId": 1,
+ "parentName": "HO"
+ },
+ "toClient": {
+ "id": 1,
+ "accountNo": "000000001",
+ "status": {
+ "id": 300,
+ "code": "clientStatusType.active",
+ "value": "Active"
+ },
+ "active": true,
+ "activationDate": [
+ 2012,
+ 3,
+ 1
+ ],
+ "fullname": "Small shop",
+ "displayName": "Small shop",
+ "officeId": 3,
+ "officeName": "branch 1",
+ "imagePresent": false,
+ "groups": []
+ },
+ "fromOfficeOptions": [
+ {
+ "id": 1,
+ "name": "HO",
+ "nameDecorated": "HO"
+ },
+ {
+ "id": 3,
+ "name": "branch 1",
+ "nameDecorated": "....branch 1"
+ }
+ ],
+ "fromClientOptions": [
+ {
+ "id": 1,
+ "displayName": "Small shop",
+ "officeId": 3,
+ "officeName": "branch 1",
+ "imagePresent": false
+ }
+ ],
+ "fromAccountOptions": [
+ {
+ "id": 1,
+ "accountNo": "000000001",
+ "clientId": 1,
+ "clientName": "Small shop",
+ "savingsProductId": 1,
+ "savingsProductName": "Passbook",
+ "fieldOfficerId": 2,
+ "fieldOfficerName": "Clare, Claire",
+ "status": {
+ "id": 300,
+ "code": "savingsAccountStatusType.active",
+ "value": "Active",
+ "submittedAndPendingApproval": false,
+ "approved": false,
+ "rejected": false,
+ "withdrawnByApplicant": false,
+ "active": true,
+ "closed": false
+ },
+ "timeline": {
+ "submittedOnDate": [
+ 2013,
+ 3,
+ 1
+ ],
+ "approvedOnDate": [
+ 2013,
+ 3,
+ 1
+ ],
+ "approvedByUsername": "mifos",
+ "approvedByFirstname": "App",
+ "approvedByLastname": "Administrator",
+ "activatedOnDate": [
+ 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 ($)"
+ },
+ "totalDeposits": 1242,
+ "totalWithdrawals": 101,
+ "totalInterestEarned": 26.03,
+ "accountBalance": 1141
+ }
+ },
+ {
+ "id": 2,
+ "accountNo": "000000002",
+ "clientId": 1,
+ "clientName": "Small shop",
+ "savingsProductId": 1,
+ "savingsProductName": "Passbook",
+ "fieldOfficerId": 3,
+ "fieldOfficerName": "George, John",
+ "status": {
+ "id": 300,
+ "code": "savingsAccountStatusType.active",
+ "value": "Active",
+ "submittedAndPendingApproval": false,
+ "approved": false,
+ "rejected": false,
+ "withdrawnByApplicant": false,
+ "active": true,
+ "closed": false
+ },
+ "timeline": {
+ "submittedOnDate": [
+ 2013,
+ 6,
+ 1
+ ],
+ "approvedOnDate": [
+ 2013,
+ 6,
+ 1
+ ],
+ "approvedByUsername": "mifos",
+ "approvedByFirstname": "App",
+ "approvedByLastname": "Administrator",
+ "activatedOnDate": [
+ 2013,
+ 6,
+ 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 ($)"
+ },
+ "totalDeposits": 101,
+ "totalWithdrawals": 42,
+ "totalInterestEarned": 0.58,
+ "accountBalance": 59
+ }
+ }
+ ],
+ "toOfficeOptions": [
+ {
+ "id": 1,
+ "name": "HO",
+ "nameDecorated": "HO"
+ },
+ {
+ "id": 3,
+ "name": "branch 1",
+ "nameDecorated": "....branch 1"
+ }
+ ],
+ "toClientOptions": [
+ {
+ "id": 1,
+ "displayName": "Small shop",
+ "officeId": 3,
+ "officeName": "branch 1",
+ "imagePresent": false
+ }
+ ],
+ "toAccountOptions": [
+ {
+ "id": 2,
+ "accountNo": "000000002",
+ "clientId": 1,
+ "clientName": "Small shop",
+ "savingsProductId": 1,
+ "savingsProductName": "Passbook",
+ "fieldOfficerId": 3,
+ "fieldOfficerName": "George, John",
+ "status": {
+ "id": 300,
+ "code": "savingsAccountStatusType.active",
+ "value": "Active",
+ "submittedAndPendingApproval": false,
+ "approved": false,
+ "rejected": false,
+ "withdrawnByApplicant": false,
+ "active": true,
+ "closed": false
+ },
+ "timeline": {
+ "submittedOnDate": [
+ 2013,
+ 6,
+ 1
+ ],
+ "approvedOnDate": [
+ 2013,
+ 6,
+ 1
+ ],
+ "approvedByUsername": "mifos",
+ "approvedByFirstname": "App",
+ "approvedByLastname": "Administrator",
+ "activatedOnDate": [
+ 2013,
+ 6,
+ 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 ($)"
+ },
+ "totalDeposits": 101,
+ "totalWithdrawals": 42,
+ "totalInterestEarned": 0.58,
+ "accountBalance": 59
+ }
+ }
+ ]
+}
+
+ Ability to create new transfer of monetary funds from one account to another.
+POST https://Domain Name/api/v1/accounttransfers
+ POST 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"
+}
+
+
+
+ Example Requests:
+GET https://Domain Name/api/v1/accounttransfers
+
+{
+ "totalFilteredRecords": 5,
+ "pageItems": [
+ {
+ "id": 1,
+ "reversed": false,
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "transferAmount": 25,
+ "transferDate": [
+ 2013,
+ 6,
+ 8
+ ],
+ "transferDescription": "another transfer",
+ "fromOffice": {
+ "id": 1,
+ "name": "HO"
+ },
+ "fromClient": {
+ "id": 1,
+ "displayName": "Small shop",
+ "officeId": 1,
+ "officeName": "HO",
+ "imagePresent": false
+ },
+ "fromAccount": {
+ "id": 1,
+ "accountNo": "000000001"
+ },
+ "toOffice": {
+ "id": 1,
+ "name": "HO"
+ },
+ "toClient": {
+ "id": 1,
+ "displayName": "Small shop",
+ "officeId": 1,
+ "officeName": "HO",
+ "imagePresent": false
+ },
+ "toAccount": {
+ "id": 2,
+ "accountNo": "000000002"
+ }
+ },
+ {
+ "id": 2,
+ "reversed": false,
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "transferAmount": 13,
+ "transferDate": [
+ 2013,
+ 6,
+ 15
+ ],
+ "transferDescription": "T3",
+ "fromOffice": {
+ "id": 1,
+ "name": "HO"
+ },
+ "fromClient": {
+ "id": 1,
+ "displayName": "Small shop",
+ "officeId": 1,
+ "officeName": "HO",
+ "imagePresent": false
+ },
+ "fromAccount": {
+ "id": 1,
+ "accountNo": "000000001"
+ },
+ "toOffice": {
+ "id": 1,
+ "name": "HO"
+ },
+ "toClient": {
+ "id": 1,
+ "displayName": "Small shop",
+ "officeId": 1,
+ "officeName": "HO",
+ "imagePresent": false
+ },
+ "toAccount": {
+ "id": 2,
+ "accountNo": "000000002"
+ }
+ },
+ {
+ "id": 3,
+ "reversed": false,
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "transferAmount": 17,
+ "transferDate": [
+ 2013,
+ 6,
+ 22
+ ],
+ "transferDescription": "T4",
+ "fromOffice": {
+ "id": 1,
+ "name": "HO"
+ },
+ "fromClient": {
+ "id": 1,
+ "displayName": "Small shop",
+ "officeId": 1,
+ "officeName": "HO",
+ "imagePresent": false
+ },
+ "fromAccount": {
+ "id": 1,
+ "accountNo": "000000001"
+ },
+ "toOffice": {
+ "id": 1,
+ "name": "HO"
+ },
+ "toClient": {
+ "id": 1,
+ "displayName": "Small shop",
+ "officeId": 1,
+ "officeName": "HO",
+ "imagePresent": false
+ },
+ "toAccount": {
+ "id": 2,
+ "accountNo": "000000002"
+ }
+ },
+ {
+ "id": 4,
+ "reversed": false,
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "transferAmount": 21,
+ "transferDate": [
+ 2013,
+ 6,
+ 29
+ ],
+ "transferDescription": "T5",
+ "fromOffice": {
+ "id": 1,
+ "name": "HO"
+ },
+ "fromClient": {
+ "id": 1,
+ "displayName": "Small shop",
+ "officeId": 1,
+ "officeName": "HO",
+ "imagePresent": false
+ },
+ "fromAccount": {
+ "id": 1,
+ "accountNo": "000000001"
+ },
+ "toOffice": {
+ "id": 1,
+ "name": "HO"
+ },
+ "toClient": {
+ "id": 1,
+ "displayName": "Small shop",
+ "officeId": 1,
+ "officeName": "HO",
+ "imagePresent": false
+ },
+ "toAccount": {
+ "id": 2,
+ "accountNo": "000000002"
+ }
+ },
+ {
+ "id": 5,
+ "reversed": false,
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "transferAmount": 42,
+ "transferDate": [
+ 2013,
+ 7,
+ 5
+ ],
+ "transferDescription": "pay back loan",
+ "fromOffice": {
+ "id": 1,
+ "name": "HO"
+ },
+ "fromClient": {
+ "id": 1,
+ "displayName": "Small shop",
+ "officeId": 1,
+ "officeName": "HO",
+ "imagePresent": false
+ },
+ "fromAccount": {
+ "id": 2,
+ "accountNo": "000000002"
+ },
+ "toOffice": {
+ "id": 1,
+ "name": "HO"
+ },
+ "toClient": {
+ "id": 1,
+ "displayName": "Small shop",
+ "officeId": 1,
+ "officeName": "HO",
+ "imagePresent": false
+ },
+ "toAccount": {
+ "id": 1,
+ "accountNo": "000000001"
+ }
+ }
+ ]
+}
+
+ Example Requests :
+GET https://DomainName/api/v1/accounttransfers/{transferId}
+
+{
+ "id": 1,
+ "reversed": false,
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "transferAmount": 25,
+ "transferDate": [
+ 2013,
+ 6,
+ 8
+ ],
+ "transferDescription": "another transfer",
+ "fromOffice": {
+ "id": 1,
+ "name": "HO"
+ },
+ "fromClient": {
+ "id": 1,
+ "displayName": "Small shop",
+ "officeId": 1,
+ "officeName": "HO",
+ "imagePresent": false
+ },
+ "fromAccount": {
+ "id": 1,
+ "accountNo": "000000001"
+ },
+ "toOffice": {
+ "id": 1,
+ "name": "HO"
+ },
+ "toClient": {
+ "id": 1,
+ "displayName": "Small shop",
+ "officeId": 1,
+ "officeName": "HO",
+ "imagePresent": false
+ },
+ "toAccount": {
+ "id": 2,
+ "accountNo": "000000002"
+ }
+}
+
+