Package org.apache.fineract.client.services

Interface AccountingRulesApi

public interface AccountingRulesApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<PostAccountingRulesResponse>	createAccountingRule()	Create/Define a Accounting rule Define a new Accounting rule.
retrofit2.Call<PostAccountingRulesResponse>	createAccountingRule(Map<String,String> headers)	Create/Define a Accounting rule Define a new Accounting rule.
retrofit2.Call<PostAccountingRulesResponse>	createAccountingRule(AccountRuleRequest accountRuleRequest)	Create/Define a Accounting rule Define a new Accounting rule.
retrofit2.Call<PostAccountingRulesResponse>	createAccountingRule(AccountRuleRequest accountRuleRequest, Map<String,String> headers)	Create/Define a Accounting rule Define a new Accounting rule.
retrofit2.Call<DeleteAccountingRulesResponse>	deleteAccountingRule(Long accountingRuleId)	Delete a Accounting Rule Deletes a Accounting rule.
retrofit2.Call<DeleteAccountingRulesResponse>	deleteAccountingRule(Long accountingRuleId, Map<String,String> headers)	Delete a Accounting Rule Deletes a Accounting rule.
retrofit2.Call<AccountingRuleData>	retreiveAccountingRule(Long accountingRuleId)	Retrieve a Accounting rule Returns the details of a defined Accounting rule.
retrofit2.Call<AccountingRuleData>	retreiveAccountingRule(Long accountingRuleId, Map<String,String> headers)	Retrieve a Accounting rule Returns the details of a defined Accounting rule.
retrofit2.Call<List<AccountingRuleData>>	retrieveAllAccountingRules()	Retrieve Accounting Rules Returns the list of defined accounting rules.
retrofit2.Call<List<AccountingRuleData>>	retrieveAllAccountingRules(Map<String,String> headers)	Retrieve Accounting Rules Returns the list of defined accounting rules.
retrofit2.Call<AccountingRuleData>	retrieveTemplate1()	Retrieve Accounting Rule Details Template This is a convenience resource.
retrofit2.Call<AccountingRuleData>	retrieveTemplate1(Map<String,String> headers)	Retrieve Accounting Rule Details Template This is a convenience resource.
retrofit2.Call<PutAccountingRulesResponse>	updateAccountingRule(Long accountingRuleId)	Update a Accounting Rule Updates the details of a Accounting rule.
retrofit2.Call<PutAccountingRulesResponse>	updateAccountingRule(Long accountingRuleId, Map<String,String> headers)	Update a Accounting Rule Updates the details of a Accounting rule.
retrofit2.Call<PutAccountingRulesResponse>	updateAccountingRule(Long accountingRuleId, AccountRuleRequest accountRuleRequest)	Update a Accounting Rule Updates the details of a Accounting rule.
retrofit2.Call<PutAccountingRulesResponse>	updateAccountingRule(Long accountingRuleId, AccountRuleRequest accountRuleRequest, Map<String,String> headers)	Update a Accounting Rule Updates the details of a Accounting rule.

Method Details

createAccountingRule

@Headers("Content-Type:application/json")
@POST("v1/accountingrules")
retrofit2.Call<PostAccountingRulesResponse> createAccountingRule(@Body
 AccountRuleRequest accountRuleRequest)

Create/Define a Accounting rule Define a new Accounting rule. Mandatory Fields name, officeId, accountToDebit OR debitTags, accountToCredit OR creditTags. Optional Fields description

Parameters:

accountRuleRequest - (optional)

Returns:

Call<PostAccountingRulesResponse>

deleteAccountingRule

@DELETE("v1/accountingrules/{accountingRuleId}")
retrofit2.Call<DeleteAccountingRulesResponse> deleteAccountingRule(@Path("accountingRuleId")
 Long accountingRuleId)

Delete a Accounting Rule Deletes a Accounting rule.

Parameters:

accountingRuleId - accountingRuleId (required)

Returns:

Call<DeleteAccountingRulesResponse>

retreiveAccountingRule

@GET("v1/accountingrules/{accountingRuleId}")
retrofit2.Call<AccountingRuleData> retreiveAccountingRule(@Path("accountingRuleId")
 Long accountingRuleId)

Retrieve a Accounting rule Returns the details of a defined Accounting rule. Example Requests: accountingrules/1

Parameters:

accountingRuleId - accountingRuleId (required)

Returns:

Call<AccountingRuleData>

retrieveAllAccountingRules

@GET("v1/accountingrules")
retrofit2.Call<List<AccountingRuleData>> retrieveAllAccountingRules()

Retrieve Accounting Rules Returns the list of defined accounting rules. Example Requests: accountingrules

Returns:

Call<List<AccountingRuleData>>

retrieveTemplate1

@GET("v1/accountingrules/template")
retrofit2.Call<AccountingRuleData> retrieveTemplate1()

Retrieve Accounting Rule Details 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 Value Lists Example Request: accountingrules/template

Returns:

Call<AccountingRuleData>

updateAccountingRule

@Headers("Content-Type:application/json")
@PUT("v1/accountingrules/{accountingRuleId}")
retrofit2.Call<PutAccountingRulesResponse> updateAccountingRule(@Path("accountingRuleId")
 Long accountingRuleId,
 @Body
 AccountRuleRequest accountRuleRequest)

Update a Accounting Rule Updates the details of a Accounting rule.

Parameters:

accountingRuleId - accountingRuleId (required)

accountRuleRequest - (optional)

Returns:

Call<PutAccountingRulesResponse>

createAccountingRule

@Headers("Content-Type:application/json")
@POST("v1/accountingrules")
retrofit2.Call<PostAccountingRulesResponse> createAccountingRule()

Create/Define a Accounting rule Define a new Accounting rule. Mandatory Fields name, officeId, accountToDebit OR debitTags, accountToCredit OR creditTags. Optional Fields description

Parameters:

accountRuleRequest - (optional)

Returns:

Call<PostAccountingRulesResponse>

updateAccountingRule

@Headers("Content-Type:application/json")
@PUT("v1/accountingrules/{accountingRuleId}")
retrofit2.Call<PutAccountingRulesResponse> updateAccountingRule(@Path("accountingRuleId")
 Long accountingRuleId)

Update a Accounting Rule Updates the details of a Accounting rule.

Parameters:

accountingRuleId - accountingRuleId (required)

accountRuleRequest - (optional)

Returns:

Call<PutAccountingRulesResponse>

createAccountingRule

@Headers("Content-Type:application/json")
@POST("v1/accountingrules")
retrofit2.Call<PostAccountingRulesResponse> createAccountingRule(@Body
 AccountRuleRequest accountRuleRequest,
 @HeaderMap
 Map<String,String> headers)

Create/Define a Accounting rule Define a new Accounting rule. Mandatory Fields name, officeId, accountToDebit OR debitTags, accountToCredit OR creditTags. Optional Fields description

Parameters:

accountRuleRequest - (optional)

Returns:

Call<PostAccountingRulesResponse>

deleteAccountingRule

@DELETE("v1/accountingrules/{accountingRuleId}")
retrofit2.Call<DeleteAccountingRulesResponse> deleteAccountingRule(@Path("accountingRuleId")
 Long accountingRuleId,
 @HeaderMap
 Map<String,String> headers)

Delete a Accounting Rule Deletes a Accounting rule.

Parameters:

accountingRuleId - accountingRuleId (required)

Returns:

Call<DeleteAccountingRulesResponse>

retreiveAccountingRule

@GET("v1/accountingrules/{accountingRuleId}")
retrofit2.Call<AccountingRuleData> retreiveAccountingRule(@Path("accountingRuleId")
 Long accountingRuleId,
 @HeaderMap
 Map<String,String> headers)

Retrieve a Accounting rule Returns the details of a defined Accounting rule. Example Requests: accountingrules/1

Parameters:

accountingRuleId - accountingRuleId (required)

Returns:

Call<AccountingRuleData>

retrieveAllAccountingRules

@GET("v1/accountingrules")
retrofit2.Call<List<AccountingRuleData>> retrieveAllAccountingRules(@HeaderMap
 Map<String,String> headers)

Retrieve Accounting Rules Returns the list of defined accounting rules. Example Requests: accountingrules

Returns:

Call<List<AccountingRuleData>>

retrieveTemplate1

@GET("v1/accountingrules/template")
retrofit2.Call<AccountingRuleData> retrieveTemplate1(@HeaderMap
 Map<String,String> headers)

Retrieve Accounting Rule Details 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 Value Lists Example Request: accountingrules/template

Returns:

Call<AccountingRuleData>

updateAccountingRule

@Headers("Content-Type:application/json")
@PUT("v1/accountingrules/{accountingRuleId}")
retrofit2.Call<PutAccountingRulesResponse> updateAccountingRule(@Path("accountingRuleId")
 Long accountingRuleId,
 @Body
 AccountRuleRequest accountRuleRequest,
 @HeaderMap
 Map<String,String> headers)

Update a Accounting Rule Updates the details of a Accounting rule.

Parameters:

accountingRuleId - accountingRuleId (required)

accountRuleRequest - (optional)

Returns:

Call<PutAccountingRulesResponse>

createAccountingRule

@Headers("Content-Type:application/json")
@POST("v1/accountingrules")
retrofit2.Call<PostAccountingRulesResponse> createAccountingRule(@HeaderMap
 Map<String,String> headers)

Create/Define a Accounting rule Define a new Accounting rule. Mandatory Fields name, officeId, accountToDebit OR debitTags, accountToCredit OR creditTags. Optional Fields description

Parameters:

accountRuleRequest - (optional)

Returns:

Call<PostAccountingRulesResponse>

updateAccountingRule

@Headers("Content-Type:application/json")
@PUT("v1/accountingrules/{accountingRuleId}")
retrofit2.Call<PutAccountingRulesResponse> updateAccountingRule(@Path("accountingRuleId")
 Long accountingRuleId,
 @HeaderMap
 Map<String,String> headers)

Update a Accounting Rule Updates the details of a Accounting rule.

Parameters:

accountingRuleId - accountingRuleId (required)

accountRuleRequest - (optional)

Returns:

Call<PutAccountingRulesResponse>