Package org.apache.fineract.client.services

Interface LoanInterestPauseApi

public interface LoanInterestPauseApi

  • Method Details

    • createInterestPause

      @Headers("Content-Type:application/json") @POST("v1/loans/{loanId}/interest-pauses") retrofit2.Call<CommandProcessingResult> createInterestPause(@Path("loanId") Long loanId, @Body InterestPauseRequestDto interestPauseRequestDto)
      Create a new interest pause period for a loan Allows users to define a period during which no interest will be accrued for a specific loan.
      Parameters:
      loanId - loanId (required)
      interestPauseRequestDto - (required)
      Returns:
      Call<CommandProcessingResult>

    • createInterestPauseByExternalId

      @Headers("Content-Type:application/json") @POST("v1/loans/external-id/{loanExternalId}/interest-pauses") retrofit2.Call<CommandProcessingResult> createInterestPauseByExternalId(@Path("loanExternalId") String loanExternalId, @Body InterestPauseRequestDto interestPauseRequestDto)
      Create a new interest pause for a loan using external ID Allows users to define a period during which no interest will be accrued for a specific loan using the external loan ID.
      Parameters:
      loanExternalId - loanExternalId (required)
      interestPauseRequestDto - (required)
      Returns:
      Call<CommandProcessingResult>

    • deleteInterestPause

      @DELETE("v1/loans/{loanId}/interest-pauses/{variationId}") retrofit2.Call<Void> deleteInterestPause(@Path("loanId") Long loanId, @Path("variationId") Long variationId)
      Delete an interest pause period Deletes a specific interest pause period by its variation ID.
      Parameters:
      loanId - loanId (required)
      variationId - variationId (required)
      Returns:
      Call<Void>

    • deleteInterestPauseByExternalId

      @DELETE("v1/loans/external-id/{loanExternalId}/interest-pauses/{variationId}") retrofit2.Call<Void> deleteInterestPauseByExternalId(@Path("loanExternalId") String loanExternalId, @Path("variationId") Long variationId)
      Delete an interest pause period by external id Deletes a specific interest pause period by its variation ID.
      Parameters:
      loanExternalId - loanExternalId (required)
      variationId - variationId (required)
      Returns:
      Call<Void>

    • retrieveInterestPauses

      @GET("v1/loans/{loanId}/interest-pauses") retrofit2.Call<List<InterestPauseResponseDto>> retrieveInterestPauses(@Path("loanId") Long loanId)
      Retrieve all interest pause periods for a loan Fetches a list of all active interest pause periods for a specific loan.
      Parameters:
      loanId - loanId (required)
      Returns:
      Call<List<InterestPauseResponseDto>>

    • retrieveInterestPausesByExternalId

      @GET("v1/loans/external-id/{loanExternalId}/interest-pauses") retrofit2.Call<List<InterestPauseResponseDto>> retrieveInterestPausesByExternalId(@Path("loanExternalId") String loanExternalId)
      Retrieve all interest pause periods for a loan using external ID Fetches a list of all active interest pause periods for a specific loan using the external loan ID.
      Parameters:
      loanExternalId - loanExternalId (required)
      Returns:
      Call<List<InterestPauseResponseDto>>

    • updateInterestPause

      @Headers("Content-Type:application/json") @PUT("v1/loans/{loanId}/interest-pauses/{variationId}") retrofit2.Call<CommandProcessingResult> updateInterestPause(@Path("loanId") Long loanId, @Path("variationId") Long variationId, @Body InterestPauseRequestDto interestPauseRequestDto)
      Update an interest pause period Updates a specific interest pause period by its variation ID.
      Parameters:
      loanId - loanId (required)
      variationId - variationId (required)
      interestPauseRequestDto - (required)
      Returns:
      Call<CommandProcessingResult>

    • updateInterestPauseByExternalId

      @Headers("Content-Type:application/json") @PUT("v1/loans/external-id/{loanExternalId}/interest-pauses/{variationId}") retrofit2.Call<CommandProcessingResult> updateInterestPauseByExternalId(@Path("loanExternalId") String loanExternalId, @Path("variationId") Long variationId, @Body InterestPauseRequestDto interestPauseRequestDto)
      Update an interest pause period by external id Updates a specific interest pause period by its variation ID.
      Parameters:
      loanExternalId - loanExternalId (required)
      variationId - variationId (required)
      interestPauseRequestDto - (required)
      Returns:
      Call<CommandProcessingResult>

    • createInterestPause

      @Headers("Content-Type:application/json") @POST("v1/loans/{loanId}/interest-pauses") retrofit2.Call<CommandProcessingResult> createInterestPause(@Path("loanId") Long loanId, @Body InterestPauseRequestDto interestPauseRequestDto, @HeaderMap Map<String,String> headers)
      Create a new interest pause period for a loan Allows users to define a period during which no interest will be accrued for a specific loan.
      Parameters:
      loanId - loanId (required)
      interestPauseRequestDto - (required)
      Returns:
      Call<CommandProcessingResult>

    • createInterestPauseByExternalId

      @Headers("Content-Type:application/json") @POST("v1/loans/external-id/{loanExternalId}/interest-pauses") retrofit2.Call<CommandProcessingResult> createInterestPauseByExternalId(@Path("loanExternalId") String loanExternalId, @Body InterestPauseRequestDto interestPauseRequestDto, @HeaderMap Map<String,String> headers)
      Create a new interest pause for a loan using external ID Allows users to define a period during which no interest will be accrued for a specific loan using the external loan ID.
      Parameters:
      loanExternalId - loanExternalId (required)
      interestPauseRequestDto - (required)
      Returns:
      Call<CommandProcessingResult>

    • deleteInterestPause

      @DELETE("v1/loans/{loanId}/interest-pauses/{variationId}") retrofit2.Call<Void> deleteInterestPause(@Path("loanId") Long loanId, @Path("variationId") Long variationId, @HeaderMap Map<String,String> headers)
      Delete an interest pause period Deletes a specific interest pause period by its variation ID.
      Parameters:
      loanId - loanId (required)
      variationId - variationId (required)
      Returns:
      Call<Void>

    • deleteInterestPauseByExternalId

      @DELETE("v1/loans/external-id/{loanExternalId}/interest-pauses/{variationId}") retrofit2.Call<Void> deleteInterestPauseByExternalId(@Path("loanExternalId") String loanExternalId, @Path("variationId") Long variationId, @HeaderMap Map<String,String> headers)
      Delete an interest pause period by external id Deletes a specific interest pause period by its variation ID.
      Parameters:
      loanExternalId - loanExternalId (required)
      variationId - variationId (required)
      Returns:
      Call<Void>

    • retrieveInterestPauses

      @GET("v1/loans/{loanId}/interest-pauses") retrofit2.Call<List<InterestPauseResponseDto>> retrieveInterestPauses(@Path("loanId") Long loanId, @HeaderMap Map<String,String> headers)
      Retrieve all interest pause periods for a loan Fetches a list of all active interest pause periods for a specific loan.
      Parameters:
      loanId - loanId (required)
      Returns:
      Call<List<InterestPauseResponseDto>>

    • retrieveInterestPausesByExternalId

      @GET("v1/loans/external-id/{loanExternalId}/interest-pauses") retrofit2.Call<List<InterestPauseResponseDto>> retrieveInterestPausesByExternalId(@Path("loanExternalId") String loanExternalId, @HeaderMap Map<String,String> headers)
      Retrieve all interest pause periods for a loan using external ID Fetches a list of all active interest pause periods for a specific loan using the external loan ID.
      Parameters:
      loanExternalId - loanExternalId (required)
      Returns:
      Call<List<InterestPauseResponseDto>>

    • updateInterestPause

      @Headers("Content-Type:application/json") @PUT("v1/loans/{loanId}/interest-pauses/{variationId}") retrofit2.Call<CommandProcessingResult> updateInterestPause(@Path("loanId") Long loanId, @Path("variationId") Long variationId, @Body InterestPauseRequestDto interestPauseRequestDto, @HeaderMap Map<String,String> headers)
      Update an interest pause period Updates a specific interest pause period by its variation ID.
      Parameters:
      loanId - loanId (required)
      variationId - variationId (required)
      interestPauseRequestDto - (required)
      Returns:
      Call<CommandProcessingResult>

    • updateInterestPauseByExternalId

      @Headers("Content-Type:application/json") @PUT("v1/loans/external-id/{loanExternalId}/interest-pauses/{variationId}") retrofit2.Call<CommandProcessingResult> updateInterestPauseByExternalId(@Path("loanExternalId") String loanExternalId, @Path("variationId") Long variationId, @Body InterestPauseRequestDto interestPauseRequestDto, @HeaderMap Map<String,String> headers)
      Update an interest pause period by external id Updates a specific interest pause period by its variation ID.
      Parameters:
      loanExternalId - loanExternalId (required)
      variationId - variationId (required)
      interestPauseRequestDto - (required)
      Returns:
      Call<CommandProcessingResult>