Package org.apache.fineract.client.services

Interface TaxGroupApi

public interface TaxGroupApi

  • Method Details

    • createTaxGroup

      @Headers("Content-Type:application/json") @POST("v1/taxes/group") retrofit2.Call<PostTaxesGroupResponse> createTaxGroup(@Body PostTaxesGroupRequest postTaxesGroupRequest)
      Create a new Tax Group Create a new Tax Group Mandatory Fields: name and taxComponents Mandatory Fields in taxComponents: taxComponentId Optional Fields in taxComponents: id, startDate and endDate
      Parameters:
      postTaxesGroupRequest - (required)
      Returns:
      Call<PostTaxesGroupResponse>

    • retrieveAllTaxGroups

      @GET("v1/taxes/group") retrofit2.Call<List<GetTaxesGroupResponse>> retrieveAllTaxGroups()
      List Tax Group List Tax Group
      Returns:
      Call<List<GetTaxesGroupResponse>>

    • retrieveTaxGroup

      @GET("v1/taxes/group/{taxGroupId}") retrofit2.Call<GetTaxesGroupResponse> retrieveTaxGroup(@Path("taxGroupId") Long taxGroupId)
      Retrieve Tax Group Retrieve Tax Group
      Parameters:
      taxGroupId - taxGroupId (required)
      Returns:
      Call<GetTaxesGroupResponse>

    • retrieveTemplate22

      @GET("v1/taxes/group/template") retrofit2.Call<TaxGroupData> retrieveTemplate22()
      Returns:
      Call<TaxGroupData>

    • updateTaxGroup

      @Headers("Content-Type:application/json") @PUT("v1/taxes/group/{taxGroupId}") retrofit2.Call<PutTaxesGroupTaxGroupIdResponse> updateTaxGroup(@Path("taxGroupId") Long taxGroupId, @Body PutTaxesGroupTaxGroupIdRequest putTaxesGroupTaxGroupIdRequest)
      Update Tax Group Updates Tax Group. Only end date can be up-datable and can insert new tax components.
      Parameters:
      taxGroupId - taxGroupId (required)
      putTaxesGroupTaxGroupIdRequest - (required)
      Returns:
      Call<PutTaxesGroupTaxGroupIdResponse>

    • createTaxGroup

      @Headers("Content-Type:application/json") @POST("v1/taxes/group") retrofit2.Call<PostTaxesGroupResponse> createTaxGroup(@Body PostTaxesGroupRequest postTaxesGroupRequest, @HeaderMap Map<String,String> headers)
      Create a new Tax Group Create a new Tax Group Mandatory Fields: name and taxComponents Mandatory Fields in taxComponents: taxComponentId Optional Fields in taxComponents: id, startDate and endDate
      Parameters:
      postTaxesGroupRequest - (required)
      Returns:
      Call<PostTaxesGroupResponse>

    • retrieveAllTaxGroups

      @GET("v1/taxes/group") retrofit2.Call<List<GetTaxesGroupResponse>> retrieveAllTaxGroups(@HeaderMap Map<String,String> headers)
      List Tax Group List Tax Group
      Returns:
      Call<List<GetTaxesGroupResponse>>

    • retrieveTaxGroup

      @GET("v1/taxes/group/{taxGroupId}") retrofit2.Call<GetTaxesGroupResponse> retrieveTaxGroup(@Path("taxGroupId") Long taxGroupId, @HeaderMap Map<String,String> headers)
      Retrieve Tax Group Retrieve Tax Group
      Parameters:
      taxGroupId - taxGroupId (required)
      Returns:
      Call<GetTaxesGroupResponse>

    • retrieveTemplate22

      @GET("v1/taxes/group/template") retrofit2.Call<TaxGroupData> retrieveTemplate22(@HeaderMap Map<String,String> headers)
      Returns:
      Call<TaxGroupData>

    • updateTaxGroup

      @Headers("Content-Type:application/json") @PUT("v1/taxes/group/{taxGroupId}") retrofit2.Call<PutTaxesGroupTaxGroupIdResponse> updateTaxGroup(@Path("taxGroupId") Long taxGroupId, @Body PutTaxesGroupTaxGroupIdRequest putTaxesGroupTaxGroupIdRequest, @HeaderMap Map<String,String> headers)
      Update Tax Group Updates Tax Group. Only end date can be up-datable and can insert new tax components.
      Parameters:
      taxGroupId - taxGroupId (required)
      putTaxesGroupTaxGroupIdRequest - (required)
      Returns:
      Call<PutTaxesGroupTaxGroupIdResponse>