Package org.apache.fineract.client.services

Interface SavingsProductApi

public interface SavingsProductApi

  • Method Summary

    Modifier and Type
    Method
    Description
    retrofit2.Call<PostSavingsProductsResponse>
    create13(PostSavingsProductsRequest postSavingsProductsRequest)
    Create a Savings Product Creates a Savings Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, nominalAnnualInterestRate, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType,accountingRule Mandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId Optional Fields: minRequiredOpeningBalance, lockinPeriodFrequency, lockinPeriodFrequencyType, withdrawalFeeForTransfers, paymentChannelToFundSourceMappings, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, allowOverdraft, overdraftLimit, minBalanceForInterestCalculation,withHoldTax,taxGroupId,accountMapping, lienAllowed, maxAllowedLienLimit
    retrofit2.Call<PostSavingsProductsResponse>
    create13(PostSavingsProductsRequest postSavingsProductsRequest, Map<String,String> headers)
    Create a Savings Product Creates a Savings Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, nominalAnnualInterestRate, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType,accountingRule Mandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId Optional Fields: minRequiredOpeningBalance, lockinPeriodFrequency, lockinPeriodFrequencyType, withdrawalFeeForTransfers, paymentChannelToFundSourceMappings, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, allowOverdraft, overdraftLimit, minBalanceForInterestCalculation,withHoldTax,taxGroupId,accountMapping, lienAllowed, maxAllowedLienLimit
    retrofit2.Call<DeleteSavingsProductsProductIdResponse>
    delete20(Long productId)
    Delete a Savings Product Deletes a Savings Product
    retrofit2.Call<DeleteSavingsProductsProductIdResponse>
    delete20(Long productId, Map<String,String> headers)
    Delete a Savings Product Deletes a Savings Product
    retrofit2.Call<List<GetSavingsProductsResponse>>
    retrieveAll34()
    List Savings Products Lists Savings Products Example Requests: savingsproducts savingsproducts?fields=name
    retrofit2.Call<List<GetSavingsProductsResponse>>
    retrieveAll34(Map<String,String> headers)
    List Savings Products Lists Savings Products Example Requests: savingsproducts savingsproducts?fields=name
    retrofit2.Call<GetSavingsProductsProductIdResponse>
    retrieveOne27(Long productId)
    Retrieve a Savings Product Retrieves a Savings Product Example Requests: savingsproducts/1 savingsproducts/1?template=true savingsproducts/1?fields=name,description
    retrofit2.Call<GetSavingsProductsProductIdResponse>
    retrieveOne27(Long productId, Map<String,String> headers)
    Retrieve a Savings Product Retrieves a Savings Product Example Requests: savingsproducts/1 savingsproducts/1?template=true savingsproducts/1?fields=name,description
    retrofit2.Call<GetSavingsProductsTemplateResponse>
    retrieveTemplate20()
    Retrieve Savings Product Template This is a convenience resource.
    retrofit2.Call<GetSavingsProductsTemplateResponse>
    retrieveTemplate20(Map<String,String> headers)
    Retrieve Savings Product Template This is a convenience resource.
    retrofit2.Call<PutSavingsProductsProductIdResponse>
    update22(Long productId, PutSavingsProductsProductIdRequest putSavingsProductsProductIdRequest)
    Update a Savings Product Updates a Savings Product
    retrofit2.Call<PutSavingsProductsProductIdResponse>
    update22(Long productId, PutSavingsProductsProductIdRequest putSavingsProductsProductIdRequest, Map<String,String> headers)
    Update a Savings Product Updates a Savings Product

  • Method Details

    • create13

      @Headers("Content-Type:application/json") @POST("v1/savingsproducts") retrofit2.Call<PostSavingsProductsResponse> create13(@Body PostSavingsProductsRequest postSavingsProductsRequest)
      Create a Savings Product Creates a Savings Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, nominalAnnualInterestRate, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType,accountingRule Mandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId Optional Fields: minRequiredOpeningBalance, lockinPeriodFrequency, lockinPeriodFrequencyType, withdrawalFeeForTransfers, paymentChannelToFundSourceMappings, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, allowOverdraft, overdraftLimit, minBalanceForInterestCalculation,withHoldTax,taxGroupId,accountMapping, lienAllowed, maxAllowedLienLimit
      Parameters:
      postSavingsProductsRequest - (required)
      Returns:
      Call<PostSavingsProductsResponse>

    • delete20

      @DELETE("v1/savingsproducts/{productId}") retrofit2.Call<DeleteSavingsProductsProductIdResponse> delete20(@Path("productId") Long productId)
      Delete a Savings Product Deletes a Savings Product
      Parameters:
      productId - productId (required)
      Returns:
      Call<DeleteSavingsProductsProductIdResponse>

    • retrieveAll34

      @GET("v1/savingsproducts") retrofit2.Call<List<GetSavingsProductsResponse>> retrieveAll34()
      List Savings Products Lists Savings Products Example Requests: savingsproducts savingsproducts?fields=name
      Returns:
      Call<List<GetSavingsProductsResponse>>

    • retrieveOne27

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

    • retrieveTemplate20

      @GET("v1/savingsproducts/template") retrofit2.Call<GetSavingsProductsTemplateResponse> retrieveTemplate20()
      Retrieve Savings Product 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: Account Mapping: savingsproducts/template
      Returns:
      Call<GetSavingsProductsTemplateResponse>

    • update22

      @Headers("Content-Type:application/json") @PUT("v1/savingsproducts/{productId}") retrofit2.Call<PutSavingsProductsProductIdResponse> update22(@Path("productId") Long productId, @Body PutSavingsProductsProductIdRequest putSavingsProductsProductIdRequest)
      Update a Savings Product Updates a Savings Product
      Parameters:
      productId - productId (required)
      putSavingsProductsProductIdRequest - (required)
      Returns:
      Call<PutSavingsProductsProductIdResponse>

    • create13

      @Headers("Content-Type:application/json") @POST("v1/savingsproducts") retrofit2.Call<PostSavingsProductsResponse> create13(@Body PostSavingsProductsRequest postSavingsProductsRequest, @HeaderMap Map<String,String> headers)
      Create a Savings Product Creates a Savings Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, nominalAnnualInterestRate, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType,accountingRule Mandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId Optional Fields: minRequiredOpeningBalance, lockinPeriodFrequency, lockinPeriodFrequencyType, withdrawalFeeForTransfers, paymentChannelToFundSourceMappings, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, allowOverdraft, overdraftLimit, minBalanceForInterestCalculation,withHoldTax,taxGroupId,accountMapping, lienAllowed, maxAllowedLienLimit
      Parameters:
      postSavingsProductsRequest - (required)
      Returns:
      Call<PostSavingsProductsResponse>

    • delete20

      @DELETE("v1/savingsproducts/{productId}") retrofit2.Call<DeleteSavingsProductsProductIdResponse> delete20(@Path("productId") Long productId, @HeaderMap Map<String,String> headers)
      Delete a Savings Product Deletes a Savings Product
      Parameters:
      productId - productId (required)
      Returns:
      Call<DeleteSavingsProductsProductIdResponse>

    • retrieveAll34

      @GET("v1/savingsproducts") retrofit2.Call<List<GetSavingsProductsResponse>> retrieveAll34(@HeaderMap Map<String,String> headers)
      List Savings Products Lists Savings Products Example Requests: savingsproducts savingsproducts?fields=name
      Returns:
      Call<List<GetSavingsProductsResponse>>

    • retrieveOne27

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

    • retrieveTemplate20

      @GET("v1/savingsproducts/template") retrofit2.Call<GetSavingsProductsTemplateResponse> retrieveTemplate20(@HeaderMap Map<String,String> headers)
      Retrieve Savings Product 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: Account Mapping: savingsproducts/template
      Returns:
      Call<GetSavingsProductsTemplateResponse>

    • update22

      @Headers("Content-Type:application/json") @PUT("v1/savingsproducts/{productId}") retrofit2.Call<PutSavingsProductsProductIdResponse> update22(@Path("productId") Long productId, @Body PutSavingsProductsProductIdRequest putSavingsProductsProductIdRequest, @HeaderMap Map<String,String> headers)
      Update a Savings Product Updates a Savings Product
      Parameters:
      productId - productId (required)
      putSavingsProductsProductIdRequest - (required)
      Returns:
      Call<PutSavingsProductsProductIdResponse>