List Ledger Entries

get

https://app.moderntreasury.com/api/ledger_entries

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

id[]

array of strings

If you have specific IDs to retrieve in bulk, you can pass them as query parameters delimited with id[]=, for example ?id[]=123&id[]=abc.

id[]

ledger_account_id

string

Shows all ledger entries on an account.

ledger_transaction_id

string

Shows all ledger entries on a transaction.

ledger_account_settlement_id

string

To retrieve the itemized Ledger Entries of an associated settlement, use this query parameter.

effective_at

date

Use gt (>), gte (>=), lt (<), lte (<=), or eq (=) to filter by the transaction's effective at. Format ISO8601.

updated_at

date-time

Use gt (>), gte (>=), lt (<), lte (<=), or eq (=) to filter by the posted at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use updated_at%5Bgt%5D=2000-01-01T12:00:00Z.

created_at

string

Use "gt" (>), "gte" (>=), "'lt" (<), "lte" (<=), or "eq" (=) to filter by the created at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use created_at%5Bgt%5D=2000-01-01T12:00:00Z.

as_of_lock_version

int64

Shows all ledger entries that were present on a ledger account at a particular lock_version. You must also specify ledger_account_id.

ledger_account_category_id

string

Shows all ledger entries for ledger accounts in a particular ledger account category.

ledger_account_statement_id

string

Shows all ledger entries for a particular ledger account statement.

show_deleted

boolean

Defaults to false

If true, response will include ledger entries that were deleted. When you update a ledger transaction to specify a new set of entries, the previous entries are deleted.

direction

string

enum

Get all ledger entries that match the direction specified.

Allowed:

status

string

To query ledger entries by status, use this query parameter. Can be pending, posted, or archived.

status[]

array of strings

To query ledger entries by status, use this query parameter. Can be pending, posted, or archived. For multiple statuses, use status[]=pending&status[]=posted.

status[]

metadata

string

For example, if you want to query for records with metadata key Type and value Loan, the query would be metadata%5BType%5D=Loan. This encodes the query parameters.

after_cursor

string

per_page

int32

Defaults to 25

order_by

string

Order by created_at or effective_at in asc or desc order. For example, to order by effective_at asc, use order_by%5Beffective_at%5D=asc. Ordering by only one field at a time is supported.

show_balances

boolean

If true, response will include the balances attached to the ledger entry. If there is no balance available, null will be returned instead.

amount

object

Use gt (>), gte (>=), lt (<), lte (<=), eq (=), or not_eq (!=) to filter by the ledger entry amount.

Response

200200