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

retrieveLoan1

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:

200: OK

Return

GetLoansLoanIdResponse

Parameters

loanExternalId

staffInSelectedOfficeOnly

staffInSelectedOfficeOnly (optional, default to false)

associations

Loan object relations to be included in the response (optional, default to "all")

exclude

Optional Loan object relation list to be filtered in the response (optional)

fields

Optional Loan attribute list to be in the response (optional)