fineract-client/org.mifos.fineract.client.apis/JournalEntriesApi

JournalEntriesApi

Functions

abstract suspend fun createGLJournalEntry(command: String? = null, journalEntryCommand: JournalEntryCommand? = null): PostJournalEntriesResponse

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 Responses:

createReversalJournalEntry

abstract suspend fun createReversalJournalEntry(transactionId: String, command: String? = null, postJournalEntriesTransactionIdRequest: PostJournalEntriesTransactionIdRequest? = null): PostJournalEntriesTransactionIdResponse

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 Responses:

getJournalEntriesTemplate

abstract suspend fun getJournalEntriesTemplate(officeId: Long? = null, dateFormat: String? = null)

Responses:

postJournalEntriesTemplate

abstract suspend fun postJournalEntriesTemplate(dateFormat: String, locale: String, uploadedInputStream: MultiPartFormDataContent): String

Responses:

retrieveAll1

abstract suspend fun retrieveAll1(officeId: Long? = null, glAccountId: Long? = null, manualEntriesOnly: Boolean? = null, fromDate: String? = null, toDate: String? = null, submittedOnDateFrom: String? = null, submittedOnDateTo: String? = null, transactionId: String? = null, entityType: Int? = null, offset: Int? = null, limit: Int? = null, orderBy: String? = null, sortOrder: String? = null, locale: String? = null, dateFormat: String? = null, loanId: Long? = null, savingsId: Long? = null, runningBalance: Boolean? = null, transactionDetails: Boolean? = null): GetJournalEntriesTransactionIdResponse

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 Responses:

retrieveJournalEntries

abstract suspend fun retrieveJournalEntries(offset: Int? = null, limit: Int? = null, entryId: Long? = null): String

Responses:

retrieveJournalEntryById

abstract suspend fun retrieveJournalEntryById(journalEntryId: Long, runningBalance: Boolean? = null, transactionDetails: Boolean? = null): JournalEntryTransactionItem

Retrieve a single Entry Example Requests: journalentries/1 journalentries/1?fields=officeName,glAccountId,entryType,amount journalentries/1?runningBalance=true journalentries/1?transactionDetails=true Responses:

retrieveOpeningBalance

abstract suspend fun retrieveOpeningBalance(officeId: Long? = null, currencyCode: String? = null): String

Responses: