Package org.apache.fineract.client.services

Interface AccountTransfersApi

public interface AccountTransfersApi

  • Method Details

    • create4

      @Headers("Content-Type:application/json") @POST("v1/accounttransfers") retrofit2.Call<PostAccountTransfersResponse> create4(@Body PostAccountTransfersRequest postAccountTransfersRequest)
      Create new Transfer Ability to create new transfer of monetary funds from one account to another.
      Parameters:
      postAccountTransfersRequest - (required)
      Returns:
      Call<PostAccountTransfersResponse>

    • retrieveAll18

      @GET("v1/accounttransfers") retrofit2.Call<GetAccountTransfersResponse> retrieveAll18(@Query("externalId") String externalId, @Query("offset") Integer offset, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder, @Query("accountDetailId") Long accountDetailId)
      List account transfers Lists account's transfers Example Requests: accounttransfers
      Parameters:
      externalId - externalId (optional)
      offset - offset (optional)
      limit - (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      accountDetailId - accountDetailId (optional)
      Returns:
      Call<GetAccountTransfersResponse>

    • retrieveOne9

      @GET("v1/accounttransfers/{transferId}") retrofit2.Call<GetAccountTransfersPageItems> retrieveOne9(@Path("transferId") Long transferId)
      Retrieve account transfer Retrieves account transfer Example Requests : accounttransfers/1
      Parameters:
      transferId - transferId (required)
      Returns:
      Call<GetAccountTransfersPageItems>

    • template5

      @GET("v1/accounttransfers/template") retrofit2.Call<GetAccountTransfersTemplateResponse> template5(@Query("fromOfficeId") Long fromOfficeId, @Query("fromClientId") Long fromClientId, @Query("fromAccountId") Long fromAccountId, @Query("fromAccountType") Integer fromAccountType, @Query("toOfficeId") Long toOfficeId, @Query("toClientId") Long toClientId, @Query("toAccountId") Long toAccountId, @Query("toAccountType") Integer toAccountType)
      Retrieve Account Transfer 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: accounttransfers/template?fromAccountType=2&fromOfficeId=1 accounttransfers/template?fromAccountType=2&fromOfficeId=1&fromClientId=1 accounttransfers/template?fromClientId=1&fromAccountType=2&fromAccountId=1
      Parameters:
      fromOfficeId - fromOfficeId (optional)
      fromClientId - fromClientId (optional)
      fromAccountId - fromAccountId (optional)
      fromAccountType - fromAccountType (optional)
      toOfficeId - toOfficeId (optional)
      toClientId - toClientId (optional)
      toAccountId - toAccountId (optional)
      toAccountType - toAccountType (optional)
      Returns:
      Call<GetAccountTransfersTemplateResponse>

    • templateRefundByTransfer

      @GET("v1/accounttransfers/templateRefundByTransfer") retrofit2.Call<GetAccountTransfersTemplateRefundByTransferResponse> templateRefundByTransfer(@Query("fromOfficeId") Long fromOfficeId, @Query("fromClientId") Long fromClientId, @Query("fromAccountId") Long fromAccountId, @Query("fromAccountType") Integer fromAccountType, @Query("toOfficeId") Long toOfficeId, @Query("toClientId") Long toClientId, @Query("toAccountId") Long toAccountId, @Query("toAccountType") Integer toAccountType)
      Retrieve Refund of an Active Loan by Transfer Template Retrieves Refund of an Active Loan by Transfer TemplateExample Requests : accounttransfers/templateRefundByTransfer?fromAccountId=2&fromAccountType=1& toAccountId=1&toAccountType=2&toClientId=1&toOfficeId=1
      Parameters:
      fromOfficeId - fromOfficeId (optional)
      fromClientId - fromClientId (optional)
      fromAccountId - fromAccountId (optional)
      fromAccountType - fromAccountType (optional)
      toOfficeId - toOfficeId (optional)
      toClientId - toClientId (optional)
      toAccountId - toAccountId (optional)
      toAccountType - toAccountType (optional)
      Returns:
      Call<GetAccountTransfersTemplateRefundByTransferResponse>

    • templateRefundByTransferPost

      @Headers("Content-Type:application/json") @POST("v1/accounttransfers/refundByTransfer") retrofit2.Call<PostAccountTransfersRefundByTransferResponse> templateRefundByTransferPost(@Body PostAccountTransfersRefundByTransferRequest postAccountTransfersRefundByTransferRequest)
      Refund of an Active Loan by Transfer Ability to refund an active loan by transferring to a savings account.
      Parameters:
      postAccountTransfersRefundByTransferRequest - (required)
      Returns:
      Call<PostAccountTransfersRefundByTransferResponse>

    • create4

      @Headers("Content-Type:application/json") @POST("v1/accounttransfers") retrofit2.Call<PostAccountTransfersResponse> create4(@Body PostAccountTransfersRequest postAccountTransfersRequest, @HeaderMap Map<String,String> headers)
      Create new Transfer Ability to create new transfer of monetary funds from one account to another.
      Parameters:
      postAccountTransfersRequest - (required)
      Returns:
      Call<PostAccountTransfersResponse>

    • retrieveAll18

      @GET("v1/accounttransfers") retrofit2.Call<GetAccountTransfersResponse> retrieveAll18(@Query("externalId") String externalId, @Query("offset") Integer offset, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder, @Query("accountDetailId") Long accountDetailId, @HeaderMap Map<String,String> headers)
      List account transfers Lists account's transfers Example Requests: accounttransfers
      Parameters:
      externalId - externalId (optional)
      offset - offset (optional)
      limit - (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      accountDetailId - accountDetailId (optional)
      Returns:
      Call<GetAccountTransfersResponse>

    • retrieveOne9

      @GET("v1/accounttransfers/{transferId}") retrofit2.Call<GetAccountTransfersPageItems> retrieveOne9(@Path("transferId") Long transferId, @HeaderMap Map<String,String> headers)
      Retrieve account transfer Retrieves account transfer Example Requests : accounttransfers/1
      Parameters:
      transferId - transferId (required)
      Returns:
      Call<GetAccountTransfersPageItems>

    • template5

      @GET("v1/accounttransfers/template") retrofit2.Call<GetAccountTransfersTemplateResponse> template5(@Query("fromOfficeId") Long fromOfficeId, @Query("fromClientId") Long fromClientId, @Query("fromAccountId") Long fromAccountId, @Query("fromAccountType") Integer fromAccountType, @Query("toOfficeId") Long toOfficeId, @Query("toClientId") Long toClientId, @Query("toAccountId") Long toAccountId, @Query("toAccountType") Integer toAccountType, @HeaderMap Map<String,String> headers)
      Retrieve Account Transfer 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: accounttransfers/template?fromAccountType=2&fromOfficeId=1 accounttransfers/template?fromAccountType=2&fromOfficeId=1&fromClientId=1 accounttransfers/template?fromClientId=1&fromAccountType=2&fromAccountId=1
      Parameters:
      fromOfficeId - fromOfficeId (optional)
      fromClientId - fromClientId (optional)
      fromAccountId - fromAccountId (optional)
      fromAccountType - fromAccountType (optional)
      toOfficeId - toOfficeId (optional)
      toClientId - toClientId (optional)
      toAccountId - toAccountId (optional)
      toAccountType - toAccountType (optional)
      Returns:
      Call<GetAccountTransfersTemplateResponse>

    • templateRefundByTransfer

      @GET("v1/accounttransfers/templateRefundByTransfer") retrofit2.Call<GetAccountTransfersTemplateRefundByTransferResponse> templateRefundByTransfer(@Query("fromOfficeId") Long fromOfficeId, @Query("fromClientId") Long fromClientId, @Query("fromAccountId") Long fromAccountId, @Query("fromAccountType") Integer fromAccountType, @Query("toOfficeId") Long toOfficeId, @Query("toClientId") Long toClientId, @Query("toAccountId") Long toAccountId, @Query("toAccountType") Integer toAccountType, @HeaderMap Map<String,String> headers)
      Retrieve Refund of an Active Loan by Transfer Template Retrieves Refund of an Active Loan by Transfer TemplateExample Requests : accounttransfers/templateRefundByTransfer?fromAccountId=2&fromAccountType=1& toAccountId=1&toAccountType=2&toClientId=1&toOfficeId=1
      Parameters:
      fromOfficeId - fromOfficeId (optional)
      fromClientId - fromClientId (optional)
      fromAccountId - fromAccountId (optional)
      fromAccountType - fromAccountType (optional)
      toOfficeId - toOfficeId (optional)
      toClientId - toClientId (optional)
      toAccountId - toAccountId (optional)
      toAccountType - toAccountType (optional)
      Returns:
      Call<GetAccountTransfersTemplateRefundByTransferResponse>

    • templateRefundByTransferPost

      @Headers("Content-Type:application/json") @POST("v1/accounttransfers/refundByTransfer") retrofit2.Call<PostAccountTransfersRefundByTransferResponse> templateRefundByTransferPost(@Body PostAccountTransfersRefundByTransferRequest postAccountTransfersRefundByTransferRequest, @HeaderMap Map<String,String> headers)
      Refund of an Active Loan by Transfer Ability to refund an active loan by transferring to a savings account.
      Parameters:
      postAccountTransfersRefundByTransferRequest - (required)
      Returns:
      Call<PostAccountTransfersRefundByTransferResponse>