Package org.apache.fineract.client.services

Interface SelfSavingsAccountApi

public interface SelfSavingsAccountApi

  • Method Details

    • modifySavingsAccountApplication

      @Headers("Content-Type:application/json") @PUT("v1/self/savingsaccounts/{accountId}") retrofit2.Call<String> modifySavingsAccountApplication(@Path("accountId") Long accountId, @Query("command") String command, @Body String body)
      Parameters:
      accountId - (required)
      command - (optional)
      body - (optional)
      Returns:
      Call<String>

    • retrieveAllSavingsAccountCharges1

      @GET("v1/self/savingsaccounts/{accountId}/charges") retrofit2.Call<List<GetSelfSavingsAccountsAccountIdChargesResponse>> retrieveAllSavingsAccountCharges1(@Path("accountId") Long accountId, @Query("chargeStatus") String chargeStatus)
      List Savings Charges Lists Savings Charges Example Requests: self/savingsaccounts/1/charges self/savingsaccounts/1/charges?chargeStatus=inactive self/savingsaccounts/1/charges?fields=name,amountOrPercentage
      Parameters:
      accountId - accountId (required)
      chargeStatus - chargeStatus (optional, default to all)
      Returns:
      Call<List<GetSelfSavingsAccountsAccountIdChargesResponse>>

    • retrieveSavings

      @GET("v1/self/savingsaccounts/{accountId}") retrofit2.Call<GetSelfSavingsAccountsResponse> retrieveSavings(@Path("accountId") Long accountId, @Query("chargeStatus") String chargeStatus, @Query("associations") String associations)
      Retrieve a savings account Retrieves a savings account Example Requests : self/savingsaccounts/1 self/savingsaccounts/1?associations=transactions
      Parameters:
      accountId - accountId (required)
      chargeStatus - chargeStatus (optional, default to all)
      associations - associations (optional)
      Returns:
      Call<GetSelfSavingsAccountsResponse>

    • retrieveSavingsAccountCharge1

      @GET("v1/self/savingsaccounts/{accountId}/charges/{savingsAccountChargeId}") retrofit2.Call<GetSelfSavingsAccountsAccountIdChargesSavingsAccountChargeIdResponse> retrieveSavingsAccountCharge1(@Path("accountId") Long accountId, @Path("savingsAccountChargeId") Long savingsAccountChargeId)
      Retrieve a Savings account Charge Retrieves a Savings account Charge Example Requests: self/savingsaccounts/1/charges/5 self/savingsaccounts/1/charges/5?fields=name,amountOrPercentage
      Parameters:
      accountId - accountId (required)
      savingsAccountChargeId - savingsAccountChargeId (required)
      Returns:
      Call<GetSelfSavingsAccountsAccountIdChargesSavingsAccountChargeIdResponse>

    • retrieveSavingsTransaction

      @GET("v1/self/savingsaccounts/{accountId}/transactions/{transactionId}") retrofit2.Call<GetSelfSavingsAccountsAccountIdTransactionsTransactionIdResponse> retrieveSavingsTransaction(@Path("accountId") Long accountId, @Path("transactionId") Long transactionId)
      Retrieve Savings Account Transaction Retrieves Savings Account Transaction Example Requests: self/savingsaccounts/1/transactions/1
      Parameters:
      accountId - accountId (required)
      transactionId - transactionId (required)
      Returns:
      Call<GetSelfSavingsAccountsAccountIdTransactionsTransactionIdResponse>

    • submitSavingsAccountApplication

      @Headers("Content-Type:application/json") @POST("v1/self/savingsaccounts") retrofit2.Call<String> submitSavingsAccountApplication(@Query("command") String command, @Body String body)
      Parameters:
      command - (optional)
      body - (optional)
      Returns:
      Call<String>

    • template18

      @GET("v1/self/savingsaccounts/template") retrofit2.Call<String> template18(@Query("clientId") Long clientId, @Query("productId") Long productId)
      Parameters:
      clientId - (optional)
      productId - (optional)
      Returns:
      Call<String>

    • modifySavingsAccountApplication

      @Headers("Content-Type:application/json") @PUT("v1/self/savingsaccounts/{accountId}") retrofit2.Call<String> modifySavingsAccountApplication(@Path("accountId") Long accountId, @Query("command") String command)
      Parameters:
      accountId - (required)
      command - (optional)
      body - (optional)
      Returns:
      Call<String>

    • submitSavingsAccountApplication

      @Headers("Content-Type:application/json") @POST("v1/self/savingsaccounts") retrofit2.Call<String> submitSavingsAccountApplication(@Query("command") String command)
      Parameters:
      command - (optional)
      body - (optional)
      Returns:
      Call<String>

    • modifySavingsAccountApplication

      @Headers("Content-Type:application/json") @PUT("v1/self/savingsaccounts/{accountId}") retrofit2.Call<String> modifySavingsAccountApplication(@Path("accountId") Long accountId, @Query("command") String command, @Body String body, @HeaderMap Map<String,String> headers)
      Parameters:
      accountId - (required)
      command - (optional)
      body - (optional)
      Returns:
      Call<String>

    • retrieveAllSavingsAccountCharges1

      @GET("v1/self/savingsaccounts/{accountId}/charges") retrofit2.Call<List<GetSelfSavingsAccountsAccountIdChargesResponse>> retrieveAllSavingsAccountCharges1(@Path("accountId") Long accountId, @Query("chargeStatus") String chargeStatus, @HeaderMap Map<String,String> headers)
      List Savings Charges Lists Savings Charges Example Requests: self/savingsaccounts/1/charges self/savingsaccounts/1/charges?chargeStatus=inactive self/savingsaccounts/1/charges?fields=name,amountOrPercentage
      Parameters:
      accountId - accountId (required)
      chargeStatus - chargeStatus (optional, default to all)
      Returns:
      Call<List<GetSelfSavingsAccountsAccountIdChargesResponse>>

    • retrieveSavings

      @GET("v1/self/savingsaccounts/{accountId}") retrofit2.Call<GetSelfSavingsAccountsResponse> retrieveSavings(@Path("accountId") Long accountId, @Query("chargeStatus") String chargeStatus, @Query("associations") String associations, @HeaderMap Map<String,String> headers)
      Retrieve a savings account Retrieves a savings account Example Requests : self/savingsaccounts/1 self/savingsaccounts/1?associations=transactions
      Parameters:
      accountId - accountId (required)
      chargeStatus - chargeStatus (optional, default to all)
      associations - associations (optional)
      Returns:
      Call<GetSelfSavingsAccountsResponse>

    • retrieveSavingsAccountCharge1

      @GET("v1/self/savingsaccounts/{accountId}/charges/{savingsAccountChargeId}") retrofit2.Call<GetSelfSavingsAccountsAccountIdChargesSavingsAccountChargeIdResponse> retrieveSavingsAccountCharge1(@Path("accountId") Long accountId, @Path("savingsAccountChargeId") Long savingsAccountChargeId, @HeaderMap Map<String,String> headers)
      Retrieve a Savings account Charge Retrieves a Savings account Charge Example Requests: self/savingsaccounts/1/charges/5 self/savingsaccounts/1/charges/5?fields=name,amountOrPercentage
      Parameters:
      accountId - accountId (required)
      savingsAccountChargeId - savingsAccountChargeId (required)
      Returns:
      Call<GetSelfSavingsAccountsAccountIdChargesSavingsAccountChargeIdResponse>

    • retrieveSavingsTransaction

      @GET("v1/self/savingsaccounts/{accountId}/transactions/{transactionId}") retrofit2.Call<GetSelfSavingsAccountsAccountIdTransactionsTransactionIdResponse> retrieveSavingsTransaction(@Path("accountId") Long accountId, @Path("transactionId") Long transactionId, @HeaderMap Map<String,String> headers)
      Retrieve Savings Account Transaction Retrieves Savings Account Transaction Example Requests: self/savingsaccounts/1/transactions/1
      Parameters:
      accountId - accountId (required)
      transactionId - transactionId (required)
      Returns:
      Call<GetSelfSavingsAccountsAccountIdTransactionsTransactionIdResponse>

    • submitSavingsAccountApplication

      @Headers("Content-Type:application/json") @POST("v1/self/savingsaccounts") retrofit2.Call<String> submitSavingsAccountApplication(@Query("command") String command, @Body String body, @HeaderMap Map<String,String> headers)
      Parameters:
      command - (optional)
      body - (optional)
      Returns:
      Call<String>

    • template18

      @GET("v1/self/savingsaccounts/template") retrofit2.Call<String> template18(@Query("clientId") Long clientId, @Query("productId") Long productId, @HeaderMap Map<String,String> headers)
      Parameters:
      clientId - (optional)
      productId - (optional)
      Returns:
      Call<String>

    • modifySavingsAccountApplication

      @Headers("Content-Type:application/json") @PUT("v1/self/savingsaccounts/{accountId}") retrofit2.Call<String> modifySavingsAccountApplication(@Path("accountId") Long accountId, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Parameters:
      accountId - (required)
      command - (optional)
      body - (optional)
      Returns:
      Call<String>

    • submitSavingsAccountApplication

      @Headers("Content-Type:application/json") @POST("v1/self/savingsaccounts") retrofit2.Call<String> submitSavingsAccountApplication(@Query("command") String command, @HeaderMap Map<String,String> headers)
      Parameters:
      command - (optional)
      body - (optional)
      Returns:
      Call<String>