Package org.apache.fineract.client.services

Interface SavingsChargesApi

public interface SavingsChargesApi

  • Method Details

    • addSavingsAccountCharge

      @Headers("Content-Type:application/json") @POST("v1/savingsaccounts/{savingsAccountId}/charges") retrofit2.Call<PostSavingsAccountsSavingsAccountIdChargesResponse> addSavingsAccountCharge(@Path("savingsAccountId") Long savingsAccountId, @Body PostSavingsAccountsSavingsAccountIdChargesRequest postSavingsAccountsSavingsAccountIdChargesRequest)
      Create a Savings account Charge Creates a Savings account Charge Mandatory Fields for Savings account Charges: chargeId, amount chargeId, amount, dueDate, dateFormat, locale chargeId, amount, feeOnMonthDay, monthDayFormat, locale
      Parameters:
      savingsAccountId - savingsAccountId (required)
      postSavingsAccountsSavingsAccountIdChargesRequest - (required)
      Returns:
      Call<PostSavingsAccountsSavingsAccountIdChargesResponse>

    • deleteSavingsAccountCharge

      @DELETE("v1/savingsaccounts/{savingsAccountId}/charges/{savingsAccountChargeId}") retrofit2.Call<DeleteSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse> deleteSavingsAccountCharge(@Path("savingsAccountId") Long savingsAccountId, @Path("savingsAccountChargeId") Long savingsAccountChargeId)
      Delete a Savings account Charge Note: Currently, A Savings account Charge may only be removed from Savings that are not yet approved.
      Parameters:
      savingsAccountId - savingsAccountId (required)
      savingsAccountChargeId - savingsAccountChargeId (required)
      Returns:
      Call<DeleteSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse>

    • payOrWaiveSavingsAccountCharge

      @Headers("Content-Type:application/json") @POST("v1/savingsaccounts/{savingsAccountId}/charges/{savingsAccountChargeId}") retrofit2.Call<PostSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse> payOrWaiveSavingsAccountCharge(@Path("savingsAccountId") Long savingsAccountId, @Path("savingsAccountChargeId") Long savingsAccountChargeId, @Body PostSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest postSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest, @Query("command") String command)
      Pay a Savings account Charge | Waive off a Savings account Charge | Inactivate a Savings account Charge Pay a Savings account Charge: An active charge will be paid when savings account is active and having sufficient balance. Waive off a Savings account Charge: Outstanding charge amount will be waived off. Inactivate a Savings account Charge: A charge will be allowed to inactivate when savings account is active and not having any dues as of today. If charge is overpaid, corresponding charge payment transactions will be reversed. Showing request/response for 'Pay a Savings account Charge'
      Parameters:
      savingsAccountId - savingsAccountId (required)
      savingsAccountChargeId - savingsAccountChargeId (required)
      postSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse>

    • retrieveAllSavingsAccountCharges

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

    • retrieveSavingsAccountCharge

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

    • retrieveTemplate18

      @GET("v1/savingsaccounts/{savingsAccountId}/charges/template") retrofit2.Call<GetSavingsAccountsSavingsAccountIdChargesTemplateResponse> retrieveTemplate18(@Path("savingsAccountId") Long savingsAccountId)
      Retrieve Savings Charges Template This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: savingsaccounts/1/charges/template
      Parameters:
      savingsAccountId - savingsAccountId (required)
      Returns:
      Call<GetSavingsAccountsSavingsAccountIdChargesTemplateResponse>

    • updateSavingsAccountCharge

      @Headers("Content-Type:application/json") @PUT("v1/savingsaccounts/{savingsAccountId}/charges/{savingsAccountChargeId}") retrofit2.Call<PutSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse> updateSavingsAccountCharge(@Path("savingsAccountId") Long savingsAccountId, @Path("savingsAccountChargeId") Long savingsAccountChargeId, @Body PutSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest putSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest)
      Update a Savings account Charge Currently Savings account Charges may be updated only if the Savings account is not yet approved.
      Parameters:
      savingsAccountId - savingsAccountId (required)
      savingsAccountChargeId - savingsAccountChargeId (required)
      putSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest - (required)
      Returns:
      Call<PutSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse>

    • addSavingsAccountCharge

      @Headers("Content-Type:application/json") @POST("v1/savingsaccounts/{savingsAccountId}/charges") retrofit2.Call<PostSavingsAccountsSavingsAccountIdChargesResponse> addSavingsAccountCharge(@Path("savingsAccountId") Long savingsAccountId, @Body PostSavingsAccountsSavingsAccountIdChargesRequest postSavingsAccountsSavingsAccountIdChargesRequest, @HeaderMap Map<String,String> headers)
      Create a Savings account Charge Creates a Savings account Charge Mandatory Fields for Savings account Charges: chargeId, amount chargeId, amount, dueDate, dateFormat, locale chargeId, amount, feeOnMonthDay, monthDayFormat, locale
      Parameters:
      savingsAccountId - savingsAccountId (required)
      postSavingsAccountsSavingsAccountIdChargesRequest - (required)
      Returns:
      Call<PostSavingsAccountsSavingsAccountIdChargesResponse>

    • deleteSavingsAccountCharge

      @DELETE("v1/savingsaccounts/{savingsAccountId}/charges/{savingsAccountChargeId}") retrofit2.Call<DeleteSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse> deleteSavingsAccountCharge(@Path("savingsAccountId") Long savingsAccountId, @Path("savingsAccountChargeId") Long savingsAccountChargeId, @HeaderMap Map<String,String> headers)
      Delete a Savings account Charge Note: Currently, A Savings account Charge may only be removed from Savings that are not yet approved.
      Parameters:
      savingsAccountId - savingsAccountId (required)
      savingsAccountChargeId - savingsAccountChargeId (required)
      Returns:
      Call<DeleteSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse>

    • payOrWaiveSavingsAccountCharge

      @Headers("Content-Type:application/json") @POST("v1/savingsaccounts/{savingsAccountId}/charges/{savingsAccountChargeId}") retrofit2.Call<PostSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse> payOrWaiveSavingsAccountCharge(@Path("savingsAccountId") Long savingsAccountId, @Path("savingsAccountChargeId") Long savingsAccountChargeId, @Body PostSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest postSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Pay a Savings account Charge | Waive off a Savings account Charge | Inactivate a Savings account Charge Pay a Savings account Charge: An active charge will be paid when savings account is active and having sufficient balance. Waive off a Savings account Charge: Outstanding charge amount will be waived off. Inactivate a Savings account Charge: A charge will be allowed to inactivate when savings account is active and not having any dues as of today. If charge is overpaid, corresponding charge payment transactions will be reversed. Showing request/response for 'Pay a Savings account Charge'
      Parameters:
      savingsAccountId - savingsAccountId (required)
      savingsAccountChargeId - savingsAccountChargeId (required)
      postSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse>

    • retrieveAllSavingsAccountCharges

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

    • retrieveSavingsAccountCharge

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

    • retrieveTemplate18

      @GET("v1/savingsaccounts/{savingsAccountId}/charges/template") retrofit2.Call<GetSavingsAccountsSavingsAccountIdChargesTemplateResponse> retrieveTemplate18(@Path("savingsAccountId") Long savingsAccountId, @HeaderMap Map<String,String> headers)
      Retrieve Savings Charges Template This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: savingsaccounts/1/charges/template
      Parameters:
      savingsAccountId - savingsAccountId (required)
      Returns:
      Call<GetSavingsAccountsSavingsAccountIdChargesTemplateResponse>

    • updateSavingsAccountCharge

      @Headers("Content-Type:application/json") @PUT("v1/savingsaccounts/{savingsAccountId}/charges/{savingsAccountChargeId}") retrofit2.Call<PutSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse> updateSavingsAccountCharge(@Path("savingsAccountId") Long savingsAccountId, @Path("savingsAccountChargeId") Long savingsAccountChargeId, @Body PutSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest putSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest, @HeaderMap Map<String,String> headers)
      Update a Savings account Charge Currently Savings account Charges may be updated only if the Savings account is not yet approved.
      Parameters:
      savingsAccountId - savingsAccountId (required)
      savingsAccountChargeId - savingsAccountChargeId (required)
      putSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest - (required)
      Returns:
      Call<PutSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse>