Package org.apache.fineract.portfolio.loanaccount.api

Class LoansApiResource

java.lang.Object

org.apache.fineract.portfolio.loanaccount.api.LoansApiResource

@Path("/v1/loans")
@Component
public class LoansApiResource
extends Object

Constructor Summary

Constructors

Constructor	Description
LoansApiResource()

Method Summary

Modifier and Type	Method	Description
String	calculateLoanScheduleOrSubmitLoanApplication(String commandParam, jakarta.ws.rs.core.UriInfo uriInfo, String apiRequestBodyAsJson)
String	createLoanDelinquencyAction(Long loanId, jakarta.ws.rs.core.UriInfo uriInfo, String apiRequestBodyAsJson)
String	createLoanDelinquencyAction(String loanExternalId, jakarta.ws.rs.core.UriInfo uriInfo, String apiRequestBodyAsJson)
String	deleteLoanApplication(Long loanId)
String	deleteLoanApplication(String loanExternalId)
String	getDelinquencyTagHistory(Long loanId, jakarta.ws.rs.core.UriInfo uriInfo)
String	getDelinquencyTagHistory(String loanExternalId, jakarta.ws.rs.core.UriInfo uriInfo)
String	getGlimRepaymentTemplate(Long glimId, jakarta.ws.rs.core.UriInfo uriInfo)
List<org.apache.fineract.portfolio.loanaccount.data.LoanApprovedAmountHistoryData>	getLoanApprovedAmountHistory(Long loanId, jakarta.ws.rs.core.UriInfo uriInfo)
List<org.apache.fineract.portfolio.loanaccount.data.LoanApprovedAmountHistoryData>	getLoanApprovedAmountHistory(String loanExternalId, jakarta.ws.rs.core.UriInfo uriInfo)
String	getLoanDelinquencyActions(Long loanId, jakarta.ws.rs.core.UriInfo uriInfo)
String	getLoanDelinquencyActions(String loanExternalId, jakarta.ws.rs.core.UriInfo uriInfo)
jakarta.ws.rs.core.Response	getLoanRepaymentTemplate(Long officeId, String dateFormat)
jakarta.ws.rs.core.Response	getLoansTemplate(Long officeId, Long staffId, String dateFormat)
String	glimStateTransitions(Long glimId, String commandParam, String apiRequestBodyAsJson)
String	modifyLoanApplication(Long loanId, String commandParam, String apiRequestBodyAsJson)
String	modifyLoanApplication(String loanExternalId, String commandParam, String apiRequestBodyAsJson)
org.apache.fineract.infrastructure.core.data.CommandProcessingResult	modifyLoanApprovedAmount(Long loanId, jakarta.ws.rs.core.UriInfo uriInfo, String apiRequestBodyAsJson)
org.apache.fineract.infrastructure.core.data.CommandProcessingResult	modifyLoanApprovedAmount(String loanExternalId, jakarta.ws.rs.core.UriInfo uriInfo, String apiRequestBodyAsJson)
org.apache.fineract.infrastructure.core.data.CommandProcessingResult	modifyLoanAvailableDisbursementAmount(Long loanId, jakarta.ws.rs.core.UriInfo uriInfo, String apiRequestBodyAsJson)
org.apache.fineract.infrastructure.core.data.CommandProcessingResult	modifyLoanAvailableDisbursementAmount(String loanExternalId, jakarta.ws.rs.core.UriInfo uriInfo, String apiRequestBodyAsJson)
String	postLoanRepaymentTemplate(InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String locale, String dateFormat)
String	postLoanTemplate(InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String locale, String dateFormat)
String	retrieveAll(jakarta.ws.rs.core.UriInfo uriInfo, String externalId, Integer offset, Integer limit, String orderBy, String sortOrder, String accountNo, String associations, Long clientId, String status)
String	retrieveApprovalTemplate(Long loanId, String templateType, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveApprovalTemplate(String loanExternalId, String templateType, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveLoan(Long loanId, boolean staffInSelectedOfficeOnly, String associations, String exclude, String fields, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveLoan(String loanExternalId, boolean staffInSelectedOfficeOnly, String associations, String exclude, String fields, jakarta.ws.rs.core.UriInfo uriInfo)
String	stateTransitions(Long loanId, String commandParam, String apiRequestBodyAsJson)
String	stateTransitions(String loanExternalId, String commandParam, String apiRequestBodyAsJson)
String	template(Long clientId, Long groupId, Long productId, String templateType, boolean staffInSelectedOfficeOnly, boolean onlyActive, jakarta.ws.rs.core.UriInfo uriInfo)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LoansApiResource

public LoansApiResource()

Method Details

retrieveApprovalTemplate

@GET
@Path("{loanId}/template")
@Consumes("application/json")
@Produces("application/json")
public String retrieveApprovalTemplate(@PathParam("loanId")
 Long loanId,
 @QueryParam("templateType")
 String templateType,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

template

@GET
@Path("template")
@Consumes("application/json")
@Produces("application/json")
public String template(@QueryParam("clientId")
 Long clientId,
 @QueryParam("groupId")
 Long groupId,
 @QueryParam("productId")
 Long productId,
 @QueryParam("templateType")
 String templateType,
 @DefaultValue("false") @QueryParam("staffInSelectedOfficeOnly")
 boolean staffInSelectedOfficeOnly,
 @DefaultValue("false") @QueryParam("activeOnly")
 boolean onlyActive,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveLoan

@GET
@Path("{loanId}")
@Consumes("application/json")
@Produces("application/json")
public String retrieveLoan(@PathParam("loanId")
 Long loanId,
 @DefaultValue("false") @QueryParam("staffInSelectedOfficeOnly")
 boolean staffInSelectedOfficeOnly,
 @DefaultValue("all") @QueryParam("associations")
 String associations,
 @QueryParam("exclude")
 String exclude,
 @QueryParam("fields")
 String fields,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveAll

@GET
@Consumes("application/json")
@Produces("application/json")
public String retrieveAll(@Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @QueryParam("externalId")
 String externalId,
 @QueryParam("offset")
 Integer offset,
 @QueryParam("limit")
 Integer limit,
 @QueryParam("orderBy")
 String orderBy,
 @QueryParam("sortOrder")
 String sortOrder,
 @QueryParam("accountNo")
 String accountNo,
 @QueryParam("associations")
 String associations,
 @QueryParam("clientId")
 Long clientId,
 @QueryParam("status")
 String status)

calculateLoanScheduleOrSubmitLoanApplication

@POST
@Consumes("application/json")
@Produces("application/json")
public String calculateLoanScheduleOrSubmitLoanApplication(@QueryParam("command")
 String commandParam,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 String apiRequestBodyAsJson)

modifyLoanApplication

@PUT
@Path("{loanId}")
@Consumes("application/json")
@Produces("application/json")
public String modifyLoanApplication(@PathParam("loanId")
 Long loanId,
 @QueryParam("command")
 String commandParam,
 String apiRequestBodyAsJson)

deleteLoanApplication

@DELETE
@Path("{loanId}")
@Consumes("application/json")
@Produces("application/json")
public String deleteLoanApplication(@PathParam("loanId")
 Long loanId)

stateTransitions

@POST
@Path("{loanId}")
@Consumes("application/json")
@Produces("application/json")
public String stateTransitions(@PathParam("loanId")
 Long loanId,
 @QueryParam("command")
 String commandParam,
 String apiRequestBodyAsJson)

getLoansTemplate

@GET
@Path("downloadtemplate")
@Produces("application/vnd.ms-excel")
public jakarta.ws.rs.core.Response getLoansTemplate(@QueryParam("officeId")
 Long officeId,
 @QueryParam("staffId")
 Long staffId,
 @QueryParam("dateFormat")
 String dateFormat)

getGlimRepaymentTemplate

@GET
@Path("glimAccount/{glimId}")
@Consumes("application/json")
@Produces("application/json")
public String getGlimRepaymentTemplate(@PathParam("glimId")
 Long glimId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

glimStateTransitions

@POST
@Path("glimAccount/{glimId}")
@Consumes("application/json")
@Produces("application/json")
public String glimStateTransitions(@PathParam("glimId")
 Long glimId,
 @QueryParam("command")
 String commandParam,
 String apiRequestBodyAsJson)

getLoanRepaymentTemplate

@GET
@Path("repayments/downloadtemplate")
@Produces("application/vnd.ms-excel")
public jakarta.ws.rs.core.Response getLoanRepaymentTemplate(@QueryParam("officeId")
 Long officeId,
 @QueryParam("dateFormat")
 String dateFormat)

postLoanTemplate

@POST
@Path("uploadtemplate")
@Consumes("multipart/form-data")
public String postLoanTemplate(InputStream uploadedInputStream,
 org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
 String locale,
 String dateFormat)

postLoanRepaymentTemplate

@POST
@Path("repayments/uploadtemplate")
@Consumes("multipart/form-data")
public String postLoanRepaymentTemplate(InputStream uploadedInputStream,
 org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
 String locale,
 String dateFormat)

getDelinquencyTagHistory

@GET
@Path("{loanId}/delinquencytags")
@Consumes({"text/html","application/json"})
@Produces("application/json")
public String getDelinquencyTagHistory(@PathParam("loanId")
 Long loanId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveApprovalTemplate

@GET
@Path("external-id/{loanExternalId}/template")
@Consumes("application/json")
@Produces("application/json")
public String retrieveApprovalTemplate(@PathParam("loanExternalId")
 String loanExternalId,
 @QueryParam("templateType")
 String templateType,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveLoan

@GET
@Path("external-id/{loanExternalId}")
@Consumes("application/json")
@Produces("application/json")
public String retrieveLoan(@PathParam("loanExternalId")
 String loanExternalId,
 @DefaultValue("false") @QueryParam("staffInSelectedOfficeOnly")
 boolean staffInSelectedOfficeOnly,
 @DefaultValue("all") @QueryParam("associations")
 String associations,
 @QueryParam("exclude")
 String exclude,
 @QueryParam("fields")
 String fields,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

modifyLoanApplication

@PUT
@Path("external-id/{loanExternalId}")
@Consumes("application/json")
@Produces("application/json")
public String modifyLoanApplication(@PathParam("loanExternalId")
 String loanExternalId,
 @QueryParam("command")
 String commandParam,
 String apiRequestBodyAsJson)

deleteLoanApplication

@DELETE
@Path("external-id/{loanExternalId}")
@Consumes("application/json")
@Produces("application/json")
public String deleteLoanApplication(@PathParam("loanExternalId")
 String loanExternalId)

stateTransitions

@POST
@Path("external-id/{loanExternalId}")
@Consumes("application/json")
@Produces("application/json")
public String stateTransitions(@PathParam("loanExternalId")
 String loanExternalId,
 @QueryParam("command")
 String commandParam,
 String apiRequestBodyAsJson)

getDelinquencyTagHistory

@GET
@Path("external-id/{loanExternalId}/delinquencytags")
@Consumes({"text/html","application/json"})
@Produces("application/json")
public String getDelinquencyTagHistory(@PathParam("loanExternalId")
 String loanExternalId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getLoanDelinquencyActions

@GET
@Path("{loanId}/delinquency-actions")
@Consumes({"text/html","application/json"})
@Produces("application/json")
public String getLoanDelinquencyActions(@PathParam("loanId")
 Long loanId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getLoanDelinquencyActions

@GET
@Path("external-id/{loanExternalId}/delinquency-actions")
@Consumes({"text/html","application/json"})
@Produces("application/json")
public String getLoanDelinquencyActions(@PathParam("loanExternalId")
 String loanExternalId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

createLoanDelinquencyAction

@POST
@Path("{loanId}/delinquency-actions")
@Consumes("application/json")
@Produces("application/json")
public String createLoanDelinquencyAction(@PathParam("loanId")
 Long loanId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 String apiRequestBodyAsJson)

createLoanDelinquencyAction

@POST
@Path("external-id/{loanExternalId}/delinquency-actions")
@Consumes("application/json")
@Produces("application/json")
public String createLoanDelinquencyAction(@PathParam("loanExternalId")
 String loanExternalId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 String apiRequestBodyAsJson)

modifyLoanApprovedAmount

@PUT
@Path("{loanId}/approved-amount")
@Consumes("application/json")
@Produces("application/json")
public org.apache.fineract.infrastructure.core.data.CommandProcessingResult modifyLoanApprovedAmount(@PathParam("loanId")
 Long loanId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 String apiRequestBodyAsJson)

modifyLoanApprovedAmount

@PUT
@Path("external-id/{loanExternalId}/approved-amount")
@Consumes("application/json")
@Produces("application/json")
public org.apache.fineract.infrastructure.core.data.CommandProcessingResult modifyLoanApprovedAmount(@PathParam("loanExternalId")
 String loanExternalId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 String apiRequestBodyAsJson)

getLoanApprovedAmountHistory

@GET
@Path("{loanId}/approved-amount")
@Consumes("application/json")
@Produces("application/json")
public List<org.apache.fineract.portfolio.loanaccount.data.LoanApprovedAmountHistoryData> getLoanApprovedAmountHistory(@PathParam("loanId")
 Long loanId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getLoanApprovedAmountHistory

@GET
@Path("external-id/{loanExternalId}/approved-amount")
@Consumes("application/json")
@Produces("application/json")
public List<org.apache.fineract.portfolio.loanaccount.data.LoanApprovedAmountHistoryData> getLoanApprovedAmountHistory(@PathParam("loanExternalId")
 String loanExternalId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

modifyLoanAvailableDisbursementAmount

@PUT
@Path("{loanId}/available-disbursement-amount")
@Consumes("application/json")
@Produces("application/json")
public org.apache.fineract.infrastructure.core.data.CommandProcessingResult modifyLoanAvailableDisbursementAmount(@PathParam("loanId")
 Long loanId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 String apiRequestBodyAsJson)

modifyLoanAvailableDisbursementAmount

@PUT
@Path("external-id/{loanExternalId}/available-disbursement-amount")
@Consumes("application/json")
@Produces("application/json")
public org.apache.fineract.infrastructure.core.data.CommandProcessingResult modifyLoanAvailableDisbursementAmount(@PathParam("loanExternalId")
 String loanExternalId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 String apiRequestBodyAsJson)