Package org.apache.fineract.client.services

Interface JournalEntriesApi

public interface JournalEntriesApi

  • Method Details

    • createGLJournalEntry

      @Headers("Content-Type:application/json") @POST("v1/journalentries") retrofit2.Call<PostJournalEntriesResponse> createGLJournalEntry(@Query("command") String command, @Body JournalEntryCommand journalEntryCommand)
      Create \"Balanced\" Journal Entries Note: A Balanced (simple) Journal entry would have atleast one \"Debit\" and one \"Credit\" entry whose amounts are equal Compound Journal entries may have \"n\" debits and \"m\" credits where both \"m\" and \"n\" are greater than 0 and the net sum or all debits and credits are equal Mandatory Fields officeId, transactionDate credits- glAccountId, amount, comments debits- glAccountId, amount, comments Optional Fields paymentTypeId, accountNumber, checkNumber, routingCode, receiptNumber, bankNumber
      Parameters:
      command - command (optional)
      journalEntryCommand - (optional)
      Returns:
      Call<PostJournalEntriesResponse>

    • createReversalJournalEntry

      @Headers("Content-Type:application/json") @POST("v1/journalentries/{transactionId}") retrofit2.Call<PostJournalEntriesTransactionIdResponse> createReversalJournalEntry(@Path("transactionId") String transactionId, @Query("command") String command, @Body PostJournalEntriesTransactionIdRequest postJournalEntriesTransactionIdRequest)
      Update Running balances for Journal Entries This API calculates the running balances for office. If office ID not provided this API calculates running balances for all offices. Mandatory Fields officeId
      Parameters:
      transactionId - transactionId (required)
      command - command (optional)
      postJournalEntriesTransactionIdRequest - (optional)
      Returns:
      Call<PostJournalEntriesTransactionIdResponse>

    • getJournalEntriesTemplate

      @GET("v1/journalentries/downloadtemplate") retrofit2.Call<Void> getJournalEntriesTemplate(@Query("officeId") Long officeId, @Query("dateFormat") String dateFormat)
      Parameters:
      officeId - (optional)
      dateFormat - (optional)
      Returns:
      Call<Void>

    • postJournalEntriesTemplate

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

    • retrieveAll1

      @GET("v1/journalentries") retrofit2.Call<GetJournalEntriesTransactionIdResponse> retrieveAll1(@Query("officeId") Long officeId, @Query("glAccountId") Long glAccountId, @Query("manualEntriesOnly") Boolean manualEntriesOnly, @Query("fromDate") Object fromDate, @Query("toDate") Object toDate, @Query("submittedOnDateFrom") Object submittedOnDateFrom, @Query("submittedOnDateTo") Object submittedOnDateTo, @Query("transactionId") String transactionId, @Query("entityType") Integer entityType, @Query("offset") Integer offset, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder, @Query("locale") String locale, @Query("dateFormat") String dateFormat, @Query("loanId") Long loanId, @Query("savingsId") Long savingsId, @Query("runningBalance") Boolean runningBalance, @Query("transactionDetails") Boolean transactionDetails)
      List Journal Entries The list capability of journal entries can support pagination and sorting. Example Requests: journalentries journalentries?transactionId=PB37X8Y21EQUY4S journalentries?officeId=1&manualEntriesOnly=true&fromDate=1 July 2013&toDate=15 July 2013&dateFormat=dd MMMM yyyy&locale=en journalentries?fields=officeName,glAccountName,transactionDate journalentries?offset=10&limit=50 journalentries?orderBy=transactionId&sortOrder=DESC journalentries?runningBalance=true journalentries?transactionDetails=true journalentries?loanId=12 journalentries?savingsId=24
      Parameters:
      officeId - officeId (optional)
      glAccountId - glAccountId (optional)
      manualEntriesOnly - manualEntriesOnly (optional)
      fromDate - fromDate (optional)
      toDate - toDate (optional)
      submittedOnDateFrom - submittedOnDateFrom (optional)
      submittedOnDateTo - submittedOnDateTo (optional)
      transactionId - transactionId (optional)
      entityType - entityType (optional)
      offset - offset (optional)
      limit - limit (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      locale - locale (optional)
      dateFormat - dateFormat (optional)
      loanId - loanId (optional)
      savingsId - savingsId (optional)
      runningBalance - runningBalance (optional)
      transactionDetails - transactionDetails (optional)
      Returns:
      Call<GetJournalEntriesTransactionIdResponse>

    • retrieveJournalEntries

      @GET("v1/journalentries/provisioning") retrofit2.Call<String> retrieveJournalEntries(@Query("offset") Integer offset, @Query("limit") Integer limit, @Query("entryId") Long entryId)
      Parameters:
      offset - (optional)
      limit - (optional)
      entryId - (optional)
      Returns:
      Call<String>

    • retrieveJournalEntryById

      @GET("v1/journalentries/{journalEntryId}") retrofit2.Call<JournalEntryTransactionItem> retrieveJournalEntryById(@Path("journalEntryId") Long journalEntryId, @Query("runningBalance") Boolean runningBalance, @Query("transactionDetails") Boolean transactionDetails)
      Retrieve a single Entry Example Requests: journalentries/1 journalentries/1?fields=officeName,glAccountId,entryType,amount journalentries/1?runningBalance=true journalentries/1?transactionDetails=true
      Parameters:
      journalEntryId - journalEntryId (required)
      runningBalance - runningBalance (optional)
      transactionDetails - transactionDetails (optional)
      Returns:
      Call<JournalEntryTransactionItem>

    • retrieveOpeningBalance

      @GET("v1/journalentries/openingbalance") retrofit2.Call<String> retrieveOpeningBalance(@Query("officeId") Long officeId, @Query("currencyCode") String currencyCode)
      Parameters:
      officeId - (optional)
      currencyCode - (optional)
      Returns:
      Call<String>

    • createGLJournalEntry

      @Headers("Content-Type:application/json") @POST("v1/journalentries") retrofit2.Call<PostJournalEntriesResponse> createGLJournalEntry(@Query("command") String command)
      Create \"Balanced\" Journal Entries Note: A Balanced (simple) Journal entry would have atleast one \"Debit\" and one \"Credit\" entry whose amounts are equal Compound Journal entries may have \"n\" debits and \"m\" credits where both \"m\" and \"n\" are greater than 0 and the net sum or all debits and credits are equal Mandatory Fields officeId, transactionDate credits- glAccountId, amount, comments debits- glAccountId, amount, comments Optional Fields paymentTypeId, accountNumber, checkNumber, routingCode, receiptNumber, bankNumber
      Parameters:
      command - command (optional)
      journalEntryCommand - (optional)
      Returns:
      Call<PostJournalEntriesResponse>

    • createReversalJournalEntry

      @Headers("Content-Type:application/json") @POST("v1/journalentries/{transactionId}") retrofit2.Call<PostJournalEntriesTransactionIdResponse> createReversalJournalEntry(@Path("transactionId") String transactionId, @Query("command") String command)
      Update Running balances for Journal Entries This API calculates the running balances for office. If office ID not provided this API calculates running balances for all offices. Mandatory Fields officeId
      Parameters:
      transactionId - transactionId (required)
      command - command (optional)
      postJournalEntriesTransactionIdRequest - (optional)
      Returns:
      Call<PostJournalEntriesTransactionIdResponse>

    • createGLJournalEntry

      @Headers("Content-Type:application/json") @POST("v1/journalentries") retrofit2.Call<PostJournalEntriesResponse> createGLJournalEntry(@Query("command") String command, @Body JournalEntryCommand journalEntryCommand, @HeaderMap Map<String,String> headers)
      Create \"Balanced\" Journal Entries Note: A Balanced (simple) Journal entry would have atleast one \"Debit\" and one \"Credit\" entry whose amounts are equal Compound Journal entries may have \"n\" debits and \"m\" credits where both \"m\" and \"n\" are greater than 0 and the net sum or all debits and credits are equal Mandatory Fields officeId, transactionDate credits- glAccountId, amount, comments debits- glAccountId, amount, comments Optional Fields paymentTypeId, accountNumber, checkNumber, routingCode, receiptNumber, bankNumber
      Parameters:
      command - command (optional)
      journalEntryCommand - (optional)
      Returns:
      Call<PostJournalEntriesResponse>

    • createReversalJournalEntry

      @Headers("Content-Type:application/json") @POST("v1/journalentries/{transactionId}") retrofit2.Call<PostJournalEntriesTransactionIdResponse> createReversalJournalEntry(@Path("transactionId") String transactionId, @Query("command") String command, @Body PostJournalEntriesTransactionIdRequest postJournalEntriesTransactionIdRequest, @HeaderMap Map<String,String> headers)
      Update Running balances for Journal Entries This API calculates the running balances for office. If office ID not provided this API calculates running balances for all offices. Mandatory Fields officeId
      Parameters:
      transactionId - transactionId (required)
      command - command (optional)
      postJournalEntriesTransactionIdRequest - (optional)
      Returns:
      Call<PostJournalEntriesTransactionIdResponse>

    • getJournalEntriesTemplate

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

    • postJournalEntriesTemplate

      @Multipart @POST("v1/journalentries/uploadtemplate") retrofit2.Call<String> postJournalEntriesTemplate(@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<String>

    • retrieveAll1

      @GET("v1/journalentries") retrofit2.Call<GetJournalEntriesTransactionIdResponse> retrieveAll1(@Query("officeId") Long officeId, @Query("glAccountId") Long glAccountId, @Query("manualEntriesOnly") Boolean manualEntriesOnly, @Query("fromDate") Object fromDate, @Query("toDate") Object toDate, @Query("submittedOnDateFrom") Object submittedOnDateFrom, @Query("submittedOnDateTo") Object submittedOnDateTo, @Query("transactionId") String transactionId, @Query("entityType") Integer entityType, @Query("offset") Integer offset, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder, @Query("locale") String locale, @Query("dateFormat") String dateFormat, @Query("loanId") Long loanId, @Query("savingsId") Long savingsId, @Query("runningBalance") Boolean runningBalance, @Query("transactionDetails") Boolean transactionDetails, @HeaderMap Map<String,String> headers)
      List Journal Entries The list capability of journal entries can support pagination and sorting. Example Requests: journalentries journalentries?transactionId=PB37X8Y21EQUY4S journalentries?officeId=1&manualEntriesOnly=true&fromDate=1 July 2013&toDate=15 July 2013&dateFormat=dd MMMM yyyy&locale=en journalentries?fields=officeName,glAccountName,transactionDate journalentries?offset=10&limit=50 journalentries?orderBy=transactionId&sortOrder=DESC journalentries?runningBalance=true journalentries?transactionDetails=true journalentries?loanId=12 journalentries?savingsId=24
      Parameters:
      officeId - officeId (optional)
      glAccountId - glAccountId (optional)
      manualEntriesOnly - manualEntriesOnly (optional)
      fromDate - fromDate (optional)
      toDate - toDate (optional)
      submittedOnDateFrom - submittedOnDateFrom (optional)
      submittedOnDateTo - submittedOnDateTo (optional)
      transactionId - transactionId (optional)
      entityType - entityType (optional)
      offset - offset (optional)
      limit - limit (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      locale - locale (optional)
      dateFormat - dateFormat (optional)
      loanId - loanId (optional)
      savingsId - savingsId (optional)
      runningBalance - runningBalance (optional)
      transactionDetails - transactionDetails (optional)
      Returns:
      Call<GetJournalEntriesTransactionIdResponse>

    • retrieveJournalEntries

      @GET("v1/journalentries/provisioning") retrofit2.Call<String> retrieveJournalEntries(@Query("offset") Integer offset, @Query("limit") Integer limit, @Query("entryId") Long entryId, @HeaderMap Map<String,String> headers)
      Parameters:
      offset - (optional)
      limit - (optional)
      entryId - (optional)
      Returns:
      Call<String>

    • retrieveJournalEntryById

      @GET("v1/journalentries/{journalEntryId}") retrofit2.Call<JournalEntryTransactionItem> retrieveJournalEntryById(@Path("journalEntryId") Long journalEntryId, @Query("runningBalance") Boolean runningBalance, @Query("transactionDetails") Boolean transactionDetails, @HeaderMap Map<String,String> headers)
      Retrieve a single Entry Example Requests: journalentries/1 journalentries/1?fields=officeName,glAccountId,entryType,amount journalentries/1?runningBalance=true journalentries/1?transactionDetails=true
      Parameters:
      journalEntryId - journalEntryId (required)
      runningBalance - runningBalance (optional)
      transactionDetails - transactionDetails (optional)
      Returns:
      Call<JournalEntryTransactionItem>

    • retrieveOpeningBalance

      @GET("v1/journalentries/openingbalance") retrofit2.Call<String> retrieveOpeningBalance(@Query("officeId") Long officeId, @Query("currencyCode") String currencyCode, @HeaderMap Map<String,String> headers)
      Parameters:
      officeId - (optional)
      currencyCode - (optional)
      Returns:
      Call<String>

    • createGLJournalEntry

      @Headers("Content-Type:application/json") @POST("v1/journalentries") retrofit2.Call<PostJournalEntriesResponse> createGLJournalEntry(@Query("command") String command, @HeaderMap Map<String,String> headers)
      Create \"Balanced\" Journal Entries Note: A Balanced (simple) Journal entry would have atleast one \"Debit\" and one \"Credit\" entry whose amounts are equal Compound Journal entries may have \"n\" debits and \"m\" credits where both \"m\" and \"n\" are greater than 0 and the net sum or all debits and credits are equal Mandatory Fields officeId, transactionDate credits- glAccountId, amount, comments debits- glAccountId, amount, comments Optional Fields paymentTypeId, accountNumber, checkNumber, routingCode, receiptNumber, bankNumber
      Parameters:
      command - command (optional)
      journalEntryCommand - (optional)
      Returns:
      Call<PostJournalEntriesResponse>

    • createReversalJournalEntry

      @Headers("Content-Type:application/json") @POST("v1/journalentries/{transactionId}") retrofit2.Call<PostJournalEntriesTransactionIdResponse> createReversalJournalEntry(@Path("transactionId") String transactionId, @Query("command") String command, @HeaderMap Map<String,String> headers)
      Update Running balances for Journal Entries This API calculates the running balances for office. If office ID not provided this API calculates running balances for all offices. Mandatory Fields officeId
      Parameters:
      transactionId - transactionId (required)
      command - command (optional)
      postJournalEntriesTransactionIdRequest - (optional)
      Returns:
      Call<PostJournalEntriesTransactionIdResponse>