Package org.apache.fineract.client.services

Interface AccountingRulesApi

public interface AccountingRulesApi

  • Method Details

    • createAccountingRule

      @Headers("Content-Type:application/json") @POST("v1/accountingrules") retrofit2.Call<PostAccountingRulesResponse> createAccountingRule(@Body PostAccountingRulesRequest postAccountingRulesRequest)
      Create/Define a Accounting rule Define a new Accounting rule. Mandatory Fields name, officeId, accountToDebit OR debitTags, accountToCredit OR creditTags. Optional Fields description
      Parameters:
      postAccountingRulesRequest - (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<GetAccountRulesResponse>> retrieveAllAccountingRules()
      Retrieve Accounting Rules Returns the list of defined accounting rules. Example Requests: accountingrules
      Returns:
      Call<List<GetAccountRulesResponse>>

    • retrieveTemplate1

      @GET("v1/accountingrules/template") retrofit2.Call<GetAccountRulesTemplateResponse> 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<GetAccountRulesTemplateResponse>

    • updateAccountingRule

      @Headers("Content-Type:application/json") @PUT("v1/accountingrules/{accountingRuleId}") retrofit2.Call<PutAccountingRulesResponse> updateAccountingRule(@Path("accountingRuleId") Long accountingRuleId, @Body PutAccountingRulesRequest putAccountingRulesRequest)
      Update a Accounting Rule Updates the details of a Accounting rule.
      Parameters:
      accountingRuleId - accountingRuleId (required)
      putAccountingRulesRequest - (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:
      postAccountingRulesRequest - (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)
      putAccountingRulesRequest - (optional)
      Returns:
      Call<PutAccountingRulesResponse>

    • createAccountingRule

      @Headers("Content-Type:application/json") @POST("v1/accountingrules") retrofit2.Call<PostAccountingRulesResponse> createAccountingRule(@Body PostAccountingRulesRequest postAccountingRulesRequest, @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:
      postAccountingRulesRequest - (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<GetAccountRulesResponse>> retrieveAllAccountingRules(@HeaderMap Map<String,String> headers)
      Retrieve Accounting Rules Returns the list of defined accounting rules. Example Requests: accountingrules
      Returns:
      Call<List<GetAccountRulesResponse>>

    • retrieveTemplate1

      @GET("v1/accountingrules/template") retrofit2.Call<GetAccountRulesTemplateResponse> 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<GetAccountRulesTemplateResponse>

    • updateAccountingRule

      @Headers("Content-Type:application/json") @PUT("v1/accountingrules/{accountingRuleId}") retrofit2.Call<PutAccountingRulesResponse> updateAccountingRule(@Path("accountingRuleId") Long accountingRuleId, @Body PutAccountingRulesRequest putAccountingRulesRequest, @HeaderMap Map<String,String> headers)
      Update a Accounting Rule Updates the details of a Accounting rule.
      Parameters:
      accountingRuleId - accountingRuleId (required)
      putAccountingRulesRequest - (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:
      postAccountingRulesRequest - (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)
      putAccountingRulesRequest - (optional)
      Returns:
      Call<PutAccountingRulesResponse>