Package org.apache.fineract.client.services

Interface SelfClientApi

public interface SelfClientApi

  • Method Details

    • addNewClientImage2

      @Multipart @POST("v1/self/clients/{clientId}/images") retrofit2.Call<CommandProcessingResult> addNewClientImage2(@Path("clientId") Long clientId, @Header("Content-Length") Long contentLength, @Part("dateFormat") String dateFormat, @Part("locale") String locale, @Part okhttp3.MultipartBody.Part uploadedInputStream)
      Parameters:
      clientId - (required)
      contentLength - (optional)
      dateFormat - (optional)
      locale - (optional)
      uploadedInputStream - (optional)
      Returns:
      Call<CommandProcessingResult>

    • deleteClientImage1

      @DELETE("v1/self/clients/{clientId}/images") retrofit2.Call<CommandProcessingResult> deleteClientImage1(@Path("clientId") Long clientId)
      Parameters:
      clientId - (required)
      Returns:
      Call<CommandProcessingResult>

    • retrieveAll36

      @GET("v1/self/clients") retrofit2.Call<GetSelfClientsResponse> retrieveAll36(@Query("displayName") String displayName, @Query("firstName") String firstName, @Query("lastName") String lastName, @Query("offset") Integer offset, @Query("status") String status, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder, @Query("legalForm") Integer legalForm)
      List Clients associated to the user The list capability of clients can support pagination and sorting. Example Requests: self/clients self/clients?fields=displayName,officeName self/clients?offset=10&limit=50 self/clients?orderBy=displayName&sortOrder=DESC
      Parameters:
      displayName - displayName (optional)
      firstName - firstName (optional)
      lastName - lastName (optional)
      offset - offset (optional)
      status - status (optional)
      limit - limit (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      legalForm - (optional)
      Returns:
      Call<GetSelfClientsResponse>

    • retrieveAllClientCharges1

      @GET("v1/self/clients/{clientId}/charges") retrofit2.Call<GetSelfClientsClientIdChargesResponse> retrieveAllClientCharges1(@Path("clientId") Long clientId, @Query("chargeStatus") String chargeStatus, @Query("pendingPayment") Boolean pendingPayment, @Query("limit") Integer limit, @Query("offset") Integer offset)
      List Client Charges The list capability of client charges supports pagination. Example Requests: self/clients/1/charges self/clients/1/charges?offset=0&limit=5
      Parameters:
      clientId - clientId (required)
      chargeStatus - chargeStatus (optional, default to all)
      pendingPayment - pendingPayment (optional)
      limit - limit (optional)
      offset - offset (optional)
      Returns:
      Call<GetSelfClientsClientIdChargesResponse>

    • retrieveAllClientTransactions2

      @GET("v1/self/clients/{clientId}/transactions") retrofit2.Call<GetSelfClientsClientIdTransactionsResponse> retrieveAllClientTransactions2(@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: self/clients/189/transactions self/clients/189/transactions?offset=10&limit=50
      Parameters:
      clientId - clientId (required)
      offset - offset (optional)
      limit - limit (optional)
      Returns:
      Call<GetSelfClientsClientIdTransactionsResponse>

    • retrieveAssociatedAccounts2

      @GET("v1/self/clients/{clientId}/accounts") retrofit2.Call<GetSelfClientsClientIdAccountsResponse> retrieveAssociatedAccounts2(@Path("clientId") Long clientId)
      Retrieve client accounts overview An example of how a loan portfolio summary can be provided. This is requested in a specific use case of the community application. It is quite reasonable to add resources like this to simplify User Interface development. Example Requests: self/clients/1/accounts self/clients/1/accounts?fields=loanAccounts,savingsAccounts
      Parameters:
      clientId - clientId (required)
      Returns:
      Call<GetSelfClientsClientIdAccountsResponse>

    • retrieveClientCharge1

      @GET("v1/self/clients/{clientId}/charges/{chargeId}") retrofit2.Call<GetSelfClientsClientIdChargesChargeIdResponse> retrieveClientCharge1(@Path("clientId") Long clientId, @Path("chargeId") Long chargeId)
      Retrieve a Client Charge Retrieves a Client Charge Example Requests: self/clients/1/charges/1 self/clients/1/charges/1?fields=name,id
      Parameters:
      clientId - clientId (required)
      chargeId - chargeId (required)
      Returns:
      Call<GetSelfClientsClientIdChargesChargeIdResponse>

    • retrieveClientTransaction4

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

    • retrieveImage1

      @GET("v1/self/clients/{clientId}/images") retrofit2.Call<Void> retrieveImage1(@Path("clientId") Long clientId, @Query("maxWidth") Integer maxWidth, @Query("maxHeight") Integer maxHeight, @Query("output") String output)
      Retrieve Client Image Optional arguments are identical to those of Get Image associated with an Entity (Binary file) Example Requests: self/clients/1/images
      Parameters:
      clientId - clientId (required)
      maxWidth - (optional)
      maxHeight - (optional)
      output - (optional)
      Returns:
      Call<Void>

    • retrieveObligeeDetails2

      @GET("v1/self/clients/{clientId}/obligeedetails") retrofit2.Call<String> retrieveObligeeDetails2(@Path("clientId") Long clientId)
      Parameters:
      clientId - (required)
      Returns:
      Call<String>

    • retrieveOne28

      @GET("v1/self/clients/{clientId}") retrofit2.Call<GetSelfClientsClientIdResponse> retrieveOne28(@Path("clientId") Long clientId)
      Retrieve a Client Retrieves a Client Example Requests: self/clients/1 self/clients/1?fields=id,displayName,officeName
      Parameters:
      clientId - clientId (required)
      Returns:
      Call<GetSelfClientsClientIdResponse>

    • addNewClientImage2

      @Multipart @POST("v1/self/clients/{clientId}/images") retrofit2.Call<CommandProcessingResult> addNewClientImage2(@Path("clientId") Long clientId, @Header("Content-Length") Long contentLength, @Part("dateFormat") String dateFormat, @Part("locale") String locale, @Part okhttp3.MultipartBody.Part uploadedInputStream, @HeaderMap Map<String,String> headers)
      Parameters:
      clientId - (required)
      contentLength - (optional)
      dateFormat - (optional)
      locale - (optional)
      uploadedInputStream - (optional)
      Returns:
      Call<CommandProcessingResult>

    • deleteClientImage1

      @DELETE("v1/self/clients/{clientId}/images") retrofit2.Call<CommandProcessingResult> deleteClientImage1(@Path("clientId") Long clientId, @HeaderMap Map<String,String> headers)
      Parameters:
      clientId - (required)
      Returns:
      Call<CommandProcessingResult>

    • retrieveAll36

      @GET("v1/self/clients") retrofit2.Call<GetSelfClientsResponse> retrieveAll36(@Query("displayName") String displayName, @Query("firstName") String firstName, @Query("lastName") String lastName, @Query("offset") Integer offset, @Query("status") String status, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder, @Query("legalForm") Integer legalForm, @HeaderMap Map<String,String> headers)
      List Clients associated to the user The list capability of clients can support pagination and sorting. Example Requests: self/clients self/clients?fields=displayName,officeName self/clients?offset=10&limit=50 self/clients?orderBy=displayName&sortOrder=DESC
      Parameters:
      displayName - displayName (optional)
      firstName - firstName (optional)
      lastName - lastName (optional)
      offset - offset (optional)
      status - status (optional)
      limit - limit (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      legalForm - (optional)
      Returns:
      Call<GetSelfClientsResponse>

    • retrieveAllClientCharges1

      @GET("v1/self/clients/{clientId}/charges") retrofit2.Call<GetSelfClientsClientIdChargesResponse> retrieveAllClientCharges1(@Path("clientId") Long clientId, @Query("chargeStatus") String chargeStatus, @Query("pendingPayment") Boolean pendingPayment, @Query("limit") Integer limit, @Query("offset") Integer offset, @HeaderMap Map<String,String> headers)
      List Client Charges The list capability of client charges supports pagination. Example Requests: self/clients/1/charges self/clients/1/charges?offset=0&limit=5
      Parameters:
      clientId - clientId (required)
      chargeStatus - chargeStatus (optional, default to all)
      pendingPayment - pendingPayment (optional)
      limit - limit (optional)
      offset - offset (optional)
      Returns:
      Call<GetSelfClientsClientIdChargesResponse>

    • retrieveAllClientTransactions2

      @GET("v1/self/clients/{clientId}/transactions") retrofit2.Call<GetSelfClientsClientIdTransactionsResponse> retrieveAllClientTransactions2(@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: self/clients/189/transactions self/clients/189/transactions?offset=10&limit=50
      Parameters:
      clientId - clientId (required)
      offset - offset (optional)
      limit - limit (optional)
      Returns:
      Call<GetSelfClientsClientIdTransactionsResponse>

    • retrieveAssociatedAccounts2

      @GET("v1/self/clients/{clientId}/accounts") retrofit2.Call<GetSelfClientsClientIdAccountsResponse> retrieveAssociatedAccounts2(@Path("clientId") Long clientId, @HeaderMap Map<String,String> headers)
      Retrieve client accounts overview An example of how a loan portfolio summary can be provided. This is requested in a specific use case of the community application. It is quite reasonable to add resources like this to simplify User Interface development. Example Requests: self/clients/1/accounts self/clients/1/accounts?fields=loanAccounts,savingsAccounts
      Parameters:
      clientId - clientId (required)
      Returns:
      Call<GetSelfClientsClientIdAccountsResponse>

    • retrieveClientCharge1

      @GET("v1/self/clients/{clientId}/charges/{chargeId}") retrofit2.Call<GetSelfClientsClientIdChargesChargeIdResponse> retrieveClientCharge1(@Path("clientId") Long clientId, @Path("chargeId") Long chargeId, @HeaderMap Map<String,String> headers)
      Retrieve a Client Charge Retrieves a Client Charge Example Requests: self/clients/1/charges/1 self/clients/1/charges/1?fields=name,id
      Parameters:
      clientId - clientId (required)
      chargeId - chargeId (required)
      Returns:
      Call<GetSelfClientsClientIdChargesChargeIdResponse>

    • retrieveClientTransaction4

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

    • retrieveImage1

      @GET("v1/self/clients/{clientId}/images") retrofit2.Call<Void> retrieveImage1(@Path("clientId") Long clientId, @Query("maxWidth") Integer maxWidth, @Query("maxHeight") Integer maxHeight, @Query("output") String output, @HeaderMap Map<String,String> headers)
      Retrieve Client Image Optional arguments are identical to those of Get Image associated with an Entity (Binary file) Example Requests: self/clients/1/images
      Parameters:
      clientId - clientId (required)
      maxWidth - (optional)
      maxHeight - (optional)
      output - (optional)
      Returns:
      Call<Void>

    • retrieveObligeeDetails2

      @GET("v1/self/clients/{clientId}/obligeedetails") retrofit2.Call<String> retrieveObligeeDetails2(@Path("clientId") Long clientId, @HeaderMap Map<String,String> headers)
      Parameters:
      clientId - (required)
      Returns:
      Call<String>

    • retrieveOne28

      @GET("v1/self/clients/{clientId}") retrofit2.Call<GetSelfClientsClientIdResponse> retrieveOne28(@Path("clientId") Long clientId, @HeaderMap Map<String,String> headers)
      Retrieve a Client Retrieves a Client Example Requests: self/clients/1 self/clients/1?fields=id,displayName,officeName
      Parameters:
      clientId - clientId (required)
      Returns:
      Call<GetSelfClientsClientIdResponse>