Package org.apache.fineract.client.services

Interface SelfLoansApi

public interface SelfLoansApi

  • Method Summary

    Modifier and Type
    Method
    Description
    retrofit2.Call<PostSelfLoansResponse>
    calculateLoanScheduleOrSubmitLoanApplication1(PostSelfLoansRequest postSelfLoansRequest, String command)
    Calculate Loan Repayment Schedule | Submit a new Loan Application Calculate Loan Repayment Schedule: Calculates Loan Repayment Schedule Mandatory Fields: productId, principal, loanTermFrequency, loanTermFrequencyType, numberOfRepayments, repaymentEvery, repaymentFrequencyType, interestRatePerPeriod, amortizationType, interestType, interestCalculationPeriodType, expectedDisbursementDate, transactionProcessingStrategyCode Submit a new Loan Application: Mandatory Fields: clientId, productId, principal, loanTermFrequency, loanTermFrequencyType, loanType, numberOfRepayments, repaymentEvery, repaymentFrequencyType, interestRatePerPeriod, amortizationType, interestType, interestCalculationPeriodType, transactionProcessingStrategyCode, expectedDisbursementDate, submittedOnDate, loanType Additional Mandatory Fields if interest recalculation is enabled for product and Rest frequency not same as repayment period: recalculationRestFrequencyDate Additional Mandatory Fields if interest recalculation with interest/fee compounding is enabled for product and compounding frequency not same as repayment period: recalculationCompoundingFrequencyDate Additional Mandatory Field if Entity-Datatable Check is enabled for the entity of type loan: datatables Optional Fields: graceOnPrincipalPayment, graceOnInterestPayment, graceOnInterestCharged, linkAccountId, allowPartialPeriodInterestCalcualtion, fixedEmiAmount, maxOutstandingLoanBalance, disbursementData, graceOnArrearsAgeing, createStandingInstructionAtDisbursement (requires linkedAccountId if set to true) Showing request/response for 'Submit a new Loan Application'
    retrofit2.Call<PostSelfLoansResponse>
    calculateLoanScheduleOrSubmitLoanApplication1(PostSelfLoansRequest postSelfLoansRequest, String command, Map<String,String> headers)
    Calculate Loan Repayment Schedule | Submit a new Loan Application Calculate Loan Repayment Schedule: Calculates Loan Repayment Schedule Mandatory Fields: productId, principal, loanTermFrequency, loanTermFrequencyType, numberOfRepayments, repaymentEvery, repaymentFrequencyType, interestRatePerPeriod, amortizationType, interestType, interestCalculationPeriodType, expectedDisbursementDate, transactionProcessingStrategyCode Submit a new Loan Application: Mandatory Fields: clientId, productId, principal, loanTermFrequency, loanTermFrequencyType, loanType, numberOfRepayments, repaymentEvery, repaymentFrequencyType, interestRatePerPeriod, amortizationType, interestType, interestCalculationPeriodType, transactionProcessingStrategyCode, expectedDisbursementDate, submittedOnDate, loanType Additional Mandatory Fields if interest recalculation is enabled for product and Rest frequency not same as repayment period: recalculationRestFrequencyDate Additional Mandatory Fields if interest recalculation with interest/fee compounding is enabled for product and compounding frequency not same as repayment period: recalculationCompoundingFrequencyDate Additional Mandatory Field if Entity-Datatable Check is enabled for the entity of type loan: datatables Optional Fields: graceOnPrincipalPayment, graceOnInterestPayment, graceOnInterestCharged, linkAccountId, allowPartialPeriodInterestCalcualtion, fixedEmiAmount, maxOutstandingLoanBalance, disbursementData, graceOnArrearsAgeing, createStandingInstructionAtDisbursement (requires linkedAccountId if set to true) Showing request/response for 'Submit a new Loan Application'
    retrofit2.Call<PutSelfLoansLoanIdResponse>
    modifyLoanApplication2(Long loanId, PutSelfLoansLoanIdRequest putSelfLoansLoanIdRequest)
    Update a Loan Application Loan application can only be modified when in 'Submitted and pending approval' state.
    retrofit2.Call<PutSelfLoansLoanIdResponse>
    modifyLoanApplication2(Long loanId, PutSelfLoansLoanIdRequest putSelfLoansLoanIdRequest, Map<String,String> headers)
    Update a Loan Application Loan application can only be modified when in 'Submitted and pending approval' state.
    retrofit2.Call<List<GetSelfLoansLoanIdChargesResponse>>
    retrieveAllLoanCharges2(Long loanId)
    List Loan Charges Lists loan Charges Example Requests: self/loans/1/charges self/loans/1/charges?fields=name,amountOrPercentage
    retrofit2.Call<List<GetSelfLoansLoanIdChargesResponse>>
    retrieveAllLoanCharges2(Long loanId, Map<String,String> headers)
    List Loan Charges Lists loan Charges Example Requests: self/loans/1/charges self/loans/1/charges?fields=name,amountOrPercentage
    retrofit2.Call<List<GuarantorData>>
    retrieveGuarantorDetails2(Long loanId)
     
    retrofit2.Call<List<GuarantorData>>
    retrieveGuarantorDetails2(Long loanId, Map<String,String> headers)
     
    retrofit2.Call<GetSelfLoansLoanIdResponse>
    retrieveLoan2(Long loanId)
    Retrieve a Loan Retrieves a Loan Example Requests: self/loans/1 self/loans/1?fields=id,principal,annualInterestRate self/loans/1?fields=id,principal,annualInterestRate&associations=repaymentSchedule,transactions
    retrofit2.Call<GetSelfLoansLoanIdResponse>
    retrieveLoan2(Long loanId, Map<String,String> headers)
    Retrieve a Loan Retrieves a Loan Example Requests: self/loans/1 self/loans/1?fields=id,principal,annualInterestRate self/loans/1?fields=id,principal,annualInterestRate&associations=repaymentSchedule,transactions
    retrofit2.Call<GetSelfLoansLoanIdChargesResponse>
    retrieveLoanCharge4(Long loanId, Long chargeId)
    Retrieve a Loan Charge Retrieves a Loan Charge Example Requests: self/loans/1/charges/1 self/loans/1/charges/1?fields=name,amountOrPercentage
    retrofit2.Call<GetSelfLoansLoanIdChargesResponse>
    retrieveLoanCharge4(Long loanId, Long chargeId, Map<String,String> headers)
    Retrieve a Loan Charge Retrieves a Loan Charge Example Requests: self/loans/1/charges/1 self/loans/1/charges/1?fields=name,amountOrPercentage
    retrofit2.Call<GetSelfLoansLoanIdTransactionsTransactionIdResponse>
    retrieveTransaction1(Long loanId, Long transactionId, String fields)
    Retrieve a Loan Transaction Details Retrieves a Loan Transaction DetailsExample Request: self/loans/5/transactions/3
    retrofit2.Call<GetSelfLoansLoanIdTransactionsTransactionIdResponse>
    retrieveTransaction1(Long loanId, Long transactionId, String fields, Map<String,String> headers)
    Retrieve a Loan Transaction Details Retrieves a Loan Transaction DetailsExample Request: self/loans/5/transactions/3
    retrofit2.Call<PostSelfLoansLoanIdResponse>
    stateTransitions2(Long loanId, PostSelfLoansLoanIdRequest postSelfLoansLoanIdRequest, String command)
    Applicant Withdraws from Loan Application Applicant Withdraws from Loan Application Mandatory Fields: withdrawnOnDate
    retrofit2.Call<PostSelfLoansLoanIdResponse>
    stateTransitions2(Long loanId, PostSelfLoansLoanIdRequest postSelfLoansLoanIdRequest, String command, Map<String,String> headers)
    Applicant Withdraws from Loan Application Applicant Withdraws from Loan Application Mandatory Fields: withdrawnOnDate
    retrofit2.Call<GetSelfLoansTemplateResponse>
    template17(Long clientId, Long productId, String templateType)
    Retrieve Loan Details Template Retrieves Loan Details Template This is a convenience resource.
    retrofit2.Call<GetSelfLoansTemplateResponse>
    template17(Long clientId, Long productId, String templateType, Map<String,String> headers)
    Retrieve Loan Details Template Retrieves Loan Details Template This is a convenience resource.

  • Method Details

    • calculateLoanScheduleOrSubmitLoanApplication1

      @Headers("Content-Type:application/json") @POST("v1/self/loans") retrofit2.Call<PostSelfLoansResponse> calculateLoanScheduleOrSubmitLoanApplication1(@Body PostSelfLoansRequest postSelfLoansRequest, @Query("command") String command)
      Calculate Loan Repayment Schedule | Submit a new Loan Application Calculate Loan Repayment Schedule: Calculates Loan Repayment Schedule Mandatory Fields: productId, principal, loanTermFrequency, loanTermFrequencyType, numberOfRepayments, repaymentEvery, repaymentFrequencyType, interestRatePerPeriod, amortizationType, interestType, interestCalculationPeriodType, expectedDisbursementDate, transactionProcessingStrategyCode Submit a new Loan Application: Mandatory Fields: clientId, productId, principal, loanTermFrequency, loanTermFrequencyType, loanType, numberOfRepayments, repaymentEvery, repaymentFrequencyType, interestRatePerPeriod, amortizationType, interestType, interestCalculationPeriodType, transactionProcessingStrategyCode, expectedDisbursementDate, submittedOnDate, loanType Additional Mandatory Fields if interest recalculation is enabled for product and Rest frequency not same as repayment period: recalculationRestFrequencyDate Additional Mandatory Fields if interest recalculation with interest/fee compounding is enabled for product and compounding frequency not same as repayment period: recalculationCompoundingFrequencyDate Additional Mandatory Field if Entity-Datatable Check is enabled for the entity of type loan: datatables Optional Fields: graceOnPrincipalPayment, graceOnInterestPayment, graceOnInterestCharged, linkAccountId, allowPartialPeriodInterestCalcualtion, fixedEmiAmount, maxOutstandingLoanBalance, disbursementData, graceOnArrearsAgeing, createStandingInstructionAtDisbursement (requires linkedAccountId if set to true) Showing request/response for 'Submit a new Loan Application'
      Parameters:
      postSelfLoansRequest - (required)
      command - command (optional)
      Returns:
      Call<PostSelfLoansResponse>

    • modifyLoanApplication2

      @Headers("Content-Type:application/json") @PUT("v1/self/loans/{loanId}") retrofit2.Call<PutSelfLoansLoanIdResponse> modifyLoanApplication2(@Path("loanId") Long loanId, @Body PutSelfLoansLoanIdRequest putSelfLoansLoanIdRequest)
      Update a Loan Application Loan application can only be modified when in 'Submitted and pending approval' state. Once the application is approved, the details cannot be changed using this method.
      Parameters:
      loanId - loanId (required)
      putSelfLoansLoanIdRequest - (required)
      Returns:
      Call<PutSelfLoansLoanIdResponse>

    • retrieveAllLoanCharges2

      @GET("v1/self/loans/{loanId}/charges") retrofit2.Call<List<GetSelfLoansLoanIdChargesResponse>> retrieveAllLoanCharges2(@Path("loanId") Long loanId)
      List Loan Charges Lists loan Charges Example Requests: self/loans/1/charges self/loans/1/charges?fields=name,amountOrPercentage
      Parameters:
      loanId - loanId (required)
      Returns:
      Call<List<GetSelfLoansLoanIdChargesResponse>>

    • retrieveGuarantorDetails2

      @GET("v1/self/loans/{loanId}/guarantors") retrofit2.Call<List<GuarantorData>> retrieveGuarantorDetails2(@Path("loanId") Long loanId)
      Parameters:
      loanId - (required)
      Returns:
      Call<List<GuarantorData>>

    • retrieveLoan2

      @GET("v1/self/loans/{loanId}") retrofit2.Call<GetSelfLoansLoanIdResponse> retrieveLoan2(@Path("loanId") Long loanId)
      Retrieve a Loan Retrieves a Loan Example Requests: self/loans/1 self/loans/1?fields=id,principal,annualInterestRate self/loans/1?fields=id,principal,annualInterestRate&associations=repaymentSchedule,transactions
      Parameters:
      loanId - loanId (required)
      Returns:
      Call<GetSelfLoansLoanIdResponse>

    • retrieveLoanCharge4

      @GET("v1/self/loans/{loanId}/charges/{chargeId}") retrofit2.Call<GetSelfLoansLoanIdChargesResponse> retrieveLoanCharge4(@Path("loanId") Long loanId, @Path("chargeId") Long chargeId)
      Retrieve a Loan Charge Retrieves a Loan Charge Example Requests: self/loans/1/charges/1 self/loans/1/charges/1?fields=name,amountOrPercentage
      Parameters:
      loanId - loanId (required)
      chargeId - chargeId (required)
      Returns:
      Call<GetSelfLoansLoanIdChargesResponse>

    • retrieveTransaction1

      @GET("v1/self/loans/{loanId}/transactions/{transactionId}") retrofit2.Call<GetSelfLoansLoanIdTransactionsTransactionIdResponse> retrieveTransaction1(@Path("loanId") Long loanId, @Path("transactionId") Long transactionId, @Query("fields") String fields)
      Retrieve a Loan Transaction Details Retrieves a Loan Transaction DetailsExample Request: self/loans/5/transactions/3
      Parameters:
      loanId - loanId (required)
      transactionId - transactionId (required)
      fields - Optional Loan Transaction attribute list to be in the response (optional)
      Returns:
      Call<GetSelfLoansLoanIdTransactionsTransactionIdResponse>

    • stateTransitions2

      @Headers("Content-Type:application/json") @POST("v1/self/loans/{loanId}") retrofit2.Call<PostSelfLoansLoanIdResponse> stateTransitions2(@Path("loanId") Long loanId, @Body PostSelfLoansLoanIdRequest postSelfLoansLoanIdRequest, @Query("command") String command)
      Applicant Withdraws from Loan Application Applicant Withdraws from Loan Application Mandatory Fields: withdrawnOnDate
      Parameters:
      loanId - loanId (required)
      postSelfLoansLoanIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostSelfLoansLoanIdResponse>

    • template17

      @GET("v1/self/loans/template") retrofit2.Call<GetSelfLoansTemplateResponse> template17(@Query("clientId") Long clientId, @Query("productId") Long productId, @Query("templateType") String templateType)
      Retrieve Loan Details Template Retrieves Loan Details 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 description Lists Example Requests: self/loans/template?templateType=individual&clientId=1 self/loans/template?templateType=individual&clientId=1&productId=1
      Parameters:
      clientId - clientId (optional)
      productId - productId (optional)
      templateType - templateType (optional)
      Returns:
      Call<GetSelfLoansTemplateResponse>

    • calculateLoanScheduleOrSubmitLoanApplication1

      @Headers("Content-Type:application/json") @POST("v1/self/loans") retrofit2.Call<PostSelfLoansResponse> calculateLoanScheduleOrSubmitLoanApplication1(@Body PostSelfLoansRequest postSelfLoansRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Calculate Loan Repayment Schedule | Submit a new Loan Application Calculate Loan Repayment Schedule: Calculates Loan Repayment Schedule Mandatory Fields: productId, principal, loanTermFrequency, loanTermFrequencyType, numberOfRepayments, repaymentEvery, repaymentFrequencyType, interestRatePerPeriod, amortizationType, interestType, interestCalculationPeriodType, expectedDisbursementDate, transactionProcessingStrategyCode Submit a new Loan Application: Mandatory Fields: clientId, productId, principal, loanTermFrequency, loanTermFrequencyType, loanType, numberOfRepayments, repaymentEvery, repaymentFrequencyType, interestRatePerPeriod, amortizationType, interestType, interestCalculationPeriodType, transactionProcessingStrategyCode, expectedDisbursementDate, submittedOnDate, loanType Additional Mandatory Fields if interest recalculation is enabled for product and Rest frequency not same as repayment period: recalculationRestFrequencyDate Additional Mandatory Fields if interest recalculation with interest/fee compounding is enabled for product and compounding frequency not same as repayment period: recalculationCompoundingFrequencyDate Additional Mandatory Field if Entity-Datatable Check is enabled for the entity of type loan: datatables Optional Fields: graceOnPrincipalPayment, graceOnInterestPayment, graceOnInterestCharged, linkAccountId, allowPartialPeriodInterestCalcualtion, fixedEmiAmount, maxOutstandingLoanBalance, disbursementData, graceOnArrearsAgeing, createStandingInstructionAtDisbursement (requires linkedAccountId if set to true) Showing request/response for 'Submit a new Loan Application'
      Parameters:
      postSelfLoansRequest - (required)
      command - command (optional)
      Returns:
      Call<PostSelfLoansResponse>

    • modifyLoanApplication2

      @Headers("Content-Type:application/json") @PUT("v1/self/loans/{loanId}") retrofit2.Call<PutSelfLoansLoanIdResponse> modifyLoanApplication2(@Path("loanId") Long loanId, @Body PutSelfLoansLoanIdRequest putSelfLoansLoanIdRequest, @HeaderMap Map<String,String> headers)
      Update a Loan Application Loan application can only be modified when in 'Submitted and pending approval' state. Once the application is approved, the details cannot be changed using this method.
      Parameters:
      loanId - loanId (required)
      putSelfLoansLoanIdRequest - (required)
      Returns:
      Call<PutSelfLoansLoanIdResponse>

    • retrieveAllLoanCharges2

      @GET("v1/self/loans/{loanId}/charges") retrofit2.Call<List<GetSelfLoansLoanIdChargesResponse>> retrieveAllLoanCharges2(@Path("loanId") Long loanId, @HeaderMap Map<String,String> headers)
      List Loan Charges Lists loan Charges Example Requests: self/loans/1/charges self/loans/1/charges?fields=name,amountOrPercentage
      Parameters:
      loanId - loanId (required)
      Returns:
      Call<List<GetSelfLoansLoanIdChargesResponse>>

    • retrieveGuarantorDetails2

      @GET("v1/self/loans/{loanId}/guarantors") retrofit2.Call<List<GuarantorData>> retrieveGuarantorDetails2(@Path("loanId") Long loanId, @HeaderMap Map<String,String> headers)
      Parameters:
      loanId - (required)
      Returns:
      Call<List<GuarantorData>>

    • retrieveLoan2

      @GET("v1/self/loans/{loanId}") retrofit2.Call<GetSelfLoansLoanIdResponse> retrieveLoan2(@Path("loanId") Long loanId, @HeaderMap Map<String,String> headers)
      Retrieve a Loan Retrieves a Loan Example Requests: self/loans/1 self/loans/1?fields=id,principal,annualInterestRate self/loans/1?fields=id,principal,annualInterestRate&associations=repaymentSchedule,transactions
      Parameters:
      loanId - loanId (required)
      Returns:
      Call<GetSelfLoansLoanIdResponse>

    • retrieveLoanCharge4

      @GET("v1/self/loans/{loanId}/charges/{chargeId}") retrofit2.Call<GetSelfLoansLoanIdChargesResponse> retrieveLoanCharge4(@Path("loanId") Long loanId, @Path("chargeId") Long chargeId, @HeaderMap Map<String,String> headers)
      Retrieve a Loan Charge Retrieves a Loan Charge Example Requests: self/loans/1/charges/1 self/loans/1/charges/1?fields=name,amountOrPercentage
      Parameters:
      loanId - loanId (required)
      chargeId - chargeId (required)
      Returns:
      Call<GetSelfLoansLoanIdChargesResponse>

    • retrieveTransaction1

      @GET("v1/self/loans/{loanId}/transactions/{transactionId}") retrofit2.Call<GetSelfLoansLoanIdTransactionsTransactionIdResponse> retrieveTransaction1(@Path("loanId") Long loanId, @Path("transactionId") Long transactionId, @Query("fields") String fields, @HeaderMap Map<String,String> headers)
      Retrieve a Loan Transaction Details Retrieves a Loan Transaction DetailsExample Request: self/loans/5/transactions/3
      Parameters:
      loanId - loanId (required)
      transactionId - transactionId (required)
      fields - Optional Loan Transaction attribute list to be in the response (optional)
      Returns:
      Call<GetSelfLoansLoanIdTransactionsTransactionIdResponse>

    • stateTransitions2

      @Headers("Content-Type:application/json") @POST("v1/self/loans/{loanId}") retrofit2.Call<PostSelfLoansLoanIdResponse> stateTransitions2(@Path("loanId") Long loanId, @Body PostSelfLoansLoanIdRequest postSelfLoansLoanIdRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Applicant Withdraws from Loan Application Applicant Withdraws from Loan Application Mandatory Fields: withdrawnOnDate
      Parameters:
      loanId - loanId (required)
      postSelfLoansLoanIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostSelfLoansLoanIdResponse>

    • template17

      @GET("v1/self/loans/template") retrofit2.Call<GetSelfLoansTemplateResponse> template17(@Query("clientId") Long clientId, @Query("productId") Long productId, @Query("templateType") String templateType, @HeaderMap Map<String,String> headers)
      Retrieve Loan Details Template Retrieves Loan Details 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 description Lists Example Requests: self/loans/template?templateType=individual&clientId=1 self/loans/template?templateType=individual&clientId=1&productId=1
      Parameters:
      clientId - clientId (optional)
      productId - productId (optional)
      templateType - templateType (optional)
      Returns:
      Call<GetSelfLoansTemplateResponse>