List journal entries

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, by tag with tagIds, and by creationSource or creationSources, 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid

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

date

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

date

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

string

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

string
enum

Only return Journal Entries with the specified creation source.

Allowed:
creationSources
array of strings

Comma-separated list of creation sources. Only return Journal Entries whose creation source matches one of the specified values.

creationSources
Allowed:
string
enum

The sort order for the results.

string
enum

Comma-separated list of expandable paths.

string

token for pagination

string

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

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.

double

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

double

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

ledgerIdGroups
array of strings

A comma-separated list of ledger IDs forming one group. Repeat the parameter to send more groups (ledgerIdGroups=a,b&ledgerIdGroups=c): each occurrence is one group. Only return Journal Entries where at least one Line Entry belongs to one of the ledgers in each group, so multiple groups return the intersection of the matches.

ledgerIdGroups
integer
1 to 1000
Defaults to 50

The maximum number of journal entries to return per page, from 1 to 1000. Defaults to 50.

tagIds
array of strings

Comma-separated list of tag IDs. Only return Journal Entries with at least one of the specified tags.

tagIds
categorizationStatus
array of strings

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

categorizationStatus
Allowed:
reviewStatus
array of strings

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

reviewStatus
Allowed:
categorizationMethod
array of strings

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.

categorizationMethod
Allowed:
Responses

400

Invalid categorizationMethod or reviewStatus or categorizationStatus or tagIds or limit or ledgerIdGroups or maxAmount or minAmount or amount or keywords or pageToken or expand or journalEntrySort or creationSources or creationSource or ledgerId or endDate or startDate or booksId

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json