Package org.apache.fineract.client.services

Interface GeneralLedgerAccountApi

public interface GeneralLedgerAccountApi

  • Method Details

    • createGLAccount1

      @Headers("Content-Type:application/json") @POST("v1/glaccounts") retrofit2.Call<PostGLAccountsResponse> createGLAccount1(@Body PostGLAccountsRequest postGLAccountsRequest)
      Create a General Ledger Account Note: You may optionally create Hierarchical Chart of Accounts by using the \"parentId\" property of an Account Mandatory Fields: name, glCode, type, usage and manualEntriesAllowed
      Parameters:
      postGLAccountsRequest - (optional)
      Returns:
      Call<PostGLAccountsResponse>

    • deleteGLAccount1

      @DELETE("v1/glaccounts/{glAccountId}") retrofit2.Call<DeleteGLAccountsResponse> deleteGLAccount1(@Path("glAccountId") Long glAccountId)
      Delete a GL Account Deletes a GL Account
      Parameters:
      glAccountId - glAccountId (required)
      Returns:
      Call<DeleteGLAccountsResponse>

    • getGlAccountsTemplate

      @GET("v1/glaccounts/downloadtemplate") retrofit2.Call<Void> getGlAccountsTemplate(@Query("dateFormat") String dateFormat)
      Parameters:
      dateFormat - (optional)
      Returns:
      Call<Void>

    • postGlAccountsTemplate

      @Multipart @POST("v1/glaccounts/uploadtemplate") retrofit2.Call<Long> postGlAccountsTemplate(@Part("dateFormat") String dateFormat, @Part("locale") String locale, @Part okhttp3.MultipartBody.Part uploadedInputStream)
      Parameters:
      dateFormat - (optional)
      locale - (optional)
      uploadedInputStream - (optional)
      Returns:
      Call<Long>

    • retreiveAccount

      @GET("v1/glaccounts/{glAccountId}") retrofit2.Call<GetGLAccountsResponse> retreiveAccount(@Path("glAccountId") Long glAccountId, @Query("fetchRunningBalance") Boolean fetchRunningBalance)
      Retrieve a General Ledger Account Example Requests: glaccounts/1 glaccounts/1?template=true glaccounts/1?fields=name,glCode glaccounts/1?fetchRunningBalance=true
      Parameters:
      glAccountId - glAccountId (required)
      fetchRunningBalance - fetchRunningBalance (optional)
      Returns:
      Call<GetGLAccountsResponse>

    • retrieveAllAccounts

      @GET("v1/glaccounts") retrofit2.Call<List<GetGLAccountsResponse>> retrieveAllAccounts(@Query("type") Integer type, @Query("searchParam") String searchParam, @Query("usage") Integer usage, @Query("manualEntriesAllowed") Boolean manualEntriesAllowed, @Query("disabled") Boolean disabled, @Query("fetchRunningBalance") Boolean fetchRunningBalance)
      List General Ledger Account ARGUMENTS type Integer optional manualEntriesAllowed boolean optional usage Integer optional disabled boolean optional parentId Long optional tagId Long optional Example Requests: glaccounts glaccounts?type=1&manualEntriesAllowed=true&usage=1&disabled=false glaccounts?fetchRunningBalance=true
      Parameters:
      type - type (optional)
      searchParam - searchParam (optional)
      usage - usage (optional)
      manualEntriesAllowed - manualEntriesAllowed (optional)
      disabled - disabled (optional)
      fetchRunningBalance - fetchRunningBalance (optional)
      Returns:
      Call<List<GetGLAccountsResponse>>

    • retrieveNewAccountDetails

      @GET("v1/glaccounts/template") retrofit2.Call<GetGLAccountsTemplateResponse> retrieveNewAccountDetails(@Query("type") Integer type)
      Retrieve GL Accounts 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: glaccounts/template glaccounts/template?type=1 type is optional and integer value from 1 to 5. 1.Assets 2.Liabilities 3.Equity 4.Income 5.Expenses
      Parameters:
      type - type (optional)
      Returns:
      Call<GetGLAccountsTemplateResponse>

    • updateGLAccount1

      @Headers("Content-Type:application/json") @PUT("v1/glaccounts/{glAccountId}") retrofit2.Call<PutGLAccountsResponse> updateGLAccount1(@Path("glAccountId") Long glAccountId, @Body PutGLAccountsRequest putGLAccountsRequest)
      Update a GL Account Updates a GL Account
      Parameters:
      glAccountId - glAccountId (required)
      putGLAccountsRequest - (optional)
      Returns:
      Call<PutGLAccountsResponse>

    • createGLAccount1

      @Headers("Content-Type:application/json") @POST("v1/glaccounts") retrofit2.Call<PostGLAccountsResponse> createGLAccount1()
      Create a General Ledger Account Note: You may optionally create Hierarchical Chart of Accounts by using the \"parentId\" property of an Account Mandatory Fields: name, glCode, type, usage and manualEntriesAllowed
      Parameters:
      postGLAccountsRequest - (optional)
      Returns:
      Call<PostGLAccountsResponse>

    • updateGLAccount1

      @Headers("Content-Type:application/json") @PUT("v1/glaccounts/{glAccountId}") retrofit2.Call<PutGLAccountsResponse> updateGLAccount1(@Path("glAccountId") Long glAccountId)
      Update a GL Account Updates a GL Account
      Parameters:
      glAccountId - glAccountId (required)
      putGLAccountsRequest - (optional)
      Returns:
      Call<PutGLAccountsResponse>

    • createGLAccount1

      @Headers("Content-Type:application/json") @POST("v1/glaccounts") retrofit2.Call<PostGLAccountsResponse> createGLAccount1(@Body PostGLAccountsRequest postGLAccountsRequest, @HeaderMap Map<String,String> headers)
      Create a General Ledger Account Note: You may optionally create Hierarchical Chart of Accounts by using the \"parentId\" property of an Account Mandatory Fields: name, glCode, type, usage and manualEntriesAllowed
      Parameters:
      postGLAccountsRequest - (optional)
      Returns:
      Call<PostGLAccountsResponse>

    • deleteGLAccount1

      @DELETE("v1/glaccounts/{glAccountId}") retrofit2.Call<DeleteGLAccountsResponse> deleteGLAccount1(@Path("glAccountId") Long glAccountId, @HeaderMap Map<String,String> headers)
      Delete a GL Account Deletes a GL Account
      Parameters:
      glAccountId - glAccountId (required)
      Returns:
      Call<DeleteGLAccountsResponse>

    • getGlAccountsTemplate

      @GET("v1/glaccounts/downloadtemplate") retrofit2.Call<Void> getGlAccountsTemplate(@Query("dateFormat") String dateFormat, @HeaderMap Map<String,String> headers)
      Parameters:
      dateFormat - (optional)
      Returns:
      Call<Void>

    • postGlAccountsTemplate

      @Multipart @POST("v1/glaccounts/uploadtemplate") retrofit2.Call<Long> postGlAccountsTemplate(@Part("dateFormat") String dateFormat, @Part("locale") String locale, @Part okhttp3.MultipartBody.Part uploadedInputStream, @HeaderMap Map<String,String> headers)
      Parameters:
      dateFormat - (optional)
      locale - (optional)
      uploadedInputStream - (optional)
      Returns:
      Call<Long>

    • retreiveAccount

      @GET("v1/glaccounts/{glAccountId}") retrofit2.Call<GetGLAccountsResponse> retreiveAccount(@Path("glAccountId") Long glAccountId, @Query("fetchRunningBalance") Boolean fetchRunningBalance, @HeaderMap Map<String,String> headers)
      Retrieve a General Ledger Account Example Requests: glaccounts/1 glaccounts/1?template=true glaccounts/1?fields=name,glCode glaccounts/1?fetchRunningBalance=true
      Parameters:
      glAccountId - glAccountId (required)
      fetchRunningBalance - fetchRunningBalance (optional)
      Returns:
      Call<GetGLAccountsResponse>

    • retrieveAllAccounts

      @GET("v1/glaccounts") retrofit2.Call<List<GetGLAccountsResponse>> retrieveAllAccounts(@Query("type") Integer type, @Query("searchParam") String searchParam, @Query("usage") Integer usage, @Query("manualEntriesAllowed") Boolean manualEntriesAllowed, @Query("disabled") Boolean disabled, @Query("fetchRunningBalance") Boolean fetchRunningBalance, @HeaderMap Map<String,String> headers)
      List General Ledger Account ARGUMENTS type Integer optional manualEntriesAllowed boolean optional usage Integer optional disabled boolean optional parentId Long optional tagId Long optional Example Requests: glaccounts glaccounts?type=1&manualEntriesAllowed=true&usage=1&disabled=false glaccounts?fetchRunningBalance=true
      Parameters:
      type - type (optional)
      searchParam - searchParam (optional)
      usage - usage (optional)
      manualEntriesAllowed - manualEntriesAllowed (optional)
      disabled - disabled (optional)
      fetchRunningBalance - fetchRunningBalance (optional)
      Returns:
      Call<List<GetGLAccountsResponse>>

    • retrieveNewAccountDetails

      @GET("v1/glaccounts/template") retrofit2.Call<GetGLAccountsTemplateResponse> retrieveNewAccountDetails(@Query("type") Integer type, @HeaderMap Map<String,String> headers)
      Retrieve GL Accounts 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: glaccounts/template glaccounts/template?type=1 type is optional and integer value from 1 to 5. 1.Assets 2.Liabilities 3.Equity 4.Income 5.Expenses
      Parameters:
      type - type (optional)
      Returns:
      Call<GetGLAccountsTemplateResponse>

    • updateGLAccount1

      @Headers("Content-Type:application/json") @PUT("v1/glaccounts/{glAccountId}") retrofit2.Call<PutGLAccountsResponse> updateGLAccount1(@Path("glAccountId") Long glAccountId, @Body PutGLAccountsRequest putGLAccountsRequest, @HeaderMap Map<String,String> headers)
      Update a GL Account Updates a GL Account
      Parameters:
      glAccountId - glAccountId (required)
      putGLAccountsRequest - (optional)
      Returns:
      Call<PutGLAccountsResponse>

    • createGLAccount1

      @Headers("Content-Type:application/json") @POST("v1/glaccounts") retrofit2.Call<PostGLAccountsResponse> createGLAccount1(@HeaderMap Map<String,String> headers)
      Create a General Ledger Account Note: You may optionally create Hierarchical Chart of Accounts by using the \"parentId\" property of an Account Mandatory Fields: name, glCode, type, usage and manualEntriesAllowed
      Parameters:
      postGLAccountsRequest - (optional)
      Returns:
      Call<PostGLAccountsResponse>

    • updateGLAccount1

      @Headers("Content-Type:application/json") @PUT("v1/glaccounts/{glAccountId}") retrofit2.Call<PutGLAccountsResponse> updateGLAccount1(@Path("glAccountId") Long glAccountId, @HeaderMap Map<String,String> headers)
      Update a GL Account Updates a GL Account
      Parameters:
      glAccountId - glAccountId (required)
      putGLAccountsRequest - (optional)
      Returns:
      Call<PutGLAccountsResponse>