Method

order.get

An order with its lines.

Returns one order with its lines.

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.create","params":{"owner":"5b22073fa4e34411b07c14a77147ce6b"}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "…"
}

Request:

{"jsonrpc":"2.0","id":2,"method":"order.get","params":{"order":"00ed0000000000000000000000000001"}}

Response:

{
  "jsonrpc": "2.0",
  "id": 2,
  "result": {
    "id": "000001",
    "closed": false,
    "dateClosed": null,
    "entryCount": 0,
    "entries": [],
    "…": "…"
  }
}

Command line

red-ale exec --book book.gnucash --script - <<'EOF'
order.create {"owner":"5b22073fa4e34411b07c14a77147ce6b"}
order.get {"order":"00ed0000000000000000000000000001"}
EOF

It prints:

[
  "…",
  {
    "id": "000001",
    "closed": false,
    "dateClosed": null,
    "entryCount": 0,
    "entries": [],
    "…": "…"
  }
]

MCP tool call

Tool call:

{"name":"order.create","arguments":{"owner":"5b22073fa4e34411b07c14a77147ce6b"}}

Result:

{
  "content": [
    {
      "type": "text",
      "text": "\"…\""
    }
  ]
}

Tool call:

{"name":"order.get","arguments":{"order":"00ed0000000000000000000000000001"}}

Result:

{
  "structuredContent": {
    "id": "000001",
    "closed": false,
    "dateClosed": null,
    "entryCount": 0,
    "entries": [],
    "…": "…"
  }
}

Effect: read.

Params

Names one order.

  • order (Guid, required): The order.

Result

An order with its lines, in GnuCash's order.

  • guid (Guid, required): A GUID: 32 hexadecimal digits.
  • id (string, required)
  • owner (OwnerInfo, required): An owner: a customer, vendor, employee or job.
  • dateOpened (Timestamp, required): An instant, RFC 3339; written in UTC with a Z suffix.
  • closed (boolean, required)
  • dateClosed (Timestamp or null)
  • notes (string, required)
  • reference (string, required)
  • active (boolean, required)
  • entryCount (integer (uint), required)
  • entries (array of EntryInfo, required): Its lines.