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

LoanChargesApi

interface LoanChargesApi

Functions

Link copied to clipboard
abstract suspend fun deleteLoanCharge(loanId: Long, loanChargeId: Long): DeleteLoansLoanIdChargesChargeIdResponse

Delete a Loan Charge Note: Currently, A Loan Charge may only be removed from Loans that are not yet approved. Responses:

Link copied to clipboard
abstract suspend fun deleteLoanCharge1(loanId: Long, loanChargeExternalId: String): DeleteLoansLoanIdChargesChargeIdResponse

Delete a Loan Charge Note: Currently, A Loan Charge may only be removed from Loans that are not yet approved. Responses:

Link copied to clipboard
abstract suspend fun deleteLoanCharge2(loanExternalId: String, loanChargeId: Long): DeleteLoansLoanIdChargesChargeIdResponse

Delete a Loan Charge Note: Currently, A Loan Charge may only be removed from Loans that are not yet approved. Responses:

Link copied to clipboard
abstract suspend fun deleteLoanCharge3(loanExternalId: String, loanChargeExternalId: String): DeleteLoansLoanIdChargesChargeIdResponse

Delete a Loan Charge Note: Currently, A Loan Charge may only be removed from Loans that are not yet approved. Responses:

Link copied to clipboard
abstract suspend fun executeLoanCharge(loanId: Long, postLoansLoanIdChargesRequest: PostLoansLoanIdChargesRequest, command: String? = null): PostLoansLoanIdChargesResponse

Create a Loan Charge (no command provided) or Pay a charge (command=pay) Creates a Loan Charge | Pay a Loan Charge Responses:

Link copied to clipboard
abstract suspend fun executeLoanCharge1(loanExternalId: String, postLoansLoanIdChargesRequest: PostLoansLoanIdChargesRequest, command: String? = null): PostLoansLoanIdChargesResponse

Create a Loan Charge (no command provided) or Pay a charge (command=pay) Creates a Loan Charge | Pay a Loan Charge Responses:

Link copied to clipboard
abstract suspend fun executeLoanCharge2(loanId: Long, loanChargeId: Long, postLoansLoanIdChargesChargeIdRequest: PostLoansLoanIdChargesChargeIdRequest, command: String? = null): PostLoansLoanIdChargesChargeIdResponse

Pay / Waive / Adjustment for Loan Charge Loan Charge will be paid if the loan is linked with a savings account | Waive Loan Charge | Add Charge Adjustment Responses:

Link copied to clipboard
abstract suspend fun executeLoanCharge3(loanId: Long, loanChargeExternalId: String, postLoansLoanIdChargesChargeIdRequest: PostLoansLoanIdChargesChargeIdRequest, command: String? = null): PostLoansLoanIdChargesChargeIdResponse

Pay / Waive / Adjustment for Loan Charge Loan Charge will be paid if the loan is linked with a savings account | Waive Loan Charge | Add Charge Adjustment Responses:

Link copied to clipboard
abstract suspend fun executeLoanCharge4(loanExternalId: String, loanChargeId: Long, postLoansLoanIdChargesChargeIdRequest: PostLoansLoanIdChargesChargeIdRequest, command: String? = null): PostLoansLoanIdChargesChargeIdResponse

Pay / Waive / Adjustment for Loan Charge Loan Charge will be paid if the loan is linked with a savings account | Waive Loan Charge | Add Charge Adjustment Responses:

Link copied to clipboard
abstract suspend fun executeLoanCharge5(loanExternalId: String, loanChargeExternalId: String, postLoansLoanIdChargesChargeIdRequest: PostLoansLoanIdChargesChargeIdRequest, command: String? = null): PostLoansLoanIdChargesChargeIdResponse

Pay / Waive / Adjustment for Loan Charge Loan Charge will be paid if the loan is linked with a savings account | Waive Loan Charge | Add Charge Adjustment Responses:

Link copied to clipboard
abstract suspend fun retrieveAllLoanCharges(loanId: Long): List<GetLoansLoanIdChargesChargeIdResponse>

List Loan Charges It lists all the Loan Charges specific to a Loan Example Requests: loans/1/charges loans/1/charges?fields=name,amountOrPercentage Responses:

Link copied to clipboard
abstract suspend fun retrieveAllLoanCharges1(loanExternalId: String): List<GetLoansLoanIdChargesChargeIdResponse>

List Loan Charges It lists all the Loan Charges specific to a Loan Example Requests: loans/1/charges loans/1/charges?fields=name,amountOrPercentage Responses:

Link copied to clipboard
abstract suspend fun retrieveLoanCharge(loanId: Long, loanChargeId: Long): GetLoansLoanIdChargesChargeIdResponse

Retrieve a Loan Charge Retrieves Loan Charge according to the Loan ID and Loan Charge IDExample Requests: /loans/1/charges/1 /loans/1/charges/1?fields=name,amountOrPercentage Responses:

Link copied to clipboard
abstract suspend fun retrieveLoanCharge1(loanId: Long, loanChargeExternalId: String): GetLoansLoanIdChargesChargeIdResponse

Retrieve a Loan Charge Retrieves Loan Charge according to the Loan ID and Loan Charge External IDExample Requests: /loans/1/charges/1 /loans/1/charges/external-id/1?fields=name,amountOrPercentage Responses:

Link copied to clipboard
abstract suspend fun retrieveLoanCharge2(loanExternalId: String, loanChargeId: Long): GetLoansLoanIdChargesChargeIdResponse

Retrieve a Loan Charge Retrieves Loan Charge according to the Loan external ID and Loan Charge IDExample Requests: /loans/1/charges/1 /loans/1/charges/1?fields=name,amountOrPercentage Responses:

Link copied to clipboard
abstract suspend fun retrieveLoanCharge3(loanExternalId: String, loanChargeExternalId: String): GetLoansLoanIdChargesChargeIdResponse

Retrieve a Loan Charge Retrieves Loan Charge according to the Loan External ID and Loan Charge External IDExample Requests: /loans/1/charges/1 /loans/1/charges/1?fields=name,amountOrPercentage Responses:

Link copied to clipboard
abstract suspend fun retrieveTemplate8(loanId: Long): GetLoansLoanIdChargesTemplateResponse

Retrieve Loan Charges 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 Request: loans/1/charges/template Responses:

Link copied to clipboard
abstract suspend fun retrieveTemplate9(loanExternalId: String): GetLoansLoanIdChargesTemplateResponse

Retrieve Loan Charges 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 Request: loans/1/charges/template Responses:

Link copied to clipboard
abstract suspend fun updateLoanCharge(loanId: Long, loanChargeId: Long, putLoansLoanIdChargesChargeIdRequest: PutLoansLoanIdChargesChargeIdRequest): PutLoansLoanIdChargesChargeIdResponse

Update a Loan Charge Currently Loan Charges may be updated only if the Loan is not yet approved Responses:

Link copied to clipboard
abstract suspend fun updateLoanCharge1(loanId: Long, loanChargeExternalId: String, putLoansLoanIdChargesChargeIdRequest: PutLoansLoanIdChargesChargeIdRequest): PutLoansLoanIdChargesChargeIdResponse

Update a Loan Charge Currently Loan Charges may be updated only if the Loan is not yet approved Responses:

Link copied to clipboard
abstract suspend fun updateLoanCharge2(loanExternalId: String, loanChargeId: Long, putLoansLoanIdChargesChargeIdRequest: PutLoansLoanIdChargesChargeIdRequest): PutLoansLoanIdChargesChargeIdResponse

Update a Loan Charge Currently Loan Charges may be updated only if the Loan is not yet approved Responses:

Link copied to clipboard
abstract suspend fun updateLoanCharge3(loanExternalId: String, loanChargeExternalId: String, putLoansLoanIdChargesChargeIdRequest: PutLoansLoanIdChargesChargeIdRequest): PutLoansLoanIdChargesChargeIdResponse

Update a Loan Charge Currently Loan Charges may be updated only if the Loan is not yet approved Responses: