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

LoanTransactionsApi

interface LoanTransactionsApi

Functions

Link copied to clipboard
abstract suspend fun adjustLoanTransaction(loanId: Long, transactionId: Long, postLoansLoanIdTransactionsTransactionIdRequest: PostLoansLoanIdTransactionsTransactionIdRequest, command: String? = null): PostLoansLoanIdTransactionsResponse

Adjust a Transaction Note: there is no need to specify command={transactionType} parameter. Mandatory Fields: transactionDate, transactionAmount Responses:

Link copied to clipboard
abstract suspend fun adjustLoanTransaction1(loanId: Long, externalTransactionId: String, postLoansLoanIdTransactionsTransactionIdRequest: PostLoansLoanIdTransactionsTransactionIdRequest, command: String? = null): PostLoansLoanIdTransactionsResponse

Adjust a Transaction Note: there is no need to specify command={transactionType} parameter. Mandatory Fields: transactionDate, transactionAmount Responses:

Link copied to clipboard
abstract suspend fun adjustLoanTransaction2(loanExternalId: String, transactionId: Long, postLoansLoanIdTransactionsTransactionIdRequest: PostLoansLoanIdTransactionsTransactionIdRequest, command: String? = null): PostLoansLoanIdTransactionsResponse

Adjust a Transaction Note: there is no need to specify command={transactionType} parameter. Mandatory Fields: transactionDate, transactionAmount Responses:

Link copied to clipboard
abstract suspend fun adjustLoanTransaction3(loanExternalId: String, externalTransactionId: String, postLoansLoanIdTransactionsTransactionIdRequest: PostLoansLoanIdTransactionsTransactionIdRequest, command: String? = null): PostLoansLoanIdTransactionsResponse

Adjust a Transaction Note: there is no need to specify command={transactionType} parameter. Mandatory Fields: transactionDate, transactionAmount Responses:

Link copied to clipboard
abstract suspend fun executeLoanTransaction(loanId: Long, postLoansLoanIdTransactionsRequest: PostLoansLoanIdTransactionsRequest, command: String? = null): PostLoansLoanIdTransactionsResponse

Significant Loan Transactions This API covers the major loan transaction functionality Example Requests: loans/1/transactions?command=repayment | Make a Repayment | loans/1/transactions?command=merchantIssuedRefund | Merchant Issued Refund | loans/1/transactions?command=payoutRefund | Payout Refund | loans/1/transactions?command=goodwillCredit | Goodwil Credit | loans/1/transactions?command=chargeRefund | Charge Refund | loans/1/transactions?command=waiveinterest | Waive Interest | loans/1/transactions?command=writeoff | Write-off Loan | loans/1/transactions?command=close-rescheduled | Close Rescheduled Loan | loans/1/transactions?command=close | Close Loan | loans/1/transactions?command=undowriteoff | Undo Loan Write-off | loans/1/transactions?command=recoverypayment | Make Recovery Payment | loans/1/transactions?command=refundByCash | Make a Refund of an Active Loan by Cash | loans/1/transactions?command=foreclosure | Foreclosure of an Active Loan | loans/1/transactions?command=creditBalanceRefund | Credit Balance Refund | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=charge-off | Charge-off Loan | loans/1/transactions?command=downPayment | Down Payment | Responses:

Link copied to clipboard
abstract suspend fun executeLoanTransaction1(loanExternalId: String, postLoansLoanIdTransactionsRequest: PostLoansLoanIdTransactionsRequest, command: String? = null): PostLoansLoanIdTransactionsResponse

Significant Loan Transactions This API covers the major loan transaction functionality Example Requests: loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=repayment | Make a Repayment | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=merchantIssuedRefund | Merchant Issued Refund | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=payoutRefund | Payout Refund | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=goodwillCredit | Goodwil Credit | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=chargeRefund | Charge Refund | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=waiveinterest | Waive Interest | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=writeoff | Write-off Loan | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=close-rescheduled | Close Rescheduled Loan | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=close | Close Loan | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=undowriteoff | Undo Loan Write-off | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=recoverypayment | Make Recovery Payment | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=refundByCash | Make a Refund of an Active Loan by Cash | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=foreclosure | Foreclosure of an Active Loan | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=creditBalanceRefund | Credit Balance Refund | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=charge-off | Charge-off Loan | loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?command=downPayment | Down Payment | Responses:

Link copied to clipboard
abstract suspend fun retrieveTransaction(loanId: Long, transactionId: Long, fields: String? = null): GetLoansLoanIdTransactionsTransactionIdResponse

Retrieve a Transaction Details Retrieves a Transaction Details Example Request: loans/5/transactions/3 Responses:

abstract suspend fun retrieveTransactionByLoanExternalIdAndTransactionExternalId(loanExternalId: String, externalTransactionId: String, fields: String? = null): GetLoansLoanIdTransactionsTransactionIdResponse

Retrieve a Transaction Details Retrieves a Transaction Details Example Request: loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions/external-id/5dd80a7c-ccba-4446-b378-01eb6f53e871 Responses:

abstract suspend fun retrieveTransactionByLoanExternalIdAndTransactionId(loanExternalId: String, transactionId: Long, fields: String? = null): GetLoansLoanIdTransactionsTransactionIdResponse

Retrieve a Transaction Details Retrieves a Transaction Details Example Request: loans/5/transactions/3 Responses:

abstract suspend fun retrieveTransactionByTransactionExternalId(loanId: Long, externalTransactionId: String, fields: String? = null): GetLoansLoanIdTransactionsTransactionIdResponse

Retrieve a Transaction Details Retrieves a Transaction Details Example Request: loans/5/transactions/external-id/5dd80a7c-ccba-4446-b378-01eb6f53e871 Responses:

Link copied to clipboard
abstract suspend fun retrieveTransactionTemplate(loanId: Long, command: String? = null, dateFormat: String? = null, transactionDate: String? = null, locale: String? = null): GetLoansLoanIdTransactionsTemplateResponse

Retrieve Loan Transaction 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 Requests: loans/1/transactions/template?command=repaymentloans/1/transactions/template?command=merchantIssuedRefundloans/1/transactions/template?command=payoutRefundloans/1/transactions/template?command=goodwillCredit loans/1/transactions/template?command=waiveinterest loans/1/transactions/template?command=writeoff loans/1/transactions/template?command=close-rescheduled loans/1/transactions/template?command=close loans/1/transactions/template?command=disburse loans/1/transactions/template?command=disburseToSavings loans/1/transactions/template?command=recoverypayment loans/1/transactions/template?command=prepayLoan loans/1/transactions/template?command=refundbycash loans/1/transactions/template?command=refundbytransfer loans/1/transactions/template?command=foreclosure loans/1/transactions/template?command=creditBalanceRefund (returned 'amount' field will have the overpaid value) loans/1/transactions/template?command=charge-off loans/1/transactions/template?command=downPayment Responses:

Link copied to clipboard
abstract suspend fun retrieveTransactionTemplate1(loanExternalId: String, command: String? = null, dateFormat: String? = null, transactionDate: String? = null, locale: String? = null): GetLoansLoanIdTransactionsTemplateResponse

Retrieve Loan Transaction 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 Requests: loans/1/transactions/template?command=repaymentloans/1/transactions/template?command=merchantIssuedRefundloans/1/transactions/template?command=payoutRefundloans/1/transactions/template?command=goodwillCredit loans/1/transactions/template?command=waiveinterest loans/1/transactions/template?command=writeoff loans/1/transactions/template?command=close-rescheduled loans/1/transactions/template?command=close loans/1/transactions/template?command=disburse loans/1/transactions/template?command=disburseToSavings loans/1/transactions/template?command=recoverypayment loans/1/transactions/template?command=prepayLoan loans/1/transactions/template?command=refundbycash loans/1/transactions/template?command=refundbytransfer loans/1/transactions/template?command=foreclosure loans/1/transactions/template?command=creditBalanceRefund (returned 'amount' field will have the overpaid value) loans/1/transactions/template?command=charge-off loans/1/transactions/template?command=downPayment Responses:

Link copied to clipboard
abstract suspend fun undoWaiveCharge(loanId: Long, transactionId: Long, putChargeTransactionChangesRequest: PutChargeTransactionChangesRequest): PutChargeTransactionChangesResponse

Undo a Waive Charge Transaction Undo a Waive Charge Transaction Responses:

Link copied to clipboard
abstract suspend fun undoWaiveCharge1(loanId: Long, transactionExternalId: String, putChargeTransactionChangesRequest: PutChargeTransactionChangesRequest): PutChargeTransactionChangesResponse

Undo a Waive Charge Transaction Undo a Waive Charge Transaction Responses:

Link copied to clipboard
abstract suspend fun undoWaiveCharge2(loanExternalId: String, transactionId: Long, putChargeTransactionChangesRequest: PutChargeTransactionChangesRequest): PutChargeTransactionChangesResponse

Undo a Waive Charge Transaction Undo a Waive Charge Transaction Responses:

Link copied to clipboard
abstract suspend fun undoWaiveCharge3(loanExternalId: String, transactionExternalId: String, putChargeTransactionChangesRequest: PutChargeTransactionChangesRequest): PutChargeTransactionChangesResponse

Undo a Waive Charge Transaction Undo a Waive Charge Transaction Responses: