billTerm.list

Billing terms; frozen copies made by posting only on request.

Lists the visible billing terms, by name. Posting a document freezes a copy of its term, so that editing the term later leaves posted documents alone. These copies are invisible and are listed only with includeFrozen.

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":"billTerm.list","params":{}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "billTerms": [
      {
        "name": "Net30",
        "type": "days",
        "dueDays": 30,
        "…": "…"
      },
      {
        "name": "Prox15",
        "type": "proximo",
        "…": "…"
      }
    ]
  }
}

Command line

red-ale exec --book book.gnucash billTerm.list

It prints:

{
  "billTerms": [
    {
      "name": "Net30",
      "type": "days",
      "dueDays": 30,
      "…": "…"
    },
    {
      "name": "Prox15",
      "type": "proximo",
      "…": "…"
    }
  ]
}

MCP tool call

Tool call:

{"name":"billTerm.list","arguments":{}}

Result:

{
  "structuredContent": {
    "billTerms": [
      {
        "name": "Net30",
        "type": "days",
        "dueDays": 30,
        "…": "…"
      },
      {
        "name": "Prox15",
        "type": "proximo",
        "…": "…"
      }
    ]
  }
}

Effect: read.

Params

Params of the lists of tax tables and billing terms.

includeFrozen (boolean): Include the invisible frozen copies posting makes.

Result

Billing terms.

billTerms (array of BillTermInfo, required): Sorted by name, then description, then GUID, as GnuCash lists them.