Package org.apache.fineract.client.services

Interface FixedDepositProductApi

public interface FixedDepositProductApi

  • Method Summary

    Modifier and Type
    Method
    Description
    retrofit2.Call<PostFixedDepositProductsResponse>
    create11(PostFixedDepositProductsRequest postFixedDepositProductsRequest)
    Create a Fixed Deposit Product Creates a Fixed Deposit Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minDepositTerm, minDepositTermTypeId, accountingRule Optional Fields: lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts, , withHoldTax, taxGroupId Mandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId
    retrofit2.Call<PostFixedDepositProductsResponse>
    create11(PostFixedDepositProductsRequest postFixedDepositProductsRequest, Map<String,String> headers)
    Create a Fixed Deposit Product Creates a Fixed Deposit Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minDepositTerm, minDepositTermTypeId, accountingRule Optional Fields: lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts, , withHoldTax, taxGroupId Mandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId
    retrofit2.Call<DeleteFixedDepositProductsProductIdResponse>
    delete15(Long productId)
    Delete a Fixed Deposit Product Deletes a Fixed Deposit Product
    retrofit2.Call<DeleteFixedDepositProductsProductIdResponse>
    delete15(Long productId, Map<String,String> headers)
    Delete a Fixed Deposit Product Deletes a Fixed Deposit Product
    retrofit2.Call<List<GetFixedDepositProductsResponse>>
    retrieveAll30()
    List Fixed Deposit Products Lists Fixed Deposit Products Example Requests: fixeddepositproducts fixeddepositproducts?fields=name
    retrofit2.Call<List<GetFixedDepositProductsResponse>>
    retrieveAll30(Map<String,String> headers)
    List Fixed Deposit Products Lists Fixed Deposit Products Example Requests: fixeddepositproducts fixeddepositproducts?fields=name
    retrofit2.Call<GetFixedDepositProductsProductIdResponse>
    retrieveOne20(Long productId)
    Retrieve a Fixed Deposit Product Retrieves a Fixed Deposit Product Example Requests: fixeddepositproducts/1 fixeddepositproducts/1?template=true fixeddepositproducts/1?fields=name,description
    retrofit2.Call<GetFixedDepositProductsProductIdResponse>
    retrieveOne20(Long productId, Map<String,String> headers)
    Retrieve a Fixed Deposit Product Retrieves a Fixed Deposit Product Example Requests: fixeddepositproducts/1 fixeddepositproducts/1?template=true fixeddepositproducts/1?fields=name,description
    retrofit2.Call<String>
    retrieveTemplate15()
     
    retrofit2.Call<String>
    retrieveTemplate15(Map<String,String> headers)
     
    retrofit2.Call<PutFixedDepositProductsProductIdResponse>
    update17(Long productId, PutFixedDepositProductsProductIdRequest putFixedDepositProductsProductIdRequest)
    Update a Fixed Deposit Product Updates a Fixed Deposit Product
    retrofit2.Call<PutFixedDepositProductsProductIdResponse>
    update17(Long productId, PutFixedDepositProductsProductIdRequest putFixedDepositProductsProductIdRequest, Map<String,String> headers)
    Update a Fixed Deposit Product Updates a Fixed Deposit Product

  • Method Details

    • create11

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

    • delete15

      @DELETE("v1/fixeddepositproducts/{productId}") retrofit2.Call<DeleteFixedDepositProductsProductIdResponse> delete15(@Path("productId") Long productId)
      Delete a Fixed Deposit Product Deletes a Fixed Deposit Product
      Parameters:
      productId - productId (required)
      Returns:
      Call<DeleteFixedDepositProductsProductIdResponse>

    • retrieveAll30

      @GET("v1/fixeddepositproducts") retrofit2.Call<List<GetFixedDepositProductsResponse>> retrieveAll30()
      List Fixed Deposit Products Lists Fixed Deposit Products Example Requests: fixeddepositproducts fixeddepositproducts?fields=name
      Returns:
      Call<List<GetFixedDepositProductsResponse>>

    • retrieveOne20

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

    • retrieveTemplate15

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

    • update17

      @Headers("Content-Type:application/json") @PUT("v1/fixeddepositproducts/{productId}") retrofit2.Call<PutFixedDepositProductsProductIdResponse> update17(@Path("productId") Long productId, @Body PutFixedDepositProductsProductIdRequest putFixedDepositProductsProductIdRequest)
      Update a Fixed Deposit Product Updates a Fixed Deposit Product
      Parameters:
      productId - productId (required)
      putFixedDepositProductsProductIdRequest - (required)
      Returns:
      Call<PutFixedDepositProductsProductIdResponse>

    • create11

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

    • delete15

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

    • retrieveAll30

      @GET("v1/fixeddepositproducts") retrofit2.Call<List<GetFixedDepositProductsResponse>> retrieveAll30(@HeaderMap Map<String,String> headers)
      List Fixed Deposit Products Lists Fixed Deposit Products Example Requests: fixeddepositproducts fixeddepositproducts?fields=name
      Returns:
      Call<List<GetFixedDepositProductsResponse>>

    • retrieveOne20

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

    • retrieveTemplate15

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

    • update17

      @Headers("Content-Type:application/json") @PUT("v1/fixeddepositproducts/{productId}") retrofit2.Call<PutFixedDepositProductsProductIdResponse> update17(@Path("productId") Long productId, @Body PutFixedDepositProductsProductIdRequest putFixedDepositProductsProductIdRequest, @HeaderMap Map<String,String> headers)
      Update a Fixed Deposit Product Updates a Fixed Deposit Product
      Parameters:
      productId - productId (required)
      putFixedDepositProductsProductIdRequest - (required)
      Returns:
      Call<PutFixedDepositProductsProductIdResponse>