Package org.apache.fineract.client.services

Interface RecurringDepositAccountTransactionsApi

public interface RecurringDepositAccountTransactionsApi

  • Method Details

    • handleTransactionCommands

      @Headers("Content-Type:application/json") @POST("v1/recurringdepositaccounts/{recurringDepositAccountId}/transactions/{transactionId}") retrofit2.Call<PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse> handleTransactionCommands(@Path("recurringDepositAccountId") Long recurringDepositAccountId, @Path("transactionId") Long transactionId, @Body PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest, @Query("command") String command)
      Adjust Transaction | Undo transaction Adjust Transaction: This command modifies the given transaction. Undo transaction: This command reverses the given transaction. Showing request/response for 'Adjust Transaction'
      Parameters:
      recurringDepositAccountId - recurringDepositAccountId (required)
      transactionId - transactionId (required)
      postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest - (required)
      command - command (optional)
      Returns:
      Call<PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse>

    • retrieveOne21

      @GET("v1/recurringdepositaccounts/{recurringDepositAccountId}/transactions/{transactionId}") retrofit2.Call<GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse> retrieveOne21(@Path("recurringDepositAccountId") Long recurringDepositAccountId, @Path("transactionId") Long transactionId)
      Retrieve Recurring Deposit Account Transaction Retrieves Recurring Deposit Account Transaction Example Requests: recurringdepositaccounts/1/transactions/1
      Parameters:
      recurringDepositAccountId - recurringDepositAccountId (required)
      transactionId - transactionId (required)
      Returns:
      Call<GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse>

    • retrieveTemplate16

      @GET("v1/recurringdepositaccounts/{recurringDepositAccountId}/transactions/template") retrofit2.Call<GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTemplateResponse> retrieveTemplate16(@Path("recurringDepositAccountId") Long recurringDepositAccountId, @Query("command") String command)
      Retrieve Recurring Deposit Account Transaction 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: recurringdepositaccounts/1/transactions/template?command=deposit recurringdepositaccounts/1/transactions/template?command=withdrawal
      Parameters:
      recurringDepositAccountId - recurringDepositAccountId (required)
      command - command (optional)
      Returns:
      Call<GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTemplateResponse>

    • transaction1

      @Headers("Content-Type:application/json") @POST("v1/recurringdepositaccounts/{recurringDepositAccountId}/transactions") retrofit2.Call<PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsResponse> transaction1(@Path("recurringDepositAccountId") Long recurringDepositAccountId, @Body PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest, @Query("command") String command)
      Deposit Transaction | Withdrawal Transaction Deposit Transaction: Used for a deposit transaction Withdrawal Transaction: Used for a Withdrawal Transaction Showing request/response for Deposit Transaction
      Parameters:
      recurringDepositAccountId - recurringDepositAccountId (required)
      postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest - (required)
      command - command (optional)
      Returns:
      Call<PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsResponse>

    • handleTransactionCommands

      @Headers("Content-Type:application/json") @POST("v1/recurringdepositaccounts/{recurringDepositAccountId}/transactions/{transactionId}") retrofit2.Call<PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse> handleTransactionCommands(@Path("recurringDepositAccountId") Long recurringDepositAccountId, @Path("transactionId") Long transactionId, @Body PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Adjust Transaction | Undo transaction Adjust Transaction: This command modifies the given transaction. Undo transaction: This command reverses the given transaction. Showing request/response for 'Adjust Transaction'
      Parameters:
      recurringDepositAccountId - recurringDepositAccountId (required)
      transactionId - transactionId (required)
      postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest - (required)
      command - command (optional)
      Returns:
      Call<PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse>

    • retrieveOne21

      @GET("v1/recurringdepositaccounts/{recurringDepositAccountId}/transactions/{transactionId}") retrofit2.Call<GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse> retrieveOne21(@Path("recurringDepositAccountId") Long recurringDepositAccountId, @Path("transactionId") Long transactionId, @HeaderMap Map<String,String> headers)
      Retrieve Recurring Deposit Account Transaction Retrieves Recurring Deposit Account Transaction Example Requests: recurringdepositaccounts/1/transactions/1
      Parameters:
      recurringDepositAccountId - recurringDepositAccountId (required)
      transactionId - transactionId (required)
      Returns:
      Call<GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse>

    • retrieveTemplate16

      @GET("v1/recurringdepositaccounts/{recurringDepositAccountId}/transactions/template") retrofit2.Call<GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTemplateResponse> retrieveTemplate16(@Path("recurringDepositAccountId") Long recurringDepositAccountId, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Retrieve Recurring Deposit Account Transaction 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: recurringdepositaccounts/1/transactions/template?command=deposit recurringdepositaccounts/1/transactions/template?command=withdrawal
      Parameters:
      recurringDepositAccountId - recurringDepositAccountId (required)
      command - command (optional)
      Returns:
      Call<GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTemplateResponse>

    • transaction1

      @Headers("Content-Type:application/json") @POST("v1/recurringdepositaccounts/{recurringDepositAccountId}/transactions") retrofit2.Call<PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsResponse> transaction1(@Path("recurringDepositAccountId") Long recurringDepositAccountId, @Body PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Deposit Transaction | Withdrawal Transaction Deposit Transaction: Used for a deposit transaction Withdrawal Transaction: Used for a Withdrawal Transaction Showing request/response for Deposit Transaction
      Parameters:
      recurringDepositAccountId - recurringDepositAccountId (required)
      postRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest - (required)
      command - command (optional)
      Returns:
      Call<PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsResponse>