List Ledger Transactions

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.

To query ledger transactions by their ledger_id, use this query parameter.

To query ledger transactions by the presence of a ledger account on either side of the transaction, use this query parameter.

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.

Use gt (>), gte (>=), lt (<), lte (<=), or eq (=) to filter by effective_at. For example, for all dates after Jan 1 2000, use effective_at%5Bgt%5D=2000-01-01T00:00:00.000.

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 posted_at%5Bgt%5D=2000-01-01T12:00:00Z.

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.

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.

Order by created_ator 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.

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

To query ledger transactions by multiple statuses, use this query parameter delimited with status[]=. Can be pending, posted, or archived.

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

To find reversal ledger transactions that reverses a ledger transaction, use this parameter.

To query ledger transactions that were auto-archived; currently only 'balance_lock_failure' for transactions that violated balance constraints.

If the ledger transaction can be reconciled to another object in Modern Treasury, the ID of the ledgerable can be used to query the ledger transactions.

If the ledger transaction can be reconciled to another object in Modern Treasury, the type of the ledgerable can be used to query the ledger transactions.

Use gt (>), gte (>=), lt (<), lte (<=), eq (=), or not_eq (!=) to filter by the ledger transaction amount. Only supported for single currency transactions.