list_journals
Retrieve paginated journal entries (accounting vouchers) from Siigo with date filtering to manage financial records.
Instructions
List journal entries (accounting vouchers) with pagination.
Args: page: Page number (starts at 1) page_size: Number of results per page (max 100) date_start: Filter by start date (YYYY-MM-DD format) date_end: Filter by end date (YYYY-MM-DD format)
Returns paginated list of journal entries with navigation links.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| page_size | No | ||
| date_start | No | ||
| date_end | No |
Implementation Reference
- src/siigo_mcp/tools/journals.py:10-35 (handler)The main handler function for the 'list_journals' tool, decorated with @mcp.tool. It constructs API parameters for pagination and date filtering, then calls the Siigo /journals endpoint.@mcp.tool async def list_journals( ctx: Context, page: int = 1, page_size: int = 25, date_start: str | None = None, date_end: str | None = None, ) -> dict[str, Any]: """List journal entries (accounting vouchers) with pagination. Args: page: Page number (starts at 1) page_size: Number of results per page (max 100) date_start: Filter by start date (YYYY-MM-DD format) date_end: Filter by end date (YYYY-MM-DD format) Returns paginated list of journal entries with navigation links. """ params: dict[str, Any] = {"page": page, "page_size": min(page_size, 100)} if date_start: params["date_start"] = date_start if date_end: params["date_end"] = date_end return await get_client(ctx).get("/journals", params=params)
- Metadata entry in the TOOL_INDEX list providing the tool's name, category, and summary for dynamic discovery in lazy loading mode.{"name": "list_journals", "category": "journals", "summary": "List journal entries with pagination"},
- src/siigo_mcp/tools/discovery.py:108-108 (registration)Registration mapping in the lazy tool loader's _tool_functions dictionary, associating the 'list_journals' name with the imported journals.list_journals function."list_journals": journals.list_journals,