com.mambu.apisdk.services

Class LoansService

java.lang.Object

com.mambu.apisdk.services.LoansService

public class LoansService
extends java.lang.Object

Service class which handles API operations like retrieval, creation or changing state of loan accounts. See full Mambu Loan API documentation at: http://api.mambu.com/customer/portal/articles/1162283-loans-api?b_id=874

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CENTRE_ID
static java.lang.String	SCHEDULE

Constructor Summary

Constructors

Constructor and Description
LoansService(MambuAPIService mambuAPIService) Create a new loan service

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	addSettlementAccount(java.lang.String loanAccountKey, java.lang.String savingsAccountKey) Updates or links a settlement account with a loan account.
com.mambu.loans.shared.model.LoanTransaction	applyFeeToLoanAccount(java.lang.String accountId, java.util.List<com.mambu.loans.shared.model.CustomPredefinedFee> fees, java.lang.Integer repaymentNumber, java.lang.String notes) Apply Predefined Fee to a loan account
com.mambu.loans.shared.model.LoanTransaction	applyFeeToLoanAccount(java.lang.String accountId, java.lang.String amount, java.lang.String repaymentNumber, java.lang.String notes) Apply FEE to a loan account
com.mambu.loans.shared.model.LoanTransaction	applyInterestToLoanAccount(java.lang.String accountId, java.util.Date date, java.lang.String notes) Apply Interest to a loan account on a given date
com.mambu.loans.shared.model.LoanAccount	approveLoanAccount(java.lang.String accountId, java.lang.String notes) Approve a loan account if the user has permission to approve loans, the maximum exposure is not exceeded for the client, the account was in Pending Approval state and if the number of loans is not exceeded
com.mambu.loans.shared.model.LoanAccount	closeLoanAccount(java.lang.String accountId, APIData.CLOSER_TYPE closerType, java.lang.String notes) Close Loan account specifying the type of closer (withdraw, reject or close)
com.mambu.loans.shared.model.LoanAccount	closeLoanAccount(java.lang.String accountId, java.lang.String notes) Close loan account with all obligations met
com.mambu.loans.shared.model.LoanAccount	createLoanAccount(com.mambu.loans.shared.model.LoanAccount loanAccount) Create new LoanAccount using LoanAccount object.
boolean	deleteLoanAccount(java.lang.String accountId) Delete Loan Account by its Id
java.lang.Boolean	deleteSettlementAccount(java.lang.String loanAccountKey, java.lang.String savingAccountKey) Deletes the link between the loan account and saving account (known as settlement account) Call: DELETE /api/loans/{LOAN_KEY}/settlementAccounts/{SAVINGS_KEY} Sample call: DELETE /api/loans/STLACC_7832648/settlementAccounts/8a80866357976c62015798e0b60e00d0 Sample response: {"returnCode":0,"returnStatus":"SUCCESS"} Available since Mambu 4.4
com.mambu.loans.shared.model.LoanTransaction	disburseLoanAccount(java.lang.String accountId, com.mambu.core.shared.model.Money amount, com.mambu.loans.shared.model.DisbursementDetails disbursementDetails, java.util.List<com.mambu.core.shared.model.CustomFieldValue> customInformation, java.lang.String notes) Disburse loan account using JSON disburse API request specifying disbursement details and transaction custom information.
com.mambu.loans.shared.model.LoanTransaction	disburseLoanAccount(java.lang.String accountId, com.mambu.core.shared.model.Money amount, com.mambu.loans.shared.model.DisbursementDetails disbursementDetails, java.lang.String notes) Convenience method to Disburse loan account using JSON Transaction and specifying Disbursement Details.
com.mambu.loans.shared.model.LoanTransaction	executeJSONTransactionRequest(java.lang.String accountId, com.mambu.loans.shared.model.LoanTransactionType transactionType, com.mambu.api.server.handler.loan.model.JSONTransactionRequest transactionRequest) Convenience method to execute Loan Account transaction by providing JSONTransactionRequest
com.mambu.loans.shared.model.LoanAccount	getLoanAccount(java.lang.String accountId) Get a loan account with full details by its id
com.mambu.loans.shared.model.LoanAccount	getLoanAccountDetails(java.lang.String accountId) Get a loan account with Details by its id
java.util.List<com.mambu.loans.shared.model.LoanAccount>	getLoanAccounts(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints, java.lang.String offset, java.lang.String limit) Get loan accounts by specifying filter constraints
java.util.List<com.mambu.loans.shared.model.LoanAccount>	getLoanAccountsByBranchCentreOfficerState(java.lang.String branchId, java.lang.String centreId, java.lang.String creditOfficerUserName, java.lang.String accountState, java.lang.String offset, java.lang.String limit) Get the loan accounts by branch id, centreId, credit officer, accountState
java.util.List<com.mambu.loans.shared.model.LoanAccount>	getLoanAccountsByBranchOfficerState(java.lang.String branchId, java.lang.String creditOfficerUserName, java.lang.String accountState, java.lang.String offset, java.lang.String limit) Get loan accounts by branch id, credit officer, accountState.
java.util.List<com.mambu.loans.shared.model.LoanAccount>	getLoanAccountsForClient(java.lang.String clientId) Get all the loan accounts for a given client
java.util.List<com.mambu.loans.shared.model.LoanAccount>	getLoanAccountsForGroup(java.lang.String groupId) Get all the loan accounts for a given group
java.util.List<com.mambu.loans.shared.model.LoanTransaction>	getLoanAccountTransactions(java.lang.String accountId, java.lang.String offset, java.lang.String limit) Get loan account Transactions by Loan id and offset and limit
com.mambu.api.server.handler.loan.model.JSONLoanAccountResponse	getLoanAccountWithSettlementAccounts(java.lang.String accountId) Get full loan account details, including settlement accounts
com.mambu.loans.shared.model.LoanProduct	getLoanProduct(java.lang.String productId) Get a Loan Product by Product id
java.util.List<com.mambu.loans.shared.model.LoanProduct>	getLoanProducts(java.lang.String offset, java.lang.String limit) Get a list of Loan Products
java.util.List<com.mambu.loans.shared.model.Repayment>	getLoanProductSchedule(java.lang.String productId, com.mambu.loans.shared.model.LoanAccount account) Get repayment schedule preview for a Loan Product
java.util.List<com.mambu.loans.shared.model.Repayment>	getLoanProductSchedule(java.lang.String productId, com.mambu.loans.shared.model.LoanAccount account, ScheduleQueryParams queryParams) Get repayment schedule preview for a Loan Product
java.util.List<com.mambu.loans.shared.model.LoanTransaction>	getLoanTransactions(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints, java.lang.String offset, java.lang.String limit) Deprecated.
java.util.List<com.mambu.loans.shared.model.LoanTransaction>	getLoanTransactionsWithBasicDetails(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints, java.lang.String offset, java.lang.String limit) Get loan transactions by specifying filter constraints with basic details level (no custom fields)
java.util.List<com.mambu.loans.shared.model.LoanTransaction>	getLoanTransactionsWithFullDetails(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints, java.lang.String offset, java.lang.String limit) Get loan transactions by specifying filter constraints (including custom fields)
java.util.List<com.mambu.loans.shared.model.LoanTransaction>	lockLoanAccount(java.lang.String accountId, java.lang.String notes) Lock loan account
com.mambu.loans.shared.model.LoanTransaction	makeLoanRepayment(java.lang.String accountId, com.mambu.core.shared.model.Money amount, java.util.Date date, com.mambu.accounts.shared.model.TransactionDetails transactionDetails, java.util.List<com.mambu.core.shared.model.CustomFieldValue> customInformation, java.lang.String notes) Make Repayment for a loan account.
boolean	patchLoanAccount(com.mambu.loans.shared.model.LoanAccount loan) Update loan terms for an existent LoanAccount This API allows updating LoanAccount terms only.
com.mambu.loans.shared.model.LoanTransaction	postInterestRateChange(java.lang.String accountId, com.mambu.api.server.handler.loan.model.JSONTransactionRequest transactionRequest) Convenience method for updating/changing the interest rate on a loan account.
com.mambu.loans.shared.model.LoanAccount	postLoanAccountRestructureAction(java.lang.String accountId, com.mambu.api.server.handler.loan.model.JSONRestructureEntity restructureEntity) POST action for loan account.
com.mambu.loans.shared.model.LoanTransaction	postPaymentMade(java.lang.String accountId, com.mambu.api.server.handler.loan.model.JSONTransactionRequest transactionRequest) Convenience method for posting a payment made transaction on a loan account.
com.mambu.loans.shared.model.LoanAccount	refinanceLoanAccount(java.lang.String accountId, com.mambu.loans.shared.model.LoanAccount loanAccount, java.util.List<com.mambu.core.shared.model.CustomFieldValue> customFieldValues, com.mambu.api.server.handler.loan.model.RestructureDetails restructureDetails) Convenience method to Refinance loan account
com.mambu.loans.shared.model.LoanAccount	rejectLoanAccount(java.lang.String accountId, java.lang.String notes) Reject a loan account if the user has permission to reject loan accounts.
com.mambu.loans.shared.model.LoanAccount	requestApprovalLoanAccount(java.lang.String accountId, java.lang.String notes) Request Approval for a loan account to transition an account from a Partial Application state to a Pending Approval state
com.mambu.loans.shared.model.LoanAccount	rescheduleLoanAccount(java.lang.String accountId, com.mambu.loans.shared.model.LoanAccount loanAccount, java.util.List<com.mambu.core.shared.model.CustomFieldValue> customFieldValues, com.mambu.api.server.handler.loan.model.RestructureDetails restructureDetails) Convenience method to Reschedule loan account
com.mambu.loans.shared.model.LoanTransaction	reverseLoanTransaction(com.mambu.loans.shared.model.LoanTransaction originalTransaction, java.lang.String notes) Convenience method to Reverse loan transaction by providing the original loan transaction
com.mambu.loans.shared.model.LoanTransaction	reverseLoanTransaction(java.lang.String accountId, com.mambu.loans.shared.model.LoanTransactionType originalTransactionType, java.lang.String originalTransactionId, java.lang.String notes) Reverse loans transactions for a loan account
com.mambu.loans.shared.model.LoanAccount	undoApproveLoanAccount(java.lang.String accountId, java.lang.String notes) Undo Approve for a loan account
com.mambu.loans.shared.model.LoanAccount	undoCloseLoanAccount(com.mambu.loans.shared.model.LoanAccount loanAccount, java.lang.String notes) Undo Close Loan account.
com.mambu.loans.shared.model.LoanTransaction	undoDisburseLoanAccount(java.lang.String accountId, java.lang.String notes) Undo Disburse for a loan account.
java.util.List<com.mambu.loans.shared.model.LoanTransaction>	unlockLoanAccount(java.lang.String accountId, java.lang.String notes) Unlock loan account
com.mambu.loans.shared.model.LoanAccount	updateLoanAccount(com.mambu.loans.shared.model.LoanAccount loanAccount) Update an existent LoanAccount using LoanAccount object and sending it as a JSON API.
com.mambu.loans.shared.model.LoanAccount	updateLoanAccountFunds(java.lang.String accountId, java.util.List<com.mambu.accountsecurity.shared.model.InvestorFund> funds) Update funds for an existent Loan Account
com.mambu.loans.shared.model.LoanAccount	updateLoanAccountGuarantees(java.lang.String accountId, java.util.List<com.mambu.accountsecurity.shared.model.Guaranty> guarantees) Update guarantees for an existent Loan Account
com.mambu.loans.shared.model.LoanAccount	updateLoanAccountTranches(java.lang.String accountId, java.util.List<com.mambu.loans.shared.model.LoanTranche> tranches) Update tranches for an existent LoanAccount
com.mambu.loans.shared.model.LoanAccount	withdrawLoanAccount(java.lang.String accountId, java.lang.String notes) Withdraw (close) loan account if the user has permission to withdraw loan accounts.
com.mambu.loans.shared.model.LoanTransaction	writeOffLoanAccount(java.lang.String accountId, java.lang.String notes) Write of loan account

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CENTRE_ID

public static final java.lang.String CENTRE_ID

See Also:

Constant Field Values

SCHEDULE

public static final java.lang.String SCHEDULE

See Also:

Constant Field Values

Constructor Detail

LoansService

@Inject
public LoansService(MambuAPIService mambuAPIService)

Create a new loan service

Parameters:

mambuAPIService - the service responsible with the connection to the server

Method Detail

getLoanAccount

public com.mambu.loans.shared.model.LoanAccount getLoanAccount(java.lang.String accountId)
                                                        throws MambuApiException

Get a loan account with full details by its id

Parameters:

accountId - the id of the account

Returns:

the loan account

Throws:

MambuApiException

getLoanAccountWithSettlementAccounts

public com.mambu.api.server.handler.loan.model.JSONLoanAccountResponse getLoanAccountWithSettlementAccounts(java.lang.String accountId)
                                                                                                     throws MambuApiException

Get full loan account details, including settlement accounts

Parameters:

accountId - the id or encoded key of a loan account. Must not be null

Returns:

JSON loan account response with loan account details and settlement savings accounts included

Throws:

MambuApiException

getLoanAccountsForClient

public java.util.List<com.mambu.loans.shared.model.LoanAccount> getLoanAccountsForClient(java.lang.String clientId)
                                                                                  throws MambuApiException

Get all the loan accounts for a given client

Parameters:

clientId - the id of the client

Returns:

the client's list of loan accounts

Throws:

MambuApiException

getLoanAccountsForGroup

public java.util.List<com.mambu.loans.shared.model.LoanAccount> getLoanAccountsForGroup(java.lang.String groupId)
                                                                                 throws MambuApiException

Get all the loan accounts for a given group

Parameters:

groupId - the id of the group

Returns:

the group's list of loan accounts

Throws:

MambuApiException

approveLoanAccount

public com.mambu.loans.shared.model.LoanAccount approveLoanAccount(java.lang.String accountId,
                                                                   java.lang.String notes)
                                                            throws MambuApiException

Approve a loan account if the user has permission to approve loans, the maximum exposure is not exceeded for the client, the account was in Pending Approval state and if the number of loans is not exceeded

Parameters:

accountId - the id of the account

notes - transaction notes

Returns:

loanAccount Note: The account object in the response doesn't contain custom fields

Throws:

MambuApiException

requestApprovalLoanAccount

public com.mambu.loans.shared.model.LoanAccount requestApprovalLoanAccount(java.lang.String accountId,
                                                                           java.lang.String notes)
                                                                    throws MambuApiException

Request Approval for a loan account to transition an account from a Partial Application state to a Pending Approval state

Parameters:

accountId - the encoded key or id of the account. Must not be null

notes - transaction notes

Returns:

loan account

Throws:

MambuApiException

undoApproveLoanAccount

public com.mambu.loans.shared.model.LoanAccount undoApproveLoanAccount(java.lang.String accountId,
                                                                       java.lang.String notes)
                                                                throws MambuApiException

Undo Approve for a loan account

Parameters:

accountId - the id of the account

notes - transaction notes

Returns:

loanAccount Note: The account object in the response doesn't contain custom fields

Throws:

MambuApiException

lockLoanAccount

public java.util.List<com.mambu.loans.shared.model.LoanTransaction> lockLoanAccount(java.lang.String accountId,
                                                                                    java.lang.String notes)
                                                                             throws MambuApiException

Lock loan account

Parameters:

accountId - the id of the account

notes - transaction notes

Returns:

a list of loan transactions performed when locking account

Throws:

MambuApiException

unlockLoanAccount

public java.util.List<com.mambu.loans.shared.model.LoanTransaction> unlockLoanAccount(java.lang.String accountId,
                                                                                      java.lang.String notes)
                                                                               throws MambuApiException

Unlock loan account

Parameters:

accountId - the id of the account

notes - transaction notes

Returns:

a list of loan transactions performed when unlocking account

Throws:

MambuApiException

writeOffLoanAccount

public com.mambu.loans.shared.model.LoanTransaction writeOffLoanAccount(java.lang.String accountId,
                                                                        java.lang.String notes)
                                                                 throws MambuApiException

Write of loan account

Parameters:

accountId - the encoded key or id of the account. Must not be null

notes - transaction notes

Returns:

loan transaction

Throws:

MambuApiException

deleteLoanAccount

public boolean deleteLoanAccount(java.lang.String accountId)
                          throws MambuApiException

Delete Loan Account by its Id

Parameters:

accountId -

Returns:

status

Throws:

MambuApiException

rejectLoanAccount

public com.mambu.loans.shared.model.LoanAccount rejectLoanAccount(java.lang.String accountId,
                                                                  java.lang.String notes)
                                                           throws MambuApiException

Reject a loan account if the user has permission to reject loan accounts.

Parameters:

accountId - the id of the account. Mandatory

notes - the reason why the account was reject

Returns:

LoanAccount

Throws:

MambuApiException

withdrawLoanAccount

public com.mambu.loans.shared.model.LoanAccount withdrawLoanAccount(java.lang.String accountId,
                                                                    java.lang.String notes)
                                                             throws MambuApiException

Withdraw (close) loan account if the user has permission to withdraw loan accounts.

Parameters:

accountId - the id of the account. Mandatory

notes - the reason why the account was withdrawn

Returns:

LoanAccount

Throws:

MambuApiException

closeLoanAccount

public com.mambu.loans.shared.model.LoanAccount closeLoanAccount(java.lang.String accountId,
                                                                 java.lang.String notes)
                                                          throws MambuApiException

Close loan account with all obligations met

Parameters:

accountId - the id of the account. Must not be nul

notes - the reason why the account is closed

Returns:

LoanAccount

Throws:

MambuApiException

closeLoanAccount

public com.mambu.loans.shared.model.LoanAccount closeLoanAccount(java.lang.String accountId,
                                                                 APIData.CLOSER_TYPE closerType,
                                                                 java.lang.String notes)
                                                          throws MambuApiException

Close Loan account specifying the type of closer (withdraw, reject or close)

Parameters:

accountId - the id of the account to close. Mandatory

closerType - type of closer (withdraw or reject). Mandatory

notes - closer reason notes

Returns:

loan account

Throws:

MambuApiException

undoCloseLoanAccount

public com.mambu.loans.shared.model.LoanAccount undoCloseLoanAccount(com.mambu.loans.shared.model.LoanAccount loanAccount,
                                                                     java.lang.String notes)
                                                              throws MambuApiException

Undo Close Loan account. Supports UNDO_CLOSE, UNDO_WITHDRAWN, UNDO_REJECT

Parameters:

loanAccount - closed loan account. Must not be null and must be in one of the supported closed states.

notes - undo closer reason notes

Returns:

loan account

Throws:

MambuApiException

disburseLoanAccount

public com.mambu.loans.shared.model.LoanTransaction disburseLoanAccount(java.lang.String accountId,
                                                                        com.mambu.core.shared.model.Money amount,
                                                                        com.mambu.loans.shared.model.DisbursementDetails disbursementDetails,
                                                                        java.lang.String notes)
                                                                 throws MambuApiException

Convenience method to Disburse loan account using JSON Transaction and specifying Disbursement Details. The JSON disburse API request supports providing transaction details and disbursement fees. See MBU-11837

Parameters:

accountId - loan account id or encoded key. Must not be null

amount - disbursement amount.

disbursementDetails - disbursement details for the loan account containing optional transaction custom fields

notes - transaction notes

Returns:

loan transaction

Throws:

MambuApiException

disburseLoanAccount

public com.mambu.loans.shared.model.LoanTransaction disburseLoanAccount(java.lang.String accountId,
                                                                        com.mambu.core.shared.model.Money amount,
                                                                        com.mambu.loans.shared.model.DisbursementDetails disbursementDetails,
                                                                        java.util.List<com.mambu.core.shared.model.CustomFieldValue> customInformation,
                                                                        java.lang.String notes)
                                                                 throws MambuApiException

Disburse loan account using JSON disburse API request specifying disbursement details and transaction custom information. The JSON disburse API request supports providing transaction details and disbursement fees.

Parameters:

accountId - loan account id or encoded key. Must not be null

amount - disbursement amount.

disbursementDetails - disbursement details for the loan account

customInformation - transaction custom fields

notes - transaction notes

Returns:

loan transaction

Throws:

MambuApiException

undoDisburseLoanAccount

public com.mambu.loans.shared.model.LoanTransaction undoDisburseLoanAccount(java.lang.String accountId,
                                                                            java.lang.String notes)
                                                                     throws MambuApiException

Undo Disburse for a loan account. If the account has multiple tranches, reverses the last tranche

Parameters:

accountId - account encoded key or id. Must not be null

notes - transaction notes

Returns:

Loan Transaction

Throws:

MambuApiException

postLoanAccountRestructureAction

public com.mambu.loans.shared.model.LoanAccount postLoanAccountRestructureAction(java.lang.String accountId,
                                                                                 com.mambu.api.server.handler.loan.model.JSONRestructureEntity restructureEntity)
                                                                          throws MambuApiException

POST action for loan account. Currently REFINANCE and RESCHEDULE actions are supported

Parameters:

accountId - the encoded key or id of the original loan account. Must not be null

restructureEntity - restructure entity containing the action, loan account and restructure details. Must not be null. Loan account must not be null. Action must not be null

Returns:

new loan account

Throws:

MambuApiException

rescheduleLoanAccount

public com.mambu.loans.shared.model.LoanAccount rescheduleLoanAccount(java.lang.String accountId,
                                                                      com.mambu.loans.shared.model.LoanAccount loanAccount,
                                                                      java.util.List<com.mambu.core.shared.model.CustomFieldValue> customFieldValues,
                                                                      com.mambu.api.server.handler.loan.model.RestructureDetails restructureDetails)
                                                               throws MambuApiException

Convenience method to Reschedule loan account

Parameters:

accountId - the encoded key or id of the original loan account. Must not be null

loanAccount - loan account with new details. Must not be null.

customFieldValues - optional custom field values. Allowed are any of the original account custom fields, regardless of the new product and any new custom fields applicable to the new product

restructureDetails - optional restructure details

Returns:

new loan account

Throws:

MambuApiException

refinanceLoanAccount

public com.mambu.loans.shared.model.LoanAccount refinanceLoanAccount(java.lang.String accountId,
                                                                     com.mambu.loans.shared.model.LoanAccount loanAccount,
                                                                     java.util.List<com.mambu.core.shared.model.CustomFieldValue> customFieldValues,
                                                                     com.mambu.api.server.handler.loan.model.RestructureDetails restructureDetails)
                                                              throws MambuApiException

Convenience method to Refinance loan account

Parameters:

accountId - the encoded key or id of the original loan account. Must not be null

loanAccount - loan account with new details. Must not be null

customFieldValues - optional custom field values. Allowed are any of the original account custom fields, regardless of the new product and any new custom fields applicable to the new product

restructureDetails - mandatory restructure details. Must not be null

Returns:

new loan account

Throws:

MambuApiException

getLoanAccountDetails

public com.mambu.loans.shared.model.LoanAccount getLoanAccountDetails(java.lang.String accountId)
                                                               throws MambuApiException

Get a loan account with Details by its id

Parameters:

accountId - the id of the account

Returns:

the loan account Note: the returned account doesn't have guarantees information.

Throws:

MambuApiException

createLoanAccount

public com.mambu.loans.shared.model.LoanAccount createLoanAccount(com.mambu.loans.shared.model.LoanAccount loanAccount)
                                                           throws MambuApiException

Create new LoanAccount using LoanAccount object. This API allows creating LoanAccount with details, including creating custom fields. The underlying API implementation uses JSONLoanAccount object.

Parameters:

loanAccount - LoanAccount object. LoanAccount encodedKey must be null for account creation

Returns:

newly created loan account with full details including custom fields

Throws:

MambuApiException

java.lang.IllegalArgumentException

updateLoanAccount

public com.mambu.loans.shared.model.LoanAccount updateLoanAccount(com.mambu.loans.shared.model.LoanAccount loanAccount)
                                                           throws MambuApiException

Update an existent LoanAccount using LoanAccount object and sending it as a JSON API. This API allows updating LoanAccount with details. As of Mambu 3.4 only custom fields can be updated.

Parameters:

loanAccount - LoanAccount object containing LoanAccount. LoanAccount encodedKey or id must be NOT null for account update

Returns:

updated LoanAccount object with updated custom fields

Throws:

MambuApiException

java.lang.IllegalArgumentException

patchLoanAccount

public boolean patchLoanAccount(com.mambu.loans.shared.model.LoanAccount loan)
                         throws MambuApiException

Update loan terms for an existent LoanAccount This API allows updating LoanAccount terms only. Use updateLoanAccount() to update custom fields for a loan account

Parameters:

loan - LoanAccount object. Either LoanAccount encoded key or its ID must be NOT null for updating account Note that only some loan terms can be updated. See MBU-7758 for details. Loan Account fields available for patching are: loanAmount, interestRate. interestSpread, repaymentInstallments, repaymentPeriodCount, repaymentPeriodUnit, expectedDisbursementDate, firstRepaymentDate, gracePeriod, principalRepaymentInterval, penaltyRate, periodicPayment

Returns:

success or failure

Throws:

MambuApiException

java.lang.IllegalArgumentException

updateLoanAccountTranches

public com.mambu.loans.shared.model.LoanAccount updateLoanAccountTranches(java.lang.String accountId,
                                                                          java.util.List<com.mambu.loans.shared.model.LoanTranche> tranches)
                                                                   throws MambuApiException

Update tranches for an existent LoanAccount

Parameters:

accountId - the encoded key or id of the loan account. Must not be null.

tranches - tranches for a loan account. Must not be null. Existent tranches with a valid "encodedKey" field will be updated. Tranches with null "encodedKey" are treated as new tranches and will be created. Tranches that are not specified in the call will be deleted. Already disbursed tranches cannot be changed or deleted, they can be omitted when updating tranches.

Returns:

loan account with updated tranches

Throws:

MambuApiException

java.lang.IllegalArgumentException

updateLoanAccountFunds

public com.mambu.loans.shared.model.LoanAccount updateLoanAccountFunds(java.lang.String accountId,
                                                                       java.util.List<com.mambu.accountsecurity.shared.model.InvestorFund> funds)
                                                                throws MambuApiException

Update funds for an existent Loan Account

Parameters:

accountId - the encoded key or id of the loan account. Account must not yet be disbursed. Must not be null.

funds - funds to be updated. Must not be null

Returns:

loan account with updated funds

Throws:

MambuApiException

java.lang.IllegalArgumentException

updateLoanAccountGuarantees

public com.mambu.loans.shared.model.LoanAccount updateLoanAccountGuarantees(java.lang.String accountId,
                                                                            java.util.List<com.mambu.accountsecurity.shared.model.Guaranty> guarantees)
                                                                     throws MambuApiException

Update guarantees for an existent Loan Account

Parameters:

accountId - the encoded key or id of the loan account. Must not be null.

guarantees - guarantees to be updated. Must not be null. The guarantees that have encodedKey will be edited. If the encodedKey is not present, a new guaranty will be created. Existing guarantees that are not specified in the update call will be deleted

Returns:

loan account with updated guarantees

Throws:

MambuApiException

java.lang.IllegalArgumentException

getLoanAccountTransactions

public java.util.List<com.mambu.loans.shared.model.LoanTransaction> getLoanAccountTransactions(java.lang.String accountId,
                                                                                               java.lang.String offset,
                                                                                               java.lang.String limit)
                                                                                        throws MambuApiException

Get loan account Transactions by Loan id and offset and limit

Parameters:

accountId - the id of the account offset - first transaction number limit - last transaction number Note: if offset and limit both equal null, all transactions are returned (Note: transaction are sorted by date)

offset - pagination offset. If not null it must be an integer greater or equal to zero

limit - pagination limit. If not null it must be an integer greater than zero

Returns:

the list of loan account transactions

Throws:

MambuApiException

getLoanTransactions

@Deprecated
public java.util.List<com.mambu.loans.shared.model.LoanTransaction> getLoanTransactions(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints,
                                                                                                    java.lang.String offset,
                                                                                                    java.lang.String limit)
                                                                                             throws MambuApiException

Deprecated.

Get loan transactions by specifying filter constraints Note: This method is deprecated, you may use the getLoanTransactionsWithFullDetails in order to obtain loan transaction with full details (custom fields included) or getLoanTransactionsWithBasicDetails to obtain the loan transactions in basic details level.

Parameters:

filterConstraints - filter constraints. Must not be null

offset - pagination offset. If not null it must be an integer greater or equal to zero

limit - pagination limit. If not null it must be an integer greater than zero

Returns:

list of loan transactions matching filter constraint

Throws:

MambuApiException - in case something failed during transaction fetching

getLoanTransactionsWithFullDetails

public java.util.List<com.mambu.loans.shared.model.LoanTransaction> getLoanTransactionsWithFullDetails(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints,
                                                                                                       java.lang.String offset,
                                                                                                       java.lang.String limit)
                                                                                                throws MambuApiException

Get loan transactions by specifying filter constraints (including custom fields)

Parameters:

filterConstraints - filter constraints. Must not be null

offset - pagination offset. If not null it must be an integer greater or equal to zero

limit - pagination limit. If not null it must be an integer greater than zero

Returns:

list of loan transactions matching filter constraint

Throws:

MambuApiException - in case something failed during transaction fetching

getLoanTransactionsWithBasicDetails

public java.util.List<com.mambu.loans.shared.model.LoanTransaction> getLoanTransactionsWithBasicDetails(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints,
                                                                                                        java.lang.String offset,
                                                                                                        java.lang.String limit)
                                                                                                 throws MambuApiException

Get loan transactions by specifying filter constraints with basic details level (no custom fields)

Parameters:

filterConstraints - filter constraints. Must not be null

offset - pagination offset. If not null it must be an integer greater or equal to zero

limit - pagination limit. If not null it must be an integer greater than zero

Returns:

list of loan transactions matching filter constraint

Throws:

MambuApiException - in case something failed during transaction fetching

makeLoanRepayment

public com.mambu.loans.shared.model.LoanTransaction makeLoanRepayment(java.lang.String accountId,
                                                                      com.mambu.core.shared.model.Money amount,
                                                                      java.util.Date date,
                                                                      com.mambu.accounts.shared.model.TransactionDetails transactionDetails,
                                                                      java.util.List<com.mambu.core.shared.model.CustomFieldValue> customInformation,
                                                                      java.lang.String notes)
                                                               throws MambuApiException

Make Repayment for a loan account. POST as JSON transaction

Parameters:

accountId - account ID or encoded key. Must not be null

amount - transaction amount

date - transaction date

customInformation - transaction custom fields

notes - transaction notes

transactionDetails - transaction details, including transaction channel and channel fields

Returns:

loan transaction

Throws:

MambuApiException

applyFeeToLoanAccount

public com.mambu.loans.shared.model.LoanTransaction applyFeeToLoanAccount(java.lang.String accountId,
                                                                          java.lang.String amount,
                                                                          java.lang.String repaymentNumber,
                                                                          java.lang.String notes)
                                                                   throws MambuApiException

Apply FEE to a loan account

Parameters:

accountId - the id or encoded key of the account

amount - transaction amount

repaymentNumber - repayment number

notes - notes

Returns:

Loan Transaction

Throws:

MambuApiException

applyFeeToLoanAccount

public com.mambu.loans.shared.model.LoanTransaction applyFeeToLoanAccount(java.lang.String accountId,
                                                                          java.util.List<com.mambu.loans.shared.model.CustomPredefinedFee> fees,
                                                                          java.lang.Integer repaymentNumber,
                                                                          java.lang.String notes)
                                                                   throws MambuApiException

Apply Predefined Fee to a loan account

Parameters:

accountId - account id or encoded key. Must not be null

fees - fees. Only Manual Predefined Fees are currently supported. Must not be null. Must contain exactly one fee. Note: Once MBU-12865 is implemented this method will support both predefined fees and arbitrary fees and the (@link #applyFeeToLoanAccount(String, String, String, String)} method used only for arbitrary fees can be deprecated

repaymentNumber - repayment number. Can be specified only for fixed loans

notes - notes

Returns:

loan transaction

Throws:

MambuApiException

executeJSONTransactionRequest

public com.mambu.loans.shared.model.LoanTransaction executeJSONTransactionRequest(java.lang.String accountId,
                                                                                  com.mambu.loans.shared.model.LoanTransactionType transactionType,
                                                                                  com.mambu.api.server.handler.loan.model.JSONTransactionRequest transactionRequest)
                                                                           throws MambuApiException

Convenience method to execute Loan Account transaction by providing JSONTransactionRequest

Parameters:

accountId - account id or encoded key. Must not be null

transactionType - loan transaction type. Must not be null. Supported types are: DISBURSMENT, FEE, REPAYMENT and INTEREST_RATE_CHANGED

transactionRequest - JSON transaction request

Returns:

loan transaction

Throws:

MambuApiException

postInterestRateChange

public com.mambu.loans.shared.model.LoanTransaction postInterestRateChange(java.lang.String accountId,
                                                                           com.mambu.api.server.handler.loan.model.JSONTransactionRequest transactionRequest)
                                                                    throws MambuApiException

Convenience method for updating/changing the interest rate on a loan account.

Parameters:

accountId - the id of the account.

transactionRequest - JSON transaction request

Returns:

loan transaction

Throws:

MambuApiException

postPaymentMade

public com.mambu.loans.shared.model.LoanTransaction postPaymentMade(java.lang.String accountId,
                                                                    com.mambu.api.server.handler.loan.model.JSONTransactionRequest transactionRequest)
                                                             throws MambuApiException

Convenience method for posting a payment made transaction on a loan account.

Parameters:

accountId - the id of the account.

transactionRequest - JSON transaction request

Returns:

newly posted transaction

Throws:

MambuApiException

applyInterestToLoanAccount

public com.mambu.loans.shared.model.LoanTransaction applyInterestToLoanAccount(java.lang.String accountId,
                                                                               java.util.Date date,
                                                                               java.lang.String notes)
                                                                        throws MambuApiException

Apply Interest to a loan account on a given date

Parameters:

accountId - the id of the account. Mandatory

date - date. Mandatory.

notes - notes

Returns:

Loan Transaction

Throws:

MambuApiException

getLoanAccountsByBranchCentreOfficerState

public java.util.List<com.mambu.loans.shared.model.LoanAccount> getLoanAccountsByBranchCentreOfficerState(java.lang.String branchId,
                                                                                                          java.lang.String centreId,
                                                                                                          java.lang.String creditOfficerUserName,
                                                                                                          java.lang.String accountState,
                                                                                                          java.lang.String offset,
                                                                                                          java.lang.String limit)
                                                                                                   throws MambuApiException

Get the loan accounts by branch id, centreId, credit officer, accountState

Parameters:

branchId - branchID The ID of the branch to which the loan accounts are assigned to

centreId - The ID of the centre to which the loan accounts are assigned to. If both branchId and centreId are provided then this centre must be assigned to the branchId

creditOfficerUserName - The username of the credit officer to whom the loans are assigned to

accountState - The desired state of the accounts to filter on (eg: APPROVED)

offset - pagination offset. If not null it must be an integer greater or equal to zero

limit - pagination limit. If not null it must be an integer greater than zero

Returns:

the list of loan accounts matching these parameters

Throws:

MambuApiException

getLoanAccountsByBranchOfficerState

public java.util.List<com.mambu.loans.shared.model.LoanAccount> getLoanAccountsByBranchOfficerState(java.lang.String branchId,
                                                                                                    java.lang.String creditOfficerUserName,
                                                                                                    java.lang.String accountState,
                                                                                                    java.lang.String offset,
                                                                                                    java.lang.String limit)
                                                                                             throws MambuApiException

Get loan accounts by branch id, credit officer, accountState. This is a convenience method to filter loan accounts without specifying centre id (centre id filtering is available only since Mambu 3.7,see MBU-5946)

Parameters:

branchId - branchID The ID of the branch to which the loan accounts are assigned to

creditOfficerUserName - The username of the credit officer to whom the loans are assigned to

accountState - The desired state of the accounts to filter on (eg: APPROVED)

offset - pagination offset. If not null it must be an integer greater or equal to zero

limit - pagination limit. If not null it must be an integer greater than zero

Returns:

the list of loan accounts matching these parameters

Throws:

MambuApiException

getLoanAccounts

public java.util.List<com.mambu.loans.shared.model.LoanAccount> getLoanAccounts(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints,
                                                                                java.lang.String offset,
                                                                                java.lang.String limit)
                                                                         throws MambuApiException

Get loan accounts by specifying filter constraints

Parameters:

filterConstraints - filter constraints. Must not be null

offset - pagination offset. If not null it must be an integer greater or equal to zero

limit - pagination limit. If not null it must be an integer greater than zero

Returns:

list of loan accounts matching filter constraints

Throws:

MambuApiException

getLoanProducts

public java.util.List<com.mambu.loans.shared.model.LoanProduct> getLoanProducts(java.lang.String offset,
                                                                                java.lang.String limit)
                                                                         throws MambuApiException

Get a list of Loan Products

Parameters:

offset - pagination offset. If not null it must be an integer greater or equal to zero

limit - pagination limit. If not null it must be an integer greater than zero

Returns:

the List of Loan Products

Throws:

MambuApiException

getLoanProduct

public com.mambu.loans.shared.model.LoanProduct getLoanProduct(java.lang.String productId)
                                                        throws MambuApiException

Get a Loan Product by Product id

Parameters:

productId - the id of the loan product

Returns:

the Loan Product

Throws:

MambuApiException

getLoanProductSchedule

public java.util.List<com.mambu.loans.shared.model.Repayment> getLoanProductSchedule(java.lang.String productId,
                                                                                     com.mambu.loans.shared.model.LoanAccount account)
                                                                              throws MambuApiException

Get repayment schedule preview for a Loan Product

Parameters:

productId - the id of the loan product. Must not be null.

account - loan account containing parameters for determining loan schedule Only the following loan account parameters are currently supported: loanAmount (mandatory), anticipatedDisbursement, firstRepaymentDate, interestRate, repaymentInstallments, gracePeriod, repaymentPeriodUnit, repaymentPeriodCount, principalRepaymentInterval, fixedDaysOfMonth Loan repayment schedule preview is not available for Revolving Credit products. See MBU-10545 See MBU-6789, MBU-7676 and MBU-10802 for more details

Returns:

the List of Repayments

Throws:

MambuApiException

getLoanProductSchedule

public java.util.List<com.mambu.loans.shared.model.Repayment> getLoanProductSchedule(java.lang.String productId,
                                                                                     com.mambu.loans.shared.model.LoanAccount account,
                                                                                     ScheduleQueryParams queryParams)
                                                                              throws MambuApiException

Get repayment schedule preview for a Loan Product

Parameters:

productId - the id of the loan product. Must not be null.

account - loan account containing parameters for determining loan schedule Only the following loan account parameters are currently supported: loanAmount (mandatory), anticipatedDisbursement, firstRepaymentDate, interestRate, repaymentInstallments, gracePeriod, repaymentPeriodUnit, repaymentPeriodCount, principalRepaymentInterval, fixedDaysOfMonth

queryParams - some extra schedule parameters to be used with for preview i.e periodicPayment, organizationCommission

Returns:

the List of Repayments (the preview)

Throws:

MambuApiException - in case something goes wrong while obtaining the preview

reverseLoanTransaction

public com.mambu.loans.shared.model.LoanTransaction reverseLoanTransaction(java.lang.String accountId,
                                                                           com.mambu.loans.shared.model.LoanTransactionType originalTransactionType,
                                                                           java.lang.String originalTransactionId,
                                                                           java.lang.String notes)
                                                                    throws MambuApiException

Reverse loans transactions for a loan account

Parameters:

accountId - the id or encoded key of the loan account. Mandatory

originalTransactionType - Original transaction type to be reversed. The following transaction types can be currently reversed: PENALTY_APPLIED (in 3.13), REPAYMENT, INTEREST_APPLIED, FEE (since 4.2). Must not be null.

originalTransactionId - the id or the encodedKey of the transaction to be reversed. Must not be null.

notes - transaction notes

Returns:

Loan Transaction

Throws:

MambuApiException

reverseLoanTransaction

public com.mambu.loans.shared.model.LoanTransaction reverseLoanTransaction(com.mambu.loans.shared.model.LoanTransaction originalTransaction,
                                                                           java.lang.String notes)
                                                                    throws MambuApiException

Convenience method to Reverse loan transaction by providing the original loan transaction

Parameters:

originalTransaction - The following loan transactions types currently can be reversed: PENALTY_APPLIED, REPAYMENT, FEE, INTEREST_APPLIED. Mandatory.

notes - transaction notes

Returns:

Loan Transaction

Throws:

MambuApiException

addSettlementAccount

public java.lang.Boolean addSettlementAccount(java.lang.String loanAccountKey,
                                              java.lang.String savingsAccountKey)
                                       throws MambuApiException

Updates or links a settlement account with a loan account. Call: POST : /api/loans/{LOAN_KEY}/settlementAccounts/{SAVINGS_KEY} Sample call: POST /api/loans/8a8086a756dfa8f30156e0bdbf060259/settlementAccounts/8a80866357976c62015798e0b60e00d0 Sample response: {"returnCode":0,"returnStatus":"SUCCESS"} Available since Mambu 4.4

Parameters:

loanAccountKey - A string key representing the ID or the encoding key of the loan account. Must NOT be NULL.

savingsAccountKey - A string key representing the ID or the encoding key of the saving account Must NOT be NULL.

Returns:

true if it succeeds linking the two accounts of the keys passed as parameters in a call to this method.

Throws:

MambuApiException

deleteSettlementAccount

public java.lang.Boolean deleteSettlementAccount(java.lang.String loanAccountKey,
                                                 java.lang.String savingAccountKey)
                                          throws MambuApiException

Deletes the link between the loan account and saving account (known as settlement account) Call: DELETE /api/loans/{LOAN_KEY}/settlementAccounts/{SAVINGS_KEY} Sample call: DELETE /api/loans/STLACC_7832648/settlementAccounts/8a80866357976c62015798e0b60e00d0 Sample response: {"returnCode":0,"returnStatus":"SUCCESS"} Available since Mambu 4.4

Parameters:

loanAccountKey - A string key representing the ID or the encoding key of the loan account. Must NOT be NULL.

savingAccountKey - A string key representing the ID or the encoding key of the saving account. Must NOT be NULL.

Returns:

true if the linkage succeeded.

Throws:

MambuApiException