Package org.apache.fineract.client.services

Interface FixedDepositAccountApi

public interface FixedDepositAccountApi

  • Method Details

    • accountClosureTemplate

      @GET("v1/fixeddepositaccounts/{accountId}/template") retrofit2.Call<String> accountClosureTemplate(@Path("accountId") Long accountId, @Query("command") String command)
      Parameters:
      accountId - accountId (required)
      command - command (optional)
      Returns:
      Call<String>

    • calculateFixedDepositInterest

      @GET("v1/fixeddepositaccounts/calculate-fd-interest") retrofit2.Call<CalculateFixedDepositInterestResponse> calculateFixedDepositInterest(@Query("principalAmount") BigDecimal principalAmount, @Query("annualInterestRate") BigDecimal annualInterestRate, @Query("tenureInMonths") Long tenureInMonths, @Query("interestCompoundingPeriodInMonths") Long interestCompoundingPeriodInMonths, @Query("interestPostingPeriodInMonths") Long interestPostingPeriodInMonths)
      Parameters:
      principalAmount - BigDecimal principalAmount (optional)
      annualInterestRate - annualInterestRate (optional)
      tenureInMonths - tenureInMonths (optional)
      interestCompoundingPeriodInMonths - interestCompoundingPeriodInMonths (optional)
      interestPostingPeriodInMonths - interestPostingPeriodInMonths (optional)
      Returns:
      Call<CalculateFixedDepositInterestResponse>

    • delete14

      @DELETE("v1/fixeddepositaccounts/{accountId}") retrofit2.Call<DeleteFixedDepositAccountsAccountIdResponse> delete14(@Path("accountId") Long accountId)
      Delete a fixed deposit application At present we support hard delete of fixed deposit application so long as its in 'Submitted and pending approval' state. One the application is moves past this state, it is not possible to do a 'hard' delete of the application or the account. An API endpoint will be added to close/de-activate the fixed deposit account.
      Parameters:
      accountId - accountId (required)
      Returns:
      Call<DeleteFixedDepositAccountsAccountIdResponse>

    • getFixedDepositTemplate

      @GET("v1/fixeddepositaccounts/downloadtemplate") retrofit2.Call<Void> getFixedDepositTemplate(@Query("officeId") Long officeId, @Query("staffId") Long staffId, @Query("dateFormat") String dateFormat)
      Parameters:
      officeId - (optional)
      staffId - (optional)
      dateFormat - (optional)
      Returns:
      Call<Void>

    • getFixedDepositTransactionTemplate

      @GET("v1/fixeddepositaccounts/transaction/downloadtemplate") retrofit2.Call<Void> getFixedDepositTransactionTemplate(@Query("officeId") Long officeId, @Query("dateFormat") String dateFormat)
      Parameters:
      officeId - (optional)
      dateFormat - (optional)
      Returns:
      Call<Void>

    • handleCommands4

      @Headers("Content-Type:application/json") @POST("v1/fixeddepositaccounts/{accountId}") retrofit2.Call<PostFixedDepositAccountsAccountIdResponse> handleCommands4(@Path("accountId") Long accountId, @Body Object body, @Query("command") String command)
      Approve fixed deposit application | Undo approval fixed deposit application | Reject fixed deposit application | Withdraw fixed deposit application | Activate a fixed deposit account | Close a fixed deposit account | Premature Close a fixed deposit account | Calculate Premature amount on Fixed deposit account | Calculate Interest on Fixed Deposit Account | Post Interest on Fixed Deposit Account Approve fixed deposit application: Approves fixed deposit application so long as its in 'Submitted and pending approval' state. Undo approval fixed deposit application: Will move 'approved' fixed deposit application back to 'Submitted and pending approval' state. Reject fixed deposit application: Rejects fixed deposit application so long as its in 'Submitted and pending approval' state. Withdraw fixed deposit application: Used when an applicant withdraws from the fixed deposit application. It must be in 'Submitted and pending approval' state. Close a fixed deposit account: Results in a Matured fixed deposit account being converted into a 'closed' fixed deposit account. Premature Close a fixed deposit account: Results in an Active fixed deposit account being converted into a 'Premature Closed' fixed deposit account with options to withdraw prematured amount. (premature amount is calculated using interest rate chart applicable along with penal interest if any.) Calculate Premature amount on Fixed deposit account: Calculate premature amount on fixed deposit account till premature close date. Premature amount is calculated based on interest chart and penal interest applicable. Calculate Interest on Fixed Deposit Account: Calculates interest earned on a fixed deposit account based on todays date. It does not attempt to post or credit the interest on the account. That is responsibility of the Post Interest API that will likely be called by overnight process. Post Interest on Fixed Deposit Account: Calculates and Posts interest earned on a fixed deposit account based on today's date and whether an interest posting or crediting event is due. Showing request/response for Calculate Interest on Fixed Deposit Account
      Parameters:
      accountId - accountId (required)
      body - (required)
      command - command (optional)
      Returns:
      Call<PostFixedDepositAccountsAccountIdResponse>

    • postFixedDepositTemplate

      @Multipart @POST("v1/fixeddepositaccounts/uploadtemplate") retrofit2.Call<String> postFixedDepositTemplate(@Part("dateFormat") String dateFormat, @Part("locale") String locale, @Part okhttp3.MultipartBody.Part uploadedInputStream)
      Parameters:
      dateFormat - (optional)
      locale - (optional)
      uploadedInputStream - (optional)
      Returns:
      Call<String>

    • postFixedDepositTransactionTemplate

      @Multipart @POST("v1/fixeddepositaccounts/transaction/uploadtemplate") retrofit2.Call<String> postFixedDepositTransactionTemplate(@Part("dateFormat") String dateFormat, @Part("locale") String locale, @Part okhttp3.MultipartBody.Part uploadedInputStream)
      Parameters:
      dateFormat - (optional)
      locale - (optional)
      uploadedInputStream - (optional)
      Returns:
      Call<String>

    • retrieveAll29

      @GET("v1/fixeddepositaccounts") retrofit2.Call<List<GetFixedDepositAccountsResponse>> retrieveAll29(@Query("paged") Boolean paged, @Query("offset") Integer offset, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder)
      List Fixed deposit applications/accounts Lists Fixed Deposit Accounts Example Requests: fixeddepositaccounts fixeddepositaccounts?fields=name
      Parameters:
      paged - paged (optional)
      offset - offset (optional)
      limit - limit (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      Returns:
      Call<List<GetFixedDepositAccountsResponse>>

    • retrieveOne19

      @GET("v1/fixeddepositaccounts/{accountId}") retrofit2.Call<GetFixedDepositAccountsAccountIdResponse> retrieveOne19(@Path("accountId") Long accountId, @Query("staffInSelectedOfficeOnly") Boolean staffInSelectedOfficeOnly, @Query("chargeStatus") String chargeStatus)
      Retrieve a fixed deposit application/account Retrieves a fixed deposit application/account Example Requests : fixeddepositaccounts/1 fixeddepositaccounts/1?associations=all
      Parameters:
      accountId - accountId (required)
      staffInSelectedOfficeOnly - staffInSelectedOfficeOnly (optional, default to false)
      chargeStatus - chargeStatus (optional, default to all)
      Returns:
      Call<GetFixedDepositAccountsAccountIdResponse>

    • submitApplication

      @Headers("Content-Type:application/json") @POST("v1/fixeddepositaccounts") retrofit2.Call<PostFixedDepositAccountsResponse> submitApplication(@Body PostFixedDepositAccountsRequest postFixedDepositAccountsRequest)
      Submit new fixed deposit application Submits a new fixed deposit applicationMandatory Fields: clientId or groupId, productId, submittedOnDate, depositAmount, depositPeriod, depositPeriodFrequencyId Optional Fields: accountNo, externalId, fieldOfficerId,linkAccountId(if provided initial deposit amount will be collected from this account),transferInterestToSavings(By enabling this flag all interest postings will be transferred to linked saving account )
      Parameters:
      postFixedDepositAccountsRequest - (required)
      Returns:
      Call<PostFixedDepositAccountsResponse>

    • template12

      @GET("v1/fixeddepositaccounts/template") retrofit2.Call<GetFixedDepositAccountsTemplateResponse> template12(@Query("clientId") Long clientId, @Query("groupId") Long groupId, @Query("productId") Long productId, @Query("staffInSelectedOfficeOnly") Boolean staffInSelectedOfficeOnly)
      Retrieve Fixed Deposit Account Template This is a convenience resource. It can be useful when building maintenance user interface screens for fixed deposit applications. The template data returned consists of any or all of: Field Defaults Allowed Value ListsExample Requests: fixeddepositaccounts/template?clientId=1
      Parameters:
      clientId - clientId (optional)
      groupId - groupId (optional)
      productId - productId (optional)
      staffInSelectedOfficeOnly - staffInSelectedOfficeOnly (optional, default to false)
      Returns:
      Call<GetFixedDepositAccountsTemplateResponse>

    • update16

      @Headers("Content-Type:application/json") @PUT("v1/fixeddepositaccounts/{accountId}") retrofit2.Call<PutFixedDepositAccountsAccountIdResponse> update16(@Path("accountId") Long accountId, @Body PutFixedDepositAccountsAccountIdRequest putFixedDepositAccountsAccountIdRequest)
      Modify a fixed deposit application Fixed deposit application can only be modified when in 'Submitted and pending approval' state. Once the application is approved, the details cannot be changed using this method. Specific api endpoints will be created to allow change of interest detail such as rate, compounding period, posting period etc
      Parameters:
      accountId - accountId (required)
      putFixedDepositAccountsAccountIdRequest - (required)
      Returns:
      Call<PutFixedDepositAccountsAccountIdResponse>

    • accountClosureTemplate

      @GET("v1/fixeddepositaccounts/{accountId}/template") retrofit2.Call<String> accountClosureTemplate(@Path("accountId") Long accountId, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Parameters:
      accountId - accountId (required)
      command - command (optional)
      Returns:
      Call<String>

    • calculateFixedDepositInterest

      @GET("v1/fixeddepositaccounts/calculate-fd-interest") retrofit2.Call<CalculateFixedDepositInterestResponse> calculateFixedDepositInterest(@Query("principalAmount") BigDecimal principalAmount, @Query("annualInterestRate") BigDecimal annualInterestRate, @Query("tenureInMonths") Long tenureInMonths, @Query("interestCompoundingPeriodInMonths") Long interestCompoundingPeriodInMonths, @Query("interestPostingPeriodInMonths") Long interestPostingPeriodInMonths, @HeaderMap Map<String,String> headers)
      Parameters:
      principalAmount - BigDecimal principalAmount (optional)
      annualInterestRate - annualInterestRate (optional)
      tenureInMonths - tenureInMonths (optional)
      interestCompoundingPeriodInMonths - interestCompoundingPeriodInMonths (optional)
      interestPostingPeriodInMonths - interestPostingPeriodInMonths (optional)
      Returns:
      Call<CalculateFixedDepositInterestResponse>

    • delete14

      @DELETE("v1/fixeddepositaccounts/{accountId}") retrofit2.Call<DeleteFixedDepositAccountsAccountIdResponse> delete14(@Path("accountId") Long accountId, @HeaderMap Map<String,String> headers)
      Delete a fixed deposit application At present we support hard delete of fixed deposit application so long as its in 'Submitted and pending approval' state. One the application is moves past this state, it is not possible to do a 'hard' delete of the application or the account. An API endpoint will be added to close/de-activate the fixed deposit account.
      Parameters:
      accountId - accountId (required)
      Returns:
      Call<DeleteFixedDepositAccountsAccountIdResponse>

    • getFixedDepositTemplate

      @GET("v1/fixeddepositaccounts/downloadtemplate") retrofit2.Call<Void> getFixedDepositTemplate(@Query("officeId") Long officeId, @Query("staffId") Long staffId, @Query("dateFormat") String dateFormat, @HeaderMap Map<String,String> headers)
      Parameters:
      officeId - (optional)
      staffId - (optional)
      dateFormat - (optional)
      Returns:
      Call<Void>

    • getFixedDepositTransactionTemplate

      @GET("v1/fixeddepositaccounts/transaction/downloadtemplate") retrofit2.Call<Void> getFixedDepositTransactionTemplate(@Query("officeId") Long officeId, @Query("dateFormat") String dateFormat, @HeaderMap Map<String,String> headers)
      Parameters:
      officeId - (optional)
      dateFormat - (optional)
      Returns:
      Call<Void>

    • handleCommands4

      @Headers("Content-Type:application/json") @POST("v1/fixeddepositaccounts/{accountId}") retrofit2.Call<PostFixedDepositAccountsAccountIdResponse> handleCommands4(@Path("accountId") Long accountId, @Body Object body, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Approve fixed deposit application | Undo approval fixed deposit application | Reject fixed deposit application | Withdraw fixed deposit application | Activate a fixed deposit account | Close a fixed deposit account | Premature Close a fixed deposit account | Calculate Premature amount on Fixed deposit account | Calculate Interest on Fixed Deposit Account | Post Interest on Fixed Deposit Account Approve fixed deposit application: Approves fixed deposit application so long as its in 'Submitted and pending approval' state. Undo approval fixed deposit application: Will move 'approved' fixed deposit application back to 'Submitted and pending approval' state. Reject fixed deposit application: Rejects fixed deposit application so long as its in 'Submitted and pending approval' state. Withdraw fixed deposit application: Used when an applicant withdraws from the fixed deposit application. It must be in 'Submitted and pending approval' state. Close a fixed deposit account: Results in a Matured fixed deposit account being converted into a 'closed' fixed deposit account. Premature Close a fixed deposit account: Results in an Active fixed deposit account being converted into a 'Premature Closed' fixed deposit account with options to withdraw prematured amount. (premature amount is calculated using interest rate chart applicable along with penal interest if any.) Calculate Premature amount on Fixed deposit account: Calculate premature amount on fixed deposit account till premature close date. Premature amount is calculated based on interest chart and penal interest applicable. Calculate Interest on Fixed Deposit Account: Calculates interest earned on a fixed deposit account based on todays date. It does not attempt to post or credit the interest on the account. That is responsibility of the Post Interest API that will likely be called by overnight process. Post Interest on Fixed Deposit Account: Calculates and Posts interest earned on a fixed deposit account based on today's date and whether an interest posting or crediting event is due. Showing request/response for Calculate Interest on Fixed Deposit Account
      Parameters:
      accountId - accountId (required)
      body - (required)
      command - command (optional)
      Returns:
      Call<PostFixedDepositAccountsAccountIdResponse>

    • postFixedDepositTemplate

      @Multipart @POST("v1/fixeddepositaccounts/uploadtemplate") retrofit2.Call<String> postFixedDepositTemplate(@Part("dateFormat") String dateFormat, @Part("locale") String locale, @Part okhttp3.MultipartBody.Part uploadedInputStream, @HeaderMap Map<String,String> headers)
      Parameters:
      dateFormat - (optional)
      locale - (optional)
      uploadedInputStream - (optional)
      Returns:
      Call<String>

    • postFixedDepositTransactionTemplate

      @Multipart @POST("v1/fixeddepositaccounts/transaction/uploadtemplate") retrofit2.Call<String> postFixedDepositTransactionTemplate(@Part("dateFormat") String dateFormat, @Part("locale") String locale, @Part okhttp3.MultipartBody.Part uploadedInputStream, @HeaderMap Map<String,String> headers)
      Parameters:
      dateFormat - (optional)
      locale - (optional)
      uploadedInputStream - (optional)
      Returns:
      Call<String>

    • retrieveAll29

      @GET("v1/fixeddepositaccounts") retrofit2.Call<List<GetFixedDepositAccountsResponse>> retrieveAll29(@Query("paged") Boolean paged, @Query("offset") Integer offset, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder, @HeaderMap Map<String,String> headers)
      List Fixed deposit applications/accounts Lists Fixed Deposit Accounts Example Requests: fixeddepositaccounts fixeddepositaccounts?fields=name
      Parameters:
      paged - paged (optional)
      offset - offset (optional)
      limit - limit (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      Returns:
      Call<List<GetFixedDepositAccountsResponse>>

    • retrieveOne19

      @GET("v1/fixeddepositaccounts/{accountId}") retrofit2.Call<GetFixedDepositAccountsAccountIdResponse> retrieveOne19(@Path("accountId") Long accountId, @Query("staffInSelectedOfficeOnly") Boolean staffInSelectedOfficeOnly, @Query("chargeStatus") String chargeStatus, @HeaderMap Map<String,String> headers)
      Retrieve a fixed deposit application/account Retrieves a fixed deposit application/account Example Requests : fixeddepositaccounts/1 fixeddepositaccounts/1?associations=all
      Parameters:
      accountId - accountId (required)
      staffInSelectedOfficeOnly - staffInSelectedOfficeOnly (optional, default to false)
      chargeStatus - chargeStatus (optional, default to all)
      Returns:
      Call<GetFixedDepositAccountsAccountIdResponse>

    • submitApplication

      @Headers("Content-Type:application/json") @POST("v1/fixeddepositaccounts") retrofit2.Call<PostFixedDepositAccountsResponse> submitApplication(@Body PostFixedDepositAccountsRequest postFixedDepositAccountsRequest, @HeaderMap Map<String,String> headers)
      Submit new fixed deposit application Submits a new fixed deposit applicationMandatory Fields: clientId or groupId, productId, submittedOnDate, depositAmount, depositPeriod, depositPeriodFrequencyId Optional Fields: accountNo, externalId, fieldOfficerId,linkAccountId(if provided initial deposit amount will be collected from this account),transferInterestToSavings(By enabling this flag all interest postings will be transferred to linked saving account )
      Parameters:
      postFixedDepositAccountsRequest - (required)
      Returns:
      Call<PostFixedDepositAccountsResponse>

    • template12

      @GET("v1/fixeddepositaccounts/template") retrofit2.Call<GetFixedDepositAccountsTemplateResponse> template12(@Query("clientId") Long clientId, @Query("groupId") Long groupId, @Query("productId") Long productId, @Query("staffInSelectedOfficeOnly") Boolean staffInSelectedOfficeOnly, @HeaderMap Map<String,String> headers)
      Retrieve Fixed Deposit Account Template This is a convenience resource. It can be useful when building maintenance user interface screens for fixed deposit applications. The template data returned consists of any or all of: Field Defaults Allowed Value ListsExample Requests: fixeddepositaccounts/template?clientId=1
      Parameters:
      clientId - clientId (optional)
      groupId - groupId (optional)
      productId - productId (optional)
      staffInSelectedOfficeOnly - staffInSelectedOfficeOnly (optional, default to false)
      Returns:
      Call<GetFixedDepositAccountsTemplateResponse>

    • update16

      @Headers("Content-Type:application/json") @PUT("v1/fixeddepositaccounts/{accountId}") retrofit2.Call<PutFixedDepositAccountsAccountIdResponse> update16(@Path("accountId") Long accountId, @Body PutFixedDepositAccountsAccountIdRequest putFixedDepositAccountsAccountIdRequest, @HeaderMap Map<String,String> headers)
      Modify a fixed deposit application Fixed deposit application can only be modified when in 'Submitted and pending approval' state. Once the application is approved, the details cannot be changed using this method. Specific api endpoints will be created to allow change of interest detail such as rate, compounding period, posting period etc
      Parameters:
      accountId - accountId (required)
      putFixedDepositAccountsAccountIdRequest - (required)
      Returns:
      Call<PutFixedDepositAccountsAccountIdResponse>