vendor.list

Vendors, optionally filtered by name, ID or active state.

Lists vendors, in GUID order, optionally only the active ones, those whose name contains some text (any case) or those with an exact ID. IDs are not unique in GnuCash, so an id may match more than one vendor.

Examples

Example: with a copy of the synthetic/business-editable example book open as book.gnucash.

JSON-RPC

Request:

{"jsonrpc":"2.0","id":1,"method":"vendor.list","params":{"id":"000001"}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "vendors": [
      {
        "guid": "9697710198334d558a9bfde219bb1e41",
        "name": "Paper Supplies",
        "…": "…"
      }
    ]
  }
}

Command line

red-ale exec --book book.gnucash vendor.list '{"id":"000001"}'

It prints:

{
  "vendors": [
    {
      "guid": "9697710198334d558a9bfde219bb1e41",
      "name": "Paper Supplies",
      "…": "…"
    }
  ]
}

MCP tool call

Tool call:

{"name":"vendor.list","arguments":{"id":"000001"}}

Result:

{
  "structuredContent": {
    "vendors": [
      {
        "guid": "9697710198334d558a9bfde219bb1e41",
        "name": "Paper Supplies",
        "…": "…"
      }
    ]
  }
}

Effect: read.

Params

Filters for the contact lists. All given filters must match.

activeOnly (boolean): Only active contacts.
name (string or null): Case-insensitive part of the name.
id (string or null): The exact ID. IDs are not unique in GnuCash, so several may match.

Result

Vendors.

vendors (array of VendorInfo, required): In GUID order.