vendor.get

A vendor.

Returns one vendor by GUID.

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.get","params":{"vendor":"9697710198334d558a9bfde219bb1e41"}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "guid": "9697710198334d558a9bfde219bb1e41",
    "id": "000001",
    "name": "Paper Supplies",
    "taxIncluded": "yes",
    "active": true,
    "…": "…"
  }
}

Command line

red-ale exec --book book.gnucash vendor.get '{"vendor":"9697710198334d558a9bfde219bb1e41"}'

It prints:

{
  "guid": "9697710198334d558a9bfde219bb1e41",
  "id": "000001",
  "name": "Paper Supplies",
  "taxIncluded": "yes",
  "active": true,
  "…": "…"
}

MCP tool call

Tool call:

{"name":"vendor.get","arguments":{"vendor":"9697710198334d558a9bfde219bb1e41"}}

Result:

{
  "structuredContent": {
    "guid": "9697710198334d558a9bfde219bb1e41",
    "id": "000001",
    "name": "Paper Supplies",
    "taxIncluded": "yes",
    "active": true,
    "…": "…"
  }
}

Effect: read.

Params

Names one vendor.

vendor (Guid, required): The vendor.

Result

A vendor.

guid (Guid, required): A GUID: 32 hexadecimal digits.
id (string, required)
name (string, required)
addr (AddressInfo, required): An address. Empty strings are unset fields.
notes (string, required)
currency (CommodityId or null)
terms (Guid or null)
taxTable (Guid or null)
taxTableOverride (boolean, required)
taxIncluded (TaxIncludedWire, required): Whether prices include tax by default for the contact's documents.
active (boolean, required)