Package org.apache.fineract.client.services

Interface CurrencyApi

public interface CurrencyApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<CurrencyConfigurationData>	retrieveCurrencies()	Retrieve Currency Configuration Returns the list of currencies permitted for use AND the list of currencies not selected (but available for selection).
retrofit2.Call<CurrencyConfigurationData>	retrieveCurrencies(Map<String,String> headers)	Retrieve Currency Configuration Returns the list of currencies permitted for use AND the list of currencies not selected (but available for selection).
retrofit2.Call<CurrencyUpdateResponse>	updateCurrencies()	Update Currency Configuration Updates the list of currencies permitted for use.
retrofit2.Call<CurrencyUpdateResponse>	updateCurrencies(Map<String,String> headers)	Update Currency Configuration Updates the list of currencies permitted for use.
retrofit2.Call<CurrencyUpdateResponse>	updateCurrencies(CurrencyUpdateRequest currencyUpdateRequest)	Update Currency Configuration Updates the list of currencies permitted for use.
retrofit2.Call<CurrencyUpdateResponse>	updateCurrencies(CurrencyUpdateRequest currencyUpdateRequest, Map<String,String> headers)	Update Currency Configuration Updates the list of currencies permitted for use.

Method Details

retrieveCurrencies

@GET("v1/currencies")
retrofit2.Call<CurrencyConfigurationData> retrieveCurrencies()

Retrieve Currency Configuration Returns the list of currencies permitted for use AND the list of currencies not selected (but available for selection). Example Requests: currencies currencies?fields=selectedCurrencyOptions

Returns:

Call<CurrencyConfigurationData>

updateCurrencies

@Headers("Content-Type:application/json")
@PUT("v1/currencies")
retrofit2.Call<CurrencyUpdateResponse> updateCurrencies(@Body
 CurrencyUpdateRequest currencyUpdateRequest)

Update Currency Configuration Updates the list of currencies permitted for use.

Parameters:

currencyUpdateRequest - (optional)

Returns:

Call<CurrencyUpdateResponse>

updateCurrencies

@Headers("Content-Type:application/json")
@PUT("v1/currencies")
retrofit2.Call<CurrencyUpdateResponse> updateCurrencies()

Update Currency Configuration Updates the list of currencies permitted for use.

Parameters:

currencyUpdateRequest - (optional)

Returns:

Call<CurrencyUpdateResponse>

retrieveCurrencies

@GET("v1/currencies")
retrofit2.Call<CurrencyConfigurationData> retrieveCurrencies(@HeaderMap
 Map<String,String> headers)

Retrieve Currency Configuration Returns the list of currencies permitted for use AND the list of currencies not selected (but available for selection). Example Requests: currencies currencies?fields=selectedCurrencyOptions

Returns:

Call<CurrencyConfigurationData>

updateCurrencies

@Headers("Content-Type:application/json")
@PUT("v1/currencies")
retrofit2.Call<CurrencyUpdateResponse> updateCurrencies(@Body
 CurrencyUpdateRequest currencyUpdateRequest,
 @HeaderMap
 Map<String,String> headers)

Update Currency Configuration Updates the list of currencies permitted for use.

Parameters:

currencyUpdateRequest - (optional)

Returns:

Call<CurrencyUpdateResponse>

updateCurrencies

@Headers("Content-Type:application/json")
@PUT("v1/currencies")
retrofit2.Call<CurrencyUpdateResponse> updateCurrencies(@HeaderMap
 Map<String,String> headers)

Update Currency Configuration Updates the list of currencies permitted for use.

Parameters:

currencyUpdateRequest - (optional)

Returns:

Call<CurrencyUpdateResponse>