Package org.apache.fineract.client.services

Interface ClientTransactionApi

public interface ClientTransactionApi

  • Method Details

    • retrieveAllClientTransactions

      @GET("v1/clients/{clientId}/transactions") retrofit2.Call<GetClientsClientIdTransactionsResponse> retrieveAllClientTransactions(@Path("clientId") Long clientId, @Query("offset") Integer offset, @Query("limit") Integer limit)
      List Client Transactions The list capability of client transaction can support pagination. Example Requests: clients/189/transactions clients/189/transactions?offset=10&limit=50
      Parameters:
      clientId - clientId (required)
      offset - offset (optional)
      limit - limit (optional)
      Returns:
      Call<GetClientsClientIdTransactionsResponse>

    • retrieveAllClientTransactions1

      @GET("v1/clients/external-id/{clientExternalId}/transactions") retrofit2.Call<GetClientsClientIdTransactionsResponse> retrieveAllClientTransactions1(@Path("clientExternalId") String clientExternalId, @Query("offset") Integer offset, @Query("limit") Integer limit)
      List Client Transactions The list capability of client transaction can support pagination. Example Requests: clients/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions clients/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?offset=10&limit=50
      Parameters:
      clientExternalId - clientExternalId (required)
      offset - offset (optional)
      limit - limit (optional)
      Returns:
      Call<GetClientsClientIdTransactionsResponse>

    • retrieveClientTransaction

      @GET("v1/clients/{clientId}/transactions/{transactionId}") retrofit2.Call<GetClientsClientIdTransactionsTransactionIdResponse> retrieveClientTransaction(@Path("clientId") Long clientId, @Path("transactionId") Long transactionId)
      Retrieve a Client Transaction Example Requests: clients/1/transactions/1 clients/1/transactions/1?fields=id,officeName
      Parameters:
      clientId - clientId (required)
      transactionId - transactionId (required)
      Returns:
      Call<GetClientsClientIdTransactionsTransactionIdResponse>

    • retrieveClientTransaction1

      @GET("v1/clients/{clientId}/transactions/external-id/{transactionExternalId}") retrofit2.Call<GetClientsClientIdTransactionsTransactionIdResponse> retrieveClientTransaction1(@Path("clientId") Long clientId, @Path("transactionExternalId") String transactionExternalId)
      Retrieve a Client Transaction Example Requests: clients/1/transactions/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854 clients/1/transactions/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854?fields=id,officeName
      Parameters:
      clientId - clientId (required)
      transactionExternalId - transactionExternalId (required)
      Returns:
      Call<GetClientsClientIdTransactionsTransactionIdResponse>

    • retrieveClientTransaction2

      @GET("v1/clients/external-id/{clientExternalId}/transactions/{transactionId}") retrofit2.Call<GetClientsClientIdTransactionsTransactionIdResponse> retrieveClientTransaction2(@Path("clientExternalId") String clientExternalId, @Path("transactionId") Long transactionId)
      Retrieve a Client Transaction Example Requests: clients/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions/1 clients/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions/1?fields=id,officeName
      Parameters:
      clientExternalId - clientExternalId (required)
      transactionId - transactionId (required)
      Returns:
      Call<GetClientsClientIdTransactionsTransactionIdResponse>

    • retrieveClientTransaction3

      @GET("v1/clients/external-id/{clientExternalId}/transactions/external-id/{transactionExternalId}") retrofit2.Call<GetClientsClientIdTransactionsTransactionIdResponse> retrieveClientTransaction3(@Path("clientExternalId") String clientExternalId, @Path("transactionExternalId") String transactionExternalId)
      Retrieve a Client Transaction Example Requests: clients/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854 clients/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854?fields=id,officeName
      Parameters:
      clientExternalId - clientExternalId (required)
      transactionExternalId - transactionExternalId (required)
      Returns:
      Call<GetClientsClientIdTransactionsTransactionIdResponse>

    • undoClientTransaction

      @POST("v1/clients/{clientId}/transactions/{transactionId}") retrofit2.Call<PostClientsClientIdTransactionsTransactionIdResponse> undoClientTransaction(@Path("clientId") Long clientId, @Path("transactionId") Long transactionId, @Query("command") String command)
      Undo a Client Transaction Undoes a Client Transaction
      Parameters:
      clientId - clientId (required)
      transactionId - transactionId (required)
      command - command (optional)
      Returns:
      Call<PostClientsClientIdTransactionsTransactionIdResponse>

    • undoClientTransaction1

      @POST("v1/clients/{clientId}/transactions/external-id/{transactionExternalId}") retrofit2.Call<PostClientsClientIdTransactionsTransactionIdResponse> undoClientTransaction1(@Path("clientId") Long clientId, @Path("transactionExternalId") String transactionExternalId, @Query("command") String command)
      Undo a Client Transaction Undoes a Client Transaction
      Parameters:
      clientId - clientId (required)
      transactionExternalId - transactionExternalId (required)
      command - command (optional)
      Returns:
      Call<PostClientsClientIdTransactionsTransactionIdResponse>

    • undoClientTransaction2

      @POST("v1/clients/external-id/{clientExternalId}/transactions/{transactionId}") retrofit2.Call<PostClientsClientIdTransactionsTransactionIdResponse> undoClientTransaction2(@Path("clientExternalId") String clientExternalId, @Path("transactionId") Long transactionId, @Query("command") String command)
      Undo a Client Transaction Undoes a Client Transaction
      Parameters:
      clientExternalId - clientExternalId (required)
      transactionId - transactionId (required)
      command - command (optional)
      Returns:
      Call<PostClientsClientIdTransactionsTransactionIdResponse>

    • undoClientTransaction3

      @POST("v1/clients/external-id/{clientExternalId}/transactions/external-id/{transactionExternalId}") retrofit2.Call<PostClientsClientIdTransactionsTransactionIdResponse> undoClientTransaction3(@Path("clientExternalId") String clientExternalId, @Path("transactionExternalId") String transactionExternalId, @Query("command") String command)
      Undo a Client Transaction Undoes a Client Transaction
      Parameters:
      clientExternalId - clientExternalId (required)
      transactionExternalId - transactionExternalId (required)
      command - command (optional)
      Returns:
      Call<PostClientsClientIdTransactionsTransactionIdResponse>

    • retrieveAllClientTransactions

      @GET("v1/clients/{clientId}/transactions") retrofit2.Call<GetClientsClientIdTransactionsResponse> retrieveAllClientTransactions(@Path("clientId") Long clientId, @Query("offset") Integer offset, @Query("limit") Integer limit, @HeaderMap Map<String,String> headers)
      List Client Transactions The list capability of client transaction can support pagination. Example Requests: clients/189/transactions clients/189/transactions?offset=10&limit=50
      Parameters:
      clientId - clientId (required)
      offset - offset (optional)
      limit - limit (optional)
      Returns:
      Call<GetClientsClientIdTransactionsResponse>

    • retrieveAllClientTransactions1

      @GET("v1/clients/external-id/{clientExternalId}/transactions") retrofit2.Call<GetClientsClientIdTransactionsResponse> retrieveAllClientTransactions1(@Path("clientExternalId") String clientExternalId, @Query("offset") Integer offset, @Query("limit") Integer limit, @HeaderMap Map<String,String> headers)
      List Client Transactions The list capability of client transaction can support pagination. Example Requests: clients/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions clients/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions?offset=10&limit=50
      Parameters:
      clientExternalId - clientExternalId (required)
      offset - offset (optional)
      limit - limit (optional)
      Returns:
      Call<GetClientsClientIdTransactionsResponse>

    • retrieveClientTransaction

      @GET("v1/clients/{clientId}/transactions/{transactionId}") retrofit2.Call<GetClientsClientIdTransactionsTransactionIdResponse> retrieveClientTransaction(@Path("clientId") Long clientId, @Path("transactionId") Long transactionId, @HeaderMap Map<String,String> headers)
      Retrieve a Client Transaction Example Requests: clients/1/transactions/1 clients/1/transactions/1?fields=id,officeName
      Parameters:
      clientId - clientId (required)
      transactionId - transactionId (required)
      Returns:
      Call<GetClientsClientIdTransactionsTransactionIdResponse>

    • retrieveClientTransaction1

      @GET("v1/clients/{clientId}/transactions/external-id/{transactionExternalId}") retrofit2.Call<GetClientsClientIdTransactionsTransactionIdResponse> retrieveClientTransaction1(@Path("clientId") Long clientId, @Path("transactionExternalId") String transactionExternalId, @HeaderMap Map<String,String> headers)
      Retrieve a Client Transaction Example Requests: clients/1/transactions/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854 clients/1/transactions/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854?fields=id,officeName
      Parameters:
      clientId - clientId (required)
      transactionExternalId - transactionExternalId (required)
      Returns:
      Call<GetClientsClientIdTransactionsTransactionIdResponse>

    • retrieveClientTransaction2

      @GET("v1/clients/external-id/{clientExternalId}/transactions/{transactionId}") retrofit2.Call<GetClientsClientIdTransactionsTransactionIdResponse> retrieveClientTransaction2(@Path("clientExternalId") String clientExternalId, @Path("transactionId") Long transactionId, @HeaderMap Map<String,String> headers)
      Retrieve a Client Transaction Example Requests: clients/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions/1 clients/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions/1?fields=id,officeName
      Parameters:
      clientExternalId - clientExternalId (required)
      transactionId - transactionId (required)
      Returns:
      Call<GetClientsClientIdTransactionsTransactionIdResponse>

    • retrieveClientTransaction3

      @GET("v1/clients/external-id/{clientExternalId}/transactions/external-id/{transactionExternalId}") retrofit2.Call<GetClientsClientIdTransactionsTransactionIdResponse> retrieveClientTransaction3(@Path("clientExternalId") String clientExternalId, @Path("transactionExternalId") String transactionExternalId, @HeaderMap Map<String,String> headers)
      Retrieve a Client Transaction Example Requests: clients/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854 clients/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854/transactions/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854?fields=id,officeName
      Parameters:
      clientExternalId - clientExternalId (required)
      transactionExternalId - transactionExternalId (required)
      Returns:
      Call<GetClientsClientIdTransactionsTransactionIdResponse>

    • undoClientTransaction

      @POST("v1/clients/{clientId}/transactions/{transactionId}") retrofit2.Call<PostClientsClientIdTransactionsTransactionIdResponse> undoClientTransaction(@Path("clientId") Long clientId, @Path("transactionId") Long transactionId, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Undo a Client Transaction Undoes a Client Transaction
      Parameters:
      clientId - clientId (required)
      transactionId - transactionId (required)
      command - command (optional)
      Returns:
      Call<PostClientsClientIdTransactionsTransactionIdResponse>

    • undoClientTransaction1

      @POST("v1/clients/{clientId}/transactions/external-id/{transactionExternalId}") retrofit2.Call<PostClientsClientIdTransactionsTransactionIdResponse> undoClientTransaction1(@Path("clientId") Long clientId, @Path("transactionExternalId") String transactionExternalId, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Undo a Client Transaction Undoes a Client Transaction
      Parameters:
      clientId - clientId (required)
      transactionExternalId - transactionExternalId (required)
      command - command (optional)
      Returns:
      Call<PostClientsClientIdTransactionsTransactionIdResponse>

    • undoClientTransaction2

      @POST("v1/clients/external-id/{clientExternalId}/transactions/{transactionId}") retrofit2.Call<PostClientsClientIdTransactionsTransactionIdResponse> undoClientTransaction2(@Path("clientExternalId") String clientExternalId, @Path("transactionId") Long transactionId, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Undo a Client Transaction Undoes a Client Transaction
      Parameters:
      clientExternalId - clientExternalId (required)
      transactionId - transactionId (required)
      command - command (optional)
      Returns:
      Call<PostClientsClientIdTransactionsTransactionIdResponse>

    • undoClientTransaction3

      @POST("v1/clients/external-id/{clientExternalId}/transactions/external-id/{transactionExternalId}") retrofit2.Call<PostClientsClientIdTransactionsTransactionIdResponse> undoClientTransaction3(@Path("clientExternalId") String clientExternalId, @Path("transactionExternalId") String transactionExternalId, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Undo a Client Transaction Undoes a Client Transaction
      Parameters:
      clientExternalId - clientExternalId (required)
      transactionExternalId - transactionExternalId (required)
      command - command (optional)
      Returns:
      Call<PostClientsClientIdTransactionsTransactionIdResponse>