Package org.apache.fineract.client.services

Interface ClientChargesApi

public interface ClientChargesApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<PostClientsClientIdChargesResponse>	applyClientCharge(Long clientId, PostClientsClientIdChargesRequest postClientsClientIdChargesRequest)	Add Client Charge This API associates a Client charge with an implicit Client account Mandatory Fields : chargeId and dueDate Optional Fields : amount
retrofit2.Call<PostClientsClientIdChargesResponse>	applyClientCharge(Long clientId, PostClientsClientIdChargesRequest postClientsClientIdChargesRequest, Map<String,String> headers)	Add Client Charge This API associates a Client charge with an implicit Client account Mandatory Fields : chargeId and dueDate Optional Fields : amount
retrofit2.Call<DeleteClientsClientIdChargesChargeIdResponse>	deleteClientCharge(Long clientId, Long chargeId)	Delete a Client Charge Deletes a Client Charge on which no transactions have taken place (either payments or waivers).
retrofit2.Call<DeleteClientsClientIdChargesChargeIdResponse>	deleteClientCharge(Long clientId, Long chargeId, Map<String,String> headers)	Delete a Client Charge Deletes a Client Charge on which no transactions have taken place (either payments or waivers).
retrofit2.Call<PostClientsClientIdChargesChargeIdResponse>	payOrWaiveClientCharge(Long clientId, Long chargeId, PostClientsClientIdChargesChargeIdRequest postClientsClientIdChargesChargeIdRequest, String command)	Pay a Client Charge | Waive a Client Charge Pay a Client Charge: Mandatory Fields:transactionDate and amount \"Pay either a part of or the entire due amount for a charge.(command=paycharge) Waive a Client Charge: This API provides the facility of waiving off the remaining amount on a client charge (command=waive) Showing request/response for 'Pay a Client Charge'
retrofit2.Call<PostClientsClientIdChargesChargeIdResponse>	payOrWaiveClientCharge(Long clientId, Long chargeId, PostClientsClientIdChargesChargeIdRequest postClientsClientIdChargesChargeIdRequest, String command, Map<String,String> headers)	Pay a Client Charge | Waive a Client Charge Pay a Client Charge: Mandatory Fields:transactionDate and amount \"Pay either a part of or the entire due amount for a charge.(command=paycharge) Waive a Client Charge: This API provides the facility of waiving off the remaining amount on a client charge (command=waive) Showing request/response for 'Pay a Client Charge'
retrofit2.Call<GetClientsClientIdChargesResponse>	retrieveAllClientCharges(Long clientId, String chargeStatus, Boolean pendingPayment, Integer limit, Integer offset)	List Client Charges The list capability of client charges supports pagination.Example Requests: clients/1/charges clients/1/charges?offset=0&limit=5
retrofit2.Call<GetClientsClientIdChargesResponse>	retrieveAllClientCharges(Long clientId, String chargeStatus, Boolean pendingPayment, Integer limit, Integer offset, Map<String,String> headers)	List Client Charges The list capability of client charges supports pagination.Example Requests: clients/1/charges clients/1/charges?offset=0&limit=5
retrofit2.Call<GetClientsChargesPageItems>	retrieveClientCharge(Long clientId, Long chargeId)	Retrieve a Client Charge Example Requests: clients/1/charges/1 clients/1/charges/1?fields=name,id
retrofit2.Call<GetClientsChargesPageItems>	retrieveClientCharge(Long clientId, Long chargeId, Map<String,String> headers)	Retrieve a Client Charge Example Requests: clients/1/charges/1 clients/1/charges/1?fields=name,id
retrofit2.Call<String>	retrieveTemplate4(Long clientId)
retrofit2.Call<String>	retrieveTemplate4(Long clientId, Map<String,String> headers)

Method Details

applyClientCharge

@Headers("Content-Type:application/json")
@POST("v1/clients/{clientId}/charges")
retrofit2.Call<PostClientsClientIdChargesResponse> applyClientCharge(@Path("clientId")
 Long clientId,
 @Body
 PostClientsClientIdChargesRequest postClientsClientIdChargesRequest)

Add Client Charge This API associates a Client charge with an implicit Client account Mandatory Fields : chargeId and dueDate Optional Fields : amount

Parameters:

clientId - clientId (required)

postClientsClientIdChargesRequest - (required)

Returns:

Call<PostClientsClientIdChargesResponse>

deleteClientCharge

@DELETE("v1/clients/{clientId}/charges/{chargeId}")
retrofit2.Call<DeleteClientsClientIdChargesChargeIdResponse> deleteClientCharge(@Path("clientId")
 Long clientId,
 @Path("chargeId")
 Long chargeId)

Delete a Client Charge Deletes a Client Charge on which no transactions have taken place (either payments or waivers).

Parameters:

clientId - clientId (required)

chargeId - chargeId (required)

Returns:

Call<DeleteClientsClientIdChargesChargeIdResponse>

payOrWaiveClientCharge

@Headers("Content-Type:application/json")
@POST("v1/clients/{clientId}/charges/{chargeId}")
retrofit2.Call<PostClientsClientIdChargesChargeIdResponse> payOrWaiveClientCharge(@Path("clientId")
 Long clientId,
 @Path("chargeId")
 Long chargeId,
 @Body
 PostClientsClientIdChargesChargeIdRequest postClientsClientIdChargesChargeIdRequest,
 @Query("command")
 String command)

Pay a Client Charge | Waive a Client Charge Pay a Client Charge: Mandatory Fields:transactionDate and amount \"Pay either a part of or the entire due amount for a charge.(command=paycharge) Waive a Client Charge: This API provides the facility of waiving off the remaining amount on a client charge (command=waive) Showing request/response for 'Pay a Client Charge'

Parameters:

clientId - clientId (required)

chargeId - chargeId (required)

postClientsClientIdChargesChargeIdRequest - (required)

command - command (optional)

Returns:

Call<PostClientsClientIdChargesChargeIdResponse>

retrieveAllClientCharges

@GET("v1/clients/{clientId}/charges")
retrofit2.Call<GetClientsClientIdChargesResponse> retrieveAllClientCharges(@Path("clientId")
 Long clientId,
 @Query("chargeStatus")
 String chargeStatus,
 @Query("pendingPayment")
 Boolean pendingPayment,
 @Query("limit")
 Integer limit,
 @Query("offset")
 Integer offset)

List Client Charges The list capability of client charges supports pagination.Example Requests: clients/1/charges clients/1/charges?offset=0&limit=5

Parameters:

clientId - clientId (required)

chargeStatus - chargeStatus (optional, default to all)

pendingPayment - pendingPayment (optional)

limit - limit (optional)

offset - offset (optional)

Returns:

Call<GetClientsClientIdChargesResponse>

retrieveClientCharge

@GET("v1/clients/{clientId}/charges/{chargeId}")
retrofit2.Call<GetClientsChargesPageItems> retrieveClientCharge(@Path("clientId")
 Long clientId,
 @Path("chargeId")
 Long chargeId)

Retrieve a Client Charge Example Requests: clients/1/charges/1 clients/1/charges/1?fields=name,id

Parameters:

clientId - clientId (required)

chargeId - chargeId (required)

Returns:

Call<GetClientsChargesPageItems>

retrieveTemplate4

@GET("v1/clients/{clientId}/charges/template")
retrofit2.Call<String> retrieveTemplate4(@Path("clientId")
 Long clientId)

Parameters:

clientId - clientId (required)

Returns:

Call<String>

applyClientCharge

@Headers("Content-Type:application/json")
@POST("v1/clients/{clientId}/charges")
retrofit2.Call<PostClientsClientIdChargesResponse> applyClientCharge(@Path("clientId")
 Long clientId,
 @Body
 PostClientsClientIdChargesRequest postClientsClientIdChargesRequest,
 @HeaderMap
 Map<String,String> headers)

Add Client Charge This API associates a Client charge with an implicit Client account Mandatory Fields : chargeId and dueDate Optional Fields : amount

Parameters:

clientId - clientId (required)

postClientsClientIdChargesRequest - (required)

Returns:

Call<PostClientsClientIdChargesResponse>

deleteClientCharge

@DELETE("v1/clients/{clientId}/charges/{chargeId}")
retrofit2.Call<DeleteClientsClientIdChargesChargeIdResponse> deleteClientCharge(@Path("clientId")
 Long clientId,
 @Path("chargeId")
 Long chargeId,
 @HeaderMap
 Map<String,String> headers)

Delete a Client Charge Deletes a Client Charge on which no transactions have taken place (either payments or waivers).

Parameters:

clientId - clientId (required)

chargeId - chargeId (required)

Returns:

Call<DeleteClientsClientIdChargesChargeIdResponse>

payOrWaiveClientCharge

@Headers("Content-Type:application/json")
@POST("v1/clients/{clientId}/charges/{chargeId}")
retrofit2.Call<PostClientsClientIdChargesChargeIdResponse> payOrWaiveClientCharge(@Path("clientId")
 Long clientId,
 @Path("chargeId")
 Long chargeId,
 @Body
 PostClientsClientIdChargesChargeIdRequest postClientsClientIdChargesChargeIdRequest,
 @Query("command")
 String command,
 @HeaderMap
 Map<String,String> headers)

Pay a Client Charge | Waive a Client Charge Pay a Client Charge: Mandatory Fields:transactionDate and amount \"Pay either a part of or the entire due amount for a charge.(command=paycharge) Waive a Client Charge: This API provides the facility of waiving off the remaining amount on a client charge (command=waive) Showing request/response for 'Pay a Client Charge'

Parameters:

clientId - clientId (required)

chargeId - chargeId (required)

postClientsClientIdChargesChargeIdRequest - (required)

command - command (optional)

Returns:

Call<PostClientsClientIdChargesChargeIdResponse>

retrieveAllClientCharges

@GET("v1/clients/{clientId}/charges")
retrofit2.Call<GetClientsClientIdChargesResponse> retrieveAllClientCharges(@Path("clientId")
 Long clientId,
 @Query("chargeStatus")
 String chargeStatus,
 @Query("pendingPayment")
 Boolean pendingPayment,
 @Query("limit")
 Integer limit,
 @Query("offset")
 Integer offset,
 @HeaderMap
 Map<String,String> headers)

List Client Charges The list capability of client charges supports pagination.Example Requests: clients/1/charges clients/1/charges?offset=0&limit=5

Parameters:

clientId - clientId (required)

chargeStatus - chargeStatus (optional, default to all)

pendingPayment - pendingPayment (optional)

limit - limit (optional)

offset - offset (optional)

Returns:

Call<GetClientsClientIdChargesResponse>

retrieveClientCharge

@GET("v1/clients/{clientId}/charges/{chargeId}")
retrofit2.Call<GetClientsChargesPageItems> retrieveClientCharge(@Path("clientId")
 Long clientId,
 @Path("chargeId")
 Long chargeId,
 @HeaderMap
 Map<String,String> headers)

Retrieve a Client Charge Example Requests: clients/1/charges/1 clients/1/charges/1?fields=name,id

Parameters:

clientId - clientId (required)

chargeId - chargeId (required)

Returns:

Call<GetClientsChargesPageItems>

retrieveTemplate4

@GET("v1/clients/{clientId}/charges/template")
retrofit2.Call<String> retrieveTemplate4(@Path("clientId")
 Long clientId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

clientId - clientId (required)

Returns:

Call<String>