order.list

Orders, optionally filtered.

Lists orders, in GUID order and without their lines, optionally those of one owner (a customer's list includes its jobs' orders), only the open or only the closed, or only the active.

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

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "orders": []
  }
}

Command line

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

It prints:

{
  "orders": []
}

MCP tool call

Tool call:

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

Result:

{
  "structuredContent": {
    "orders": []
  }
}

Effect: read.

Params

Filters for order.list.

owner (Guid or null): Only this owner's orders; a customer or vendor also matches its jobs' orders.
closed (boolean or null): Only open (false) or closed (true) orders.
activeOnly (boolean): Only active orders.

Result

Orders.

orders (array of OrderInfo, required): In GUID order.