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

Class LoanTransactionsApiResource

java.lang.Object

org.apache.fineract.portfolio.loanaccount.api.LoanTransactionsApiResource

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CAPITALIZED_INCOME
static final String	CHARGE_OFF_COMMAND_VALUE
static final String	DOWN_PAYMENT
static final String	INTEREST_REFUND_COMMAND_VALUE
static final String	REAGE
static final String	REAMORTIZE
static final String	UNDO_CHARGE_OFF_COMMAND_VALUE
static final String	UNDO_REAGE
static final String	UNDO_REAMORTIZE

Constructor Summary

Constructors

Constructor	Description
LoanTransactionsApiResource()

Method Summary

Modifier and Type	Method	Description
String	adjustLoanTransaction(Long loanId, Long transactionId, String apiRequestBodyAsJson, String commandParam)
String	adjustLoanTransaction(Long loanId, String transactionExternalId, String apiRequestBodyAsJson, String commandParam)
String	adjustLoanTransaction(String loanExternalId, Long transactionId, String apiRequestBodyAsJson, String commandParam)
String	adjustLoanTransaction(String loanExternalId, String transactionExternalId, String apiRequestBodyAsJson, String commandParam)
String	executeLoanTransaction(Long loanId, String commandParam, String apiRequestBodyAsJson)
String	executeLoanTransaction(String loanExternalId, String commandParam, String apiRequestBodyAsJson)
String	retrieveTransaction(Long loanId, Long transactionId, String fields, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveTransactionByLoanExternalIdAndTransactionExternalId(String loanExternalId, String externalTransactionId, String fields, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveTransactionByLoanExternalIdAndTransactionId(String loanExternalId, Long transactionId, String fields, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveTransactionByTransactionExternalId(Long loanId, String externalTransactionId, String fields, jakarta.ws.rs.core.UriInfo uriInfo)
org.springframework.data.domain.Page<org.apache.fineract.portfolio.loanaccount.data.LoanTransactionData>	retrieveTransactionsByExternalLoanId(String loanExternalId, List<org.apache.fineract.portfolio.loanaccount.api.LoanTransactionApiConstants.TransactionType> excludedTypes, Integer page, Integer size, String sort, org.springframework.data.domain.Pageable pageable, jakarta.ws.rs.core.UriInfo uriInfo)
org.springframework.data.domain.Page<org.apache.fineract.portfolio.loanaccount.data.LoanTransactionData>	retrieveTransactionsByLoanId(Long loanId, List<org.apache.fineract.portfolio.loanaccount.api.LoanTransactionApiConstants.TransactionType> excludedTypes, Integer page, Integer size, String sort, org.springframework.data.domain.Pageable pageable, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveTransactionTemplate(Long loanId, String commandParam, jakarta.ws.rs.core.UriInfo uriInfo, String rawDateFormat, org.apache.fineract.infrastructure.core.api.DateParam transactionDateParam, String locale, Long transactionId)
String	retrieveTransactionTemplate(String loanExternalId, String commandParam, jakarta.ws.rs.core.UriInfo uriInfo, String rawDateFormat, org.apache.fineract.infrastructure.core.api.DateParam transactionDateParam, String locale, Long transactionId)
String	undoWaiveCharge(Long loanId, Long transactionId)
String	undoWaiveCharge(Long loanId, String transactionExternalId)
String	undoWaiveCharge(String loanExternalId, Long transactionId)
String	undoWaiveCharge(String loanExternalId, String transactionExternalId)

Methods inherited from class java.lang.Object

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

Field Details

CHARGE_OFF_COMMAND_VALUE

public static final String CHARGE_OFF_COMMAND_VALUE

See Also:

• Constant Field Values

UNDO_CHARGE_OFF_COMMAND_VALUE

public static final String UNDO_CHARGE_OFF_COMMAND_VALUE

See Also:

• Constant Field Values

DOWN_PAYMENT

public static final String DOWN_PAYMENT

See Also:

• Constant Field Values

UNDO_REAGE

public static final String UNDO_REAGE

See Also:

• Constant Field Values

REAGE

public static final String REAGE

See Also:

• Constant Field Values

REAMORTIZE

public static final String REAMORTIZE

See Also:

• Constant Field Values

UNDO_REAMORTIZE

public static final String UNDO_REAMORTIZE

See Also:

• Constant Field Values

CAPITALIZED_INCOME

public static final String CAPITALIZED_INCOME

See Also:

• Constant Field Values

INTEREST_REFUND_COMMAND_VALUE

public static final String INTEREST_REFUND_COMMAND_VALUE

See Also:

• Constant Field Values

Constructor Details

LoanTransactionsApiResource

public LoanTransactionsApiResource()

Method Details

retrieveTransactionTemplate

@GET
@Path("{loanId}/transactions/template")
@Consumes("application/json")
@Produces("application/json")
public String retrieveTransactionTemplate(@PathParam("loanId")
 Long loanId,
 @QueryParam("command")
 String commandParam,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @QueryParam("dateFormat")
 String rawDateFormat,
 @QueryParam("transactionDate")
 org.apache.fineract.infrastructure.core.api.DateParam transactionDateParam,
 @QueryParam("locale")
 String locale,
 @QueryParam("transactionId")
 Long transactionId)

retrieveTransactionTemplate

@GET
@Path("external-id/{loanExternalId}/transactions/template")
@Consumes("application/json")
@Produces("application/json")
public String retrieveTransactionTemplate(@PathParam("loanExternalId")
 String loanExternalId,
 @QueryParam("command")
 String commandParam,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @QueryParam("dateFormat")
 String rawDateFormat,
 @QueryParam("transactionDate")
 org.apache.fineract.infrastructure.core.api.DateParam transactionDateParam,
 @QueryParam("locale")
 String locale,
 @QueryParam("transactionId")
 Long transactionId)

retrieveTransaction

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

retrieveTransactionByTransactionExternalId

@GET
@Path("{loanId}/transactions/external-id/{externalTransactionId}")
@Consumes("application/json")
@Produces("application/json")
public String retrieveTransactionByTransactionExternalId(@PathParam("loanId")
 Long loanId,
 @PathParam("externalTransactionId")
 String externalTransactionId,
 @QueryParam("fields")
 String fields,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveTransactionByLoanExternalIdAndTransactionId

@GET
@Path("external-id/{loanExternalId}/transactions/{transactionId}")
@Consumes("application/json")
@Produces("application/json")
public String retrieveTransactionByLoanExternalIdAndTransactionId(@PathParam("loanExternalId")
 String loanExternalId,
 @PathParam("transactionId")
 Long transactionId,
 @QueryParam("fields")
 String fields,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveTransactionByLoanExternalIdAndTransactionExternalId

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

retrieveTransactionsByLoanId

@GET
@Path("{loanId}/transactions")
@Consumes("application/json")
@Produces("application/json")
public org.springframework.data.domain.Page<org.apache.fineract.portfolio.loanaccount.data.LoanTransactionData> retrieveTransactionsByLoanId(@PathParam("loanId")
 Long loanId,
 @QueryParam("excludedTypes")
 List<org.apache.fineract.portfolio.loanaccount.api.LoanTransactionApiConstants.TransactionType> excludedTypes,
 @QueryParam("page")
 Integer page,
 @QueryParam("size")
 Integer size,
 @QueryParam("sort")
 String sort,
 org.springframework.data.domain.Pageable pageable,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveTransactionsByExternalLoanId

@GET
@Path("external-id/{loanExternalId}/transactions")
@Consumes("application/json")
@Produces("application/json")
public org.springframework.data.domain.Page<org.apache.fineract.portfolio.loanaccount.data.LoanTransactionData> retrieveTransactionsByExternalLoanId(@PathParam("loanExternalId")
 String loanExternalId,
 @QueryParam("excludedTypes")
 List<org.apache.fineract.portfolio.loanaccount.api.LoanTransactionApiConstants.TransactionType> excludedTypes,
 @QueryParam("page")
 Integer page,
 @QueryParam("size")
 Integer size,
 @QueryParam("sort")
 String sort,
 org.springframework.data.domain.Pageable pageable,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

executeLoanTransaction

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

executeLoanTransaction

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

adjustLoanTransaction

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

adjustLoanTransaction

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

adjustLoanTransaction

@POST
@Path("{loanId}/transactions/external-id/{externalTransactionId}")
@Consumes("application/json")
@Produces("application/json")
public String adjustLoanTransaction(@PathParam("loanId")
 Long loanId,
 @PathParam("externalTransactionId")
 String transactionExternalId,
 String apiRequestBodyAsJson,
 @QueryParam("command")
 String commandParam)

adjustLoanTransaction

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

undoWaiveCharge

@PUT
@Path("{loanId}/transactions/{transactionId}")
@Consumes("application/json")
@Produces("application/json")
public String undoWaiveCharge(@PathParam("loanId")
 Long loanId,
 @PathParam("transactionId")
 Long transactionId)

undoWaiveCharge

@PUT
@Path("external-id/{loanExternalId}/transactions/{transactionId}")
@Consumes("application/json")
@Produces("application/json")
public String undoWaiveCharge(@PathParam("loanExternalId")
 String loanExternalId,
 @PathParam("transactionId")
 Long transactionId)

undoWaiveCharge

@PUT
@Path("{loanId}/transactions/external-id/{transactionExternalId}")
@Consumes("application/json")
@Produces("application/json")
public String undoWaiveCharge(@PathParam("loanId")
 Long loanId,
 @PathParam("transactionExternalId")
 String transactionExternalId)

undoWaiveCharge

@PUT
@Path("external-id/{loanExternalId}/transactions/external-id/{transactionExternalId}")
@Consumes("application/json")
@Produces("application/json")
public String undoWaiveCharge(@PathParam("loanExternalId")
 String loanExternalId,
 @PathParam("transactionExternalId")
 String transactionExternalId)