Package org.apache.fineract.client.services

Interface LoansApi

public interface LoansApi

  • Method Details

    • calculateLoanScheduleOrSubmitLoanApplication

      @Headers("Content-Type:application/json") @POST("v1/loans") retrofit2.Call<PostLoansResponse> calculateLoanScheduleOrSubmitLoanApplication(@Body PostLoansRequest postLoansRequest, @Query("command") String command)
      Calculate loan repayment schedule | Submit a new Loan Application It calculates the loan repayment Schedule Submits a new loan application Mandatory Fields: clientId, productId, principal, loanTermFrequency, loanTermFrequencyType, loanType, numberOfRepayments, repaymentEvery, repaymentFrequencyType, interestRatePerPeriod, amortizationType, interestType, interestCalculationPeriodType, transactionProcessingStrategyCode, expectedDisbursementDate, submittedOnDate, loanType Optional Fields: graceOnPrincipalPayment, graceOnInterestPayment, graceOnInterestCharged, linkAccountId, allowPartialPeriodInterestCalcualtion, fixedEmiAmount, maxOutstandingLoanBalance, disbursementData, graceOnArrearsAgeing, createStandingInstructionAtDisbursement (requires linkedAccountId if set to true) 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
      Parameters:
      postLoansRequest - (required)
      command - command (optional)
      Returns:
      Call<PostLoansResponse>

    • createLoanDelinquencyAction

      @Headers("Content-Type:application/json") @POST("v1/loans/{loanId}/delinquency-actions") retrofit2.Call<PostLoansDelinquencyActionResponse> createLoanDelinquencyAction(@Path("loanId") Long loanId, @Body PostLoansDelinquencyActionRequest postLoansDelinquencyActionRequest)
      Adds a new delinquency action for a loan
      Parameters:
      loanId - loanId (required)
      postLoansDelinquencyActionRequest - (required)
      Returns:
      Call<PostLoansDelinquencyActionResponse>

    • createLoanDelinquencyAction1

      @Headers("Content-Type:application/json") @POST("v1/loans/external-id/{loanExternalId}/delinquency-actions") retrofit2.Call<PostLoansDelinquencyActionResponse> createLoanDelinquencyAction1(@Path("loanExternalId") String loanExternalId, @Body PostLoansDelinquencyActionRequest postLoansDelinquencyActionRequest)
      Adds a new delinquency action for a loan
      Parameters:
      loanExternalId - loanExternalId (required)
      postLoansDelinquencyActionRequest - (required)
      Returns:
      Call<PostLoansDelinquencyActionResponse>

    • deleteLoanApplication

      @DELETE("v1/loans/{loanId}") retrofit2.Call<DeleteLoansLoanIdResponse> deleteLoanApplication(@Path("loanId") Long loanId)
      Delete a Loan Application Note: Only loans in \"Submitted and awaiting approval\" status can be deleted.
      Parameters:
      loanId - loanId (required)
      Returns:
      Call<DeleteLoansLoanIdResponse>

    • deleteLoanApplication1

      @DELETE("v1/loans/external-id/{loanExternalId}") retrofit2.Call<DeleteLoansLoanIdResponse> deleteLoanApplication1(@Path("loanExternalId") String loanExternalId)
      Delete a Loan Application Note: Only loans in \"Submitted and awaiting approval\" status can be deleted.
      Parameters:
      loanExternalId - loanExternalId (required)
      Returns:
      Call<DeleteLoansLoanIdResponse>

    • getDelinquencyTagHistory

      @GET("v1/loans/{loanId}/delinquencytags") retrofit2.Call<List<GetDelinquencyTagHistoryResponse>> getDelinquencyTagHistory(@Path("loanId") Long loanId)
      Retrieve the Loan Delinquency Tag history using the Loan Id
      Parameters:
      loanId - loanId (required)
      Returns:
      Call<List<GetDelinquencyTagHistoryResponse>>

    • getDelinquencyTagHistory1

      @GET("v1/loans/external-id/{loanExternalId}/delinquencytags") retrofit2.Call<List<GetDelinquencyTagHistoryResponse>> getDelinquencyTagHistory1(@Path("loanExternalId") String loanExternalId)
      Retrieve the Loan Delinquency Tag history using the Loan Id
      Parameters:
      loanExternalId - loanExternalId (required)
      Returns:
      Call<List<GetDelinquencyTagHistoryResponse>>

    • getGlimRepaymentTemplate

      @GET("v1/loans/glimAccount/{glimId}") retrofit2.Call<String> getGlimRepaymentTemplate(@Path("glimId") Long glimId)
      Parameters:
      glimId - (required)
      Returns:
      Call<String>

    • getLoanDelinquencyActions

      @GET("v1/loans/{loanId}/delinquency-actions") retrofit2.Call<List<GetDelinquencyActionsResponse>> getLoanDelinquencyActions(@Path("loanId") Long loanId)
      Retrieve delinquency actions related to the loan
      Parameters:
      loanId - loanId (required)
      Returns:
      Call<List<GetDelinquencyActionsResponse>>

    • getLoanDelinquencyActions1

      @GET("v1/loans/external-id/{loanExternalId}/delinquency-actions") retrofit2.Call<List<GetDelinquencyActionsResponse>> getLoanDelinquencyActions1(@Path("loanExternalId") String loanExternalId)
      Retrieve delinquency actions related to the loan
      Parameters:
      loanExternalId - loanExternalId (required)
      Returns:
      Call<List<GetDelinquencyActionsResponse>>

    • getLoanRepaymentTemplate

      @GET("v1/loans/repayments/downloadtemplate") retrofit2.Call<Void> getLoanRepaymentTemplate(@Query("officeId") Long officeId, @Query("dateFormat") String dateFormat)
      Parameters:
      officeId - (optional)
      dateFormat - (optional)
      Returns:
      Call<Void>

    • getLoansTemplate

      @GET("v1/loans/downloadtemplate") retrofit2.Call<Void> getLoansTemplate(@Query("officeId") Long officeId, @Query("staffId") Long staffId, @Query("dateFormat") String dateFormat)
      Parameters:
      officeId - (optional)
      staffId - (optional)
      dateFormat - (optional)
      Returns:
      Call<Void>

    • glimStateTransitions

      @Headers("Content-Type:application/json") @POST("v1/loans/glimAccount/{glimId}") retrofit2.Call<PostLoansLoanIdResponse> glimStateTransitions(@Path("glimId") Long glimId, @Body PostLoansLoanIdRequest postLoansLoanIdRequest, @Query("command") String command)
      Approve GLIM Application | Undo GLIM Application Approval | Reject GLIM Application | Disburse Loan Disburse Loan To Savings Account | Undo Loan Disbursal Approve GLIM Application: Mandatory Fields: approvedOnDate Optional Fields: approvedLoanAmount and expectedDisbursementDate Approves the GLIM application Undo GLIM Application Approval: Undoes the GLIM Application Approval Reject GLIM Application: Mandatory Fields: rejectedOnDate Allows you to reject the GLIM application Disburse Loan: Mandatory Fields: actualDisbursementDate Optional Fields: transactionAmount and fixedEmiAmount Disburses the Loan Disburse Loan To Savings Account: Mandatory Fields: actualDisbursementDate Optional Fields: transactionAmount and fixedEmiAmount Disburses the loan to Saving Account Undo Loan Disbursal: Undoes the Loan Disbursal
      Parameters:
      glimId - (required)
      postLoansLoanIdRequest - (required)
      command - (optional)
      Returns:
      Call<PostLoansLoanIdResponse>

    • modifyLoanApplication

      @Headers("Content-Type:application/json") @PUT("v1/loans/{loanId}") retrofit2.Call<PutLoansLoanIdResponse> modifyLoanApplication(@Path("loanId") Long loanId, @Body PutLoansLoanIdRequest putLoansLoanIdRequest, @Query("command") String command)
      Modify 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)
      putLoansLoanIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PutLoansLoanIdResponse>

    • modifyLoanApplication1

      @Headers("Content-Type:application/json") @PUT("v1/loans/external-id/{loanExternalId}") retrofit2.Call<PutLoansLoanIdResponse> modifyLoanApplication1(@Path("loanExternalId") String loanExternalId, @Body PutLoansLoanIdRequest putLoansLoanIdRequest, @Query("command") String command)
      Modify 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:
      loanExternalId - loanExternalId (required)
      putLoansLoanIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PutLoansLoanIdResponse>

    • postLoanRepaymentTemplate

      @Multipart @POST("v1/loans/repayments/uploadtemplate") retrofit2.Call<String> postLoanRepaymentTemplate(@Part("dateFormat") String dateFormat, @Part("locale") String locale, @Part okhttp3.MultipartBody.Part uploadedInputStream)
      Parameters:
      dateFormat - (optional)
      locale - (optional)
      uploadedInputStream - (optional)
      Returns:
      Call<String>

    • postLoanTemplate

      @Multipart @POST("v1/loans/uploadtemplate") retrofit2.Call<String> postLoanTemplate(@Part("dateFormat") String dateFormat, @Part("locale") String locale, @Part okhttp3.MultipartBody.Part uploadedInputStream)
      Parameters:
      dateFormat - (optional)
      locale - (optional)
      uploadedInputStream - (optional)
      Returns:
      Call<String>

    • retrieveAll27

      @GET("v1/loans") retrofit2.Call<GetLoansResponse> retrieveAll27(@Query("externalId") String externalId, @Query("offset") Integer offset, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder, @Query("accountNo") String accountNo, @Query("associations") String associations, @Query("clientId") Long clientId, @Query("status") String status)
      List Loans The list capability of loans can support pagination and sorting. Example Requests: loans loans?fields=accountNo loans?offset=10&limit=50 loans?orderBy=accountNo&sortOrder=DESC
      Parameters:
      externalId - externalId (optional)
      offset - offset (optional)
      limit - limit (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      accountNo - accountNo (optional)
      associations - associations (optional)
      clientId - clientId (optional)
      status - status (optional)
      Returns:
      Call<GetLoansResponse>

    • retrieveApprovalTemplate

      @GET("v1/loans/{loanId}/template") retrofit2.Call<GetLoansApprovalTemplateResponse> retrieveApprovalTemplate(@Path("loanId") Long loanId, @Query("templateType") String templateType)
      Parameters:
      loanId - loanId (required)
      templateType - templateType (optional)
      Returns:
      Call<GetLoansApprovalTemplateResponse>

    • retrieveApprovalTemplate1

      @GET("v1/loans/external-id/{loanExternalId}/template") retrofit2.Call<GetLoansApprovalTemplateResponse> retrieveApprovalTemplate1(@Path("loanExternalId") String loanExternalId, @Query("templateType") String templateType)
      Parameters:
      loanExternalId - loanExternalId (required)
      templateType - templateType (optional)
      Returns:
      Call<GetLoansApprovalTemplateResponse>

    • retrieveLoan

      @GET("v1/loans/{loanId}") retrofit2.Call<GetLoansLoanIdResponse> retrieveLoan(@Path("loanId") Long loanId, @Query("staffInSelectedOfficeOnly") Boolean staffInSelectedOfficeOnly, @Query("associations") String associations, @Query("exclude") String exclude, @Query("fields") String fields)
      Retrieve a Loan Note: template=true parameter doesn't apply to this resource.Example Requests: loans/1 loans/1?fields=id,principal,annualInterestRate loans/1?associations=all loans/1?associations=all&exclude=guarantors loans/1?fields=id,principal,annualInterestRate&associations=repaymentSchedule,transactions
      Parameters:
      loanId - loanId (required)
      staffInSelectedOfficeOnly - staffInSelectedOfficeOnly (optional, default to false)
      associations - Loan object relations to be included in the response (optional, default to all)
      exclude - Optional Loan object relation list to be filtered in the response (optional)
      fields - Optional Loan attribute list to be in the response (optional)
      Returns:
      Call<GetLoansLoanIdResponse>

    • retrieveLoan1

      @GET("v1/loans/external-id/{loanExternalId}") retrofit2.Call<GetLoansLoanIdResponse> retrieveLoan1(@Path("loanExternalId") String loanExternalId, @Query("staffInSelectedOfficeOnly") Boolean staffInSelectedOfficeOnly, @Query("associations") String associations, @Query("exclude") String exclude, @Query("fields") String fields)
      Retrieve a Loan Note: template=true parameter doesn't apply to this resource.Example Requests: loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854 loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854?fields=id,principal,annualInterestRate loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854?associations=all loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854?associations=all&exclude=guarantors loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854?fields=id,principal,annualInterestRate&associations=repaymentSchedule,transactions
      Parameters:
      loanExternalId - loanExternalId (required)
      staffInSelectedOfficeOnly - staffInSelectedOfficeOnly (optional, default to false)
      associations - Loan object relations to be included in the response (optional, default to all)
      exclude - Optional Loan object relation list to be filtered in the response (optional)
      fields - Optional Loan attribute list to be in the response (optional)
      Returns:
      Call<GetLoansLoanIdResponse>

    • stateTransitions

      @Headers("Content-Type:application/json") @POST("v1/loans/{loanId}") retrofit2.Call<PostLoansLoanIdResponse> stateTransitions(@Path("loanId") Long loanId, @Body PostLoansLoanIdRequest postLoansLoanIdRequest, @Query("command") String command)
      Approve Loan Application | Recover Loan Guarantee | Undo Loan Application Approval | Assign a Loan Officer | Unassign a Loan Officer | Reject Loan Application | Applicant Withdraws from Loan Application | Disburse Loan Disburse Loan To Savings Account | Undo Loan Disbursal Approve Loan Application: Mandatory Fields: approvedOnDate Optional Fields: approvedLoanAmount and expectedDisbursementDate Approves the loan application Recover Loan Guarantee: Recovers the loan guarantee Undo Loan Application Approval: Undoes the Loan Application Approval Assign a Loan Officer: Allows you to assign Loan Officer for existing Loan. Unassign a Loan Officer: Allows you to unassign the Loan Officer. Reject Loan Application: Mandatory Fields: rejectedOnDate Allows you to reject the loan application Applicant Withdraws from Loan Application: Mandatory Fields: withdrawnOnDate Allows the applicant to withdraw the loan application Disburse Loan: Mandatory Fields: actualDisbursementDate Optional Fields: transactionAmount and fixedEmiAmount Disburses the Loan Disburse Loan To Savings Account: Mandatory Fields: actualDisbursementDate Optional Fields: transactionAmount and fixedEmiAmount Disburses the loan to Saving Account Undo Loan Disbursal: Undoes the Loan Disbursal Showing request and response for Assign a Loan Officer
      Parameters:
      loanId - loanId (required)
      postLoansLoanIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostLoansLoanIdResponse>

    • stateTransitions1

      @Headers("Content-Type:application/json") @POST("v1/loans/external-id/{loanExternalId}") retrofit2.Call<PostLoansLoanIdResponse> stateTransitions1(@Path("loanExternalId") String loanExternalId, @Body PostLoansLoanIdRequest postLoansLoanIdRequest, @Query("command") String command)
      Approve Loan Application | Recover Loan Guarantee | Undo Loan Application Approval | Assign a Loan Officer | Unassign a Loan Officer | Reject Loan Application | Applicant Withdraws from Loan Application | Disburse Loan Disburse Loan To Savings Account | Undo Loan Disbursal Approve Loan Application: Mandatory Fields: approvedOnDate Optional Fields: approvedLoanAmount and expectedDisbursementDate Approves the loan application Recover Loan Guarantee: Recovers the loan guarantee Undo Loan Application Approval: Undoes the Loan Application Approval Assign a Loan Officer: Allows you to assign Loan Officer for existing Loan. Unassign a Loan Officer: Allows you to unassign the Loan Officer. Reject Loan Application: Mandatory Fields: rejectedOnDate Allows you to reject the loan application Applicant Withdraws from Loan Application: Mandatory Fields: withdrawnOnDate Allows the applicant to withdraw the loan application Disburse Loan: Mandatory Fields: actualDisbursementDate Optional Fields: transactionAmount and fixedEmiAmount Disburses the Loan Disburse Loan To Savings Account: Mandatory Fields: actualDisbursementDate Optional Fields: transactionAmount and fixedEmiAmount Disburses the loan to Saving Account Undo Loan Disbursal: Undoes the Loan Disbursal Showing request and response for Assign a Loan Officer
      Parameters:
      loanExternalId - loanExternalId (required)
      postLoansLoanIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostLoansLoanIdResponse>

    • template10

      @GET("v1/loans/template") retrofit2.Call<GetLoansTemplateResponse> template10(@Query("clientId") Long clientId, @Query("groupId") Long groupId, @Query("productId") Long productId, @Query("templateType") String templateType, @Query("staffInSelectedOfficeOnly") Boolean staffInSelectedOfficeOnly, @Query("activeOnly") Boolean activeOnly)
      Retrieve 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: loans/template?templateType=individual&clientId=1 loans/template?templateType=individual&clientId=1&productId=1
      Parameters:
      clientId - clientId (optional)
      groupId - groupId (optional)
      productId - productId (optional)
      templateType - templateType (optional)
      staffInSelectedOfficeOnly - staffInSelectedOfficeOnly (optional, default to false)
      activeOnly - activeOnly (optional, default to false)
      Returns:
      Call<GetLoansTemplateResponse>

    • calculateLoanScheduleOrSubmitLoanApplication

      @Headers("Content-Type:application/json") @POST("v1/loans") retrofit2.Call<PostLoansResponse> calculateLoanScheduleOrSubmitLoanApplication(@Body PostLoansRequest postLoansRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Calculate loan repayment schedule | Submit a new Loan Application It calculates the loan repayment Schedule Submits a new loan application Mandatory Fields: clientId, productId, principal, loanTermFrequency, loanTermFrequencyType, loanType, numberOfRepayments, repaymentEvery, repaymentFrequencyType, interestRatePerPeriod, amortizationType, interestType, interestCalculationPeriodType, transactionProcessingStrategyCode, expectedDisbursementDate, submittedOnDate, loanType Optional Fields: graceOnPrincipalPayment, graceOnInterestPayment, graceOnInterestCharged, linkAccountId, allowPartialPeriodInterestCalcualtion, fixedEmiAmount, maxOutstandingLoanBalance, disbursementData, graceOnArrearsAgeing, createStandingInstructionAtDisbursement (requires linkedAccountId if set to true) 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
      Parameters:
      postLoansRequest - (required)
      command - command (optional)
      Returns:
      Call<PostLoansResponse>

    • createLoanDelinquencyAction

      @Headers("Content-Type:application/json") @POST("v1/loans/{loanId}/delinquency-actions") retrofit2.Call<PostLoansDelinquencyActionResponse> createLoanDelinquencyAction(@Path("loanId") Long loanId, @Body PostLoansDelinquencyActionRequest postLoansDelinquencyActionRequest, @HeaderMap Map<String,String> headers)
      Adds a new delinquency action for a loan
      Parameters:
      loanId - loanId (required)
      postLoansDelinquencyActionRequest - (required)
      Returns:
      Call<PostLoansDelinquencyActionResponse>

    • createLoanDelinquencyAction1

      @Headers("Content-Type:application/json") @POST("v1/loans/external-id/{loanExternalId}/delinquency-actions") retrofit2.Call<PostLoansDelinquencyActionResponse> createLoanDelinquencyAction1(@Path("loanExternalId") String loanExternalId, @Body PostLoansDelinquencyActionRequest postLoansDelinquencyActionRequest, @HeaderMap Map<String,String> headers)
      Adds a new delinquency action for a loan
      Parameters:
      loanExternalId - loanExternalId (required)
      postLoansDelinquencyActionRequest - (required)
      Returns:
      Call<PostLoansDelinquencyActionResponse>

    • deleteLoanApplication

      @DELETE("v1/loans/{loanId}") retrofit2.Call<DeleteLoansLoanIdResponse> deleteLoanApplication(@Path("loanId") Long loanId, @HeaderMap Map<String,String> headers)
      Delete a Loan Application Note: Only loans in \"Submitted and awaiting approval\" status can be deleted.
      Parameters:
      loanId - loanId (required)
      Returns:
      Call<DeleteLoansLoanIdResponse>

    • deleteLoanApplication1

      @DELETE("v1/loans/external-id/{loanExternalId}") retrofit2.Call<DeleteLoansLoanIdResponse> deleteLoanApplication1(@Path("loanExternalId") String loanExternalId, @HeaderMap Map<String,String> headers)
      Delete a Loan Application Note: Only loans in \"Submitted and awaiting approval\" status can be deleted.
      Parameters:
      loanExternalId - loanExternalId (required)
      Returns:
      Call<DeleteLoansLoanIdResponse>

    • getDelinquencyTagHistory

      @GET("v1/loans/{loanId}/delinquencytags") retrofit2.Call<List<GetDelinquencyTagHistoryResponse>> getDelinquencyTagHistory(@Path("loanId") Long loanId, @HeaderMap Map<String,String> headers)
      Retrieve the Loan Delinquency Tag history using the Loan Id
      Parameters:
      loanId - loanId (required)
      Returns:
      Call<List<GetDelinquencyTagHistoryResponse>>

    • getDelinquencyTagHistory1

      @GET("v1/loans/external-id/{loanExternalId}/delinquencytags") retrofit2.Call<List<GetDelinquencyTagHistoryResponse>> getDelinquencyTagHistory1(@Path("loanExternalId") String loanExternalId, @HeaderMap Map<String,String> headers)
      Retrieve the Loan Delinquency Tag history using the Loan Id
      Parameters:
      loanExternalId - loanExternalId (required)
      Returns:
      Call<List<GetDelinquencyTagHistoryResponse>>

    • getGlimRepaymentTemplate

      @GET("v1/loans/glimAccount/{glimId}") retrofit2.Call<String> getGlimRepaymentTemplate(@Path("glimId") Long glimId, @HeaderMap Map<String,String> headers)
      Parameters:
      glimId - (required)
      Returns:
      Call<String>

    • getLoanDelinquencyActions

      @GET("v1/loans/{loanId}/delinquency-actions") retrofit2.Call<List<GetDelinquencyActionsResponse>> getLoanDelinquencyActions(@Path("loanId") Long loanId, @HeaderMap Map<String,String> headers)
      Retrieve delinquency actions related to the loan
      Parameters:
      loanId - loanId (required)
      Returns:
      Call<List<GetDelinquencyActionsResponse>>

    • getLoanDelinquencyActions1

      @GET("v1/loans/external-id/{loanExternalId}/delinquency-actions") retrofit2.Call<List<GetDelinquencyActionsResponse>> getLoanDelinquencyActions1(@Path("loanExternalId") String loanExternalId, @HeaderMap Map<String,String> headers)
      Retrieve delinquency actions related to the loan
      Parameters:
      loanExternalId - loanExternalId (required)
      Returns:
      Call<List<GetDelinquencyActionsResponse>>

    • getLoanRepaymentTemplate

      @GET("v1/loans/repayments/downloadtemplate") retrofit2.Call<Void> getLoanRepaymentTemplate(@Query("officeId") Long officeId, @Query("dateFormat") String dateFormat, @HeaderMap Map<String,String> headers)
      Parameters:
      officeId - (optional)
      dateFormat - (optional)
      Returns:
      Call<Void>

    • getLoansTemplate

      @GET("v1/loans/downloadtemplate") retrofit2.Call<Void> getLoansTemplate(@Query("officeId") Long officeId, @Query("staffId") Long staffId, @Query("dateFormat") String dateFormat, @HeaderMap Map<String,String> headers)
      Parameters:
      officeId - (optional)
      staffId - (optional)
      dateFormat - (optional)
      Returns:
      Call<Void>

    • glimStateTransitions

      @Headers("Content-Type:application/json") @POST("v1/loans/glimAccount/{glimId}") retrofit2.Call<PostLoansLoanIdResponse> glimStateTransitions(@Path("glimId") Long glimId, @Body PostLoansLoanIdRequest postLoansLoanIdRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Approve GLIM Application | Undo GLIM Application Approval | Reject GLIM Application | Disburse Loan Disburse Loan To Savings Account | Undo Loan Disbursal Approve GLIM Application: Mandatory Fields: approvedOnDate Optional Fields: approvedLoanAmount and expectedDisbursementDate Approves the GLIM application Undo GLIM Application Approval: Undoes the GLIM Application Approval Reject GLIM Application: Mandatory Fields: rejectedOnDate Allows you to reject the GLIM application Disburse Loan: Mandatory Fields: actualDisbursementDate Optional Fields: transactionAmount and fixedEmiAmount Disburses the Loan Disburse Loan To Savings Account: Mandatory Fields: actualDisbursementDate Optional Fields: transactionAmount and fixedEmiAmount Disburses the loan to Saving Account Undo Loan Disbursal: Undoes the Loan Disbursal
      Parameters:
      glimId - (required)
      postLoansLoanIdRequest - (required)
      command - (optional)
      Returns:
      Call<PostLoansLoanIdResponse>

    • modifyLoanApplication

      @Headers("Content-Type:application/json") @PUT("v1/loans/{loanId}") retrofit2.Call<PutLoansLoanIdResponse> modifyLoanApplication(@Path("loanId") Long loanId, @Body PutLoansLoanIdRequest putLoansLoanIdRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Modify 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)
      putLoansLoanIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PutLoansLoanIdResponse>

    • modifyLoanApplication1

      @Headers("Content-Type:application/json") @PUT("v1/loans/external-id/{loanExternalId}") retrofit2.Call<PutLoansLoanIdResponse> modifyLoanApplication1(@Path("loanExternalId") String loanExternalId, @Body PutLoansLoanIdRequest putLoansLoanIdRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Modify 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:
      loanExternalId - loanExternalId (required)
      putLoansLoanIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PutLoansLoanIdResponse>

    • postLoanRepaymentTemplate

      @Multipart @POST("v1/loans/repayments/uploadtemplate") retrofit2.Call<String> postLoanRepaymentTemplate(@Part("dateFormat") String dateFormat, @Part("locale") String locale, @Part okhttp3.MultipartBody.Part uploadedInputStream, @HeaderMap Map<String,String> headers)
      Parameters:
      dateFormat - (optional)
      locale - (optional)
      uploadedInputStream - (optional)
      Returns:
      Call<String>

    • postLoanTemplate

      @Multipart @POST("v1/loans/uploadtemplate") retrofit2.Call<String> postLoanTemplate(@Part("dateFormat") String dateFormat, @Part("locale") String locale, @Part okhttp3.MultipartBody.Part uploadedInputStream, @HeaderMap Map<String,String> headers)
      Parameters:
      dateFormat - (optional)
      locale - (optional)
      uploadedInputStream - (optional)
      Returns:
      Call<String>

    • retrieveAll27

      @GET("v1/loans") retrofit2.Call<GetLoansResponse> retrieveAll27(@Query("externalId") String externalId, @Query("offset") Integer offset, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder, @Query("accountNo") String accountNo, @Query("associations") String associations, @Query("clientId") Long clientId, @Query("status") String status, @HeaderMap Map<String,String> headers)
      List Loans The list capability of loans can support pagination and sorting. Example Requests: loans loans?fields=accountNo loans?offset=10&limit=50 loans?orderBy=accountNo&sortOrder=DESC
      Parameters:
      externalId - externalId (optional)
      offset - offset (optional)
      limit - limit (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      accountNo - accountNo (optional)
      associations - associations (optional)
      clientId - clientId (optional)
      status - status (optional)
      Returns:
      Call<GetLoansResponse>

    • retrieveApprovalTemplate

      @GET("v1/loans/{loanId}/template") retrofit2.Call<GetLoansApprovalTemplateResponse> retrieveApprovalTemplate(@Path("loanId") Long loanId, @Query("templateType") String templateType, @HeaderMap Map<String,String> headers)
      Parameters:
      loanId - loanId (required)
      templateType - templateType (optional)
      Returns:
      Call<GetLoansApprovalTemplateResponse>

    • retrieveApprovalTemplate1

      @GET("v1/loans/external-id/{loanExternalId}/template") retrofit2.Call<GetLoansApprovalTemplateResponse> retrieveApprovalTemplate1(@Path("loanExternalId") String loanExternalId, @Query("templateType") String templateType, @HeaderMap Map<String,String> headers)
      Parameters:
      loanExternalId - loanExternalId (required)
      templateType - templateType (optional)
      Returns:
      Call<GetLoansApprovalTemplateResponse>

    • retrieveLoan

      @GET("v1/loans/{loanId}") retrofit2.Call<GetLoansLoanIdResponse> retrieveLoan(@Path("loanId") Long loanId, @Query("staffInSelectedOfficeOnly") Boolean staffInSelectedOfficeOnly, @Query("associations") String associations, @Query("exclude") String exclude, @Query("fields") String fields, @HeaderMap Map<String,String> headers)
      Retrieve a Loan Note: template=true parameter doesn't apply to this resource.Example Requests: loans/1 loans/1?fields=id,principal,annualInterestRate loans/1?associations=all loans/1?associations=all&exclude=guarantors loans/1?fields=id,principal,annualInterestRate&associations=repaymentSchedule,transactions
      Parameters:
      loanId - loanId (required)
      staffInSelectedOfficeOnly - staffInSelectedOfficeOnly (optional, default to false)
      associations - Loan object relations to be included in the response (optional, default to all)
      exclude - Optional Loan object relation list to be filtered in the response (optional)
      fields - Optional Loan attribute list to be in the response (optional)
      Returns:
      Call<GetLoansLoanIdResponse>

    • retrieveLoan1

      @GET("v1/loans/external-id/{loanExternalId}") retrofit2.Call<GetLoansLoanIdResponse> retrieveLoan1(@Path("loanExternalId") String loanExternalId, @Query("staffInSelectedOfficeOnly") Boolean staffInSelectedOfficeOnly, @Query("associations") String associations, @Query("exclude") String exclude, @Query("fields") String fields, @HeaderMap Map<String,String> headers)
      Retrieve a Loan Note: template=true parameter doesn't apply to this resource.Example Requests: loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854 loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854?fields=id,principal,annualInterestRate loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854?associations=all loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854?associations=all&exclude=guarantors loans/external-id/7dd80a7c-ycba-a446-t378-91eb6f53e854?fields=id,principal,annualInterestRate&associations=repaymentSchedule,transactions
      Parameters:
      loanExternalId - loanExternalId (required)
      staffInSelectedOfficeOnly - staffInSelectedOfficeOnly (optional, default to false)
      associations - Loan object relations to be included in the response (optional, default to all)
      exclude - Optional Loan object relation list to be filtered in the response (optional)
      fields - Optional Loan attribute list to be in the response (optional)
      Returns:
      Call<GetLoansLoanIdResponse>

    • stateTransitions

      @Headers("Content-Type:application/json") @POST("v1/loans/{loanId}") retrofit2.Call<PostLoansLoanIdResponse> stateTransitions(@Path("loanId") Long loanId, @Body PostLoansLoanIdRequest postLoansLoanIdRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Approve Loan Application | Recover Loan Guarantee | Undo Loan Application Approval | Assign a Loan Officer | Unassign a Loan Officer | Reject Loan Application | Applicant Withdraws from Loan Application | Disburse Loan Disburse Loan To Savings Account | Undo Loan Disbursal Approve Loan Application: Mandatory Fields: approvedOnDate Optional Fields: approvedLoanAmount and expectedDisbursementDate Approves the loan application Recover Loan Guarantee: Recovers the loan guarantee Undo Loan Application Approval: Undoes the Loan Application Approval Assign a Loan Officer: Allows you to assign Loan Officer for existing Loan. Unassign a Loan Officer: Allows you to unassign the Loan Officer. Reject Loan Application: Mandatory Fields: rejectedOnDate Allows you to reject the loan application Applicant Withdraws from Loan Application: Mandatory Fields: withdrawnOnDate Allows the applicant to withdraw the loan application Disburse Loan: Mandatory Fields: actualDisbursementDate Optional Fields: transactionAmount and fixedEmiAmount Disburses the Loan Disburse Loan To Savings Account: Mandatory Fields: actualDisbursementDate Optional Fields: transactionAmount and fixedEmiAmount Disburses the loan to Saving Account Undo Loan Disbursal: Undoes the Loan Disbursal Showing request and response for Assign a Loan Officer
      Parameters:
      loanId - loanId (required)
      postLoansLoanIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostLoansLoanIdResponse>

    • stateTransitions1

      @Headers("Content-Type:application/json") @POST("v1/loans/external-id/{loanExternalId}") retrofit2.Call<PostLoansLoanIdResponse> stateTransitions1(@Path("loanExternalId") String loanExternalId, @Body PostLoansLoanIdRequest postLoansLoanIdRequest, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Approve Loan Application | Recover Loan Guarantee | Undo Loan Application Approval | Assign a Loan Officer | Unassign a Loan Officer | Reject Loan Application | Applicant Withdraws from Loan Application | Disburse Loan Disburse Loan To Savings Account | Undo Loan Disbursal Approve Loan Application: Mandatory Fields: approvedOnDate Optional Fields: approvedLoanAmount and expectedDisbursementDate Approves the loan application Recover Loan Guarantee: Recovers the loan guarantee Undo Loan Application Approval: Undoes the Loan Application Approval Assign a Loan Officer: Allows you to assign Loan Officer for existing Loan. Unassign a Loan Officer: Allows you to unassign the Loan Officer. Reject Loan Application: Mandatory Fields: rejectedOnDate Allows you to reject the loan application Applicant Withdraws from Loan Application: Mandatory Fields: withdrawnOnDate Allows the applicant to withdraw the loan application Disburse Loan: Mandatory Fields: actualDisbursementDate Optional Fields: transactionAmount and fixedEmiAmount Disburses the Loan Disburse Loan To Savings Account: Mandatory Fields: actualDisbursementDate Optional Fields: transactionAmount and fixedEmiAmount Disburses the loan to Saving Account Undo Loan Disbursal: Undoes the Loan Disbursal Showing request and response for Assign a Loan Officer
      Parameters:
      loanExternalId - loanExternalId (required)
      postLoansLoanIdRequest - (required)
      command - command (optional)
      Returns:
      Call<PostLoansLoanIdResponse>

    • template10

      @GET("v1/loans/template") retrofit2.Call<GetLoansTemplateResponse> template10(@Query("clientId") Long clientId, @Query("groupId") Long groupId, @Query("productId") Long productId, @Query("templateType") String templateType, @Query("staffInSelectedOfficeOnly") Boolean staffInSelectedOfficeOnly, @Query("activeOnly") Boolean activeOnly, @HeaderMap Map<String,String> headers)
      Retrieve 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: loans/template?templateType=individual&clientId=1 loans/template?templateType=individual&clientId=1&productId=1
      Parameters:
      clientId - clientId (optional)
      groupId - groupId (optional)
      productId - productId (optional)
      templateType - templateType (optional)
      staffInSelectedOfficeOnly - staffInSelectedOfficeOnly (optional, default to false)
      activeOnly - activeOnly (optional, default to false)
      Returns:
      Call<GetLoansTemplateResponse>