MEmercurytechnologies
Books

List journal entries

Changed on

Returns the journal entries of a Books instance. A journal entry is a balanced set of line entries, each a debit or credit to one ledger, i.e. a general ledger (GL) account in the organization's chart of accounts. Each journal entry includes its ID, datetime, description, creation source, categorization and review status, and the IDs of its line entries; pass expand=lineEntries to include the line entries themselves, with their ledger IDs, amounts, and debit/credit direction. Filter by date range with startDate and endDate, by ledger with ledgerId or ledgerIdGroups, by amount with amount, minAmount, and maxAmount, by description with keywords, and by creationSource, categorizationStatus, reviewStatus, and categorizationMethod. A ledgerId filter must belong to the Books instance. Results are paginated: pass a response's nextPageToken as pageToken to fetch the next page. To read one journal entry by ID, use retrieveBooksJournalEntry; to discover ledger IDs, use getBooksLedgers; to read individual debits and credits across ledgers, use getBooksLineEntries.

get/books/journal-entries

Request

Query parameters

booksIdstring uuid

The Books instance to act on. Must be the token organization's own instance, which it defaults to.

startDatestring date

Only return Journal Entries after the start date (inclusive).

endDatestring date

Only return Journal Entries before the end date (inclusive).

ledgerIdstring base58 (max length 22)

Only return Journal Entries where at least one Line Entry belongs to the specified Ledger.

Example:7JRNsKwy2Lw66caxVU7WGC
creationSource'manual' | 'transaction' | 'accrual' | 'paymentApplication' | 'legacy'

Only return Journal Entries with the specified creation source.

journalEntrySort'descriptionAsc' | 'descriptionDesc' | 'dateTimeAsc' | 'dateTimeDesc' | 'amountAsc' | 'amountDesc' | 'creationDateAsc' | 'creationDateDesc' | 'transactionSourceAccountAsc' | 'transactionSourceAccountDesc' | 'transactionContraLedgerAsc' | 'transactionContraLedgerDesc' | 'tagNameAsc' | 'tagNameDesc' | 'debitLedgerAsc' | 'debitLedgerDesc' | 'creditLedgerAsc' | 'creditLedgerDesc' | 'reconciliationContraLedgerAsc' | 'reconciliationContraLedgerDesc'

The sort order for the results.

expand'lineEntries' | 'lineEntriesTransactions' | 'lineEntriesLedger' | 'lineEntriesOpposingLedgerIds' | 'lineEntriesPaymentApplications' | 'lineEntriesLinePaymentApplications' | 'accrualSource' | 'transfer' | 'autocatResult'

Comma-separated list of expandable paths.

pageTokenstring

token for pagination

keywordsstring

Only return Journal Entries where the description matches the specified keyword(s).

amountnumber double

Only return journal entries with the specified monetary amount. If specified, minAmount and maxAmount parameters are ignored. If no decimal place provided, rounded values will be matched. E.g. an input of 100 will match 100.13 and 100.45, but an input of 100.13 will only match that value.

minAmountnumber double

Only return journal entries with a monetary amount of at least the specified amount. Ignored if amount is set.

maxAmountnumber double

Only return journal entries with a monetary amount less than specified amount. Ignored if amount is set.

ledgerIdGroupsstring[]

One or more comma-separated lists of ledger IDs. Only return Journal Entries where at least one Line Entry belongs to one of the specified ledgers in a group. Specifying multiple groups will return an intersection of the matches.

[
  "7JRNsKwy2Lw66caxVU7WGC"
]
limitinteger

The maximum number of journal entries to return per page.

categorizationStatusstring[]

Comma-separated list of categorization statuses ('pending', 'delayed', 'completed', 'notAttempted'). Only return Journal Entries whose categorization status matches one of the specified values.

reviewStatusstring[]

Comma-separated list of review statuses ('unreviewed', 'reviewed'). Only return Journal Entries whose review status matches one of the specified values.

categorizationMethodstring[]

Comma-separated list of categorization methods ('ai', 'rule', 'user', 'matched', 'uncategorized'). Only return Journal Entries that were categorized by one of the specified methods. 'ai' matches every automatic method except 'rule'; 'user' matches Journal Entries with no live automatic categorization; 'matched' matches payment-application Journal Entries; 'uncategorized' matches Journal Entries with a Line Entry on an Uncategorized ledger. The other values never match the last two.

Response

nextPageTokenstring nullable

Token to fetch the next page of results

prevPageTokenstring nullable

Token to fetch the previous page of results

Changes