Package org.apache.fineract.client.services

Interface SavingsAccountApi

public interface SavingsAccountApi

  • Method Details

    • delete18

      @DELETE("v1/savingsaccounts/{accountId}") retrofit2.Call<DeleteSavingsAccountsAccountIdResponse> delete18(@Path("accountId") Long accountId)
      Delete a savings application At present we support hard delete of savings 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 savings account.
      Parameters:
      accountId - accountId (required)
      Returns:
      Call<DeleteSavingsAccountsAccountIdResponse>

    • delete19

      @DELETE("v1/savingsaccounts/external-id/{externalId}") retrofit2.Call<DeleteSavingsAccountsAccountIdResponse> delete19(@Path("externalId") String externalId)
      Delete a savings application At present we support hard delete of savings 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 savings account.
      Parameters:
      externalId - externalId (required)
      Returns:
      Call<DeleteSavingsAccountsAccountIdResponse>

    • getSavingsTemplate

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

    • getSavingsTransactionTemplate

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

    • handleCommands6

      @Headers("Content-Type:application/json") @POST("v1/savingsaccounts/{accountId}") retrofit2.Call<PostSavingsAccountsAccountIdResponse> handleCommands6(@Path("accountId") Long accountId, @Body PostSavingsAccountsAccountIdRequest postSavingsAccountsAccountIdRequest, @Query("command") String command)
      Approve savings application | Undo approval savings application | Assign Savings Officer | Unassign Savings Officer | Reject savings application | Withdraw savings application | Activate a savings account | Close a savings account | Calculate Interest on Savings Account | Post Interest on Savings Account | Block Savings Account | Unblock Savings Account | Block Savings Account Credit transactions | Unblock Savings Account Credit transactions | Block Savings Account Debit transactions | Unblock Savings Account debit transactions Approve savings application: Approves savings application so long as its in 'Submitted and pending approval' state. Undo approval savings application: Will move 'approved' savings application back to 'Submitted and pending approval' state. Assign Savings Officer: Allows you to assign Savings Officer for existing Savings Account. Unassign Savings Officer: Allows you to unassign the Savings Officer. Reject savings application: Rejects savings application so long as its in 'Submitted and pending approval' state. Withdraw savings application: Used when an applicant withdraws from the savings application. It must be in 'Submitted and pending approval' state. Activate a savings account: Results in an approved savings application being converted into an 'active' savings account. Close a savings account: Results in an Activated savings application being converted into an 'closed' savings account. closedOnDate is closure date of savings account withdrawBalance is a boolean description, true value of this field performs a withdrawal transaction with account's running balance. Mandatory Fields: dateFormat,locale,closedOnDate Optional Fields: note, withdrawBalance, paymentTypeId, accountNumber, checkNumber, routingCode, receiptNumber, bankNumber Calculate Interest on Savings Account: Calculates interest earned on a savings 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 Savings Account: Calculates and Posts interest earned on a savings account based on today's date and whether an interest posting or crediting event is due. Block Savings Account: Blocks Savings account from all types of credit and debit transactions Unblock Savings Account: Unblock a blocked account. On unblocking account, user can perform debit and credit transactions Block Savings Account Credit transactions: Savings account will be blocked from all types of credit transactions. Unblock Savings Account Credit transactions: It unblocks the Saving account's credit operations. Now all types of credits can be transacted to Savings account Block Savings Account Debit transactions: All types of debit operations from Savings account wil be blocked Unblock Savings Account debit transactions: It unblocks the Saving account's debit operations. Now all types of debits can be transacted from Savings account Showing request/response for 'Unassign Savings Officer'
      Parameters:
      accountId - accountId (required)
      postSavingsAccountsAccountIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostSavingsAccountsAccountIdResponse>

    • handleCommands7

      @Headers("Content-Type:application/json") @POST("v1/savingsaccounts/external-id/{externalId}") retrofit2.Call<PostSavingsAccountsAccountIdResponse> handleCommands7(@Path("externalId") String externalId, @Body PostSavingsAccountsAccountIdRequest postSavingsAccountsAccountIdRequest, @Query("command") String command)
      Approve savings application | Undo approval savings application | Assign Savings Officer | Unassign Savings Officer | Reject savings application | Withdraw savings application | Activate a savings account | Close a savings account | Calculate Interest on Savings Account | Post Interest on Savings Account | Block Savings Account | Unblock Savings Account | Block Savings Account Credit transactions | Unblock Savings Account Credit transactions | Block Savings Account Debit transactions | Unblock Savings Account debit transactions Approve savings application: Approves savings application so long as its in 'Submitted and pending approval' state. Undo approval savings application: Will move 'approved' savings application back to 'Submitted and pending approval' state. Assign Savings Officer: Allows you to assign Savings Officer for existing Savings Account. Unassign Savings Officer: Allows you to unassign the Savings Officer. Reject savings application: Rejects savings application so long as its in 'Submitted and pending approval' state. Withdraw savings application: Used when an applicant withdraws from the savings application. It must be in 'Submitted and pending approval' state. Activate a savings account: Results in an approved savings application being converted into an 'active' savings account. Close a savings account: Results in an Activated savings application being converted into an 'closed' savings account. closedOnDate is closure date of savings account withdrawBalance is a boolean description, true value of this field performs a withdrawal transaction with account's running balance. Mandatory Fields: dateFormat,locale,closedOnDate Optional Fields: note, withdrawBalance, paymentTypeId, accountNumber, checkNumber, routingCode, receiptNumber, bankNumber Calculate Interest on Savings Account: Calculates interest earned on a savings 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 Savings Account: Calculates and Posts interest earned on a savings account based on today's date and whether an interest posting or crediting event is due. Block Savings Account: Blocks Savings account from all types of credit and debit transactions Unblock Savings Account: Unblock a blocked account. On unblocking account, user can perform debit and credit transactions Block Savings Account Credit transactions: Savings account will be blocked from all types of credit transactions. Unblock Savings Account Credit transactions: It unblocks the Saving account's credit operations. Now all types of credits can be transacted to Savings account Block Savings Account Debit transactions: All types of debit operations from Savings account wil be blocked Unblock Savings Account debit transactions: It unblocks the Saving account's debit operations. Now all types of debits can be transacted from Savings account Showing request/response for 'Unassign Savings Officer'
      Parameters:
      externalId - externalId (required)
      postSavingsAccountsAccountIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostSavingsAccountsAccountIdResponse>

    • handleGSIMCommands

      @Headers("Content-Type:application/json") @POST("v1/savingsaccounts/gsimcommands/{parentAccountId}") retrofit2.Call<String> handleGSIMCommands(@Path("parentAccountId") Long parentAccountId, @Query("command") String command, @Body String body)
      Parameters:
      parentAccountId - (required)
      command - (optional)
      body - (optional)
      Returns:
      Call<String>

    • postSavingsTemplate

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

    • postSavingsTransactionTemplate

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

    • retrieveAll33

      @GET("v1/savingsaccounts") retrofit2.Call<GetSavingsAccountsResponse> retrieveAll33(@Query("externalId") String externalId, @Query("offset") Integer offset, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder)
      List savings applications/accounts Lists savings applications/accounts Example Requests: savingsaccounts savingsaccounts?fields=name
      Parameters:
      externalId - externalId (optional)
      offset - offset (optional)
      limit - limit (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      Returns:
      Call<GetSavingsAccountsResponse>

    • retrieveOne25

      @GET("v1/savingsaccounts/{accountId}") retrofit2.Call<SavingsAccountData> retrieveOne25(@Path("accountId") Long accountId, @Query("staffInSelectedOfficeOnly") Boolean staffInSelectedOfficeOnly, @Query("chargeStatus") String chargeStatus, @Query("associations") String associations)
      Parameters:
      accountId - (required)
      staffInSelectedOfficeOnly - (optional, default to false)
      chargeStatus - (optional, default to all)
      associations - (optional)
      Returns:
      Call<SavingsAccountData>

    • retrieveOne26

      @GET("v1/savingsaccounts/external-id/{externalId}") retrofit2.Call<SavingsAccountData> retrieveOne26(@Path("externalId") String externalId, @Query("staffInSelectedOfficeOnly") Boolean staffInSelectedOfficeOnly, @Query("chargeStatus") String chargeStatus, @Query("associations") String associations)
      Parameters:
      externalId - (required)
      staffInSelectedOfficeOnly - (optional, default to false)
      chargeStatus - (optional, default to all)
      associations - (optional)
      Returns:
      Call<SavingsAccountData>

    • submitApplication2

      @Headers("Content-Type:application/json") @POST("v1/savingsaccounts") retrofit2.Call<PostSavingsAccountsResponse> submitApplication2(@Body PostSavingsAccountsRequest postSavingsAccountsRequest)
      Submit new savings application Submits new savings application Mandatory Fields: clientId or groupId, productId, submittedOnDate Optional Fields: accountNo, externalId, fieldOfficerId Inherited from Product (if not provided): nominalAnnualInterestRate, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minRequiredOpeningBalance, lockinPeriodFrequency, lockinPeriodFrequencyType, withdrawalFeeForTransfers, allowOverdraft, overdraftLimit, withHoldTax Additional Mandatory Field if Entity-Datatable Check is enabled for the entity of type Savings: datatables
      Parameters:
      postSavingsAccountsRequest - (required)
      Returns:
      Call<PostSavingsAccountsResponse>

    • submitGSIMApplication

      @Headers("Content-Type:application/json") @POST("v1/savingsaccounts/gsim") retrofit2.Call<String> submitGSIMApplication(@Body String body)
      Parameters:
      body - (optional)
      Returns:
      Call<String>

    • template14

      @GET("v1/savingsaccounts/template") retrofit2.Call<GetSavingsAccountsTemplateResponse> template14(@Query("clientId") Long clientId, @Query("groupId") Long groupId, @Query("productId") Long productId, @Query("staffInSelectedOfficeOnly") Boolean staffInSelectedOfficeOnly)
      Retrieve Savings Account 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 Value Lists Example Requests: savingsaccounts/template?clientId=1 savingsaccounts/template?clientId=1&productId=1
      Parameters:
      clientId - clientId (optional)
      groupId - groupId (optional)
      productId - productId (optional)
      staffInSelectedOfficeOnly - staffInSelectedOfficeOnly (optional, default to false)
      Returns:
      Call<GetSavingsAccountsTemplateResponse>

    • update20

      @Headers("Content-Type:application/json") @PUT("v1/savingsaccounts/{accountId}") retrofit2.Call<PutSavingsAccountsAccountIdResponse> update20(@Path("accountId") Long accountId, @Body PutSavingsAccountsAccountIdRequest putSavingsAccountsAccountIdRequest, @Query("command") String command)
      Modify a savings application | Modify savings account withhold tax applicability Modify a savings application: Savings 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 Modify savings account withhold tax applicability: Savings application's withhold tax can be modified when in 'Active' state. Once the application is activated, can modify the account withhold tax to post tax or vice-versaShowing request/response for 'Modify a savings application'
      Parameters:
      accountId - accountId (required)
      putSavingsAccountsAccountIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PutSavingsAccountsAccountIdResponse>

    • update21

      @Headers("Content-Type:application/json") @PUT("v1/savingsaccounts/external-id/{externalId}") retrofit2.Call<PutSavingsAccountsAccountIdResponse> update21(@Path("externalId") String externalId, @Body PutSavingsAccountsAccountIdRequest putSavingsAccountsAccountIdRequest, @Query("command") String command)
      Modify a savings application | Modify savings account withhold tax applicability Modify a savings application: Savings 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 Modify savings account withhold tax applicability: Savings application's withhold tax can be modified when in 'Active' state. Once the application is activated, can modify the account withhold tax to post tax or vice-versaShowing request/response for 'Modify a savings application'
      Parameters:
      externalId - externalId (required)
      putSavingsAccountsAccountIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PutSavingsAccountsAccountIdResponse>

    • updateGsim

      @Headers("Content-Type:application/json") @PUT("v1/savingsaccounts/gsim/{parentAccountId}") retrofit2.Call<String> updateGsim(@Path("parentAccountId") Long parentAccountId, @Body String body)
      Parameters:
      parentAccountId - (required)
      body - (optional)
      Returns:
      Call<String>

    • handleGSIMCommands

      @Headers("Content-Type:application/json") @POST("v1/savingsaccounts/gsimcommands/{parentAccountId}") retrofit2.Call<String> handleGSIMCommands(@Path("parentAccountId") Long parentAccountId, @Query("command") String command)
      Parameters:
      parentAccountId - (required)
      command - (optional)
      body - (optional)
      Returns:
      Call<String>

    • submitGSIMApplication

      @Headers("Content-Type:application/json") @POST("v1/savingsaccounts/gsim") retrofit2.Call<String> submitGSIMApplication()
      Parameters:
      body - (optional)
      Returns:
      Call<String>

    • updateGsim

      @Headers("Content-Type:application/json") @PUT("v1/savingsaccounts/gsim/{parentAccountId}") retrofit2.Call<String> updateGsim(@Path("parentAccountId") Long parentAccountId)
      Parameters:
      parentAccountId - (required)
      body - (optional)
      Returns:
      Call<String>

    • delete18

      @DELETE("v1/savingsaccounts/{accountId}") retrofit2.Call<DeleteSavingsAccountsAccountIdResponse> delete18(@Path("accountId") Long accountId, @HeaderMap Map<String,String> headers)
      Delete a savings application At present we support hard delete of savings 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 savings account.
      Parameters:
      accountId - accountId (required)
      Returns:
      Call<DeleteSavingsAccountsAccountIdResponse>

    • delete19

      @DELETE("v1/savingsaccounts/external-id/{externalId}") retrofit2.Call<DeleteSavingsAccountsAccountIdResponse> delete19(@Path("externalId") String externalId, @HeaderMap Map<String,String> headers)
      Delete a savings application At present we support hard delete of savings 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 savings account.
      Parameters:
      externalId - externalId (required)
      Returns:
      Call<DeleteSavingsAccountsAccountIdResponse>

    • getSavingsTemplate

      @GET("v1/savingsaccounts/downloadtemplate") retrofit2.Call<Void> getSavingsTemplate(@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>

    • getSavingsTransactionTemplate

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

    • handleCommands6

      @Headers("Content-Type:application/json") @POST("v1/savingsaccounts/{accountId}") retrofit2.Call<PostSavingsAccountsAccountIdResponse> handleCommands6(@Path("accountId") Long accountId, @Body PostSavingsAccountsAccountIdRequest postSavingsAccountsAccountIdRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Approve savings application | Undo approval savings application | Assign Savings Officer | Unassign Savings Officer | Reject savings application | Withdraw savings application | Activate a savings account | Close a savings account | Calculate Interest on Savings Account | Post Interest on Savings Account | Block Savings Account | Unblock Savings Account | Block Savings Account Credit transactions | Unblock Savings Account Credit transactions | Block Savings Account Debit transactions | Unblock Savings Account debit transactions Approve savings application: Approves savings application so long as its in 'Submitted and pending approval' state. Undo approval savings application: Will move 'approved' savings application back to 'Submitted and pending approval' state. Assign Savings Officer: Allows you to assign Savings Officer for existing Savings Account. Unassign Savings Officer: Allows you to unassign the Savings Officer. Reject savings application: Rejects savings application so long as its in 'Submitted and pending approval' state. Withdraw savings application: Used when an applicant withdraws from the savings application. It must be in 'Submitted and pending approval' state. Activate a savings account: Results in an approved savings application being converted into an 'active' savings account. Close a savings account: Results in an Activated savings application being converted into an 'closed' savings account. closedOnDate is closure date of savings account withdrawBalance is a boolean description, true value of this field performs a withdrawal transaction with account's running balance. Mandatory Fields: dateFormat,locale,closedOnDate Optional Fields: note, withdrawBalance, paymentTypeId, accountNumber, checkNumber, routingCode, receiptNumber, bankNumber Calculate Interest on Savings Account: Calculates interest earned on a savings 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 Savings Account: Calculates and Posts interest earned on a savings account based on today's date and whether an interest posting or crediting event is due. Block Savings Account: Blocks Savings account from all types of credit and debit transactions Unblock Savings Account: Unblock a blocked account. On unblocking account, user can perform debit and credit transactions Block Savings Account Credit transactions: Savings account will be blocked from all types of credit transactions. Unblock Savings Account Credit transactions: It unblocks the Saving account's credit operations. Now all types of credits can be transacted to Savings account Block Savings Account Debit transactions: All types of debit operations from Savings account wil be blocked Unblock Savings Account debit transactions: It unblocks the Saving account's debit operations. Now all types of debits can be transacted from Savings account Showing request/response for 'Unassign Savings Officer'
      Parameters:
      accountId - accountId (required)
      postSavingsAccountsAccountIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostSavingsAccountsAccountIdResponse>

    • handleCommands7

      @Headers("Content-Type:application/json") @POST("v1/savingsaccounts/external-id/{externalId}") retrofit2.Call<PostSavingsAccountsAccountIdResponse> handleCommands7(@Path("externalId") String externalId, @Body PostSavingsAccountsAccountIdRequest postSavingsAccountsAccountIdRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Approve savings application | Undo approval savings application | Assign Savings Officer | Unassign Savings Officer | Reject savings application | Withdraw savings application | Activate a savings account | Close a savings account | Calculate Interest on Savings Account | Post Interest on Savings Account | Block Savings Account | Unblock Savings Account | Block Savings Account Credit transactions | Unblock Savings Account Credit transactions | Block Savings Account Debit transactions | Unblock Savings Account debit transactions Approve savings application: Approves savings application so long as its in 'Submitted and pending approval' state. Undo approval savings application: Will move 'approved' savings application back to 'Submitted and pending approval' state. Assign Savings Officer: Allows you to assign Savings Officer for existing Savings Account. Unassign Savings Officer: Allows you to unassign the Savings Officer. Reject savings application: Rejects savings application so long as its in 'Submitted and pending approval' state. Withdraw savings application: Used when an applicant withdraws from the savings application. It must be in 'Submitted and pending approval' state. Activate a savings account: Results in an approved savings application being converted into an 'active' savings account. Close a savings account: Results in an Activated savings application being converted into an 'closed' savings account. closedOnDate is closure date of savings account withdrawBalance is a boolean description, true value of this field performs a withdrawal transaction with account's running balance. Mandatory Fields: dateFormat,locale,closedOnDate Optional Fields: note, withdrawBalance, paymentTypeId, accountNumber, checkNumber, routingCode, receiptNumber, bankNumber Calculate Interest on Savings Account: Calculates interest earned on a savings 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 Savings Account: Calculates and Posts interest earned on a savings account based on today's date and whether an interest posting or crediting event is due. Block Savings Account: Blocks Savings account from all types of credit and debit transactions Unblock Savings Account: Unblock a blocked account. On unblocking account, user can perform debit and credit transactions Block Savings Account Credit transactions: Savings account will be blocked from all types of credit transactions. Unblock Savings Account Credit transactions: It unblocks the Saving account's credit operations. Now all types of credits can be transacted to Savings account Block Savings Account Debit transactions: All types of debit operations from Savings account wil be blocked Unblock Savings Account debit transactions: It unblocks the Saving account's debit operations. Now all types of debits can be transacted from Savings account Showing request/response for 'Unassign Savings Officer'
      Parameters:
      externalId - externalId (required)
      postSavingsAccountsAccountIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostSavingsAccountsAccountIdResponse>

    • handleGSIMCommands

      @Headers("Content-Type:application/json") @POST("v1/savingsaccounts/gsimcommands/{parentAccountId}") retrofit2.Call<String> handleGSIMCommands(@Path("parentAccountId") Long parentAccountId, @Query("command") String command, @Body String body, @HeaderMap Map<String,String> headers)
      Parameters:
      parentAccountId - (required)
      command - (optional)
      body - (optional)
      Returns:
      Call<String>

    • postSavingsTemplate

      @Multipart @POST("v1/savingsaccounts/uploadtemplate") retrofit2.Call<String> postSavingsTemplate(@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>

    • postSavingsTransactionTemplate

      @Multipart @POST("v1/savingsaccounts/transactions/uploadtemplate") retrofit2.Call<String> postSavingsTransactionTemplate(@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>

    • retrieveAll33

      @GET("v1/savingsaccounts") retrofit2.Call<GetSavingsAccountsResponse> retrieveAll33(@Query("externalId") String externalId, @Query("offset") Integer offset, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder, @HeaderMap Map<String,String> headers)
      List savings applications/accounts Lists savings applications/accounts Example Requests: savingsaccounts savingsaccounts?fields=name
      Parameters:
      externalId - externalId (optional)
      offset - offset (optional)
      limit - limit (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      Returns:
      Call<GetSavingsAccountsResponse>

    • retrieveOne25

      @GET("v1/savingsaccounts/{accountId}") retrofit2.Call<SavingsAccountData> retrieveOne25(@Path("accountId") Long accountId, @Query("staffInSelectedOfficeOnly") Boolean staffInSelectedOfficeOnly, @Query("chargeStatus") String chargeStatus, @Query("associations") String associations, @HeaderMap Map<String,String> headers)
      Parameters:
      accountId - (required)
      staffInSelectedOfficeOnly - (optional, default to false)
      chargeStatus - (optional, default to all)
      associations - (optional)
      Returns:
      Call<SavingsAccountData>

    • retrieveOne26

      @GET("v1/savingsaccounts/external-id/{externalId}") retrofit2.Call<SavingsAccountData> retrieveOne26(@Path("externalId") String externalId, @Query("staffInSelectedOfficeOnly") Boolean staffInSelectedOfficeOnly, @Query("chargeStatus") String chargeStatus, @Query("associations") String associations, @HeaderMap Map<String,String> headers)
      Parameters:
      externalId - (required)
      staffInSelectedOfficeOnly - (optional, default to false)
      chargeStatus - (optional, default to all)
      associations - (optional)
      Returns:
      Call<SavingsAccountData>

    • submitApplication2

      @Headers("Content-Type:application/json") @POST("v1/savingsaccounts") retrofit2.Call<PostSavingsAccountsResponse> submitApplication2(@Body PostSavingsAccountsRequest postSavingsAccountsRequest, @HeaderMap Map<String,String> headers)
      Submit new savings application Submits new savings application Mandatory Fields: clientId or groupId, productId, submittedOnDate Optional Fields: accountNo, externalId, fieldOfficerId Inherited from Product (if not provided): nominalAnnualInterestRate, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minRequiredOpeningBalance, lockinPeriodFrequency, lockinPeriodFrequencyType, withdrawalFeeForTransfers, allowOverdraft, overdraftLimit, withHoldTax Additional Mandatory Field if Entity-Datatable Check is enabled for the entity of type Savings: datatables
      Parameters:
      postSavingsAccountsRequest - (required)
      Returns:
      Call<PostSavingsAccountsResponse>

    • submitGSIMApplication

      @Headers("Content-Type:application/json") @POST("v1/savingsaccounts/gsim") retrofit2.Call<String> submitGSIMApplication(@Body String body, @HeaderMap Map<String,String> headers)
      Parameters:
      body - (optional)
      Returns:
      Call<String>

    • template14

      @GET("v1/savingsaccounts/template") retrofit2.Call<GetSavingsAccountsTemplateResponse> template14(@Query("clientId") Long clientId, @Query("groupId") Long groupId, @Query("productId") Long productId, @Query("staffInSelectedOfficeOnly") Boolean staffInSelectedOfficeOnly, @HeaderMap Map<String,String> headers)
      Retrieve Savings Account 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 Value Lists Example Requests: savingsaccounts/template?clientId=1 savingsaccounts/template?clientId=1&productId=1
      Parameters:
      clientId - clientId (optional)
      groupId - groupId (optional)
      productId - productId (optional)
      staffInSelectedOfficeOnly - staffInSelectedOfficeOnly (optional, default to false)
      Returns:
      Call<GetSavingsAccountsTemplateResponse>

    • update20

      @Headers("Content-Type:application/json") @PUT("v1/savingsaccounts/{accountId}") retrofit2.Call<PutSavingsAccountsAccountIdResponse> update20(@Path("accountId") Long accountId, @Body PutSavingsAccountsAccountIdRequest putSavingsAccountsAccountIdRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Modify a savings application | Modify savings account withhold tax applicability Modify a savings application: Savings 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 Modify savings account withhold tax applicability: Savings application's withhold tax can be modified when in 'Active' state. Once the application is activated, can modify the account withhold tax to post tax or vice-versaShowing request/response for 'Modify a savings application'
      Parameters:
      accountId - accountId (required)
      putSavingsAccountsAccountIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PutSavingsAccountsAccountIdResponse>

    • update21

      @Headers("Content-Type:application/json") @PUT("v1/savingsaccounts/external-id/{externalId}") retrofit2.Call<PutSavingsAccountsAccountIdResponse> update21(@Path("externalId") String externalId, @Body PutSavingsAccountsAccountIdRequest putSavingsAccountsAccountIdRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Modify a savings application | Modify savings account withhold tax applicability Modify a savings application: Savings 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 Modify savings account withhold tax applicability: Savings application's withhold tax can be modified when in 'Active' state. Once the application is activated, can modify the account withhold tax to post tax or vice-versaShowing request/response for 'Modify a savings application'
      Parameters:
      externalId - externalId (required)
      putSavingsAccountsAccountIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PutSavingsAccountsAccountIdResponse>

    • updateGsim

      @Headers("Content-Type:application/json") @PUT("v1/savingsaccounts/gsim/{parentAccountId}") retrofit2.Call<String> updateGsim(@Path("parentAccountId") Long parentAccountId, @Body String body, @HeaderMap Map<String,String> headers)
      Parameters:
      parentAccountId - (required)
      body - (optional)
      Returns:
      Call<String>

    • handleGSIMCommands

      @Headers("Content-Type:application/json") @POST("v1/savingsaccounts/gsimcommands/{parentAccountId}") retrofit2.Call<String> handleGSIMCommands(@Path("parentAccountId") Long parentAccountId, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Parameters:
      parentAccountId - (required)
      command - (optional)
      body - (optional)
      Returns:
      Call<String>

    • submitGSIMApplication

      @Headers("Content-Type:application/json") @POST("v1/savingsaccounts/gsim") retrofit2.Call<String> submitGSIMApplication(@HeaderMap Map<String,String> headers)
      Parameters:
      body - (optional)
      Returns:
      Call<String>

    • updateGsim

      @Headers("Content-Type:application/json") @PUT("v1/savingsaccounts/gsim/{parentAccountId}") retrofit2.Call<String> updateGsim(@Path("parentAccountId") Long parentAccountId, @HeaderMap Map<String,String> headers)
      Parameters:
      parentAccountId - (required)
      body - (optional)
      Returns:
      Call<String>