Package org.apache.fineract.client.services

Interface AccountingClosureApi

public interface AccountingClosureApi

  • Method Details

    • createGLClosure

      @Headers("Content-Type:application/json") @POST("v1/glclosures") retrofit2.Call<PostGlClosuresResponse> createGLClosure(@Body PostGlClosuresRequest postGlClosuresRequest)
      Create an Accounting Closure Mandatory Fields officeId,closingDate
      Parameters:
      postGlClosuresRequest - (required)
      Returns:
      Call<PostGlClosuresResponse>

    • deleteGLClosure

      @DELETE("v1/glclosures/{glClosureId}") retrofit2.Call<DeleteGlClosuresResponse> deleteGLClosure(@Path("glClosureId") Long glClosureId)
      Delete an accounting closure Note: Only the latest accounting closure associated with a branch may be deleted.
      Parameters:
      glClosureId - glclosureId (required)
      Returns:
      Call<DeleteGlClosuresResponse>

    • retreiveClosure

      @GET("v1/glclosures/{glClosureId}") retrofit2.Call<GetGlClosureResponse> retreiveClosure(@Path("glClosureId") Long glClosureId)
      Retrieve an Accounting Closure Example Requests: glclosures/1 /glclosures/1?fields=officeName,closingDate
      Parameters:
      glClosureId - glClosureId (required)
      Returns:
      Call<GetGlClosureResponse>

    • retrieveAllClosures

      @GET("v1/glclosures") retrofit2.Call<List<GetGlClosureResponse>> retrieveAllClosures(@Query("officeId") Long officeId)
      List Accounting closures Example Requests: glclosures
      Parameters:
      officeId - (optional)
      Returns:
      Call<List<GetGlClosureResponse>>

    • updateGLClosure

      @Headers("Content-Type:application/json") @PUT("v1/glclosures/{glClosureId}") retrofit2.Call<PutGlClosuresResponse> updateGLClosure(@Path("glClosureId") Long glClosureId, @Body PutGlClosuresRequest putGlClosuresRequest)
      Update an Accounting closure Once an accounting closure is created, only the comments associated with it may be edited
      Parameters:
      glClosureId - glClosureId (required)
      putGlClosuresRequest - (optional)
      Returns:
      Call<PutGlClosuresResponse>

    • updateGLClosure

      @Headers("Content-Type:application/json") @PUT("v1/glclosures/{glClosureId}") retrofit2.Call<PutGlClosuresResponse> updateGLClosure(@Path("glClosureId") Long glClosureId)
      Update an Accounting closure Once an accounting closure is created, only the comments associated with it may be edited
      Parameters:
      glClosureId - glClosureId (required)
      putGlClosuresRequest - (optional)
      Returns:
      Call<PutGlClosuresResponse>

    • createGLClosure

      @Headers("Content-Type:application/json") @POST("v1/glclosures") retrofit2.Call<PostGlClosuresResponse> createGLClosure(@Body PostGlClosuresRequest postGlClosuresRequest, @HeaderMap Map<String,String> headers)
      Create an Accounting Closure Mandatory Fields officeId,closingDate
      Parameters:
      postGlClosuresRequest - (required)
      Returns:
      Call<PostGlClosuresResponse>

    • deleteGLClosure

      @DELETE("v1/glclosures/{glClosureId}") retrofit2.Call<DeleteGlClosuresResponse> deleteGLClosure(@Path("glClosureId") Long glClosureId, @HeaderMap Map<String,String> headers)
      Delete an accounting closure Note: Only the latest accounting closure associated with a branch may be deleted.
      Parameters:
      glClosureId - glclosureId (required)
      Returns:
      Call<DeleteGlClosuresResponse>

    • retreiveClosure

      @GET("v1/glclosures/{glClosureId}") retrofit2.Call<GetGlClosureResponse> retreiveClosure(@Path("glClosureId") Long glClosureId, @HeaderMap Map<String,String> headers)
      Retrieve an Accounting Closure Example Requests: glclosures/1 /glclosures/1?fields=officeName,closingDate
      Parameters:
      glClosureId - glClosureId (required)
      Returns:
      Call<GetGlClosureResponse>

    • retrieveAllClosures

      @GET("v1/glclosures") retrofit2.Call<List<GetGlClosureResponse>> retrieveAllClosures(@Query("officeId") Long officeId, @HeaderMap Map<String,String> headers)
      List Accounting closures Example Requests: glclosures
      Parameters:
      officeId - (optional)
      Returns:
      Call<List<GetGlClosureResponse>>

    • updateGLClosure

      @Headers("Content-Type:application/json") @PUT("v1/glclosures/{glClosureId}") retrofit2.Call<PutGlClosuresResponse> updateGLClosure(@Path("glClosureId") Long glClosureId, @Body PutGlClosuresRequest putGlClosuresRequest, @HeaderMap Map<String,String> headers)
      Update an Accounting closure Once an accounting closure is created, only the comments associated with it may be edited
      Parameters:
      glClosureId - glClosureId (required)
      putGlClosuresRequest - (optional)
      Returns:
      Call<PutGlClosuresResponse>

    • updateGLClosure

      @Headers("Content-Type:application/json") @PUT("v1/glclosures/{glClosureId}") retrofit2.Call<PutGlClosuresResponse> updateGLClosure(@Path("glClosureId") Long glClosureId, @HeaderMap Map<String,String> headers)
      Update an Accounting closure Once an accounting closure is created, only the comments associated with it may be edited
      Parameters:
      glClosureId - glClosureId (required)
      putGlClosuresRequest - (optional)
      Returns:
      Call<PutGlClosuresResponse>