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

LoanCollateralApi

Functions

abstract suspend fun createCollateral(loanId: Long, postLoansLoanIdCollateralsRequest: PostLoansLoanIdCollateralsRequest): PostLoansLoanIdCollateralsResponse

Create a Collateral Note: Currently, Collaterals may be added only before a Loan is approved Responses:

deleteCollateral

abstract suspend fun deleteCollateral(loanId: Long, collateralId: Long): DeleteLoansLoanIdCollateralsCollateralIdResponse

Remove a Collateral Note: A collateral can only be removed from Loans that are not yet approved. Responses:

newCollateralTemplate

abstract suspend fun newCollateralTemplate(loanId: Long): GetLoansLoanIdCollateralsTemplateResponse

Retrieve Collateral 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 Value Lists Example Request: loans/1/collaterals/template Responses:

retrieveCollateralDetails

abstract suspend fun retrieveCollateralDetails(loanId: Long): List<GetLoansLoanIdCollateralsResponse>

List Loan Collaterals Example Requests: loans/1/collaterals loans/1/collaterals?fields=value,description Responses:

retrieveCollateralDetails1

abstract suspend fun retrieveCollateralDetails1(loanId: Long, collateralId: Long): GetLoansLoanIdCollateralsResponse

Retrieve a Collateral Example Requests: /loans/1/collaterals/1 /loans/1/collaterals/1?fields=description,description Responses:

updateCollateral

abstract suspend fun updateCollateral(loanId: Long, collateralId: Long, putLoansLoandIdCollateralsCollateralIdRequest: PutLoansLoandIdCollateralsCollateralIdRequest): PutLoansLoanIdCollateralsCollateralIdResponse

Update a Collateral