Package org.apache.fineract.client.services

Interface LoansPointInTimeApi

public interface LoansPointInTimeApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<LoanPointInTimeData>	retrieveLoanPointInTime(Long loanId, Object date, String dateFormat, String locale)
retrofit2.Call<LoanPointInTimeData>	retrieveLoanPointInTime(Long loanId, Object date, String dateFormat, String locale, Map<String,String> headers)
retrofit2.Call<LoanPointInTimeData>	retrieveLoanPointInTimeByExternalId(String loanExternalId, Object date, String dateFormat, String locale)
retrofit2.Call<LoanPointInTimeData>	retrieveLoanPointInTimeByExternalId(String loanExternalId, Object date, String dateFormat, String locale, Map<String,String> headers)
retrofit2.Call<List<LoanPointInTimeData>>	retrieveLoansPointInTime()
retrofit2.Call<List<LoanPointInTimeData>>	retrieveLoansPointInTime(Map<String,String> headers)
retrofit2.Call<List<LoanPointInTimeData>>	retrieveLoansPointInTime(RetrieveLoansPointInTimeRequest retrieveLoansPointInTimeRequest)
retrofit2.Call<List<LoanPointInTimeData>>	retrieveLoansPointInTime(RetrieveLoansPointInTimeRequest retrieveLoansPointInTimeRequest, Map<String,String> headers)
retrofit2.Call<List<LoanPointInTimeData>>	retrieveLoansPointInTimeByExternalIds()
retrofit2.Call<List<LoanPointInTimeData>>	retrieveLoansPointInTimeByExternalIds(Map<String,String> headers)
retrofit2.Call<List<LoanPointInTimeData>>	retrieveLoansPointInTimeByExternalIds(RetrieveLoansPointInTimeExternalIdsRequest retrieveLoansPointInTimeExternalIdsRequest)
retrofit2.Call<List<LoanPointInTimeData>>	retrieveLoansPointInTimeByExternalIds(RetrieveLoansPointInTimeExternalIdsRequest retrieveLoansPointInTimeExternalIdsRequest, Map<String,String> headers)

Method Details

retrieveLoanPointInTime

@GET("v1/loans/at-date/{loanId}")
retrofit2.Call<LoanPointInTimeData> retrieveLoanPointInTime(@Path("loanId")
 Long loanId,
 @Query("date")
 Object date,
 @Query("dateFormat")
 String dateFormat,
 @Query("locale")
 String locale)

Parameters:

loanId - loanId (required)

date - date (required)

dateFormat - dateFormat (optional)

locale - locale (optional)

Returns:

Call<LoanPointInTimeData>

retrieveLoanPointInTimeByExternalId

@GET("v1/loans/at-date/external-id/{loanExternalId}")
retrofit2.Call<LoanPointInTimeData> retrieveLoanPointInTimeByExternalId(@Path("loanExternalId")
 String loanExternalId,
 @Query("date")
 Object date,
 @Query("dateFormat")
 String dateFormat,
 @Query("locale")
 String locale)

Parameters:

loanExternalId - loanExternalId (required)

date - date (required)

dateFormat - dateFormat (optional)

locale - locale (optional)

Returns:

Call<LoanPointInTimeData>

retrieveLoansPointInTime

@Headers("Content-Type:application/json")
@POST("v1/loans/at-date/search")
retrofit2.Call<List<LoanPointInTimeData>> retrieveLoansPointInTime(@Body
 RetrieveLoansPointInTimeRequest retrieveLoansPointInTimeRequest)

Parameters:

retrieveLoansPointInTimeRequest - (optional)

Returns:

Call<List<LoanPointInTimeData>>

retrieveLoansPointInTimeByExternalIds

@Headers("Content-Type:application/json")
@POST("v1/loans/at-date/search/external-id")
retrofit2.Call<List<LoanPointInTimeData>> retrieveLoansPointInTimeByExternalIds(@Body
 RetrieveLoansPointInTimeExternalIdsRequest retrieveLoansPointInTimeExternalIdsRequest)

Parameters:

retrieveLoansPointInTimeExternalIdsRequest - (optional)

Returns:

Call<List<LoanPointInTimeData>>

retrieveLoansPointInTime

@Headers("Content-Type:application/json")
@POST("v1/loans/at-date/search")
retrofit2.Call<List<LoanPointInTimeData>> retrieveLoansPointInTime()

Parameters:

retrieveLoansPointInTimeRequest - (optional)

Returns:

Call<List<LoanPointInTimeData>>

retrieveLoansPointInTimeByExternalIds

@Headers("Content-Type:application/json")
@POST("v1/loans/at-date/search/external-id")
retrofit2.Call<List<LoanPointInTimeData>> retrieveLoansPointInTimeByExternalIds()

Parameters:

retrieveLoansPointInTimeExternalIdsRequest - (optional)

Returns:

Call<List<LoanPointInTimeData>>

retrieveLoanPointInTime

@GET("v1/loans/at-date/{loanId}")
retrofit2.Call<LoanPointInTimeData> retrieveLoanPointInTime(@Path("loanId")
 Long loanId,
 @Query("date")
 Object date,
 @Query("dateFormat")
 String dateFormat,
 @Query("locale")
 String locale,
 @HeaderMap
 Map<String,String> headers)

Parameters:

loanId - loanId (required)

date - date (required)

dateFormat - dateFormat (optional)

locale - locale (optional)

Returns:

Call<LoanPointInTimeData>

retrieveLoanPointInTimeByExternalId

@GET("v1/loans/at-date/external-id/{loanExternalId}")
retrofit2.Call<LoanPointInTimeData> retrieveLoanPointInTimeByExternalId(@Path("loanExternalId")
 String loanExternalId,
 @Query("date")
 Object date,
 @Query("dateFormat")
 String dateFormat,
 @Query("locale")
 String locale,
 @HeaderMap
 Map<String,String> headers)

Parameters:

loanExternalId - loanExternalId (required)

date - date (required)

dateFormat - dateFormat (optional)

locale - locale (optional)

Returns:

Call<LoanPointInTimeData>

retrieveLoansPointInTime

@Headers("Content-Type:application/json")
@POST("v1/loans/at-date/search")
retrofit2.Call<List<LoanPointInTimeData>> retrieveLoansPointInTime(@Body
 RetrieveLoansPointInTimeRequest retrieveLoansPointInTimeRequest,
 @HeaderMap
 Map<String,String> headers)

Parameters:

retrieveLoansPointInTimeRequest - (optional)

Returns:

Call<List<LoanPointInTimeData>>

retrieveLoansPointInTimeByExternalIds

@Headers("Content-Type:application/json")
@POST("v1/loans/at-date/search/external-id")
retrofit2.Call<List<LoanPointInTimeData>> retrieveLoansPointInTimeByExternalIds(@Body
 RetrieveLoansPointInTimeExternalIdsRequest retrieveLoansPointInTimeExternalIdsRequest,
 @HeaderMap
 Map<String,String> headers)

Parameters:

retrieveLoansPointInTimeExternalIdsRequest - (optional)

Returns:

Call<List<LoanPointInTimeData>>

retrieveLoansPointInTime

@Headers("Content-Type:application/json")
@POST("v1/loans/at-date/search")
retrofit2.Call<List<LoanPointInTimeData>> retrieveLoansPointInTime(@HeaderMap
 Map<String,String> headers)

Parameters:

retrieveLoansPointInTimeRequest - (optional)

Returns:

Call<List<LoanPointInTimeData>>

retrieveLoansPointInTimeByExternalIds

@Headers("Content-Type:application/json")
@POST("v1/loans/at-date/search/external-id")
retrofit2.Call<List<LoanPointInTimeData>> retrieveLoansPointInTimeByExternalIds(@HeaderMap
 Map<String,String> headers)

Parameters:

retrieveLoansPointInTimeExternalIdsRequest - (optional)

Returns:

Call<List<LoanPointInTimeData>>