Package org.apache.fineract.client.services

Interface ShareAccountApi

public interface ShareAccountApi

  • Method Details

    • createAccount

      @Headers("Content-Type:application/json") @POST("v1/accounts/{type}") retrofit2.Call<PostAccountsTypeResponse> createAccount(@Path("type") String type, @Body AccountRequest accountRequest)
      Submit new share application Submits new share application Mandatory Fields: clientId, productId, submittedDate, savingsAccountId, requestedShares, applicationDate Optional Fields: accountNo, externalId Inherited from Product (if not provided): minimumActivePeriod, minimumActivePeriodFrequencyType, lockinPeriodFrequency, lockinPeriodFrequencyType
      Parameters:
      type - type (required)
      accountRequest - (required)
      Returns:
      Call<PostAccountsTypeResponse>

    • getSharedAccountsTemplate

      @GET("v1/accounts/{type}/downloadtemplate") retrofit2.Call<Void> getSharedAccountsTemplate(@Path("type") String type, @Query("officeId") Long officeId, @Query("dateFormat") String dateFormat)
      Parameters:
      type - type (required)
      officeId - (optional)
      dateFormat - (optional)
      Returns:
      Call<Void>

    • handleCommands2

      @Headers("Content-Type:application/json") @POST("v1/accounts/{type}/{accountId}") retrofit2.Call<PostAccountsTypeAccountIdResponse> handleCommands2(@Path("type") String type, @Path("accountId") Long accountId, @Body PostAccountsTypeAccountIdRequest postAccountsTypeAccountIdRequest, @Query("command") String command)
      Approve share application | Undo approval share application | Reject share application | Activate a share account | Close a share account | Apply additional shares on a share account | Approve additional shares request on a share account | Reject additional shares request on a share account | Redeem shares on a share account Approve share application: Approves share application so long as its in 'Submitted and pending approval' state. Undo approval share application: Will move 'approved' share application back to 'Submitted and pending approval' state. Reject share application: Rejects share application so long as its in 'Submitted and pending approval' state. Activate a share account: Results in an approved share application being converted into an 'active' share account. Close a share account: Results in an Activated share application being converted into an 'closed' share account. closedDate is closure date of share account Mandatory Fields: dateFormat,locale,closedDate Apply additional shares on a share account: requestedDate is requsted date of share purchase requestedShares is number of shares to be purchase Mandatory Fields: dateFormat,locale,requestedDate, requestedShares Approve additional shares request on a share account requestedShares is Share purchase transaction ids Mandatory Fields: requestedShares Reject additional shares request on a share account: requestedShares is Share purchase transaction ids Mandatory Fields: requestedShares Redeem shares on a share account: Results redeem some/all shares from share account. requestedDate is requsted date of shares redeem requestedShares is number of shares to be redeemed Mandatory Fields: dateFormat,locale,requestedDate,requestedShares Showing request/response for 'Reject additional shares request on a share account' For more info visit this link - https://fineract.apache.org/docs/legacy/#shareaccounts
      Parameters:
      type - type (required)
      accountId - accountId (required)
      postAccountsTypeAccountIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostAccountsTypeAccountIdResponse>

    • postSharedAccountsTemplate

      @Multipart @POST("v1/accounts/{type}/uploadtemplate") retrofit2.Call<Long> postSharedAccountsTemplate(@Path("type") String type, @Part("dateFormat") String dateFormat, @Part("locale") String locale, @Part okhttp3.MultipartBody.Part uploadedInputStream)
      Parameters:
      type - type (required)
      dateFormat - (optional)
      locale - (optional)
      uploadedInputStream - (optional)
      Returns:
      Call<Long>

    • retrieveAccount

      @GET("v1/accounts/{type}/{accountId}") retrofit2.Call<GetAccountsTypeAccountIdResponse> retrieveAccount(@Path("accountId") Long accountId, @Path("type") String type)
      Retrieve a share application/account Retrieves a share application/account Example Requests : shareaccount/1
      Parameters:
      accountId - accountId (required)
      type - type (required)
      Returns:
      Call<GetAccountsTypeAccountIdResponse>

    • retrieveAllAccounts1

      @GET("v1/accounts/{type}") retrofit2.Call<GetAccountsTypeResponse> retrieveAllAccounts1(@Path("type") String type, @Query("offset") Integer offset, @Query("limit") Integer limit)
      List share applications/accounts Lists share applications/accounts Example Requests: shareaccount
      Parameters:
      type - type (required)
      offset - offset (optional)
      limit - limit (optional)
      Returns:
      Call<GetAccountsTypeResponse>

    • template7

      @GET("v1/accounts/{type}/template") retrofit2.Call<GetAccountsTypeTemplateResponse> template7(@Path("type") String type, @Query("clientId") Long clientId, @Query("productId") Long productId)
      Retrieve Share 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: accounts/share/template?clientId=1 accounts/share/template?clientId=1&productId=1
      Parameters:
      type - type (required)
      clientId - clientId (optional)
      productId - productId (optional)
      Returns:
      Call<GetAccountsTypeTemplateResponse>

    • updateAccount

      @Headers("Content-Type:application/json") @PUT("v1/accounts/{type}/{accountId}") retrofit2.Call<PutAccountsTypeAccountIdResponse> updateAccount(@Path("type") String type, @Path("accountId") Long accountId, @Body PutAccountsTypeAccountIdRequest putAccountsTypeAccountIdRequest)
      Modify a share application Share 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:
      type - type (required)
      accountId - accountId (required)
      putAccountsTypeAccountIdRequest - (required)
      Returns:
      Call<PutAccountsTypeAccountIdResponse>

    • createAccount

      @Headers("Content-Type:application/json") @POST("v1/accounts/{type}") retrofit2.Call<PostAccountsTypeResponse> createAccount(@Path("type") String type, @Body AccountRequest accountRequest, @HeaderMap Map<String,String> headers)
      Submit new share application Submits new share application Mandatory Fields: clientId, productId, submittedDate, savingsAccountId, requestedShares, applicationDate Optional Fields: accountNo, externalId Inherited from Product (if not provided): minimumActivePeriod, minimumActivePeriodFrequencyType, lockinPeriodFrequency, lockinPeriodFrequencyType
      Parameters:
      type - type (required)
      accountRequest - (required)
      Returns:
      Call<PostAccountsTypeResponse>

    • getSharedAccountsTemplate

      @GET("v1/accounts/{type}/downloadtemplate") retrofit2.Call<Void> getSharedAccountsTemplate(@Path("type") String type, @Query("officeId") Long officeId, @Query("dateFormat") String dateFormat, @HeaderMap Map<String,String> headers)
      Parameters:
      type - type (required)
      officeId - (optional)
      dateFormat - (optional)
      Returns:
      Call<Void>

    • handleCommands2

      @Headers("Content-Type:application/json") @POST("v1/accounts/{type}/{accountId}") retrofit2.Call<PostAccountsTypeAccountIdResponse> handleCommands2(@Path("type") String type, @Path("accountId") Long accountId, @Body PostAccountsTypeAccountIdRequest postAccountsTypeAccountIdRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Approve share application | Undo approval share application | Reject share application | Activate a share account | Close a share account | Apply additional shares on a share account | Approve additional shares request on a share account | Reject additional shares request on a share account | Redeem shares on a share account Approve share application: Approves share application so long as its in 'Submitted and pending approval' state. Undo approval share application: Will move 'approved' share application back to 'Submitted and pending approval' state. Reject share application: Rejects share application so long as its in 'Submitted and pending approval' state. Activate a share account: Results in an approved share application being converted into an 'active' share account. Close a share account: Results in an Activated share application being converted into an 'closed' share account. closedDate is closure date of share account Mandatory Fields: dateFormat,locale,closedDate Apply additional shares on a share account: requestedDate is requsted date of share purchase requestedShares is number of shares to be purchase Mandatory Fields: dateFormat,locale,requestedDate, requestedShares Approve additional shares request on a share account requestedShares is Share purchase transaction ids Mandatory Fields: requestedShares Reject additional shares request on a share account: requestedShares is Share purchase transaction ids Mandatory Fields: requestedShares Redeem shares on a share account: Results redeem some/all shares from share account. requestedDate is requsted date of shares redeem requestedShares is number of shares to be redeemed Mandatory Fields: dateFormat,locale,requestedDate,requestedShares Showing request/response for 'Reject additional shares request on a share account' For more info visit this link - https://fineract.apache.org/docs/legacy/#shareaccounts
      Parameters:
      type - type (required)
      accountId - accountId (required)
      postAccountsTypeAccountIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostAccountsTypeAccountIdResponse>

    • postSharedAccountsTemplate

      @Multipart @POST("v1/accounts/{type}/uploadtemplate") retrofit2.Call<Long> postSharedAccountsTemplate(@Path("type") String type, @Part("dateFormat") String dateFormat, @Part("locale") String locale, @Part okhttp3.MultipartBody.Part uploadedInputStream, @HeaderMap Map<String,String> headers)
      Parameters:
      type - type (required)
      dateFormat - (optional)
      locale - (optional)
      uploadedInputStream - (optional)
      Returns:
      Call<Long>

    • retrieveAccount

      @GET("v1/accounts/{type}/{accountId}") retrofit2.Call<GetAccountsTypeAccountIdResponse> retrieveAccount(@Path("accountId") Long accountId, @Path("type") String type, @HeaderMap Map<String,String> headers)
      Retrieve a share application/account Retrieves a share application/account Example Requests : shareaccount/1
      Parameters:
      accountId - accountId (required)
      type - type (required)
      Returns:
      Call<GetAccountsTypeAccountIdResponse>

    • retrieveAllAccounts1

      @GET("v1/accounts/{type}") retrofit2.Call<GetAccountsTypeResponse> retrieveAllAccounts1(@Path("type") String type, @Query("offset") Integer offset, @Query("limit") Integer limit, @HeaderMap Map<String,String> headers)
      List share applications/accounts Lists share applications/accounts Example Requests: shareaccount
      Parameters:
      type - type (required)
      offset - offset (optional)
      limit - limit (optional)
      Returns:
      Call<GetAccountsTypeResponse>

    • template7

      @GET("v1/accounts/{type}/template") retrofit2.Call<GetAccountsTypeTemplateResponse> template7(@Path("type") String type, @Query("clientId") Long clientId, @Query("productId") Long productId, @HeaderMap Map<String,String> headers)
      Retrieve Share 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: accounts/share/template?clientId=1 accounts/share/template?clientId=1&productId=1
      Parameters:
      type - type (required)
      clientId - clientId (optional)
      productId - productId (optional)
      Returns:
      Call<GetAccountsTypeTemplateResponse>

    • updateAccount

      @Headers("Content-Type:application/json") @PUT("v1/accounts/{type}/{accountId}") retrofit2.Call<PutAccountsTypeAccountIdResponse> updateAccount(@Path("type") String type, @Path("accountId") Long accountId, @Body PutAccountsTypeAccountIdRequest putAccountsTypeAccountIdRequest, @HeaderMap Map<String,String> headers)
      Modify a share application Share 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:
      type - type (required)
      accountId - accountId (required)
      putAccountsTypeAccountIdRequest - (required)
      Returns:
      Call<PutAccountsTypeAccountIdResponse>