Method

billTerm.get

A billing term, with its family links.

Returns one billing term, by GUID or by the name of a visible one. refcount counts the customers, vendors and documents using it; parent and child link it to its frozen copy (see billTerm.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":"billTerm.get","params":{"billTerm":"Prox15"}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "name": "Prox15",
    "type": "proximo",
    "dueDays": 15,
    "cutoff": 25,
    "…": "…"
  }
}

Command line

red-ale exec --book book.gnucash billTerm.get '{"billTerm":"Prox15"}'

It prints:

{
  "name": "Prox15",
  "type": "proximo",
  "dueDays": 15,
  "cutoff": 25,
  "…": "…"
}

MCP tool call

Tool call:

{"name":"billTerm.get","arguments":{"billTerm":"Prox15"}}

Result:

{
  "structuredContent": {
    "name": "Prox15",
    "type": "proximo",
    "dueDays": 15,
    "cutoff": 25,
    "…": "…"
  }
}

Effect: read.

Params

Names one billing term.

  • billTerm (BillTermRef, required): The billing term.

Result

A billing term.

  • guid (Guid, required): Its GUID.
  • name (string, required): Its name; frozen copies share their parent's.
  • description (string, required): Description.
  • type (BillTermTypeWire or null): Days or proximo; absent for a term whose type was never set.
  • dueDays (integer (int64), required): Days until due, or the proximo due day.
  • discountDays (integer (int64), required): Discount days, or the proximo discount day.
  • discount (Amount, required): Discount percentage.
  • cutoff (integer (int64), required): Proximo cutoff day.
  • refcount (integer (int64), required): How many customers, vendors and documents use it (always 0 for a frozen copy).
  • invisible (boolean, required): True for frozen copies.
  • parent (Guid or null): The term it is a frozen copy of.
  • child (Guid or null): Its current frozen copy.