diff --git a/fineract-provider/src/main/resources/static/api-docs/apiLive.htm b/fineract-provider/src/main/resources/static/api-docs/apiLive.htm index e85a44651..56636ccd4 100644 --- a/fineract-provider/src/main/resources/static/api-docs/apiLive.htm +++ b/fineract-provider/src/main/resources/static/api-docs/apiLive.htm @@ -678,6 +678,62 @@
Associations: String optional + One of, or comma separated of GSIM Applications or all for all associations +
+ +
+GET https://DomainName/fineract-provider/api/v1/groups/{groupId}/gsimaccounts
+
+
+
+
+[{
+ "gsimId": 1,
+ "groupId": 1,
+ "accountNumber": "000000006",
+ "childGSIMAccounts": [],
+ "parentBalance": 2500.000000,
+ "savingsStatus": "SUBMITTED_AND_PENDING_APPROVAL"
+ },
+ {
+ "gsimId": 8,
+ "groupId": 1,
+ "accountNumber": "000000014",
+ "childGSIMAccounts": [{
+ "id": 14,
+ "displayName": "(1) qwe poi",
+ "accountNo": "0000000141",
+ "productId": 1,
+ "productName": "productrial",
+ "shortProductName": "Ipro",
+ "status": {
+ "id": 400,
+ "code": "savingsAccountStatusType.withdrawn.by.applicant",
+ "value": "Withdrawn by applicant",
+ "submittedAndPendingApproval": false,
+ "approved": false,
+ "rejected": false,
+ "withdrawnByApplicant": true,
+ "active": false,
+ "closed": true,
+ "prematureClosed": false,
+ "transferInProgress": false,
+ "transferOnHold": false,
+ "matured": false
+ },
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "inMultiplesOf": 1,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "accountType": {
+ "id": 0,
+ "code": "accountType.invalid",
+ "value": "Invalid"
+ },
+ "timeline": {
+ "submittedOnDate": [2020, 6, 3],
+ "submittedByUsername": "mifos",
+ "submittedByFirstname": "App",
+ "submittedByLastname": "Administrator",
+ "withdrawnOnDate": [2020, 6, 3],
+ "withdrawnByUsername": "mifos",
+ "withdrawnByFirstname": "App",
+ "withdrawnByLastname": "Administrator",
+ "closedOnDate": [2020, 6, 3],
+ "closedByUsername": "mifos",
+ "closedByFirstname": "App",
+ "closedByLastname": "Administrator"
+ },
+ "subStatus": {
+ "id": 0,
+ "code": "SavingsAccountSubStatusEnum.none",
+ "value": "None",
+ "none": true,
+ "inactive": false,
+ "dormant": false,
+ "escheat": false,
+ "block": false,
+ "blockCredit": false,
+ "blockDebit": false
+ },
+ "depositType": {
+ "id": 100,
+ "code": "depositAccountType.savingsDeposit",
+ "value": "Savings"
+ }
+ }],
+ "parentBalance": 0.000000,
+ "savingsStatus": "SUBMITTED_AND_PENDING_APPROVAL"
+ }, {
+ "gsimId": 10,
+ "groupId": 1,
+ "accountNumber": "000000016",
+ "childGSIMAccounts": [{
+ "id": 16,
+ "displayName": "(1) qwe poi",
+ "accountNo": "0000000161",
+ "productId": 1,
+ "productName": "productrial",
+ "shortProductName": "Ipro",
+ "status": {
+ "id": 600,
+ "code": "savingsAccountStatusType.closed",
+ "value": "Closed",
+ "submittedAndPendingApproval": false,
+ "approved": false,
+ "rejected": false,
+ "withdrawnByApplicant": false,
+ "active": false,
+ "closed": true,
+ "prematureClosed": false,
+ "transferInProgress": false,
+ "transferOnHold": false,
+ "matured": false
+ },
+ "currency": {
+ "code": "USD",
+ "name": "US Dollar",
+ "decimalPlaces": 2,
+ "inMultiplesOf": 1,
+ "displaySymbol": "$",
+ "nameCode": "currency.USD",
+ "displayLabel": "US Dollar ($)"
+ },
+ "accountType": {
+ "id": 0,
+ "code": "accountType.invalid",
+ "value": "Invalid"
+ },
+ "timeline": {
+ "submittedOnDate": [2020, 6, 3],
+ "submittedByUsername": "mifos",
+ "submittedByFirstname": "App",
+ "submittedByLastname": "Administrator",
+ "approvedOnDate": [2020, 6, 4],
+ "approvedByUsername": "mifos",
+ "approvedByFirstname": "App",
+ "approvedByLastname": "Administrator",
+ "activatedOnDate": [2020, 6, 4],
+ "closedOnDate": [2020, 6, 4],
+ "closedByUsername": "mifos",
+ "closedByFirstname": "App",
+ "closedByLastname": "Administrator"
+ },
+ "subStatus": {
+ "id": 0,
+ "code": "SavingsAccountSubStatusEnum.none",
+ "value": "None",
+ "none": true,
+ "inactive": false,
+ "dormant": false,
+ "escheat": false,
+ "block": false,
+ "blockCredit": false,
+ "blockDebit": false
+ },
+ "lastActiveTransactionDate": [2020, 6, 4],
+ "depositType": {
+ "id": 100,
+ "code": "depositAccountType.savingsDeposit",
+ "value": "Savings"
+ }
+ }],
+ "parentBalance": 0.000000,
+ "savingsStatus": "CLOSED_OBLIGATIONS_MET"
+}]
+
+
+ Associations: String optional + One of, or comma separated of GLIM Applications or all for all associations +
+ +
+GET https://DomainName/fineract-provider/api/v1/groups/{groupId}/glimaccounts
+
+
+
+[{
+ "glimId": 1,
+ "groupId": 1,
+ "accountNumber": "000000002",
+ "childGLIMAccounts": [{
+ "id": 2,
+ "accountNo": "0000000021",
+ "parentAccountNumber": "000000002",
+ "productId": 1,
+ "productName": "loanp1",
+ "shortProductName": "LP1",
+ "status": {
+ "id": 500,
+ "code": "loanStatusType.rejected",
+ "value": "Rejected",
+ "pendingApproval": false,
+ "waitingForDisbursal": false,
+ "active": false,
+ "closedObligationsMet": false,
+ "closedWrittenOff": false,
+ "closedRescheduled": false,
+ "closed": false,
+ "overpaid": false
+ },
+ "loanType": {
+ "id": 4,
+ "code": "accountType.glim",
+ "value": "GLIM"
+ },
+ "timeline": {
+ "submittedOnDate": [2020, 6, 10],
+ "submittedByUsername": "mifos",
+ "submittedByFirstname": "App",
+ "submittedByLastname": "Administrator",
+ "rejectedOnDate": [2020, 6, 12],
+ "rejectedByUsername": "mifos",
+ "rejectedByFirstname": "App",
+ "rejectedByLastname": "Administrator",
+ "expectedDisbursementDate": [2020, 6, 10],
+ "closedOnDate": [2020, 6, 12],
+ "closedByUsername": "mifos",
+ "closedByFirstname": "App",
+ "closedByLastname": "Administrator",
+ "expectedMaturityDate": [2021, 4, 10],
+ "writeOffByUsername": "mifos",
+ "writeOffByFirstname": "App",
+ "writeOffByLastname": "Administrator"
+ },
+ "inArrears": false
+ }],
+ "parentPrincipalAmount": 10.000000,
+ "loanStatus": "SUBMITTED_AND_PENDING_APPROVAL"
+},{
+ "glimId": 2,
+ "groupId": 1,
+ "accountNumber": "000000003",
+ "childGLIMAccounts": [{
+ "id": 3,
+ "accountNo": "0000000031",
+ "parentAccountNumber": "000000003",
+ "productId": 1,
+ "productName": "loanp1",
+ "shortProductName": "LP1",
+ "status": {
+ "id": 200,
+ "code": "loanStatusType.approved",
+ "value": "Approved",
+ "pendingApproval": false,
+ "waitingForDisbursal": true,
+ "active": false,
+ "closedObligationsMet": false,
+ "closedWrittenOff": false,
+ "closedRescheduled": false,
+ "closed": false,
+ "overpaid": false
+ },
+ "loanType": {
+ "id": 4,
+ "code": "accountType.glim",
+ "value": "GLIM"
+ },
+ "timeline": {
+ "submittedOnDate": [2020, 6, 10],
+ "submittedByUsername": "mifos",
+ "submittedByFirstname": "App",
+ "submittedByLastname": "Administrator",
+ "approvedOnDate": [2020, 6, 12],
+ "approvedByUsername": "mifos",
+ "approvedByFirstname": "App",
+ "approvedByLastname": "Administrator",
+ "expectedDisbursementDate": [2020, 6, 10],
+ "expectedMaturityDate": [2021, 4, 10]
+ },
+ "inArrears": false
+ }],
+ "parentPrincipalAmount": 10.000000,
+ "loanStatus": "SUBMITTED_AND_PENDING_APPROVAL"
+}]
+
+ Allows you to retrieve the GLIM Application.
+
+GET https://DomainName/fineract-provider/api/v1/loans/glimAccount/{glimId}
+
+
+[
+ {
+ "glimId": 1,
+ "groupId": 1,
+ "clientId": 2,
+ "clientName": "client1 qwe",
+ "childLoanId": 2,
+ "parentAccountNo": "000000002",
+ "parentPrincipalAmount": 10.000000,
+ "childLoanAccountNo": "0000000021",
+ "childPrincipalAmount": 1000.000000
+ }
+]
+
+ Allows you to Submit the GLIM Application. GLIM Application should be in Pending state.
+Mandatory Fields |
+
| interestRatePerPeriod, expectedDisbursementDate, clientId, groupId, productId, totalLoan, loanType, interestType, + principal, charges, transactionProcessingStrategyId, submittedOnDate, amortizationType, repaymentFrequencyType, + loanTermFrequencyType, loanTermFrequency, repaymentEvery, numberOfRepayments, interestCalculationPeriodType, + isParentAccount, locale,dateFormat | +
+https://DomainName/fineract-provider/api/v1/loans
+
+
+POST: loans
+Content-Type: application/json
+Request Body:
+{
+ "interestRatePerPeriod":"2",
+ "expectedDisbursementDate":"10 June 2020",
+ "productId":"1",
+ "loanType":"glim",
+ "dateFormat":"dd MMMM yyyy",
+ "groupId":"1",
+ "clientId":"2",
+ "totalLoan":"10",
+ "interestType":"0",
+ "locale":"en_GB",
+ "principal":"1000.00",
+ "charges":[],
+ "transactionProcessingStrategyId":"1",
+ "submittedOnDate":"10 June 2020",
+ "amortizationType":"1",
+ "repaymentFrequencyType":"2",
+ "loanTermFrequencyType":"2",
+ "loanTermFrequency":"10",
+ "repaymentEvery":"1",
+ "numberOfRepayments":"10",
+ "interestCalculationPeriodType":"1",
+ "isParentAccount":"1"
+}
+
+
+
+{
+ "officeId": 1,
+ "groupId": 1,
+ "clientId": 2,
+ "loanId": 2,
+ "resourceId": 2,
+ "glimId": 1
+}
+
+ Allows you to Approve the GLIM Application.
+Mandatory Fields |
+
| loanId, approvedOnDate, dateFormat, locale | +
+POST https://DomainName/fineract-provider/api/v1/loans/glimAccount/{glimId}?command=approve
+
+
+POST: loans/glimAccount/1?command=approve
+Content-Type: application/json
+Request Body:
+{
+"approvalFormData":[
+ {
+ "loanId":2,
+ "approvedOnDate": "12 June 2020",
+ "dateFormat":"dd MMMM yyyy",
+ "locale":"en"
+ }
+ ]
+}
+
+
+
+{
+ "officeId": 1,
+ "groupId": 1,
+ "clientId": 2,
+ "loanId": 2,
+ "resourceId": 2,
+ "changes": {
+ "status": {
+ "id": 200,
+ "code": "loanStatusType.approved",
+ "value": "Approved",
+ "pendingApproval": false,
+ "waitingForDisbursal": true,
+ "active": false,
+ "closedObligationsMet": false,
+ "closedWrittenOff": false,
+ "closedRescheduled": false,
+ "closed": false,
+ "overpaid": false
+ },
+ "locale": "en",
+ "dateFormat": "dd MMMM yyyy",
+ "approvedOnDate": "12 June 2020"
+ }
+}
+
+ Allows you to undoApprove the GLIM Application. GLIM application should be in Approved state.
+Optional Fields |
+
| note | +
+POST https://DomainName/fineract-provider/api/v1/loans/glimAccount/{glimId}?command=undoapproval
+
+
+POST: loans/glimAccount/1?command=undoapproval
+Content-Type: application/json
+Request Body:
+{
+ "note":"Undoapproving glim application due to some reasons"
+}
+
+
+
+{
+ "officeId": 1,
+ "groupId": 1,
+ "clientId": 2,
+ "loanId": 2,
+ "resourceId": 2,
+ "changes": {
+ "status": {
+ "id": 100,
+ "code": "loanStatusType.submitted.and.pending.approval",
+ "value": "Submitted and pending approval",
+ "pendingApproval": true,
+ "waitingForDisbursal": false,
+ "active": false,
+ "closedObligationsMet": false,
+ "closedWrittenOff": false,
+ "closedRescheduled": false,
+ "closed": false,
+ "overpaid": false
+ },
+ "approvedOnDate": ""
+ }
+}
+
+ Allows you to reject the GLIM Application. GLIM application should be in pending state
+Mandatory Fields |
+
| rejectedOnDate, dateFormat, locale | +
+POST https://DomainName/fineract-provider/api/v1/loans/glimAccount/{glimId}?command=reject
+
+
+POST: loans/glimAccount/1?command=reject
+Content-Type: application/json
+Request Body:
+{
+ "rejectedOnDate":"12 June 2020",
+ "dateFormat":"dd MMMM yyyy",
+ "locale":"en"
+}
+
+
+
+{
+ "officeId": 1,
+ "groupId": 1,
+ "clientId": 2,
+ "loanId": 2,
+ "resourceId": 2,
+ "changes": {
+ "status": {
+ "id": 500,
+ "code": "loanStatusType.rejected",
+ "value": "Rejected",
+ "pendingApproval": false,
+ "waitingForDisbursal": false,
+ "active": false,
+ "closedObligationsMet": false,
+ "closedWrittenOff": false,
+ "closedRescheduled": false,
+ "closed": false,
+ "overpaid": false
+ },
+ "locale": "en",
+ "dateFormat": "dd MMMM yyyy",
+ "rejectedOnDate": "12 June 2020",
+ "closedOnDate": "12 June 2020"
+ }
+ }
+
+ Allows you to disburse the GLIM Application, GLIM Account should be in Approved state.
+Mandatory Fields |
+
| actualDisbursementDate, dateFormat, locale | +
+POST https://DomainName/fineract-provider/api/v1/loans/glimAccount/{glimId}?command=disburse
+
+
+POST: loans/glimAccount/2?command=disburse
+Content-Type: application/json
+Request Body:
+{
+ "actualDisbursementDate":"12 June 2020",
+ "dateFormat":"dd MMMM yyyy",
+ "locale":"en"
+}
+
+
+
+{
+ "officeId": 1,
+ "groupId": 1,
+ "clientId": 2,
+ "loanId": 3,
+ "resourceId": 3,
+ "changes": {
+ "status": {
+ "id": 300,
+ "code": "loanStatusType.active",
+ "value": "Active",
+ "pendingApproval": false,
+ "waitingForDisbursal": false,
+ "active": true,
+ "closedObligationsMet": false,
+ "closedWrittenOff": false,
+ "closedRescheduled": false,
+ "closed": false,
+ "overpaid": false
+ },
+ "locale": "en",
+ "dateFormat": "dd MMMM yyyy",
+ "actualDisbursementDate": "12 June 2020"
+ }
+}
+
+ Allows you to undoDisburse the GLIM Application. GLIM application should be in Disburse state
+Optional Fields |
+
| note | +
+POST https://DomainName/fineract-provider/api/v1/loans/glimAccount/{glimId}?command=undodisbursal
+
+
+POST: loans/glimAccount/2?command=undodisbursal
+Content-Type: application/json
+Request Body:
+{
+ "note":"undoDisbursal due to some reasons."
+}
+
+
+
+{
+ "officeId": 1,
+ "groupId": 1,
+ "clientId": 2,
+ "loanId": 3,
+ "resourceId": 3,
+ "changes": {
+ "status": {
+ "id": 200,
+ "code": "loanStatusType.approved",
+ "value": "Approved",
+ "pendingApproval": false,
+ "waitingForDisbursal": true,
+ "active": false,
+ "closedObligationsMet": false,
+ "closedWrittenOff": false,
+ "closedRescheduled": false,
+ "closed": false,
+ "overpaid": false
+ },
+ "actualDisbursementDate": ""
+ }
+}
+
+ Allows you to repayment the GLIM Application, GLIM Application should be in Disburse state.
+Mandatory Fields |
+
| loanId, transactionDate, dateFormat, locale, transactionAmount | +
+POST https://DomainName/fineract-provider/api/v1/loans/glimAccount/{glimId}?command=glimrepayment
+
+
+POST: loans/glimAccount/2?command=glimrepayment
+Content-Type: application/json
+Request Body:
+{
+ "formDataArray":[
+ {
+ "loanId":3,
+ "transactionDate":"12 June 2020",
+ "dateFormat":"dd MMMM yyyy",
+ "locale":"en",
+ "transactionAmount":"1000"
+ }
+ ]
+}
+
+
+
+{
+ "officeId": 1,
+ "groupId": 1,
+ "clientId": 2,
+ "loanId": 3,
+ "resourceId": 3,
+ "changes": {
+ "transactionDate": "12 June 2020",
+ "transactionAmount": "1000",
+ "locale": "en",
+ "dateFormat": "dd MMMM yyyy",
+ "paymentTypeId": ""
+ }
+}
+
+ The API concept of GSIM models the Group Savings Individual Monitoring system and the process of maintaining the savings of groups.
+Field Descriptions |
+
| gsimId | +
| The gsimId associated with the account is Auto Generated and it is pass through route-parameters while taking actions on that specific GSIM Account. | +
| isGSIM | +
| isGSIM is a boolean value, which is included when a savings account will be child account of a GSIM. | +
| childAccountId | +
| childAccountId is the Id of Savings Account linked to the GSIM Account(ParentAccount). | +
+POST https://DomainName/fineract-provider/api/v1/savingsaccounts/gsim
+
+
+{
+ "clientArray":[
+ {
+ "clientId":2,
+ "groupId":1,
+ "productId":"1",
+ "submittedOnDate":"10 June 2020",
+ "dateFormat":"dd MMMM yyyy",
+ "locale":"en",
+ "isParentAccount":1,
+ "isGSIM":true,
+ "applicationId":1234
+ },
+ {
+ "clientId":5,
+ "groupId":1,
+ "productId":"1",
+ "submittedOnDate":"10 June 2020",
+ "dateFormat":"dd MMMM yyyy",
+ "locale":"en",
+ "isParentAccount":1,
+ "isGSIM":true,
+ "applicationId":1234
+ }
+ ]
+}
+
+
+
+
+{
+ "officeId": 1,
+ "groupId": 1,
+ "clientId": 5,
+ "savingsId": 2,
+ "resourceId": 2,
+ "gsimId": 2
+}
+
+ Approves GSIM application so long as its in 'Submitted and pending approval' state.
+Mandatory Fields |
+
| approvedOnDate, dateFormat, locale | +
+POST https://DomainName/fineract-provider/api/v1/savingsaccounts/gsimcommands/{gsimId}?command=approve
+
+
+
+{
+ "approvedOnDate": "03 June 2020",
+ "dateFormat":"dd MMMM yyyy",
+ "locale":"en"
+}
+
+
+
+{
+ "officeId": 1,
+ "groupId": 2,
+ "clientId": 4,
+ "savingsId": 13,
+ "resourceId": 13,
+ "changes": {
+ "status": {
+ "id": 200,
+ "code": "savingsAccountStatusType.approved",
+ "value": "Approved",
+ "submittedAndPendingApproval": false,
+ "approved": true,
+ "rejected": false,
+ "withdrawnByApplicant": false,
+ "active": false,
+ "closed": false,
+ "prematureClosed": false,
+ "transferInProgress": false,
+ "transferOnHold": false,
+ "matured": false
+ },
+ "locale": "en",
+ "dateFormat": "dd MMMM yyyy",
+ "approvedOnDate": "03 June 2020"
+ }
+}
+
+ Will move 'approved' GSIM application back to 'Submitted and pending approval' state.
+Optional Fields |
+
| note | +
+POST https://DomainName/fineract-provider/api/v1/savingsaccounts/gsimcommands/{gsimId}?command=undoapproval
+
+
+{
+ “note”:”GSIM Application Undo Approval Note”
+}
+
+
+{
+ "officeId": 1,
+ "groupId": 2,
+ "clientId": 4,
+ "savingsId": 13,
+ "resourceId": 13,
+ "changes": {
+ "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,
+ "prematureClosed": false,
+ "transferInProgress": false,
+ "transferOnHold": false,
+ "matured": false
+ },
+ "approvedOnDate": ""
+ }
+}
+
+ Rejects GSIM application so long as its in 'Submitted and pending approval' state.
+Mandatory Fields |
+
| rejectedOnDate, dateFormat, locale | +
+https://DomainName/fineract-provider/api/v1/savingsaccounts/gsimcommands/{gsimId}?command=reject
+
+ Associations: String optional One of, or comma separated of GSIM Applications or all for all associations
+POST: savingsaccounts/gsimcommands/7?command=reject
+Content-Type: application/json
+Request Body:
+{
+ "rejectedOnDate": "03 June 2020",
+ "dateFormat":"dd MMMM yyyy",
+ "locale":"en",
+ "note":"rejection due to some reason"
+}
+
+
+
+
+{
+ "officeId": 1,
+ "groupId": 2,
+ "clientId": 4,
+ "savingsId": 13,
+ "resourceId": 13,
+ "changes": {
+ "status": {
+ "id": 500,
+ "code": "savingsAccountStatusType.rejected",
+ "value": "Rejected",
+ "submittedAndPendingApproval": false,
+ "approved": false,
+ "rejected": true,
+ "withdrawnByApplicant": false,
+ "active": false,
+ "closed": true,
+ "prematureClosed": false,
+ "transferInProgress": false,
+ "transferOnHold": false,
+ "matured": false
+ },
+ "locale": "en",
+ "dateFormat": "dd MMMM yyyy",
+ "rejectedOnDate": "03 June 2020",
+ "closedOnDate": "03 June 2020",
+ "note": "rejection due to some reason"
+ }
+}
+
+ Used when an applicant withdraws from the GSIM application. It must be in 'Submitted and pending approval' state.
+ +Mandatory Fields |
+
| withdrawnOnDate, dateFormat, locale | +
+https://DomainName/fineract-provider/api/v1/savingsaccounts/gsimcommands/{gsimId}?command=withdrawnByApplicant
+
+
+POST: /savingsaccounts/gsimcommands/1?command=withdrawnOnDate
+Content-Type: application/json
+Request Body:
+{
+ "withdrawnOnDate": "03 June 2020",
+ "dateFormat":"dd MMMM yyyy",
+ "locale":"en",
+ "note":"withdrawal by applicant"
+}
+
+
+
+{
+ "officeId": 1,
+ "groupId": 1,
+ "clientId": 1,
+ "savingsId": 1,
+ "resourceId": 1,
+ "changes": {
+ "status": {
+ "id": 400,
+ "code": "savingsAccountStatusType.withdrawn.by.applicant",
+ "value": "Withdrawn by applicant",
+ "submittedAndPendingApproval": false,
+ "approved": false,
+ "rejected": false,
+ "withdrawnByApplicant": true,
+ "active": false,
+ "closed": true,
+ "prematureClosed": false,
+ "transferInProgress": false,
+ "transferOnHold": false,
+ "matured": false
+ },
+ "locale": "en",
+ "dateFormat": "dd MMMM yyyy",
+ "withdrawnOnDate": "03 June 2020",
+ "closedOnDate": "03 June 2020",
+ "note": "withdrawal by applicant"
+ }
+}
+
+ Results in an approved GSIM application being converted into an 'active' savings account.
+Mandatory Fields |
+
| activatedOnDate, dateFormat, locale | +
+https://DomainName/fineract-provider/api/v1/savingsaccounts/gsimcommands/{gsimId}?command=activate
+
+
+POST: /savingsaccounts/gsimcommands/10?command=activate
+Content-Type: application/json
+Request Body:
+{
+ "activatedOnDate": "03 June 2020",
+ "dateFormat":"dd MMMM yyyy",
+ "locale":"en"
+}
+
+
+
+
+{
+ "officeId": 1,
+ "groupId": 1,
+ "clientId": 1,
+ "savingsId": 16,
+ "resourceId": 16,
+ "changes": {
+ "status": {
+ "id": 300,
+ "code": "savingsAccountStatusType.active",
+ "value": "Active",
+ "submittedAndPendingApproval": false,
+ "approved": false,
+ "rejected": false,
+ "withdrawnByApplicant": false,
+ "active": true,
+ "closed": false,
+ "prematureClosed": false,
+ "transferInProgress": false,
+ "transferOnHold": false,
+ "matured": false
+ },
+ "locale": "en",
+ "dateFormat": "dd MMMM yyyy",
+ "activatedOnDate": "03 June 2020"
+ }
+}
+
+ Results in an Activated savings application being converted into an 'closed' savings account.
+Mandatory Fields |
+
| closedOnDate, dateFormat, locale | +
+https://DomainName/fineract-provider/api/v1/savingsaccounts/gsimcommands/{gsimId}?command=close
+
+
+POST: savingsaccounts/gsimcommands/10?command=close
+Content-Type: application/json
+Request Body:
+{
+ "closedOnDate": "04 June 2020",
+ "dateFormat":"dd MMMM yyyy",
+ "locale":"en"
+}
+
+
+{
+ "officeId": 1,
+ "groupId": 1,
+ "clientId": 1,
+ "savingsId": 16,
+ "resourceId": 16,
+ "changes": {
+ "status": {
+ "id": 600,
+ "code": "savingsAccountStatusType.closed",
+ "value": "Closed",
+ "submittedAndPendingApproval": false,
+ "approved": false,
+ "rejected": false,
+ "withdrawnByApplicant": false,
+ "active": false,
+ "closed": true,
+ "prematureClosed": false,
+ "transferInProgress": false,
+ "transferOnHold": false,
+ "matured": false
+ },
+ "locale": "en",
+ "dateFormat": "dd MMMM yyyy",
+ "closedOnDate": "04 June 2020"
+ }
+}
+
+ Allows you to modify the GSIM Application by updating groupId, clientId, productId.
+Mandatory Fields |
+
| groupId, clientId, productId | +
+https://DomainName/fineract-provider/api/v1/savingsaccounts/gsim/{gsimId}
+
+
+PUT: savingsaccounts/gsim/6
+Content-Type: application/json
+Request Body:
+{
+ "groupId": 2,
+ "clientId": 3,
+ "productId":2
+}
+
+
+
+{
+ "officeId": 1,
+ "groupId": 2,
+ "clientId": 3,
+ "savingsId": 12,
+ "resourceId": 12,
+ "changes": {
+ "clientId": 3,
+ "productId": 2
+ }
+}
+
+ POST
+https://DomainName/fineract-provider/api/v1 /savingsaccounts/{savingsId}/transactions?command=gsimDeposit
+
+ POST : savingsaccounts/1/transactions?command=gsimDeposit
+Content-Type: application/json
+No Request Body:
+{
+ savingsArray:[
+ {
+ "transactionDate":"04 June 2020",
+ "dateFormat"="dd MMMM yyyy",
+ "locale"="en",
+ "transactionAmount":2500,
+ "paymentTypeId":1,
+ "childAccountId":1
+ }
+ ]
+}
+
+
+
+ {
+ "officeId": 1,
+ "groupId": 1,
+ "savingsId": 1,
+ "resourceId": 26,
+ "changes": {}
+ }
+
+
+