Books

List all journal entries

Changed on
get/journal-entries/{booksId}

Request

  • Base URL
    https://api.mercury.com/api/v1
  • URL
    https://api.mercury.com/api/v1/journal-entries/{booksId}
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

booksIdstring uuid required

Query parameters

time_zonestring
start_datestring date

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

end_datestring date

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

ledger_idstring base58 (max length 22)

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

Example:7JRNsKwy2Lw66caxVU7WGC
creation_source'manual' | 'transaction' | 'accrual' | 'legacy'

Only return Journal Entries with the specified creation source.

sort'description' | '-description' | 'datetime' | '-datetime'

A comma separated list of sort orders for the results.

expand'line_entries' | 'line_entries.transaction' | 'line_entries.ledger' | 'line_entries.opposing_ledger_ids' | 'line_entries.payment_applications'

Comma-separated list of expandable paths.

page_tokenstring
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, min_amount and max_amount 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.

min_amountnumber double

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

max_amountnumber double

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

ledger_id_groupsstring[]

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.

Changes