Package org.apache.fineract.client.services

Interface SavingsAccountTransactionsApi

public interface SavingsAccountTransactionsApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<List<PostSavingsAccountBulkReversalTransactionsRequest>>	adjustTransaction1(Long savingsId, Long transactionId, PostSavingsAccountBulkReversalTransactionsRequest postSavingsAccountBulkReversalTransactionsRequest, String command)	Undo/Reverse/Modify/Release Amount transaction API Undo/Reverse/Modify/Release Amount transaction API Example Requests: savingsaccounts/{savingsId}/transactions/{transactionId}?command=reverse Accepted command = undo, reverse, modify, releaseAmount
retrofit2.Call<List<PostSavingsAccountBulkReversalTransactionsRequest>>	adjustTransaction1(Long savingsId, Long transactionId, PostSavingsAccountBulkReversalTransactionsRequest postSavingsAccountBulkReversalTransactionsRequest, String command, Map<String,String> headers)	Undo/Reverse/Modify/Release Amount transaction API Undo/Reverse/Modify/Release Amount transaction API Example Requests: savingsaccounts/{savingsId}/transactions/{transactionId}?command=reverse Accepted command = undo, reverse, modify, releaseAmount
retrofit2.Call<String>	advancedQuery1(Long savingsId)	Advanced search Savings Account Transactions
retrofit2.Call<String>	advancedQuery1(Long savingsId, Map<String,String> headers)	Advanced search Savings Account Transactions
retrofit2.Call<String>	advancedQuery1(Long savingsId, PagedLocalRequestAdvancedQueryRequest pagedLocalRequestAdvancedQueryRequest)	Advanced search Savings Account Transactions
retrofit2.Call<String>	advancedQuery1(Long savingsId, PagedLocalRequestAdvancedQueryRequest pagedLocalRequestAdvancedQueryRequest, Map<String,String> headers)	Advanced search Savings Account Transactions
retrofit2.Call<String>	retrieveOne24(Long savingsId, Long transactionId)
retrofit2.Call<String>	retrieveOne24(Long savingsId, Long transactionId, Map<String,String> headers)
retrofit2.Call<String>	retrieveTemplate19(Long savingsId)
retrofit2.Call<String>	retrieveTemplate19(Long savingsId, Map<String,String> headers)
retrofit2.Call<SavingsAccountTransactionsSearchResponse>	searchTransactions(Long savingsId, String fromDate, String toDate, String fromSubmittedDate, String toSubmittedDate, BigDecimal fromAmount, BigDecimal toAmount, String types, Boolean credit, Boolean debit, Integer offset, Integer limit, String orderBy, String sortOrder, String locale, String dateFormat)	Search Savings Account Transactions
retrofit2.Call<SavingsAccountTransactionsSearchResponse>	searchTransactions(Long savingsId, String fromDate, String toDate, String fromSubmittedDate, String toSubmittedDate, BigDecimal fromAmount, BigDecimal toAmount, String types, Boolean credit, Boolean debit, Integer offset, Integer limit, String orderBy, String sortOrder, String locale, String dateFormat, Map<String,String> headers)	Search Savings Account Transactions
retrofit2.Call<PostSavingsAccountTransactionsResponse>	transaction2(Long savingsId, PostSavingsAccountTransactionsRequest postSavingsAccountTransactionsRequest, String command)
retrofit2.Call<PostSavingsAccountTransactionsResponse>	transaction2(Long savingsId, PostSavingsAccountTransactionsRequest postSavingsAccountTransactionsRequest, String command, Map<String,String> headers)

Method Details

adjustTransaction1

@Headers("Content-Type:application/json")
@POST("v1/savingsaccounts/{savingsId}/transactions/{transactionId}")
retrofit2.Call<List<PostSavingsAccountBulkReversalTransactionsRequest>> adjustTransaction1(@Path("savingsId")
 Long savingsId,
 @Path("transactionId")
 Long transactionId,
 @Body
 PostSavingsAccountBulkReversalTransactionsRequest postSavingsAccountBulkReversalTransactionsRequest,
 @Query("command")
 String command)

Undo/Reverse/Modify/Release Amount transaction API Undo/Reverse/Modify/Release Amount transaction API Example Requests: savingsaccounts/{savingsId}/transactions/{transactionId}?command=reverse Accepted command = undo, reverse, modify, releaseAmount

Parameters:

savingsId - (required)

transactionId - (required)

postSavingsAccountBulkReversalTransactionsRequest - (required)

command - (optional)

Returns:

Call<List<PostSavingsAccountBulkReversalTransactionsRequest>>

advancedQuery1

@Headers("Content-Type:application/json")
@POST("v1/savingsaccounts/{savingsId}/transactions/query")
retrofit2.Call<String> advancedQuery1(@Path("savingsId")
 Long savingsId,
 @Body
 PagedLocalRequestAdvancedQueryRequest pagedLocalRequestAdvancedQueryRequest)

Advanced search Savings Account Transactions

Parameters:

savingsId - savingsId (required)

pagedLocalRequestAdvancedQueryRequest - (optional)

Returns:

Call<String>

retrieveOne24

@GET("v1/savingsaccounts/{savingsId}/transactions/{transactionId}")
retrofit2.Call<String> retrieveOne24(@Path("savingsId")
 Long savingsId,
 @Path("transactionId")
 Long transactionId)

Parameters:

savingsId - (required)

transactionId - (required)

Returns:

Call<String>

retrieveTemplate19

@GET("v1/savingsaccounts/{savingsId}/transactions/template")
retrofit2.Call<String> retrieveTemplate19(@Path("savingsId")
 Long savingsId)

Parameters:

savingsId - (required)

Returns:

Call<String>

searchTransactions

@GET("v1/savingsaccounts/{savingsId}/transactions/search")
retrofit2.Call<SavingsAccountTransactionsSearchResponse> searchTransactions(@Path("savingsId")
 Long savingsId,
 @Query("fromDate")
 String fromDate,
 @Query("toDate")
 String toDate,
 @Query("fromSubmittedDate")
 String fromSubmittedDate,
 @Query("toSubmittedDate")
 String toSubmittedDate,
 @Query("fromAmount")
 BigDecimal fromAmount,
 @Query("toAmount")
 BigDecimal toAmount,
 @Query("types")
 String types,
 @Query("credit")
 Boolean credit,
 @Query("debit")
 Boolean debit,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit,
 @Query("orderBy")
 String orderBy,
 @Query("sortOrder")
 String sortOrder,
 @Query("locale")
 String locale,
 @Query("dateFormat")
 String dateFormat)

Search Savings Account Transactions

Parameters:

savingsId - savings account id (required)

fromDate - minimum value date (inclusive) (optional)

toDate - maximum value date (inclusive) (optional)

fromSubmittedDate - minimum booking date (inclusive) (optional)

toSubmittedDate - maximum booking date (inclusive) (optional)

fromAmount - minimum transaction amount (inclusive) (optional)

toAmount - maximum transaction amount (inclusive) (optional)

types - transaction types (optional)

credit - credit (optional)

debit - debit (optional)

offset - offset (optional)

limit - limit (optional)

orderBy - sort properties (optional)

sortOrder - sort direction (optional)

locale - locale (optional)

dateFormat - date format (optional)

Returns:

Call<SavingsAccountTransactionsSearchResponse>

transaction2

@Headers("Content-Type:application/json")
@POST("v1/savingsaccounts/{savingsId}/transactions")
retrofit2.Call<PostSavingsAccountTransactionsResponse> transaction2(@Path("savingsId")
 Long savingsId,
 @Body
 PostSavingsAccountTransactionsRequest postSavingsAccountTransactionsRequest,
 @Query("command")
 String command)

Parameters:

savingsId - (required)

postSavingsAccountTransactionsRequest - (required)

command - (optional)

Returns:

Call<PostSavingsAccountTransactionsResponse>

advancedQuery1

@Headers("Content-Type:application/json")
@POST("v1/savingsaccounts/{savingsId}/transactions/query")
retrofit2.Call<String> advancedQuery1(@Path("savingsId")
 Long savingsId)

Advanced search Savings Account Transactions

Parameters:

savingsId - savingsId (required)

pagedLocalRequestAdvancedQueryRequest - (optional)

Returns:

Call<String>

adjustTransaction1

@Headers("Content-Type:application/json")
@POST("v1/savingsaccounts/{savingsId}/transactions/{transactionId}")
retrofit2.Call<List<PostSavingsAccountBulkReversalTransactionsRequest>> adjustTransaction1(@Path("savingsId")
 Long savingsId,
 @Path("transactionId")
 Long transactionId,
 @Body
 PostSavingsAccountBulkReversalTransactionsRequest postSavingsAccountBulkReversalTransactionsRequest,
 @Query("command")
 String command,
 @HeaderMap
 Map<String,String> headers)

Undo/Reverse/Modify/Release Amount transaction API Undo/Reverse/Modify/Release Amount transaction API Example Requests: savingsaccounts/{savingsId}/transactions/{transactionId}?command=reverse Accepted command = undo, reverse, modify, releaseAmount

Parameters:

savingsId - (required)

transactionId - (required)

postSavingsAccountBulkReversalTransactionsRequest - (required)

command - (optional)

Returns:

Call<List<PostSavingsAccountBulkReversalTransactionsRequest>>

advancedQuery1

@Headers("Content-Type:application/json")
@POST("v1/savingsaccounts/{savingsId}/transactions/query")
retrofit2.Call<String> advancedQuery1(@Path("savingsId")
 Long savingsId,
 @Body
 PagedLocalRequestAdvancedQueryRequest pagedLocalRequestAdvancedQueryRequest,
 @HeaderMap
 Map<String,String> headers)

Advanced search Savings Account Transactions

Parameters:

savingsId - savingsId (required)

pagedLocalRequestAdvancedQueryRequest - (optional)

Returns:

Call<String>

retrieveOne24

@GET("v1/savingsaccounts/{savingsId}/transactions/{transactionId}")
retrofit2.Call<String> retrieveOne24(@Path("savingsId")
 Long savingsId,
 @Path("transactionId")
 Long transactionId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

savingsId - (required)

transactionId - (required)

Returns:

Call<String>

retrieveTemplate19

@GET("v1/savingsaccounts/{savingsId}/transactions/template")
retrofit2.Call<String> retrieveTemplate19(@Path("savingsId")
 Long savingsId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

savingsId - (required)

Returns:

Call<String>

searchTransactions

@GET("v1/savingsaccounts/{savingsId}/transactions/search")
retrofit2.Call<SavingsAccountTransactionsSearchResponse> searchTransactions(@Path("savingsId")
 Long savingsId,
 @Query("fromDate")
 String fromDate,
 @Query("toDate")
 String toDate,
 @Query("fromSubmittedDate")
 String fromSubmittedDate,
 @Query("toSubmittedDate")
 String toSubmittedDate,
 @Query("fromAmount")
 BigDecimal fromAmount,
 @Query("toAmount")
 BigDecimal toAmount,
 @Query("types")
 String types,
 @Query("credit")
 Boolean credit,
 @Query("debit")
 Boolean debit,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit,
 @Query("orderBy")
 String orderBy,
 @Query("sortOrder")
 String sortOrder,
 @Query("locale")
 String locale,
 @Query("dateFormat")
 String dateFormat,
 @HeaderMap
 Map<String,String> headers)

Search Savings Account Transactions

Parameters:

savingsId - savings account id (required)

fromDate - minimum value date (inclusive) (optional)

toDate - maximum value date (inclusive) (optional)

fromSubmittedDate - minimum booking date (inclusive) (optional)

toSubmittedDate - maximum booking date (inclusive) (optional)

fromAmount - minimum transaction amount (inclusive) (optional)

toAmount - maximum transaction amount (inclusive) (optional)

types - transaction types (optional)

credit - credit (optional)

debit - debit (optional)

offset - offset (optional)

limit - limit (optional)

orderBy - sort properties (optional)

sortOrder - sort direction (optional)

locale - locale (optional)

dateFormat - date format (optional)

Returns:

Call<SavingsAccountTransactionsSearchResponse>

transaction2

@Headers("Content-Type:application/json")
@POST("v1/savingsaccounts/{savingsId}/transactions")
retrofit2.Call<PostSavingsAccountTransactionsResponse> transaction2(@Path("savingsId")
 Long savingsId,
 @Body
 PostSavingsAccountTransactionsRequest postSavingsAccountTransactionsRequest,
 @Query("command")
 String command,
 @HeaderMap
 Map<String,String> headers)

Parameters:

savingsId - (required)

postSavingsAccountTransactionsRequest - (required)

command - (optional)

Returns:

Call<PostSavingsAccountTransactionsResponse>

advancedQuery1

@Headers("Content-Type:application/json")
@POST("v1/savingsaccounts/{savingsId}/transactions/query")
retrofit2.Call<String> advancedQuery1(@Path("savingsId")
 Long savingsId,
 @HeaderMap
 Map<String,String> headers)

Advanced search Savings Account Transactions

Parameters:

savingsId - savingsId (required)

pagedLocalRequestAdvancedQueryRequest - (optional)

Returns:

Call<String>