taxTable.get

A tax table, with its lines and family links.

Returns one tax table, by GUID or by the name of a visible one, with its lines and its refcount, the number of customers, vendors and document lines using it. parent and child link a table to its frozen copy: see taxTable.list.

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":"taxTable.get","params":{"taxTable":"GST+Levy"}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "guid": "489200ce534b46379dd206e300012248",
    "name": "GST+Levy",
    "refcount": 1,
    "entries": [
      {
        "accountName": "Liabilities:Levy",
        "type": "value",
        "…": "…"
      },
      {
        "accountName": "Liabilities:Tax",
        "type": "percent",
        "…": "…"
      }
    ],
    "…": "…"
  }
}

Command line

red-ale exec --book book.gnucash taxTable.get '{"taxTable":"GST+Levy"}'

It prints:

{
  "guid": "489200ce534b46379dd206e300012248",
  "name": "GST+Levy",
  "refcount": 1,
  "entries": [
    {
      "accountName": "Liabilities:Levy",
      "type": "value",
      "…": "…"
    },
    {
      "accountName": "Liabilities:Tax",
      "type": "percent",
      "…": "…"
    }
  ],
  "…": "…"
}

MCP tool call

Tool call:

{"name":"taxTable.get","arguments":{"taxTable":"GST+Levy"}}

Result:

{
  "structuredContent": {
    "guid": "489200ce534b46379dd206e300012248",
    "name": "GST+Levy",
    "refcount": 1,
    "entries": [
      {
        "accountName": "Liabilities:Levy",
        "type": "value",
        "…": "…"
      },
      {
        "accountName": "Liabilities:Tax",
        "type": "percent",
        "…": "…"
      }
    ],
    "…": "…"
  }
}

Effect: read.

Params

Names one tax table.

taxTable (TaxTableRef, required): The tax table.

Result

A tax table.

guid (Guid, required): Its GUID.
name (string, required): Its name; frozen copies share their parent's.
refcount (integer (int64), required): How many customers, vendors and lines use it (always 0 for a frozen copy).
invisible (boolean, required): True for frozen copies.
parent (Guid or null): The table it is a frozen copy of.
child (Guid or null): Its current frozen copy, reused by the next posting.
entries (array of TaxLineInfo, required): Lines, sorted by account full name then amount, as GnuCash keeps them.