get_credit_note
Retrieve detailed credit note information by ID from the Siigo electronic invoicing system. Use this tool to access specific credit note data for accounting or customer service purposes.
Instructions
Get a credit note by ID.
Args: credit_note_id: The credit note's GUID
Returns the full credit note details.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| credit_note_id | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- The handler function decorated with @mcp.tool that implements the logic to fetch a credit note by ID from the Siigo API.
@mcp.tool async def get_credit_note(ctx: Context, credit_note_id: str) -> dict[str, Any]: """Get a credit note by ID. Args: credit_note_id: The credit note's GUID Returns the full credit note details. """ return await get_client(ctx).get(f"/credit-notes/{credit_note_id}") - src/siigo_mcp/tools/discovery.py:103-106 (registration)Registration of the get_credit_note tool (and related credit notes tools) in the lazy-loading tool functions dictionary.
"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, - Schema-like entry in TOOL_INDEX providing name, category, and summary for discovery of the get_credit_note tool.
{"name": "get_credit_note", "category": "credit_notes", "summary": "Get a credit note by ID"}, - src/siigo_mcp/tools/discovery.py:69-69 (registration)Import of the credit_notes module containing the get_credit_note handler.
from siigo_mcp.tools import reference, customers, products, invoices, credit_notes, journals