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

Class LoanChargesApiResource

java.lang.Object

org.apache.fineract.portfolio.loanaccount.api.LoanChargesApiResource

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMMAND_ADJUSTMENT
static final String	COMMAND_DEACTIVATE_OVERDUE
static final String	COMMAND_PAY
static final String	COMMAND_WAIVE

Constructor Summary

Constructors

Constructor	Description
LoanChargesApiResource()

Method Summary

Modifier and Type	Method	Description
String	deleteLoanCharge(Long loanId, Long loanChargeId)
String	deleteLoanCharge(Long loanId, String loanChargeExternalId)
String	deleteLoanCharge(String loanExternalId, Long loanChargeId)
String	deleteLoanCharge(String loanExternalId, String loanChargeExternalId)
String	executeLoanCharge(Long loanId, Long loanChargeId, String commandParam, String apiRequestBodyAsJson)
String	executeLoanCharge(Long loanId, String commandParam, String apiRequestBodyAsJson)
String	executeLoanCharge(Long loanId, String loanChargeExternalId, String commandParam, String apiRequestBodyAsJson)
String	executeLoanCharge(String loanExternalId, Long loanChargeId, String commandParam, String apiRequestBodyAsJson)
String	executeLoanCharge(String loanExternalId, String commandParam, String apiRequestBodyAsJson)
String	executeLoanCharge(String loanExternalId, String loanChargeExternalId, String commandParam, String apiRequestBodyAsJson)
String	retrieveAllLoanCharges(Long loanId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveAllLoanCharges(String loanExternalId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveLoanCharge(Long loanId, Long loanChargeId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveLoanCharge(Long loanId, String loanChargeExternalId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveLoanCharge(String loanExternalId, Long loanChargeId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveLoanCharge(String loanExternalId, String loanChargeExternalId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveTemplate(Long loanId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveTemplate(String loanExternalId, jakarta.ws.rs.core.UriInfo uriInfo)
String	updateLoanCharge(Long loanId, Long loanChargeId, String apiRequestBodyAsJson)
String	updateLoanCharge(Long loanId, String loanChargeExternalId, String apiRequestBodyAsJson)
String	updateLoanCharge(String loanExternalId, Long loanChargeId, String apiRequestBodyAsJson)
String	updateLoanCharge(String loanExternalId, String loanChargeExternalId, String apiRequestBodyAsJson)

Methods inherited from class java.lang.Object

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

Field Details

COMMAND_PAY

public static final String COMMAND_PAY

See Also:

• Constant Field Values

COMMAND_WAIVE

public static final String COMMAND_WAIVE

See Also:

• Constant Field Values

COMMAND_ADJUSTMENT

public static final String COMMAND_ADJUSTMENT

See Also:

• Constant Field Values

COMMAND_DEACTIVATE_OVERDUE

public static final String COMMAND_DEACTIVATE_OVERDUE

See Also:

• Constant Field Values

Constructor Details

LoanChargesApiResource

public LoanChargesApiResource()

Method Details

retrieveAllLoanCharges

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

retrieveAllLoanCharges

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

retrieveTemplate

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

retrieveTemplate

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

retrieveLoanCharge

@GET
@Path("{loanId}/charges/{loanChargeId}")
@Consumes("application/json")
@Produces("application/json")
public String retrieveLoanCharge(@PathParam("loanId")
 Long loanId,
 @PathParam("loanChargeId")
 Long loanChargeId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveLoanCharge

@GET
@Path("{loanId}/charges/external-id/{loanChargeExternalId}")
@Consumes("application/json")
@Produces("application/json")
public String retrieveLoanCharge(@PathParam("loanId")
 Long loanId,
 @PathParam("loanChargeExternalId")
 String loanChargeExternalId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveLoanCharge

@GET
@Path("external-id/{loanExternalId}/charges/{loanChargeId}")
@Consumes("application/json")
@Produces("application/json")
public String retrieveLoanCharge(@PathParam("loanExternalId")
 String loanExternalId,
 @PathParam("loanChargeId")
 Long loanChargeId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveLoanCharge

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

executeLoanCharge

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

executeLoanCharge

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

executeLoanCharge

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

executeLoanCharge

@POST
@Path("{loanId}/charges/external-id/{loanChargeExternalId}")
@Consumes("application/json")
@Produces("application/json")
public String executeLoanCharge(@PathParam("loanId")
 Long loanId,
 @PathParam("loanChargeExternalId")
 String loanChargeExternalId,
 @QueryParam("command")
 String commandParam,
 String apiRequestBodyAsJson)

executeLoanCharge

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

executeLoanCharge

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

updateLoanCharge

@PUT
@Path("{loanId}/charges/{loanChargeId}")
@Consumes("application/json")
@Produces("application/json")
public String updateLoanCharge(@PathParam("loanId")
 Long loanId,
 @PathParam("loanChargeId")
 Long loanChargeId,
 String apiRequestBodyAsJson)

updateLoanCharge

@PUT
@Path("{loanId}/charges/external-id/{loanChargeExternalId}")
@Consumes("application/json")
@Produces("application/json")
public String updateLoanCharge(@PathParam("loanId")
 Long loanId,
 @PathParam("loanChargeExternalId")
 String loanChargeExternalId,
 String apiRequestBodyAsJson)

updateLoanCharge

@PUT
@Path("external-id/{loanExternalId}/charges/{loanChargeId}")
@Consumes("application/json")
@Produces("application/json")
public String updateLoanCharge(@PathParam("loanExternalId")
 String loanExternalId,
 @PathParam("loanChargeId")
 Long loanChargeId,
 String apiRequestBodyAsJson)

updateLoanCharge

@PUT
@Path("external-id/{loanExternalId}/charges/external-id/{loanChargeExternalId}")
@Consumes("application/json")
@Produces("application/json")
public String updateLoanCharge(@PathParam("loanExternalId")
 String loanExternalId,
 @PathParam("loanChargeExternalId")
 String loanChargeExternalId,
 String apiRequestBodyAsJson)

deleteLoanCharge

@DELETE
@Path("{loanId}/charges/{loanChargeId}")
@Consumes("application/json")
@Produces("application/json")
public String deleteLoanCharge(@PathParam("loanId")
 Long loanId,
 @PathParam("loanChargeId")
 Long loanChargeId)

deleteLoanCharge

@DELETE
@Path("{loanId}/charges/external-id/{loanChargeExternalId}")
@Consumes("application/json")
@Produces("application/json")
public String deleteLoanCharge(@PathParam("loanId")
 Long loanId,
 @PathParam("loanChargeExternalId")
 String loanChargeExternalId)

deleteLoanCharge

@DELETE
@Path("external-id/{loanExternalId}/charges/{loanChargeId}")
@Consumes("application/json")
@Produces("application/json")
public String deleteLoanCharge(@PathParam("loanExternalId")
 String loanExternalId,
 @PathParam("loanChargeId")
 Long loanChargeId)

deleteLoanCharge

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