Package org.apache.fineract.portfolio.client.api

Class ClientChargesApiResource

java.lang.Object

org.apache.fineract.portfolio.client.api.ClientChargesApiResource

@Path("/v1/clients/{clientId}/charges")
@Component
public class ClientChargesApiResource
extends Object

Constructor Summary

Constructors

Constructor	Description
ClientChargesApiResource()

Method Summary

Modifier and Type	Method	Description
String	applyClientCharge(Long clientId, String apiRequestBodyAsJson)
String	deleteClientCharge(Long clientId, Long chargeId)
String	payOrWaiveClientCharge(Long clientId, Long chargeId, String commandParam, String apiRequestBodyAsJson)
String	retrieveAllClientCharges(Long clientId, String chargeStatus, Boolean pendingPayment, jakarta.ws.rs.core.UriInfo uriInfo, Integer limit, Integer offset)
String	retrieveClientCharge(Long clientId, Long chargeId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveTemplate(jakarta.ws.rs.core.UriInfo uriInfo, Long clientId)

Methods inherited from class java.lang.Object

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

Constructor Details

ClientChargesApiResource

public ClientChargesApiResource()

Method Details

retrieveAllClientCharges

@GET
@Consumes("application/json")
@Produces("application/json")
public String retrieveAllClientCharges(@PathParam("clientId")
 Long clientId,
 @DefaultValue("all") @QueryParam("chargeStatus")
 String chargeStatus,
 @QueryParam("pendingPayment")
 Boolean pendingPayment,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @QueryParam("limit")
 Integer limit,
 @QueryParam("offset")
 Integer offset)

retrieveTemplate

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

retrieveClientCharge

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

applyClientCharge

@POST
@Consumes("application/json")
@Produces("application/json")
public String applyClientCharge(@PathParam("clientId")
 Long clientId,
 String apiRequestBodyAsJson)

payOrWaiveClientCharge

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

deleteClientCharge

@DELETE
@Path("{chargeId}")
@Consumes("application/json")
@Produces("application/json")
public String deleteClientCharge(@PathParam("clientId")
 Long clientId,
 @PathParam("chargeId")
 Long chargeId)