Package org.apache.fineract.client.services

Interface PaymentTypeApi

public interface PaymentTypeApi

  • Method Details

    • createPaymentType

      @Headers("Content-Type:application/json") @POST("v1/paymenttypes") retrofit2.Call<PostPaymentTypesResponse> createPaymentType(@Body PaymentTypeRequest paymentTypeRequest)
      Create a Payment Type Creates a new Payment type Mandatory Fields: name Optional Fields: Description, isCashPayment,Position
      Parameters:
      paymentTypeRequest - (required)
      Returns:
      Call<PostPaymentTypesResponse>

    • deleteCode1

      @DELETE("v1/paymenttypes/{paymentTypeId}") retrofit2.Call<DeletePaymentTypesPaymentTypeIdResponse> deleteCode1(@Path("paymentTypeId") Long paymentTypeId)
      Delete a Payment Type Deletes payment type
      Parameters:
      paymentTypeId - paymentTypeId (required)
      Returns:
      Call<DeletePaymentTypesPaymentTypeIdResponse>

    • getAllPaymentTypes

      @GET("v1/paymenttypes") retrofit2.Call<List<PaymentTypeData>> getAllPaymentTypes(@Query("onlyWithCode") Boolean onlyWithCode)
      Retrieve all Payment Types Retrieve list of payment types
      Parameters:
      onlyWithCode - onlyWithCode (optional)
      Returns:
      Call<List<PaymentTypeData>>

    • retrieveOnePaymentType

      @GET("v1/paymenttypes/{paymentTypeId}") retrofit2.Call<PaymentTypeData> retrieveOnePaymentType(@Path("paymentTypeId") Long paymentTypeId)
      Retrieve a Payment Type Retrieves a payment type
      Parameters:
      paymentTypeId - paymentTypeId (required)
      Returns:
      Call<PaymentTypeData>

    • updatePaymentType

      @Headers("Content-Type:application/json") @PUT("v1/paymenttypes/{paymentTypeId}") retrofit2.Call<PutPaymentTypesPaymentTypeIdResponse> updatePaymentType(@Path("paymentTypeId") Long paymentTypeId, @Body PutPaymentTypesPaymentTypeIdRequest putPaymentTypesPaymentTypeIdRequest)
      Update a Payment Type Updates a Payment Type
      Parameters:
      paymentTypeId - paymentTypeId (required)
      putPaymentTypesPaymentTypeIdRequest - (required)
      Returns:
      Call<PutPaymentTypesPaymentTypeIdResponse>

    • createPaymentType

      @Headers("Content-Type:application/json") @POST("v1/paymenttypes") retrofit2.Call<PostPaymentTypesResponse> createPaymentType(@Body PaymentTypeRequest paymentTypeRequest, @HeaderMap Map<String,String> headers)
      Create a Payment Type Creates a new Payment type Mandatory Fields: name Optional Fields: Description, isCashPayment,Position
      Parameters:
      paymentTypeRequest - (required)
      Returns:
      Call<PostPaymentTypesResponse>

    • deleteCode1

      @DELETE("v1/paymenttypes/{paymentTypeId}") retrofit2.Call<DeletePaymentTypesPaymentTypeIdResponse> deleteCode1(@Path("paymentTypeId") Long paymentTypeId, @HeaderMap Map<String,String> headers)
      Delete a Payment Type Deletes payment type
      Parameters:
      paymentTypeId - paymentTypeId (required)
      Returns:
      Call<DeletePaymentTypesPaymentTypeIdResponse>

    • getAllPaymentTypes

      @GET("v1/paymenttypes") retrofit2.Call<List<PaymentTypeData>> getAllPaymentTypes(@Query("onlyWithCode") Boolean onlyWithCode, @HeaderMap Map<String,String> headers)
      Retrieve all Payment Types Retrieve list of payment types
      Parameters:
      onlyWithCode - onlyWithCode (optional)
      Returns:
      Call<List<PaymentTypeData>>

    • retrieveOnePaymentType

      @GET("v1/paymenttypes/{paymentTypeId}") retrofit2.Call<PaymentTypeData> retrieveOnePaymentType(@Path("paymentTypeId") Long paymentTypeId, @HeaderMap Map<String,String> headers)
      Retrieve a Payment Type Retrieves a payment type
      Parameters:
      paymentTypeId - paymentTypeId (required)
      Returns:
      Call<PaymentTypeData>

    • updatePaymentType

      @Headers("Content-Type:application/json") @PUT("v1/paymenttypes/{paymentTypeId}") retrofit2.Call<PutPaymentTypesPaymentTypeIdResponse> updatePaymentType(@Path("paymentTypeId") Long paymentTypeId, @Body PutPaymentTypesPaymentTypeIdRequest putPaymentTypesPaymentTypeIdRequest, @HeaderMap Map<String,String> headers)
      Update a Payment Type Updates a Payment Type
      Parameters:
      paymentTypeId - paymentTypeId (required)
      putPaymentTypesPaymentTypeIdRequest - (required)
      Returns:
      Call<PutPaymentTypesPaymentTypeIdResponse>