Package org.apache.fineract.client.services

Interface RecurringDepositProductApi

public interface RecurringDepositProductApi

  • Method Summary

    Modifier and Type
    Method
    Description
    retrofit2.Call<PostRecurringDepositProductsResponse>
    create12(PostRecurringDepositProductsRequest postRecurringDepositProductsRequest)
    Create a Recurring Deposit Product Creates a Recurring Deposit Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minDepositTerm, minDepositTermTypeId, recurringDepositFrequency, recurringDepositFrequencyTypeId, accountingRule, depositAmount Mandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId Optional Fields: lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts, minDepositAmount, maxDepositAmount, withHoldTax, taxGroupId
    retrofit2.Call<PostRecurringDepositProductsResponse>
    create12(PostRecurringDepositProductsRequest postRecurringDepositProductsRequest, Map<String,String> headers)
    Create a Recurring Deposit Product Creates a Recurring Deposit Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minDepositTerm, minDepositTermTypeId, recurringDepositFrequency, recurringDepositFrequencyTypeId, accountingRule, depositAmount Mandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId Optional Fields: lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts, minDepositAmount, maxDepositAmount, withHoldTax, taxGroupId
    retrofit2.Call<DeleteRecurringDepositProductsProductIdResponse>
    delete17(Long productId)
    Delete a Recurring Deposit Product Deletes a Recurring Deposit Product
    retrofit2.Call<DeleteRecurringDepositProductsProductIdResponse>
    delete17(Long productId, Map<String,String> headers)
    Delete a Recurring Deposit Product Deletes a Recurring Deposit Product
    retrofit2.Call<List<GetRecurringDepositProductsResponse>>
    retrieveAll32()
    List Recuring Deposit Products Lists Recuring Deposit Products Example Requests: recurringdepositproducts recurringdepositproducts?fields=name
    retrofit2.Call<List<GetRecurringDepositProductsResponse>>
    retrieveAll32(Map<String,String> headers)
    List Recuring Deposit Products Lists Recuring Deposit Products Example Requests: recurringdepositproducts recurringdepositproducts?fields=name
    retrofit2.Call<GetRecurringDepositProductsProductIdResponse>
    retrieveOne23(Long productId)
    Retrieve a Recurring Deposit Product Retrieves a Recurring Deposit Product Example Requests: recurringdepositproducts/1 recurringdepositproducts/1?template=true recurringdepositproducts/1?fields=name,description
    retrofit2.Call<GetRecurringDepositProductsProductIdResponse>
    retrieveOne23(Long productId, Map<String,String> headers)
    Retrieve a Recurring Deposit Product Retrieves a Recurring Deposit Product Example Requests: recurringdepositproducts/1 recurringdepositproducts/1?template=true recurringdepositproducts/1?fields=name,description
    retrofit2.Call<String>
    retrieveTemplate17()
     
    retrofit2.Call<String>
    retrieveTemplate17(Map<String,String> headers)
     
    retrofit2.Call<PutRecurringDepositProductsResponse>
    update19(Long productId, PutRecurringDepositProductsRequest putRecurringDepositProductsRequest)
    Update a Recurring Deposit Product Updates a Recurring Deposit Product
    retrofit2.Call<PutRecurringDepositProductsResponse>
    update19(Long productId, PutRecurringDepositProductsRequest putRecurringDepositProductsRequest, Map<String,String> headers)
    Update a Recurring Deposit Product Updates a Recurring Deposit Product

  • Method Details

    • create12

      @Headers("Content-Type:application/json") @POST("v1/recurringdepositproducts") retrofit2.Call<PostRecurringDepositProductsResponse> create12(@Body PostRecurringDepositProductsRequest postRecurringDepositProductsRequest)
      Create a Recurring Deposit Product Creates a Recurring Deposit Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minDepositTerm, minDepositTermTypeId, recurringDepositFrequency, recurringDepositFrequencyTypeId, accountingRule, depositAmount Mandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId Optional Fields: lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts, minDepositAmount, maxDepositAmount, withHoldTax, taxGroupId
      Parameters:
      postRecurringDepositProductsRequest - (required)
      Returns:
      Call<PostRecurringDepositProductsResponse>

    • delete17

      @DELETE("v1/recurringdepositproducts/{productId}") retrofit2.Call<DeleteRecurringDepositProductsProductIdResponse> delete17(@Path("productId") Long productId)
      Delete a Recurring Deposit Product Deletes a Recurring Deposit Product
      Parameters:
      productId - productId (required)
      Returns:
      Call<DeleteRecurringDepositProductsProductIdResponse>

    • retrieveAll32

      @GET("v1/recurringdepositproducts") retrofit2.Call<List<GetRecurringDepositProductsResponse>> retrieveAll32()
      List Recuring Deposit Products Lists Recuring Deposit Products Example Requests: recurringdepositproducts recurringdepositproducts?fields=name
      Returns:
      Call<List<GetRecurringDepositProductsResponse>>

    • retrieveOne23

      @GET("v1/recurringdepositproducts/{productId}") retrofit2.Call<GetRecurringDepositProductsProductIdResponse> retrieveOne23(@Path("productId") Long productId)
      Retrieve a Recurring Deposit Product Retrieves a Recurring Deposit Product Example Requests: recurringdepositproducts/1 recurringdepositproducts/1?template=true recurringdepositproducts/1?fields=name,description
      Parameters:
      productId - productId (required)
      Returns:
      Call<GetRecurringDepositProductsProductIdResponse>

    • retrieveTemplate17

      @GET("v1/recurringdepositproducts/template") retrofit2.Call<String> retrieveTemplate17()
      Returns:
      Call<String>

    • update19

      @Headers("Content-Type:application/json") @PUT("v1/recurringdepositproducts/{productId}") retrofit2.Call<PutRecurringDepositProductsResponse> update19(@Path("productId") Long productId, @Body PutRecurringDepositProductsRequest putRecurringDepositProductsRequest)
      Update a Recurring Deposit Product Updates a Recurring Deposit Product
      Parameters:
      productId - productId (required)
      putRecurringDepositProductsRequest - (required)
      Returns:
      Call<PutRecurringDepositProductsResponse>

    • create12

      @Headers("Content-Type:application/json") @POST("v1/recurringdepositproducts") retrofit2.Call<PostRecurringDepositProductsResponse> create12(@Body PostRecurringDepositProductsRequest postRecurringDepositProductsRequest, @HeaderMap Map<String,String> headers)
      Create a Recurring Deposit Product Creates a Recurring Deposit Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minDepositTerm, minDepositTermTypeId, recurringDepositFrequency, recurringDepositFrequencyTypeId, accountingRule, depositAmount Mandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId Optional Fields: lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts, minDepositAmount, maxDepositAmount, withHoldTax, taxGroupId
      Parameters:
      postRecurringDepositProductsRequest - (required)
      Returns:
      Call<PostRecurringDepositProductsResponse>

    • delete17

      @DELETE("v1/recurringdepositproducts/{productId}") retrofit2.Call<DeleteRecurringDepositProductsProductIdResponse> delete17(@Path("productId") Long productId, @HeaderMap Map<String,String> headers)
      Delete a Recurring Deposit Product Deletes a Recurring Deposit Product
      Parameters:
      productId - productId (required)
      Returns:
      Call<DeleteRecurringDepositProductsProductIdResponse>

    • retrieveAll32

      @GET("v1/recurringdepositproducts") retrofit2.Call<List<GetRecurringDepositProductsResponse>> retrieveAll32(@HeaderMap Map<String,String> headers)
      List Recuring Deposit Products Lists Recuring Deposit Products Example Requests: recurringdepositproducts recurringdepositproducts?fields=name
      Returns:
      Call<List<GetRecurringDepositProductsResponse>>

    • retrieveOne23

      @GET("v1/recurringdepositproducts/{productId}") retrofit2.Call<GetRecurringDepositProductsProductIdResponse> retrieveOne23(@Path("productId") Long productId, @HeaderMap Map<String,String> headers)
      Retrieve a Recurring Deposit Product Retrieves a Recurring Deposit Product Example Requests: recurringdepositproducts/1 recurringdepositproducts/1?template=true recurringdepositproducts/1?fields=name,description
      Parameters:
      productId - productId (required)
      Returns:
      Call<GetRecurringDepositProductsProductIdResponse>

    • retrieveTemplate17

      @GET("v1/recurringdepositproducts/template") retrofit2.Call<String> retrieveTemplate17(@HeaderMap Map<String,String> headers)
      Returns:
      Call<String>

    • update19

      @Headers("Content-Type:application/json") @PUT("v1/recurringdepositproducts/{productId}") retrofit2.Call<PutRecurringDepositProductsResponse> update19(@Path("productId") Long productId, @Body PutRecurringDepositProductsRequest putRecurringDepositProductsRequest, @HeaderMap Map<String,String> headers)
      Update a Recurring Deposit Product Updates a Recurring Deposit Product
      Parameters:
      productId - productId (required)
      putRecurringDepositProductsRequest - (required)
      Returns:
      Call<PutRecurringDepositProductsResponse>