list_credit_notes

Retrieve paginated credit notes from Siigo with optional date filters to manage refunds and adjustments efficiently.

Instructions

List credit notes with pagination and optional filters.

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 credit notes 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/credit_notes.py:11-36 (handler)

The core handler function for the 'list_credit_notes' tool. It fetches credit notes from the Siigo API endpoint '/credit-notes' with pagination and optional date range filters.

@mcp.tool
async def list_credit_notes(
    ctx: Context,
    page: int = 1,
    page_size: int = 25,
    date_start: str | None = None,
    date_end: str | None = None,
) -> dict[str, Any]:
    """List credit notes with pagination and optional filters.

    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 credit notes 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("/credit-notes", params=params)

src/siigo_mcp/tools/discovery.py:102-106 (registration)

Registers the list_credit_notes function (and related credit note tools) in the dynamic tool functions map used for lazy loading.

# Credit notes
"list_credit_notes": credit_notes.list_credit_notes,
"get_credit_note": credit_notes.get_credit_note,
"create_credit_note": credit_notes.create_credit_note,
"get_credit_note_pdf": credit_notes.get_credit_note_pdf,

src/siigo_mcp/tools/discovery.py:48-52 (schema)

TOOL_INDEX entry providing discovery metadata (name, category, summary) for the list_credit_notes tool, used by list_siigo_tools.

# Credit notes
{"name": "list_credit_notes", "category": "credit_notes", "summary": "List credit notes with pagination"},
{"name": "get_credit_note", "category": "credit_notes", "summary": "Get a credit note by ID"},
{"name": "create_credit_note", "category": "credit_notes", "summary": "Create a new credit note"},
{"name": "get_credit_note_pdf", "category": "credit_notes", "summary": "Download credit note as PDF"},

Siigo MCP Server