Package org.apache.fineract.client.services

Interface TaxComponentsApi

public interface TaxComponentsApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<PostTaxesComponentsResponse>	createTaxComponent(PostTaxesComponentsRequest postTaxesComponentsRequest)	Create a new Tax Component Creates a new Tax Component Mandatory Fields: name, percentage Optional Fields: debitAccountType, debitAcountId, creditAccountType, creditAcountId, startDate
retrofit2.Call<PostTaxesComponentsResponse>	createTaxComponent(PostTaxesComponentsRequest postTaxesComponentsRequest, Map<String,String> headers)	Create a new Tax Component Creates a new Tax Component Mandatory Fields: name, percentage Optional Fields: debitAccountType, debitAcountId, creditAccountType, creditAcountId, startDate
retrofit2.Call<List<GetTaxesComponentsResponse>>	retrieveAllTaxComponents()	List Tax Components List Tax Components
retrofit2.Call<List<GetTaxesComponentsResponse>>	retrieveAllTaxComponents(Map<String,String> headers)	List Tax Components List Tax Components
retrofit2.Call<GetTaxesComponentsResponse>	retrieveTaxComponent(Long taxComponentId)	Retrieve Tax Component Retrieve Tax Component
retrofit2.Call<GetTaxesComponentsResponse>	retrieveTaxComponent(Long taxComponentId, Map<String,String> headers)	Retrieve Tax Component Retrieve Tax Component
retrofit2.Call<TaxComponentData>	retrieveTemplate21()
retrofit2.Call<TaxComponentData>	retrieveTemplate21(Map<String,String> headers)
retrofit2.Call<PutTaxesComponentsTaxComponentIdResponse>	updateTaxCompoent(Long taxComponentId, PutTaxesComponentsTaxComponentIdRequest putTaxesComponentsTaxComponentIdRequest)	Update Tax Component Updates Tax component.
retrofit2.Call<PutTaxesComponentsTaxComponentIdResponse>	updateTaxCompoent(Long taxComponentId, PutTaxesComponentsTaxComponentIdRequest putTaxesComponentsTaxComponentIdRequest, Map<String,String> headers)	Update Tax Component Updates Tax component.

Method Details

createTaxComponent

@Headers("Content-Type:application/json")
@POST("v1/taxes/component")
retrofit2.Call<PostTaxesComponentsResponse> createTaxComponent(@Body
 PostTaxesComponentsRequest postTaxesComponentsRequest)

Create a new Tax Component Creates a new Tax Component Mandatory Fields: name, percentage Optional Fields: debitAccountType, debitAcountId, creditAccountType, creditAcountId, startDate

Parameters:

postTaxesComponentsRequest - (required)

Returns:

Call<PostTaxesComponentsResponse>

retrieveAllTaxComponents

@GET("v1/taxes/component")
retrofit2.Call<List<GetTaxesComponentsResponse>> retrieveAllTaxComponents()

List Tax Components List Tax Components

Returns:

Call<List<GetTaxesComponentsResponse>>

retrieveTaxComponent

@GET("v1/taxes/component/{taxComponentId}")
retrofit2.Call<GetTaxesComponentsResponse> retrieveTaxComponent(@Path("taxComponentId")
 Long taxComponentId)

Retrieve Tax Component Retrieve Tax Component

Parameters:

taxComponentId - taxComponentId (required)

Returns:

Call<GetTaxesComponentsResponse>

retrieveTemplate21

@GET("v1/taxes/component/template")
retrofit2.Call<TaxComponentData> retrieveTemplate21()

Returns:

Call<TaxComponentData>

updateTaxCompoent

@Headers("Content-Type:application/json")
@PUT("v1/taxes/component/{taxComponentId}")
retrofit2.Call<PutTaxesComponentsTaxComponentIdResponse> updateTaxCompoent(@Path("taxComponentId")
 Long taxComponentId,
 @Body
 PutTaxesComponentsTaxComponentIdRequest putTaxesComponentsTaxComponentIdRequest)

Update Tax Component Updates Tax component. Debit and credit account details cannot be modified. All the future tax components would be replaced with the new percentage.

Parameters:

taxComponentId - taxComponentId (required)

putTaxesComponentsTaxComponentIdRequest - (required)

Returns:

Call<PutTaxesComponentsTaxComponentIdResponse>

createTaxComponent

@Headers("Content-Type:application/json")
@POST("v1/taxes/component")
retrofit2.Call<PostTaxesComponentsResponse> createTaxComponent(@Body
 PostTaxesComponentsRequest postTaxesComponentsRequest,
 @HeaderMap
 Map<String,String> headers)

Create a new Tax Component Creates a new Tax Component Mandatory Fields: name, percentage Optional Fields: debitAccountType, debitAcountId, creditAccountType, creditAcountId, startDate

Parameters:

postTaxesComponentsRequest - (required)

Returns:

Call<PostTaxesComponentsResponse>

retrieveAllTaxComponents

@GET("v1/taxes/component")
retrofit2.Call<List<GetTaxesComponentsResponse>> retrieveAllTaxComponents(@HeaderMap
 Map<String,String> headers)

List Tax Components List Tax Components

Returns:

Call<List<GetTaxesComponentsResponse>>

retrieveTaxComponent

@GET("v1/taxes/component/{taxComponentId}")
retrofit2.Call<GetTaxesComponentsResponse> retrieveTaxComponent(@Path("taxComponentId")
 Long taxComponentId,
 @HeaderMap
 Map<String,String> headers)

Retrieve Tax Component Retrieve Tax Component

Parameters:

taxComponentId - taxComponentId (required)

Returns:

Call<GetTaxesComponentsResponse>

retrieveTemplate21

@GET("v1/taxes/component/template")
retrofit2.Call<TaxComponentData> retrieveTemplate21(@HeaderMap
 Map<String,String> headers)

Returns:

Call<TaxComponentData>

updateTaxCompoent

@Headers("Content-Type:application/json")
@PUT("v1/taxes/component/{taxComponentId}")
retrofit2.Call<PutTaxesComponentsTaxComponentIdResponse> updateTaxCompoent(@Path("taxComponentId")
 Long taxComponentId,
 @Body
 PutTaxesComponentsTaxComponentIdRequest putTaxesComponentsTaxComponentIdRequest,
 @HeaderMap
 Map<String,String> headers)

Update Tax Component Updates Tax component. Debit and credit account details cannot be modified. All the future tax components would be replaced with the new percentage.

Parameters:

taxComponentId - taxComponentId (required)

putTaxesComponentsTaxComponentIdRequest - (required)

Returns:

Call<PutTaxesComponentsTaxComponentIdResponse>