com.mambu.apisdk.services

Class OrganizationService

java.lang.Object

com.mambu.apisdk.services.OrganizationService

public class OrganizationService
extends java.lang.Object

Service class which handles API operations available for the organizations like getting it's currency

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	baseCurrencyMustBeDefined

Constructor Summary

Constructors

Constructor and Description
OrganizationService(MambuAPIService mambuAPIService) Create a new organization service

Method Summary

Modifier and Type	Method and Description
com.mambu.admin.shared.model.ExchangeRate	createExchangeRate(com.mambu.core.shared.model.Currency currency, com.mambu.admin.shared.model.ExchangeRate exchangeRate) Convenience method to create ExchangeRate.
com.mambu.admin.shared.model.ExchangeRate	createExchangeRate(java.lang.String currencyCode, com.mambu.admin.shared.model.ExchangeRate exchangeRate) Creates a new exchange rate using a currency code and ExchangeRate object and sends it as a JSON api.
java.util.List<com.mambu.core.shared.model.Currency>	getAllCurrencies() Convenience method to GET all organization currencies
com.mambu.organization.shared.model.Branch	getBranch(java.lang.String branchId) Requests a branch by their Mambu ID
java.util.List<com.mambu.organization.shared.model.Branch>	getBranches(java.lang.String offset, java.lang.String limit) Get a paginated list of branches
java.lang.String	getBrandingIcon() Get Organization Icon
java.lang.String	getBrandingLogo() Get Organization Logo
com.mambu.organization.shared.model.Centre	getCentre(java.lang.String centreId) Requests a centre details by their Mambu ID
java.util.List<com.mambu.organization.shared.model.Centre>	getCentres(java.lang.String branchId, java.lang.String offset, java.lang.String limit) Get paginated list of centres
java.util.List<com.mambu.core.shared.model.Currency>	getCurrencies(boolean getAllCurrencies) Requests organization currencies.
com.mambu.core.shared.model.Currency	getCurrency() Convenience method to request the organization's base currency only
com.mambu.core.shared.model.Currency	getCurrency(java.lang.String currencyCode) Requests a currency for a supplied currency code.
com.mambu.core.shared.model.CustomField	getCustomField(java.lang.String fieldId) Get CustomField object details by Custom Field ID
java.util.List<com.mambu.core.shared.model.CustomFieldSet>	getCustomFieldSets(com.mambu.core.shared.model.CustomFieldType customFieldType) Get Custom Field Sets
java.util.List<com.mambu.admin.shared.model.ExchangeRate>	getExchangeRates(java.lang.String toCurrencyCode, java.lang.String startDate, java.lang.String endDate, java.lang.Integer offset, java.lang.Integer limit) Get paginated list of available exchange rates for a base currency
com.mambu.core.shared.model.GeneralSettings	getGeneralSettings() Get organization's general settings
java.util.List<com.mambu.clients.shared.model.IdentificationDocumentTemplate>	getIdentificationDocumentTemplates() Get all Identification Document Templates
java.util.List<com.mambu.core.shared.model.ObjectLabel>	getObjectLabels() Get Object labels
com.mambu.api.server.handler.settings.organization.model.JSONOrganization	getOrganization() Get Organization details
java.util.List<com.mambu.accounts.shared.model.TransactionChannel>	getTransactionChannels() Get Transaction Channels Note: since Mambu 4.1 the returned transaction channels also contain a list of custom fields applicable to this channel and channel's accounting rule.
com.mambu.core.shared.model.IndexRate	postIndexInterestRate(java.lang.String indexRateSourceKey, com.mambu.core.shared.model.IndexRate indexRate) Post Index Interest Rate

Methods inherited from class java.lang.Object

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

Field Detail

baseCurrencyMustBeDefined

public static final java.lang.String baseCurrencyMustBeDefined

See Also:

Constant Field Values

Constructor Detail

OrganizationService

@Inject
public OrganizationService(MambuAPIService mambuAPIService)

Create a new organization service

Parameters:

mambuAPIService - the service responsible with the connection to the server

Method Detail

getCurrencies

public java.util.List<com.mambu.core.shared.model.Currency> getCurrencies(boolean getAllCurrencies)
                                                                   throws MambuApiException

Requests organization currencies. Either getting all organization currencies or getting just the base currency can be requested

Parameters:

getAllCurrencies - a boolean indicating if all currencies should be returned (true) or if only the base currency needs to be returned (false)

Returns:

the list of all currencies or only the base currency depending on a flag

Throws:

MambuApiException

getCurrency

public com.mambu.core.shared.model.Currency getCurrency()
                                                 throws MambuApiException

Convenience method to request the organization's base currency only

Returns:

the Mambu base currency

Throws:

MambuApiException

getCurrency

public com.mambu.core.shared.model.Currency getCurrency(java.lang.String currencyCode)
                                                 throws MambuApiException

Requests a currency for a supplied currency code.

Parameters:

currencyCode - the currency code for the currency to be searched in Mambu. Must not be null.

Returns:

Currency having as currency code the currency code passed as parameter to this method call. In case a wrong currency code (there is no currency having this code) is passed to this method call then the server will return INVALID_CURRENCY_CODE error code.

Throws:

MambuApiException

getAllCurrencies

public java.util.List<com.mambu.core.shared.model.Currency> getAllCurrencies()
                                                                      throws MambuApiException

Convenience method to GET all organization currencies

Returns:

the list of all currencies defined for the organization

Throws:

MambuApiException

getBranches

public java.util.List<com.mambu.organization.shared.model.Branch> getBranches(java.lang.String offset,
                                                                              java.lang.String limit)
                                                                       throws MambuApiException

Get a paginated list of branches

Parameters:

offset - the offset of the response. If not set a value of 0 is used by default

limit - the maximum number of response entries. If not set a value of 50 is used by default

Returns:

List

Throws:

MambuApiException

getBranch

public com.mambu.organization.shared.model.Branch getBranch(java.lang.String branchId)
                                                     throws MambuApiException

Requests a branch by their Mambu ID

Parameters:

branchId -

Returns:

the Mambu branch model

Throws:

MambuApiException

getCentre

public com.mambu.organization.shared.model.Centre getCentre(java.lang.String centreId)
                                                     throws MambuApiException

Requests a centre details by their Mambu ID

Parameters:

centreId -

Returns:

the Mambu centre model (with full details)

Throws:

MambuApiException

getCentres

public java.util.List<com.mambu.organization.shared.model.Centre> getCentres(java.lang.String branchId,
                                                                             java.lang.String offset,
                                                                             java.lang.String limit)
                                                                      throws MambuApiException

Get paginated list of centres

Parameters:

branchId - Centers for the specified branch are returned. If NULL, all centres are searched

offset - the offset of the response. If not set a value of 0 is used by default

limit - the maximum number of response entries. If not set a value of 50 is used by default

Returns:

an array of Centres

Throws:

MambuApiException

getCustomField

public com.mambu.core.shared.model.CustomField getCustomField(java.lang.String fieldId)
                                                       throws MambuApiException

Get CustomField object details by Custom Field ID

Parameters:

fieldId - The id of the required CustomField

Returns:

CustomField

Throws:

MambuApiException

getCustomFieldSets

public java.util.List<com.mambu.core.shared.model.CustomFieldSet> getCustomFieldSets(com.mambu.core.shared.model.CustomFieldType customFieldType)
                                                                              throws MambuApiException

Get Custom Field Sets

Parameters:

customFieldType - The type of the required CustomField Set. Example CLIENT_INFO, GROUP_INFO, LOAN_ACCOUNT_INFO, SAVINGS_ACCOUNT_INFO, BRANCH_INFO, USER_INFO Can be null - all types requested.

Returns:

List of CustomFieldSet sets

Throws:

MambuApiException

getTransactionChannels

public java.util.List<com.mambu.accounts.shared.model.TransactionChannel> getTransactionChannels()
                                                                                          throws MambuApiException

Get Transaction Channels Note: since Mambu 4.1 the returned transaction channels also contain a list of custom fields applicable to this channel and channel's accounting rule. See MBU-12226- As a Developer, I want to GET transaction channels with custom fields via APIs

Returns:

List of all Transaction Channels for the organization

Throws:

MambuApiException

postIndexInterestRate

public com.mambu.core.shared.model.IndexRate postIndexInterestRate(java.lang.String indexRateSourceKey,
                                                                   com.mambu.core.shared.model.IndexRate indexRate)
                                                            throws MambuApiException

Post Index Interest Rate

Parameters:

indexRateSourceKey - the encoded key of the Interest Rate Source

indexRate - index rate object

Returns:

index rate

Throws:

MambuApiException

getIdentificationDocumentTemplates

public java.util.List<com.mambu.clients.shared.model.IdentificationDocumentTemplate> getIdentificationDocumentTemplates()
                                                                                                                 throws MambuApiException

Get all Identification Document Templates

Returns:

a list of all Identification Document Templates defined for an organization. This API doesn't support pagination.

Throws:

MambuApiException

getOrganization

public com.mambu.api.server.handler.settings.organization.model.JSONOrganization getOrganization()
                                                                                          throws MambuApiException

Get Organization details

Returns:

Mambu organization definition details

Throws:

MambuApiException

getGeneralSettings

public com.mambu.core.shared.model.GeneralSettings getGeneralSettings()
                                                               throws MambuApiException

Get organization's general settings

Returns:

Mambu organization general settings

Throws:

MambuApiException

getObjectLabels

public java.util.List<com.mambu.core.shared.model.ObjectLabel> getObjectLabels()
                                                                        throws MambuApiException

Get Object labels

Returns:

a list of all object labels defined for all languages supported by Mambu

Throws:

MambuApiException

getBrandingLogo

public java.lang.String getBrandingLogo()
                                 throws MambuApiException

Get Organization Logo

Returns:

string with base64 encoded logo image, Example: data:image/PNG;base64,iVBORw0...

Throws:

MambuApiException

getBrandingIcon

public java.lang.String getBrandingIcon()
                                 throws MambuApiException

Get Organization Icon

Returns:

string with base64 encoded logo image, Example: data:image/PNG;base64,iVBORw0...

Throws:

MambuApiException

createExchangeRate

public com.mambu.admin.shared.model.ExchangeRate createExchangeRate(com.mambu.core.shared.model.Currency currency,
                                                                    com.mambu.admin.shared.model.ExchangeRate exchangeRate)
                                                             throws MambuApiException

Convenience method to create ExchangeRate.

Parameters:

currency - the Currency object. Must not be null or have a null currency code.

exchangeRate - the ExchangeRate to be created in Mambu. Must not be null. The required start date should be provided in the startDate as the date in UTC at midnight. The startDate of the exchangeRate can be left null and the API will handle the setting of this field using the organization current date/time.

Returns:

newly created ExchangeRate

Throws:

MambuApiException

createExchangeRate

public com.mambu.admin.shared.model.ExchangeRate createExchangeRate(java.lang.String currencyCode,
                                                                    com.mambu.admin.shared.model.ExchangeRate exchangeRate)
                                                             throws MambuApiException

Creates a new exchange rate using a currency code and ExchangeRate object and sends it as a JSON api.

Parameters:

currencyCode - the currency code. Must not be null.

exchangeRate - the exchange rate to be created. Must not be null. The required start date should be provided in the startDate as the date in UTC at midnight. The startDate of the exchangeRate can be left null and the API will handle the setting of this field using the organization current date/time.

Returns:

newly created ExchangeRate

Throws:

MambuApiException

java.lang.IllegalArgumentException

getExchangeRates

public java.util.List<com.mambu.admin.shared.model.ExchangeRate> getExchangeRates(java.lang.String toCurrencyCode,
                                                                                  java.lang.String startDate,
                                                                                  java.lang.String endDate,
                                                                                  java.lang.Integer offset,
                                                                                  java.lang.Integer limit)
                                                                           throws MambuApiException

Get paginated list of available exchange rates for a base currency

Parameters:

toCurrencyCode - currency code to exchange to from the base currency. Must not be null. It should be a valid non-base currency code for a currency used by the organization

startDate - start date in a "yyyy-MM=dd" format

endDate - end date in a "yyyy-MM=dd" format. Note, startDate should be <= endDate, If both the startDate and the endDate are not specified the all available exchange rates are returned

offset - the pagination offset of the response. If not set a value of 0 is used by default by Mambu

limit - the maximum number of response entries. If not set a value of 50 is used by default by Mambu

Returns:

a list of Exchange Rates. Note, the dates in startDate and endDate are returned as dates in UTC. And also the exchange rates from the list are sorted descending by start date.

Throws:

MambuApiException