Package org.apache.fineract.client.services

Interface LoanCapitalizedIncomeApi

public interface LoanCapitalizedIncomeApi

  • Method Details

    • fetchCapitalizedIncomeDetails

      @GET("v1/loans/{loanId}/capitalized-incomes") retrofit2.Call<List<CapitalizedIncomeDetails>> fetchCapitalizedIncomeDetails(@Path("loanId") Long loanId)
      Fetch the Capitalized Income related informations
      Parameters:
      loanId - loanId (required)
      Returns:
      Call<List<CapitalizedIncomeDetails>>

    • fetchCapitalizedIncomeDetailsByExternalId

      @GET("v1/loans/external-id/{loanExternalId}/capitalized-incomes") retrofit2.Call<List<CapitalizedIncomeDetails>> fetchCapitalizedIncomeDetailsByExternalId(@Path("loanExternalId") String loanExternalId)
      Get the amortization details of Capitalized Income for a loan by external ID
      Parameters:
      loanExternalId - loanExternalId (required)
      Returns:
      Call<List<CapitalizedIncomeDetails>>

    • fetchLoanCapitalizedIncomeData

      @Deprecated @GET("v1/loans/{loanId}/deferredincome") retrofit2.Call<LoanCapitalizedIncomeData> fetchLoanCapitalizedIncomeData(@Path("loanId") Long loanId)
      Deprecated.
      Fetch the Capitalized Income related informations
      Parameters:
      loanId - loanId (required)
      Returns:
      Call<LoanCapitalizedIncomeData>

    • fetchLoanCapitalizedIncomeDataByExternalId

      @Deprecated @GET("v1/loans/external-id/{loanExternalId}/deferredincome") retrofit2.Call<LoanCapitalizedIncomeData> fetchLoanCapitalizedIncomeDataByExternalId(@Path("loanExternalId") String loanExternalId)
      Deprecated.
      Get the amortization details of Capitalized Income for a loan by external ID
      Parameters:
      loanExternalId - loanExternalId (required)
      Returns:
      Call<LoanCapitalizedIncomeData>

    • getCapitalizedIncomeAllocationDataByExternalIds

      @GET("v1/loans/external-id/{loanExternalId}/capitalized-incomes/external-id/{loanTransactionExternalId}") retrofit2.Call<LoanAmortizationAllocationResponse> getCapitalizedIncomeAllocationDataByExternalIds(@Path("loanExternalId") String loanExternalId, @Path("loanTransactionExternalId") String loanTransactionExternalId)
      Retrieve a capitalized income allocation data Retrieves capitalized income allocation data according to the Loan external ID and Loan Transaction external IDExample Requests: /loans/external-id/1/capitalized-incomes/1 /loans/external-id/1/capitalized-incomes/1?fields=baseLoanTransaction,unrecognizedAmount
      Parameters:
      loanExternalId - loanExternalId (required)
      loanTransactionExternalId - loanTransactionExternalId (required)
      Returns:
      Call<LoanAmortizationAllocationResponse>

    • getCapitalizedIncomeAllocationDataByLoanExternalId

      @GET("v1/loans/external-id/{loanExternalId}/capitalized-incomes/{loanTransactionId}") retrofit2.Call<LoanAmortizationAllocationResponse> getCapitalizedIncomeAllocationDataByLoanExternalId(@Path("loanExternalId") String loanExternalId, @Path("loanTransactionId") Long loanTransactionId)
      Retrieve a capitalized income allocation data Retrieves capitalized income allocation data according to the Loan external ID and Loan Transaction IDExample Requests: /loans/external-id/1/capitalized-incomes/1 /loans/external-id/1/capitalized-incomes/1?fields=baseLoanTransaction,unrecognizedAmount
      Parameters:
      loanExternalId - loanExternalId (required)
      loanTransactionId - loanTransactionId (required)
      Returns:
      Call<LoanAmortizationAllocationResponse>

    • getCapitalizedIncomeAllocationDataByTransactionExternalId

      @GET("v1/loans/{loanId}/capitalized-incomes/external-id/{loanTransactionExternalId}") retrofit2.Call<LoanAmortizationAllocationResponse> getCapitalizedIncomeAllocationDataByTransactionExternalId(@Path("loanId") Long loanId, @Path("loanTransactionExternalId") String loanTransactionExternalId)
      Retrieve a capitalized income allocation data Retrieves capitalized income allocation data according to the Loan ID and Loan Transaction external IDExample Requests: /loans/1/capitalized-incomes/external-id/1 /loans/1/capitalized-incomes/external-id/1?fields=baseLoanTransaction,unrecognizedAmount
      Parameters:
      loanId - loanId (required)
      loanTransactionExternalId - loanTransactionExternalId (required)
      Returns:
      Call<LoanAmortizationAllocationResponse>

    • retrieveCapitalizedIncomeAllocationData

      @GET("v1/loans/{loanId}/capitalized-incomes/{loanTransactionId}") retrofit2.Call<LoanAmortizationAllocationResponse> retrieveCapitalizedIncomeAllocationData(@Path("loanId") Long loanId, @Path("loanTransactionId") Long loanTransactionId)
      Retrieve a capitalized income allocation data Retrieves capitalized income allocation data according to the Loan ID and Loan Transaction IDExample Requests: /loans/1/capitalized-incomes/1 /loans/1/capitalized-incomes/1?fields=baseLoanTransaction,unrecognizedAmount
      Parameters:
      loanId - loanId (required)
      loanTransactionId - loanTransactionId (required)
      Returns:
      Call<LoanAmortizationAllocationResponse>

    • fetchCapitalizedIncomeDetails

      @GET("v1/loans/{loanId}/capitalized-incomes") retrofit2.Call<List<CapitalizedIncomeDetails>> fetchCapitalizedIncomeDetails(@Path("loanId") Long loanId, @HeaderMap Map<String,String> headers)
      Fetch the Capitalized Income related informations
      Parameters:
      loanId - loanId (required)
      Returns:
      Call<List<CapitalizedIncomeDetails>>

    • fetchCapitalizedIncomeDetailsByExternalId

      @GET("v1/loans/external-id/{loanExternalId}/capitalized-incomes") retrofit2.Call<List<CapitalizedIncomeDetails>> fetchCapitalizedIncomeDetailsByExternalId(@Path("loanExternalId") String loanExternalId, @HeaderMap Map<String,String> headers)
      Get the amortization details of Capitalized Income for a loan by external ID
      Parameters:
      loanExternalId - loanExternalId (required)
      Returns:
      Call<List<CapitalizedIncomeDetails>>

    • fetchLoanCapitalizedIncomeData

      @Deprecated @GET("v1/loans/{loanId}/deferredincome") retrofit2.Call<LoanCapitalizedIncomeData> fetchLoanCapitalizedIncomeData(@Path("loanId") Long loanId, @HeaderMap Map<String,String> headers)
      Deprecated.
      Fetch the Capitalized Income related informations
      Parameters:
      loanId - loanId (required)
      Returns:
      Call<LoanCapitalizedIncomeData>

    • fetchLoanCapitalizedIncomeDataByExternalId

      @Deprecated @GET("v1/loans/external-id/{loanExternalId}/deferredincome") retrofit2.Call<LoanCapitalizedIncomeData> fetchLoanCapitalizedIncomeDataByExternalId(@Path("loanExternalId") String loanExternalId, @HeaderMap Map<String,String> headers)
      Deprecated.
      Get the amortization details of Capitalized Income for a loan by external ID
      Parameters:
      loanExternalId - loanExternalId (required)
      Returns:
      Call<LoanCapitalizedIncomeData>

    • getCapitalizedIncomeAllocationDataByExternalIds

      @GET("v1/loans/external-id/{loanExternalId}/capitalized-incomes/external-id/{loanTransactionExternalId}") retrofit2.Call<LoanAmortizationAllocationResponse> getCapitalizedIncomeAllocationDataByExternalIds(@Path("loanExternalId") String loanExternalId, @Path("loanTransactionExternalId") String loanTransactionExternalId, @HeaderMap Map<String,String> headers)
      Retrieve a capitalized income allocation data Retrieves capitalized income allocation data according to the Loan external ID and Loan Transaction external IDExample Requests: /loans/external-id/1/capitalized-incomes/1 /loans/external-id/1/capitalized-incomes/1?fields=baseLoanTransaction,unrecognizedAmount
      Parameters:
      loanExternalId - loanExternalId (required)
      loanTransactionExternalId - loanTransactionExternalId (required)
      Returns:
      Call<LoanAmortizationAllocationResponse>

    • getCapitalizedIncomeAllocationDataByLoanExternalId

      @GET("v1/loans/external-id/{loanExternalId}/capitalized-incomes/{loanTransactionId}") retrofit2.Call<LoanAmortizationAllocationResponse> getCapitalizedIncomeAllocationDataByLoanExternalId(@Path("loanExternalId") String loanExternalId, @Path("loanTransactionId") Long loanTransactionId, @HeaderMap Map<String,String> headers)
      Retrieve a capitalized income allocation data Retrieves capitalized income allocation data according to the Loan external ID and Loan Transaction IDExample Requests: /loans/external-id/1/capitalized-incomes/1 /loans/external-id/1/capitalized-incomes/1?fields=baseLoanTransaction,unrecognizedAmount
      Parameters:
      loanExternalId - loanExternalId (required)
      loanTransactionId - loanTransactionId (required)
      Returns:
      Call<LoanAmortizationAllocationResponse>

    • getCapitalizedIncomeAllocationDataByTransactionExternalId

      @GET("v1/loans/{loanId}/capitalized-incomes/external-id/{loanTransactionExternalId}") retrofit2.Call<LoanAmortizationAllocationResponse> getCapitalizedIncomeAllocationDataByTransactionExternalId(@Path("loanId") Long loanId, @Path("loanTransactionExternalId") String loanTransactionExternalId, @HeaderMap Map<String,String> headers)
      Retrieve a capitalized income allocation data Retrieves capitalized income allocation data according to the Loan ID and Loan Transaction external IDExample Requests: /loans/1/capitalized-incomes/external-id/1 /loans/1/capitalized-incomes/external-id/1?fields=baseLoanTransaction,unrecognizedAmount
      Parameters:
      loanId - loanId (required)
      loanTransactionExternalId - loanTransactionExternalId (required)
      Returns:
      Call<LoanAmortizationAllocationResponse>

    • retrieveCapitalizedIncomeAllocationData

      @GET("v1/loans/{loanId}/capitalized-incomes/{loanTransactionId}") retrofit2.Call<LoanAmortizationAllocationResponse> retrieveCapitalizedIncomeAllocationData(@Path("loanId") Long loanId, @Path("loanTransactionId") Long loanTransactionId, @HeaderMap Map<String,String> headers)
      Retrieve a capitalized income allocation data Retrieves capitalized income allocation data according to the Loan ID and Loan Transaction IDExample Requests: /loans/1/capitalized-incomes/1 /loans/1/capitalized-incomes/1?fields=baseLoanTransaction,unrecognizedAmount
      Parameters:
      loanId - loanId (required)
      loanTransactionId - loanTransactionId (required)
      Returns:
      Call<LoanAmortizationAllocationResponse>