docLink.documents

Invoices, bills and vouchers with a document link, with the URI each one opens.

Lists the business documents (invoices, bills and expense vouchers) that have a document link, with the URI each one opens. It is the counterpart of docLink.transactions for the business side.

Examples

Example: with a copy of the reports/test-data example book open as book.gnucash.

JSON-RPC

Request:

{"jsonrpc":"2.0","id":1,"method":"docLink.documents","params":{}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "pathHead": null,
    "links": []
  }
}

Command line

red-ale exec --book book.gnucash docLink.documents

It prints:

{
  "pathHead": null,
  "links": []
}

MCP tool call

Tool call:

{"name":"docLink.documents","arguments":{}}

Result:

{
  "structuredContent": {
    "pathHead": null,
    "links": []
  }
}

Effect: read.

Params

Params for methods that take none.

Type: NoParams.

Result

The links of one kind, with the path head they were resolved against.

pathHead (string or null): The configured path head, if any.
links (array of DocumentLink, required): The links.