Package org.apache.fineract.client.services

Interface HolidaysApi

public interface HolidaysApi

  • Method Details

    • createNewHoliday

      @Headers("Content-Type:application/json") @POST("v1/holidays") retrofit2.Call<PostHolidaysResponse> createNewHoliday(@Body PostHolidaysRequest postHolidaysRequest)
      Create a Holiday Mandatory Fields: name, description, fromDate, toDate, repaymentsRescheduledTo, offices
      Parameters:
      postHolidaysRequest - (required)
      Returns:
      Call<PostHolidaysResponse>

    • delete6

      @DELETE("v1/holidays/{holidayId}") retrofit2.Call<DeleteHolidaysHolidayIdResponse> delete6(@Path("holidayId") Long holidayId)
      Delete a Holiday This API allows to delete a holiday. This is a soft delete the deleted holiday status is marked as deleted.
      Parameters:
      holidayId - holidayId (required)
      Returns:
      Call<DeleteHolidaysHolidayIdResponse>

    • handleCommands1

      @Headers("Content-Type:application/json") @POST("v1/holidays/{holidayId}") retrofit2.Call<PostHolidaysHolidayIdResponse> handleCommands1(@Path("holidayId") Long holidayId, @Body Object body, @Query("command") String command)
      Activate a Holiday Always Holidays are created in pending state. This API allows to activate a holiday. Only the active holidays are considered for rescheduling the loan repayment.
      Parameters:
      holidayId - holidayId (required)
      body - (required)
      command - command (optional)
      Returns:
      Call<PostHolidaysHolidayIdResponse>

    • retrieveAllHolidays

      @GET("v1/holidays") retrofit2.Call<List<GetHolidaysResponse>> retrieveAllHolidays(@Query("officeId") Long officeId, @Query("fromDate") Object fromDate, @Query("toDate") Object toDate, @Query("locale") String locale, @Query("dateFormat") String dateFormat)
      List Holidays Example Requests: holidays?officeId=1
      Parameters:
      officeId - officeId (optional)
      fromDate - fromDate (optional)
      toDate - toDate (optional)
      locale - locale (optional)
      dateFormat - dateFormat (optional)
      Returns:
      Call<List<GetHolidaysResponse>>

    • retrieveOne7

      @GET("v1/holidays/{holidayId}") retrofit2.Call<GetHolidaysResponse> retrieveOne7(@Path("holidayId") Long holidayId)
      Retrieve a Holiday Example Requests: holidays/1
      Parameters:
      holidayId - holidayId (required)
      Returns:
      Call<GetHolidaysResponse>

    • retrieveRepaymentScheduleUpdationTyeOptions

      @GET("v1/holidays/template") retrofit2.Call<String> retrieveRepaymentScheduleUpdationTyeOptions()
      Returns:
      Call<String>

    • update6

      @Headers("Content-Type:application/json") @PUT("v1/holidays/{holidayId}") retrofit2.Call<PutHolidaysHolidayIdResponse> update6(@Path("holidayId") Long holidayId, @Body PutHolidaysHolidayIdRequest putHolidaysHolidayIdRequest)
      Update a Holiday If a holiday is in pending state (created and not activated) then all fields are allowed to modify. Once holidays become active only name and descriptions are allowed to modify.
      Parameters:
      holidayId - holidayId (required)
      putHolidaysHolidayIdRequest - (required)
      Returns:
      Call<PutHolidaysHolidayIdResponse>

    • createNewHoliday

      @Headers("Content-Type:application/json") @POST("v1/holidays") retrofit2.Call<PostHolidaysResponse> createNewHoliday(@Body PostHolidaysRequest postHolidaysRequest, @HeaderMap Map<String,String> headers)
      Create a Holiday Mandatory Fields: name, description, fromDate, toDate, repaymentsRescheduledTo, offices
      Parameters:
      postHolidaysRequest - (required)
      Returns:
      Call<PostHolidaysResponse>

    • delete6

      @DELETE("v1/holidays/{holidayId}") retrofit2.Call<DeleteHolidaysHolidayIdResponse> delete6(@Path("holidayId") Long holidayId, @HeaderMap Map<String,String> headers)
      Delete a Holiday This API allows to delete a holiday. This is a soft delete the deleted holiday status is marked as deleted.
      Parameters:
      holidayId - holidayId (required)
      Returns:
      Call<DeleteHolidaysHolidayIdResponse>

    • handleCommands1

      @Headers("Content-Type:application/json") @POST("v1/holidays/{holidayId}") retrofit2.Call<PostHolidaysHolidayIdResponse> handleCommands1(@Path("holidayId") Long holidayId, @Body Object body, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Activate a Holiday Always Holidays are created in pending state. This API allows to activate a holiday. Only the active holidays are considered for rescheduling the loan repayment.
      Parameters:
      holidayId - holidayId (required)
      body - (required)
      command - command (optional)
      Returns:
      Call<PostHolidaysHolidayIdResponse>

    • retrieveAllHolidays

      @GET("v1/holidays") retrofit2.Call<List<GetHolidaysResponse>> retrieveAllHolidays(@Query("officeId") Long officeId, @Query("fromDate") Object fromDate, @Query("toDate") Object toDate, @Query("locale") String locale, @Query("dateFormat") String dateFormat, @HeaderMap Map<String,String> headers)
      List Holidays Example Requests: holidays?officeId=1
      Parameters:
      officeId - officeId (optional)
      fromDate - fromDate (optional)
      toDate - toDate (optional)
      locale - locale (optional)
      dateFormat - dateFormat (optional)
      Returns:
      Call<List<GetHolidaysResponse>>

    • retrieveOne7

      @GET("v1/holidays/{holidayId}") retrofit2.Call<GetHolidaysResponse> retrieveOne7(@Path("holidayId") Long holidayId, @HeaderMap Map<String,String> headers)
      Retrieve a Holiday Example Requests: holidays/1
      Parameters:
      holidayId - holidayId (required)
      Returns:
      Call<GetHolidaysResponse>

    • retrieveRepaymentScheduleUpdationTyeOptions

      @GET("v1/holidays/template") retrofit2.Call<String> retrieveRepaymentScheduleUpdationTyeOptions(@HeaderMap Map<String,String> headers)
      Returns:
      Call<String>

    • update6

      @Headers("Content-Type:application/json") @PUT("v1/holidays/{holidayId}") retrofit2.Call<PutHolidaysHolidayIdResponse> update6(@Path("holidayId") Long holidayId, @Body PutHolidaysHolidayIdRequest putHolidaysHolidayIdRequest, @HeaderMap Map<String,String> headers)
      Update a Holiday If a holiday is in pending state (created and not activated) then all fields are allowed to modify. Once holidays become active only name and descriptions are allowed to modify.
      Parameters:
      holidayId - holidayId (required)
      putHolidaysHolidayIdRequest - (required)
      Returns:
      Call<PutHolidaysHolidayIdResponse>