List all statement entries
list_entriesRead-onlyIdempotent
Retrieve a flat list of all booked entries from a camt.05x bank statement XML. Supports pagination with offset and limit parameters for browsing large entry lists.
Instructions
List every booked entry across all statements in a camt.05x document.
Use this to get the flat, paginable entry list from a statement. To keep
only the entries carrying a given return-reason code use ``filter_entries``;
for the full nested document structure use ``parse_statement``.
When ``limit`` is ``None`` (the default) the full list of entries is
returned. When ``limit`` is given, a paginated envelope ``{"total",
"offset", "limit", "entries"}`` is returned instead, exposing the
``offset:offset + limit`` slice. A negative ``offset`` or ``limit`` yields
an ``{"error": ...}`` payload.
Args:
xml: The raw statement XML as a string.
offset: The zero-based index of the first entry to return (paginated
mode only; default ``0``).
limit: The maximum number of entries to return, or ``None`` for the
full list (default ``None``).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| xml | Yes | The raw camt.05x statement XML document as a string; every booked entry across all its statements is returned. | |
| limit | No | Maximum number of entries to return, starting at offset. None (the default) returns the full unpaginated list; a non-None value returns a {total, offset, limit, entries} envelope. Must be non-negative. | |
| offset | No | Zero-based index of the first entry to return. Applies only when limit is given; must be non-negative. Defaults to 0. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |