Retrieve Journal Entries

Retrieves a paginated and filterable list of journal entries with detailed account information.

Command Name

RetrieveJournalEntriesQuery

Endpoint

POST /api/core/cmd

Request Parameters

Parameter	Type	Required	Description
currencyCode	string	No	Filter by currency code (e.g., "NGN", "USD")
startDate	datetime	No	Start date for filtering (inclusive)
endDate	datetime	No	End date for filtering (inclusive)
searchText	string	No	Search by GL Code or Transaction Reference
glCode	string	No	Filter by specific General Ledger code
branchId	long	No	Filter by branch ID (omit for all branches)
pageNumber	integer	No	Page number for pagination (default: 1)
pageSize	integer	No	Number of items per page (default: 20)
isExport	boolean	No	Export all results without pagination (default: false)

Request Example

{
  "Cmd": "RetrieveJournalEntriesQuery",
  "Data": {
    "currencyCode": "NGN",
    "startDate": "2024-01-01",
    "endDate": "2024-12-31",
    "searchText": "SAL",
    "pageNumber": 1,
    "pageSize": 50
  }
}

Response Structure

{
  "IsSuccessful": true,
  "StatusCode": "00",
  "Message": "Journal entries retrieved successfully.",
  "Data": {
    "items": [
      {
        "Id": 12345,
        "GLCode": "1001",
        "AccountName": "Cash at Bank",
        "AccountTypeId": 1,
        "AccountTypeDescription": "Asset",
        "JournalEntryType": 1,
        "JournalEntryTypeDescription": "Debit",
        "DebitAmount": "50000.00",
        "CreditAmount": "",
        "CurrencyCode": "NGN",
        "BranchName": "Head Office",
        "TransactionReference": "SAL/2024/001",
        "AccountDescription": "Salary Payment January 2024",
        "BookingDate": "2024-01-15 10:30:00",
        "JournalTransactionId": 789,
        "TransactionEncodedKey": "8a8e8e8e8e8e8e8e",
        "Notes": "Monthly salary disbursement"
      }
    ],
    "totalRows": 150,
    "totalPages": 3,
    "pageSize": 50,
    "currentPage": 1
  },
  "HasNext": true,
  "HasPrevious": false
}

Response Fields

Field	Type	Description
Id	long	Unique journal entry ID
GLCode	string	General ledger account code
AccountName	string	Name of the GL account
AccountTypeId	integer	Account type enum value (1=Asset, 2=Liability, 3=Equity, 4=Income, 5=Expense)
AccountTypeDescription	string	Human-readable account type
JournalEntryType	integer	Entry type (1=Debit, 2=Credit)
JournalEntryTypeDescription	string	"Debit" or "Credit"
DebitAmount	string	Formatted debit amount (empty if credit)
CreditAmount	string	Formatted credit amount (empty if debit)
CurrencyCode	string	Three-letter currency code
BranchName	string	Name of the branch
TransactionReference	string	Unique transaction reference
AccountDescription	string	Description/narration of the entry
BookingDate	string	Formatted booking date
JournalTransactionId	long	Parent transaction ID (groups related entries)
TransactionEncodedKey	string	Encoded key for the entry
Notes	string	Additional notes

Use Case Example

Retrieve all journal entries for month-end reporting:

{
  "Cmd": "RetrieveJournalEntriesQuery",
  "Data": {
    "startDate": "2024-01-01",
    "endDate": "2024-01-31",
    "isExport": true,
    "currencyCode": "NGN"
  }
}