fineract-client/org.mifos.fineract.client.apis/LoansApi

LoansApi

interface LoansApi

Functions

abstract suspend fun calculateLoanScheduleOrSubmitLoanApplication(postLoansRequest: PostLoansRequest, command: String? = null): PostLoansResponse

Calculate loan repayment schedule | Submit a new Loan Application It calculates the loan repayment Schedule Submits a new loan application Mandatory Fields: clientId, productId, principal, loanTermFrequency, loanTermFrequencyType, loanType, numberOfRepayments, repaymentEvery, repaymentFrequencyType, interestRatePerPeriod, amortizationType, interestType, interestCalculationPeriodType, transactionProcessingStrategyCode, expectedDisbursementDate, submittedOnDate, loanType Optional Fields: graceOnPrincipalPayment, graceOnInterestPayment, graceOnInterestCharged, linkAccountId, allowPartialPeriodInterestCalcualtion, fixedEmiAmount, maxOutstandingLoanBalance, disbursementData, graceOnArrearsAgeing, createStandingInstructionAtDisbursement (requires linkedAccountId if set to true) Additional Mandatory Fields if interest recalculation is enabled for product and Rest frequency not same as repayment period: recalculationRestFrequencyDate Additional Mandatory Fields if interest recalculation with interest/fee compounding is enabled for product and compounding frequency not same as repayment period: recalculationCompoundingFrequencyDate Additional Mandatory Field if Entity-Datatable Check is enabled for the entity of type loan: datatables Responses:

Link copied to clipboard
abstract suspend fun createLoanDelinquencyAction(loanId: Long, postLoansDelinquencyActionRequest: PostLoansDelinquencyActionRequest): PostLoansDelinquencyActionResponse

Adds a new delinquency action for a loan

Link copied to clipboard
abstract suspend fun createLoanDelinquencyAction1(loanExternalId: String, postLoansDelinquencyActionRequest: PostLoansDelinquencyActionRequest): PostLoansDelinquencyActionResponse

Adds a new delinquency action for a loan

Link copied to clipboard
abstract suspend fun deleteLoanApplication(loanId: Long): DeleteLoansLoanIdResponse

Delete a Loan Application Note: Only loans in \"Submitted and awaiting approval\" status can be deleted. Responses:

Link copied to clipboard
abstract suspend fun deleteLoanApplication1(loanExternalId: String): DeleteLoansLoanIdResponse

Delete a Loan Application Note: Only loans in \"Submitted and awaiting approval\" status can be deleted. Responses:

Link copied to clipboard
abstract suspend fun getDelinquencyTagHistory(loanId: Long): List<GetDelinquencyTagHistoryResponse>

Retrieve the Loan Delinquency Tag history using the Loan Id

Link copied to clipboard
abstract suspend fun getDelinquencyTagHistory1(loanExternalId: String): List<GetDelinquencyTagHistoryResponse>

Retrieve the Loan Delinquency Tag history using the Loan Id

Link copied to clipboard
abstract suspend fun getGlimRepaymentTemplate(glimId: Long): String

Responses:

Link copied to clipboard
abstract suspend fun getLoanDelinquencyActions(loanId: Long): List<GetDelinquencyActionsResponse>

Retrieve delinquency actions related to the loan

Link copied to clipboard
abstract suspend fun getLoanDelinquencyActions1(loanExternalId: String): List<GetDelinquencyActionsResponse>

Retrieve delinquency actions related to the loan

Link copied to clipboard
abstract suspend fun getLoanRepaymentTemplate(officeId: Long? = null, dateFormat: String? = null)

Responses:

Link copied to clipboard
abstract suspend fun getLoansTemplate(officeId: Long? = null, staffId: Long? = null, dateFormat: String? = null)

Responses:

Link copied to clipboard
abstract suspend fun glimStateTransitions(glimId: Long, postLoansLoanIdRequest: PostLoansLoanIdRequest, command: String? = null): PostLoansLoanIdResponse

Approve GLIM Application | Undo GLIM Application Approval | Reject GLIM Application | Disburse Loan Disburse Loan To Savings Account | Undo Loan Disbursal Approve GLIM Application: Mandatory Fields: approvedOnDate Optional Fields: approvedLoanAmount and expectedDisbursementDate Approves the GLIM application Undo GLIM Application Approval: Undoes the GLIM Application Approval Reject GLIM Application: Mandatory Fields: rejectedOnDate Allows you to reject the GLIM application Disburse Loan: Mandatory Fields: actualDisbursementDate Optional Fields: transactionAmount and fixedEmiAmount Disburses the Loan Disburse Loan To Savings Account: Mandatory Fields: actualDisbursementDate Optional Fields: transactionAmount and fixedEmiAmount Disburses the loan to Saving Account Undo Loan Disbursal: Undoes the Loan Disbursal Responses:

Link copied to clipboard
abstract suspend fun modifyLoanApplication(loanId: Long, putLoansLoanIdRequest: PutLoansLoanIdRequest, command: String? = null): PutLoansLoanIdResponse

Modify a loan application Loan application can only be modified when in 'Submitted and pending approval' state. Once the application is approved, the details cannot be changed using this method. Responses:

Link copied to clipboard
abstract suspend fun modifyLoanApplication1(loanExternalId: String, putLoansLoanIdRequest: PutLoansLoanIdRequest, command: String? = null): PutLoansLoanIdResponse

Modify a loan application Loan application can only be modified when in 'Submitted and pending approval' state. Once the application is approved, the details cannot be changed using this method. Responses:

Link copied to clipboard
abstract suspend fun postLoanRepaymentTemplate(dateFormat: String, locale: String, uploadedInputStream: MultiPartFormDataContent): String

Responses:

Link copied to clipboard
abstract suspend fun postLoanTemplate(dateFormat: String, locale: String, uploadedInputStream: MultiPartFormDataContent): String

Responses:

Link copied to clipboard
abstract suspend fun retrieveAll27(externalId: String? = null, offset: Int? = null, limit: Int? = null, orderBy: String? = null, sortOrder: String? = null, accountNo: String? = null, status: String? = null): GetLoansResponse

List Loans The list capability of loans can support pagination and sorting. Example Requests: loans loans?fields=accountNo loans?offset=10&limit=50 loans?orderBy=accountNo&sortOrder=DESC Responses:

Link copied to clipboard
abstract suspend fun retrieveApprovalTemplate(loanId: Long, templateType: String? = null): GetLoansApprovalTemplateResponse

Responses:

Link copied to clipboard
abstract suspend fun retrieveApprovalTemplate1(loanExternalId: String, templateType: String? = null): GetLoansApprovalTemplateResponse

Responses:

Link copied to clipboard
abstract suspend fun retrieveLoan(loanId: Long, staffInSelectedOfficeOnly: Boolean? = false, associations: String? = "all", exclude: String? = null, fields: String? = null): GetLoansLoanIdResponse

Retrieve a Loan Note: template=true parameter doesn't apply to this resource.Example Requests: loans/1 loans/1?fields=id,principal,annualInterestRate loans/1?associations=all loans/1?associations=all&exclude=guarantors loans/1?fields=id,principal,annualInterestRate&associations=repaymentSchedule,transactions Responses:

Link copied to clipboard
abstract suspend fun retrieveLoan1(loanExternalId: String, staffInSelectedOfficeOnly: Boolean? = false, associations: String? = "all", exclude: String? = null, fields: String? = null): GetLoansLoanIdResponse

Retrieve a Loan Note: template=true parameter doesn't apply to this resource.Example Requests: loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854 loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854?fields=id,principal,annualInterestRate loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854?associations=all loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854?associations=all&exclude=guarantors loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854?fields=id,principal,annualInterestRate&associations=repaymentSchedule,transactions Responses:

Link copied to clipboard
abstract suspend fun stateTransitions(loanId: Long, postLoansLoanIdRequest: PostLoansLoanIdRequest, command: String? = null): PostLoansLoanIdResponse

Approve Loan Application | Recover Loan Guarantee | Undo Loan Application Approval | Assign a Loan Officer | Unassign a Loan Officer | Reject Loan Application | Applicant Withdraws from Loan Application | Disburse Loan Disburse Loan To Savings Account | Undo Loan Disbursal Approve Loan Application: Mandatory Fields: approvedOnDate Optional Fields: approvedLoanAmount and expectedDisbursementDate Approves the loan application Recover Loan Guarantee: Recovers the loan guarantee Undo Loan Application Approval: Undoes the Loan Application Approval Assign a Loan Officer: Allows you to assign Loan Officer for existing Loan. Unassign a Loan Officer: Allows you to unassign the Loan Officer. Reject Loan Application: Mandatory Fields: rejectedOnDate Allows you to reject the loan application Applicant Withdraws from Loan Application: Mandatory Fields: withdrawnOnDate Allows the applicant to withdraw the loan application Disburse Loan: Mandatory Fields: actualDisbursementDate Optional Fields: transactionAmount and fixedEmiAmount Disburses the Loan Disburse Loan To Savings Account: Mandatory Fields: actualDisbursementDate Optional Fields: transactionAmount and fixedEmiAmount Disburses the loan to Saving Account Undo Loan Disbursal: Undoes the Loan Disbursal Showing request and response for Assign a Loan Officer Responses:

Link copied to clipboard
abstract suspend fun stateTransitions1(loanExternalId: String, postLoansLoanIdRequest: PostLoansLoanIdRequest, command: String? = null): PostLoansLoanIdResponse

Approve Loan Application | Recover Loan Guarantee | Undo Loan Application Approval | Assign a Loan Officer | Unassign a Loan Officer | Reject Loan Application | Applicant Withdraws from Loan Application | Disburse Loan Disburse Loan To Savings Account | Undo Loan Disbursal Approve Loan Application: Mandatory Fields: approvedOnDate Optional Fields: approvedLoanAmount and expectedDisbursementDate Approves the loan application Recover Loan Guarantee: Recovers the loan guarantee Undo Loan Application Approval: Undoes the Loan Application Approval Assign a Loan Officer: Allows you to assign Loan Officer for existing Loan. Unassign a Loan Officer: Allows you to unassign the Loan Officer. Reject Loan Application: Mandatory Fields: rejectedOnDate Allows you to reject the loan application Applicant Withdraws from Loan Application: Mandatory Fields: withdrawnOnDate Allows the applicant to withdraw the loan application Disburse Loan: Mandatory Fields: actualDisbursementDate Optional Fields: transactionAmount and fixedEmiAmount Disburses the Loan Disburse Loan To Savings Account: Mandatory Fields: actualDisbursementDate Optional Fields: transactionAmount and fixedEmiAmount Disburses the loan to Saving Account Undo Loan Disbursal: Undoes the Loan Disbursal Showing request and response for Assign a Loan Officer Responses:

Link copied to clipboard
abstract suspend fun template10(clientId: Long? = null, groupId: Long? = null, productId: Long? = null, templateType: String? = null, staffInSelectedOfficeOnly: Boolean? = false, activeOnly: Boolean? = false): GetLoansTemplateResponse

Retrieve Loan Details Template 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: Field Defaults Allowed description Lists Example Requests: loans/template?templateType=individual&clientId=1 loans/template?templateType=individual&clientId=1&productId=1 Responses: