com.mambu.apisdk.services

Class LinesOfCreditService

java.lang.Object

com.mambu.apisdk.services.LinesOfCreditService

public class LinesOfCreditService
extends java.lang.Object

Service class which handles API operations for Lines of Credit (LoC) The following APIs are supported: Get all lines of credit Get a specific line of credit by its ID/key Get all lines of credits for a client or a group Get all loan and savings accounts for a specific line of credit Add accounts to lines of credit Remove accounts from lines of credit * More details in MBU-8607, MBU-8413, MBU-8414, MBU-8415, MBU-8417, MBU-9864, MBU-9873

Constructor Summary

Constructors

Constructor and Description
LinesOfCreditService(MambuAPIService mambuAPIService) Create a new Lines Of Credit service

Method Summary

Modifier and Type	Method and Description
com.mambu.loans.shared.model.LoanAccount	addLoanAccount(java.lang.String lineOfCreditId, java.lang.String loanAccountId) Add Loan Account to a line of credit
com.mambu.savings.shared.model.SavingsAccount	addSavingsAccount(java.lang.String lineOfCreditId, java.lang.String savingsAccountId) Add Savings Account to a line of credit
com.mambu.linesofcredit.shared.model.LineOfCredit	createLineOfCredit(com.mambu.linesofcredit.shared.model.LineOfCredit lineOfCredit) Creates a line of credit (Credit arrangement) for a client or a group, depending on the key set on the LineOfCredit.
boolean	deleteAccount(java.lang.String lineOfCreditId, com.mambu.accounts.shared.model.Account.Type accountType, java.lang.String accountId) Delete Account from a line of credit
boolean	deleteLoanAccount(java.lang.String lineOfCreditId, java.lang.String loanAccountId) Convenience method to Delete Loan Account from a line of credit
boolean	deleteSavingsAccount(java.lang.String lineOfCreditId, java.lang.String savingsAccountId) Convenience method to Delete Savings Account from a line of credit
com.mambu.linesofcredit.shared.model.AccountsFromLineOfCredit	getAccountsForLineOfCredit(java.lang.String lineOfCreditId) Get all accounts for a line of credit
java.util.List<com.mambu.linesofcredit.shared.model.LineOfCredit>	getAllLinesOfCredit(java.lang.Integer offset, java.lang.Integer limit) Get all lines of credit defined for all clients and groups Call sample: GET api/linesofcredit Available since 3.11.
java.util.List<com.mambu.linesofcredit.shared.model.LineOfCredit>	getAllLinesOfCreditWithDetails(java.lang.Integer offset, java.lang.Integer limit) Get all lines of credit defined for all clients and groups with all the details (including custom fields) Call sample: GET api/linesofcredit?fullDetails=true Available since 4.5.
java.util.List<com.mambu.linesofcredit.shared.model.LineOfCredit>	getClientLinesOfCredit(java.lang.String clientId, java.lang.Integer offset, java.lang.Integer limit) Convenience method to Get lines of credit for a Client
java.util.List<com.mambu.linesofcredit.shared.model.LineOfCredit>	getClientLinesOfCreditDetails(java.lang.String clientId, java.lang.Integer offset, java.lang.Integer limit) Convenience method to Get lines of credit with all details (including custom fields) for a Client Example: GET /api/clients/{clientId}/linesofcredit?fullDetails=true Available since 4.5.
java.util.List<com.mambu.linesofcredit.shared.model.LineOfCredit>	getGroupLinesOfCredit(java.lang.String groupId, java.lang.Integer offset, java.lang.Integer limit) Convenience method to Get lines of credit for a Group Example: GET /api/groups/{groupId}/linesofcredit Available since 3.11.
java.util.List<com.mambu.linesofcredit.shared.model.LineOfCredit>	getGroupLinesOfCreditDetails(java.lang.String groupId, java.lang.Integer offset, java.lang.Integer limit) Convenience method to Get lines of credit for a Group with all the details (including custom fields) Example: GET /api/groups/{groupId}/linesofcredit?fullDetails=true Available since 4.5.
com.mambu.linesofcredit.shared.model.LineOfCredit	getLineOfCredit(java.lang.String lineOfCreditId) Get line of credit
com.mambu.linesofcredit.shared.model.LineOfCredit	getLineOfCreditDetails(java.lang.String lineOfCreditId) Gets the details of a line of credit including custom fields information GET api/linesofcredit/{id}?fullDetails=true Response example: {"lineOfCredit":{"encodedKey":"abc123","id":"FVT160", "amount":"5000",..
java.util.List<com.mambu.linesofcredit.shared.model.LineOfCredit>	getLinesOfCredit(MambuEntityType customerType, java.lang.String customerId, java.lang.Integer offset, java.lang.Integer limit, boolean requiresFullDetails) Get lines of credit for a Client or a Group
boolean	patchLinesOfCredit(com.mambu.linesofcredit.shared.model.LineOfCredit lineOfCredit) Patches a line of credit.

Methods inherited from class java.lang.Object

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

Constructor Detail

LinesOfCreditService

@Inject
public LinesOfCreditService(MambuAPIService mambuAPIService)

Create a new Lines Of Credit service

Parameters:

mambuAPIService - the service responsible with the connection to the server

Method Detail

getAllLinesOfCredit

public java.util.List<com.mambu.linesofcredit.shared.model.LineOfCredit> getAllLinesOfCredit(java.lang.Integer offset,
                                                                                             java.lang.Integer limit)
                                                                                      throws MambuApiException

Get all lines of credit defined for all clients and groups Call sample: GET api/linesofcredit Available since 3.11. See MBU-8414

Parameters:

offset - pagination offset. If null, Mambu default (zero) will be used

limit - pagination limit. If null, Mambu default will be used

Returns:

a list of all Lines of Credit

Throws:

MambuApiException

getAllLinesOfCreditWithDetails

public java.util.List<com.mambu.linesofcredit.shared.model.LineOfCredit> getAllLinesOfCreditWithDetails(java.lang.Integer offset,
                                                                                                        java.lang.Integer limit)
                                                                                                 throws MambuApiException

Get all lines of credit defined for all clients and groups with all the details (including custom fields) Call sample: GET api/linesofcredit?fullDetails=true Available since 4.5. See JSDK-88

Parameters:

offset - pagination offset. If null, Mambu default (zero) will be used

limit - pagination limit. If null, Mambu default will be used

Returns:

a list of all Lines of Credit having all the details

Throws:

MambuApiException

getLineOfCredit

public com.mambu.linesofcredit.shared.model.LineOfCredit getLineOfCredit(java.lang.String lineOfCreditId)
                                                                  throws MambuApiException

Get line of credit

Parameters:

lineOfCreditId - the id or the encoded key of a Line Of Credit. Mandatory. Must not be null

Returns:

Line of Credit

Throws:

MambuApiException

getLineOfCreditDetails

public com.mambu.linesofcredit.shared.model.LineOfCredit getLineOfCreditDetails(java.lang.String lineOfCreditId)
                                                                         throws MambuApiException

Gets the details of a line of credit including custom fields information GET api/linesofcredit/{id}?fullDetails=true Response example: {"lineOfCredit":{"encodedKey":"abc123","id":"FVT160", "amount":"5000",.. }} Available since 4.5.

Parameters:

lineOfCreditId - the id or the encoded key of a Line Of Credit. Mandatory. Must not be null

Returns:

Line of Credit with all the details including custom field values

Throws:

MambuApiException

getLinesOfCredit

public java.util.List<com.mambu.linesofcredit.shared.model.LineOfCredit> getLinesOfCredit(MambuEntityType customerType,
                                                                                          java.lang.String customerId,
                                                                                          java.lang.Integer offset,
                                                                                          java.lang.Integer limit,
                                                                                          boolean requiresFullDetails)
                                                                                   throws MambuApiException

Get lines of credit for a Client or a Group

Parameters:

customerType - customer type (Client or Group). Must be either MambuEntityType.CLIENT or MambuEntityType.GROUP. Mandatory. Must not be null.

customerId - the encoded key or id of the customer. Mandatory. Must not be null.

offset - pagination offset. If null, Mambu default (zero) will be used

limit - pagination limit. If null, Mambu default will be used

Returns:

the List of Lines of Credit

Throws:

MambuApiException

getClientLinesOfCredit

public java.util.List<com.mambu.linesofcredit.shared.model.LineOfCredit> getClientLinesOfCredit(java.lang.String clientId,
                                                                                                java.lang.Integer offset,
                                                                                                java.lang.Integer limit)
                                                                                         throws MambuApiException

Convenience method to Get lines of credit for a Client

Parameters:

clientId - client ID. Mandatory. Must not be null.

offset - pagination offset.

limit - pagination limit.

Returns:

the List of Lines of Credit

Throws:

MambuApiException

getClientLinesOfCreditDetails

public java.util.List<com.mambu.linesofcredit.shared.model.LineOfCredit> getClientLinesOfCreditDetails(java.lang.String clientId,
                                                                                                       java.lang.Integer offset,
                                                                                                       java.lang.Integer limit)
                                                                                                throws MambuApiException

Convenience method to Get lines of credit with all details (including custom fields) for a Client Example: GET /api/clients/{clientId}/linesofcredit?fullDetails=true Available since 4.5. See JSDK-88

Parameters:

clientId - the ID of the client

offset - pagination offset.

limit - pagination limit.

Returns:

the List of Lines of Credit with full details

Throws:

MambuApiException

getGroupLinesOfCredit

public java.util.List<com.mambu.linesofcredit.shared.model.LineOfCredit> getGroupLinesOfCredit(java.lang.String groupId,
                                                                                               java.lang.Integer offset,
                                                                                               java.lang.Integer limit)
                                                                                        throws MambuApiException

Convenience method to Get lines of credit for a Group Example: GET /api/groups/{groupId}/linesofcredit Available since 3.11. See MBU-8413

Parameters:

groupId - group ID. Mandatory. Must not be null.

offset - pagination offset.

limit - pagination limit.

Returns:

the List of Lines of Credit

Throws:

MambuApiException

getGroupLinesOfCreditDetails

public java.util.List<com.mambu.linesofcredit.shared.model.LineOfCredit> getGroupLinesOfCreditDetails(java.lang.String groupId,
                                                                                                      java.lang.Integer offset,
                                                                                                      java.lang.Integer limit)
                                                                                               throws MambuApiException

Convenience method to Get lines of credit for a Group with all the details (including custom fields) Example: GET /api/groups/{groupId}/linesofcredit?fullDetails=true Available since 4.5. See JSDK-88

Parameters:

groupId - group ID. Mandatory. Must not be null.

offset - pagination offset.

limit - pagination limit.

Returns:

he List of Lines of Credit with full details

Throws:

MambuApiException

getAccountsForLineOfCredit

public com.mambu.linesofcredit.shared.model.AccountsFromLineOfCredit getAccountsForLineOfCredit(java.lang.String lineOfCreditId)
                                                                                         throws MambuApiException

Get all accounts for a line of credit

Parameters:

lineOfCreditId - the id or the encoded key of a Line Of Credit. Mandatory. Must not be null

Returns:

accounts for the line of credit

Throws:

MambuApiException

addLoanAccount

public com.mambu.loans.shared.model.LoanAccount addLoanAccount(java.lang.String lineOfCreditId,
                                                               java.lang.String loanAccountId)
                                                        throws MambuApiException

Add Loan Account to a line of credit

Parameters:

lineOfCreditId - the id or the encoded key of a Line Of Credit. Mandatory. Must not be null

loanAccountId - the id or the encoded key of a Loan Account. Mandatory. Must not be null

Returns:

added loan account

Throws:

MambuApiException

addSavingsAccount

public com.mambu.savings.shared.model.SavingsAccount addSavingsAccount(java.lang.String lineOfCreditId,
                                                                       java.lang.String savingsAccountId)
                                                                throws MambuApiException

Add Savings Account to a line of credit

Parameters:

lineOfCreditId - the id or the encoded key of a Line Of Credit. Mandatory. Must not be null

savingsAccountId - the id or the encoded key of a Savings Account. Mandatory. Must not be null

Returns:

added savings account

Throws:

MambuApiException

deleteAccount

public boolean deleteAccount(java.lang.String lineOfCreditId,
                             com.mambu.accounts.shared.model.Account.Type accountType,
                             java.lang.String accountId)
                      throws MambuApiException

Delete Account from a line of credit

Parameters:

lineOfCreditId - the id or the encoded key of a Line Of Credit. Mandatory. Must not be null

accountType - account type. Must not be null

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

Returns:

true if success

Throws:

MambuApiException

createLineOfCredit

public com.mambu.linesofcredit.shared.model.LineOfCredit createLineOfCredit(com.mambu.linesofcredit.shared.model.LineOfCredit lineOfCredit)
                                                                     throws MambuApiException

Creates a line of credit (Credit arrangement) for a client or a group, depending on the key set on the LineOfCredit.

Parameters:

lineOfCredit - The line of credit to be created in Mambu. Must not be null.

Returns:

Newly created line of credit

Throws:

MambuApiException

deleteLoanAccount

public boolean deleteLoanAccount(java.lang.String lineOfCreditId,
                                 java.lang.String loanAccountId)
                          throws MambuApiException

Convenience method to Delete Loan Account from a line of credit

Parameters:

lineOfCreditId - the id or the encoded key of a Line Of Credit. Mandatory. Must not be null

loanAccountId - the id or the encoded key of a Loan Account. Mandatory. Must not be null

Returns:

true if success

Throws:

MambuApiException

deleteSavingsAccount

public boolean deleteSavingsAccount(java.lang.String lineOfCreditId,
                                    java.lang.String savingsAccountId)
                             throws MambuApiException

Convenience method to Delete Savings Account from a line of credit

Parameters:

lineOfCreditId - the id or the encoded key of a Line Of Credit. Mandatory. Must not be null

savingsAccountId - the id or the encoded key of a Savings Account. Mandatory. Must not be null

Returns:

true if success

Throws:

MambuApiException

patchLinesOfCredit

public boolean patchLinesOfCredit(com.mambu.linesofcredit.shared.model.LineOfCredit lineOfCredit)
                           throws MambuApiException

Patches a line of credit.

Parameters:

lineOfCredit - The line of credit object to be patched. LineOfCredit object must NOT be null. Note that either the encodedKey or the ID must NOT be null for PATCHing a line of credit

Returns:

true if the PATCH operation succeeded.

Throws:

MambuApiException