Package org.apache.fineract.client.services

Interface ChargesApi

public interface ChargesApi

  • Method Details

    • createCharge

      @Headers("Content-Type:application/json") @POST("v1/charges") retrofit2.Call<PostChargesResponse> createCharge(@Body ChargeRequest chargeRequest)
      Create/Define a Charge Define a new charge that can later be associated with loans and savings through their respective product definitions or directly on each account instance.
      Parameters:
      chargeRequest - (required)
      Returns:
      Call<PostChargesResponse>

    • deleteCharge

      @DELETE("v1/charges/{chargeId}") retrofit2.Call<DeleteChargesChargeIdResponse> deleteCharge(@Path("chargeId") Long chargeId)
      Delete a Charge Deletes a Charge.
      Parameters:
      chargeId - chargeId (required)
      Returns:
      Call<DeleteChargesChargeIdResponse>

    • retrieveAllCharges

      @GET("v1/charges") retrofit2.Call<List<ChargeData>> retrieveAllCharges()
      Retrieve Charges Returns the list of defined charges. Example Requests: charges
      Returns:
      Call<List<ChargeData>>

    • retrieveCharge

      @GET("v1/charges/{chargeId}") retrofit2.Call<GetChargesResponse> retrieveCharge(@Path("chargeId") Long chargeId)
      Retrieve a Charge Returns the details of a defined Charge. Example Requests: charges/1
      Parameters:
      chargeId - chargeId (required)
      Returns:
      Call<GetChargesResponse>

    • retrieveNewChargeDetails

      @GET("v1/charges/template") retrofit2.Call<ChargeData> retrieveNewChargeDetails()
      Retrieve Charge Template This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: charges/template
      Returns:
      Call<ChargeData>

    • updateCharge

      @Headers("Content-Type:application/json") @PUT("v1/charges/{chargeId}") retrofit2.Call<PutChargesChargeIdResponse> updateCharge(@Path("chargeId") Long chargeId, @Body ChargeRequest chargeRequest)
      Update a Charge Updates the details of a Charge.
      Parameters:
      chargeId - chargeId (required)
      chargeRequest - (required)
      Returns:
      Call<PutChargesChargeIdResponse>

    • createCharge

      @Headers("Content-Type:application/json") @POST("v1/charges") retrofit2.Call<PostChargesResponse> createCharge(@Body ChargeRequest chargeRequest, @HeaderMap Map<String,String> headers)
      Create/Define a Charge Define a new charge that can later be associated with loans and savings through their respective product definitions or directly on each account instance.
      Parameters:
      chargeRequest - (required)
      Returns:
      Call<PostChargesResponse>

    • deleteCharge

      @DELETE("v1/charges/{chargeId}") retrofit2.Call<DeleteChargesChargeIdResponse> deleteCharge(@Path("chargeId") Long chargeId, @HeaderMap Map<String,String> headers)
      Delete a Charge Deletes a Charge.
      Parameters:
      chargeId - chargeId (required)
      Returns:
      Call<DeleteChargesChargeIdResponse>

    • retrieveAllCharges

      @GET("v1/charges") retrofit2.Call<List<ChargeData>> retrieveAllCharges(@HeaderMap Map<String,String> headers)
      Retrieve Charges Returns the list of defined charges. Example Requests: charges
      Returns:
      Call<List<ChargeData>>

    • retrieveCharge

      @GET("v1/charges/{chargeId}") retrofit2.Call<GetChargesResponse> retrieveCharge(@Path("chargeId") Long chargeId, @HeaderMap Map<String,String> headers)
      Retrieve a Charge Returns the details of a defined Charge. Example Requests: charges/1
      Parameters:
      chargeId - chargeId (required)
      Returns:
      Call<GetChargesResponse>

    • retrieveNewChargeDetails

      @GET("v1/charges/template") retrofit2.Call<ChargeData> retrieveNewChargeDetails(@HeaderMap Map<String,String> headers)
      Retrieve Charge Template This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: charges/template
      Returns:
      Call<ChargeData>

    • updateCharge

      @Headers("Content-Type:application/json") @PUT("v1/charges/{chargeId}") retrofit2.Call<PutChargesChargeIdResponse> updateCharge(@Path("chargeId") Long chargeId, @Body ChargeRequest chargeRequest, @HeaderMap Map<String,String> headers)
      Update a Charge Updates the details of a Charge.
      Parameters:
      chargeId - chargeId (required)
      chargeRequest - (required)
      Returns:
      Call<PutChargesChargeIdResponse>