Skip to main content

Retrieve Journal Transactions

Retrieves a list of journal transactions (grouped journal entries). Each transaction contains multiple debit and credit entries.

Command Name

RetrieveJournalTransactionsQuery

Endpoint

POST /api/core/cmd

Request Parameters

ParameterTypeRequiredDescription
startDatedatetimeNoStart date for filtering
endDatedatetimeNoEnd date for filtering
searchTextstringNoSearch by transaction ID or username
pageNumberintegerNoPage number (default: 1)
pageSizeintegerNoItems per page (default: 20)
isExportbooleanNoExport all results (default: false)

Request Example

{
"Cmd": "RetrieveJournalTransactionsQuery",
"Data": {
"startDate": "2024-01-01",
"endDate": "2024-01-31",
"searchText": "admin",
"pageNumber": 1,
"pageSize": 20
}
}

Response Structure

{
"IsSuccessful": true,
"StatusCode": "00",
"Message": "Journal transactions retrieved successfully.",
"Data": {
"items": [
{
"Id": 789,
"TransactionId": "JT/2024/000789",
"TransactionDate": "2024-01-15 10:30:00",
"BookingDate": "2024-01-15T10:30:00",
"TransactionType": 1,
"TransactionTypeDesc": "Manual Journal Entry",
"Amount": 50000.00,
"Entries": 4,
"UserName": "admin@banklingo.com",
"UserEncodedKey": "8a8e8e8e8e8e8e8e",
"IsManualPosting": true,
"IsReversed": false,
"IsAReversedTransaction": false,
"Remarks": "Monthly salary entries"
}
],
"totalRows": 25,
"totalPages": 2,
"pageSize": 20,
"currentPage": 1
},
"HasNext": true,
"HasPrevious": false
}

Response Fields

FieldTypeDescription
IdlongUnique transaction ID
TransactionIdstringHuman-readable transaction reference
TransactionDatestringFormatted transaction date
BookingDatedatetimeRaw booking date
TransactionTypeintegerTransaction type enum
TransactionTypeDescstringDescription of transaction type
AmountdecimalTotal debit amount
EntriesintegerNumber of journal entries in this transaction
UserNamestringUser who created the transaction
UserEncodedKeystringEncoded key of the user
IsManualPostingbooleanTrue if manually posted
IsReversedbooleanTrue if this transaction has been reversed
IsAReversedTransactionbooleanTrue if this is a reversal of another transaction
RemarksstringTransaction remarks