Docs / Reference / read: ledger

read: ledger.

A strategy, the window to every move, action, forecast, effect and impact in order, with the budget spent by kind

Figure 1POST /v1/read/ledgerspecified

The caller sends LedgerInput to /v1/read/ledger. The platform returns a card whose body is Ledger.

POST/v1/read/ledger

Read a strategy’s ledger. The call needs the strategy rung under a token with the read grant, and it is served by either, by the size bound.

The route takes LedgerInput and returns a card whose body is Ledger.

Request body#

The request body is LedgerInput.

field	type	required	note
`strategy`	`id`	yes
`window`	Window	yes

Response#

The route returns a card whose body is Ledger. Every card ends with a foot that states the basis of each number, the scope of the call, and the time when the facts were true.

Headers#

header	required	meaning
`Scale-Scope`	yes	the scope the call runs in: tenant/, then /brand/, then /strategy/
`Scale-As-True-On`	no	the date the facts must have been true on; defaults to now
`Scale-As-Known-On`	no	the date the facts must have been known on; defaults to now
`Scale-Key`	no	for a change, the key made from the input; a repeat under the same key returns the unit held and writes nothing

A caller needs the strategy rung and a token with the read grant. The platform or the desktop app serves this route.

Example#

The example sends the smallest body that LedgerInput allows. The build validates it against the schema of LedgerInput.

Example

curl -X POST https://api.scaleintelligence.co/v1/read/ledger \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "strategy": "…", "window": { "from": "…", "to": "…" } }'

import { client } from "@scale/sdk";
const answer = await client.read.ledger({
    "strategy": "…",
    "window": {
      "from": "…",
      "to": "…"
    }
  });
// answer.body is a Ledger. answer.foot holds the basis, the scope and the time.

import requests
answer = requests.post("https://api.scaleintelligence.co/v1/read/ledger",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "strategy": "…",
      "window": {
        "from": "…",
        "to": "…"
      }
    }).json()

let answer: Card = client.post("https://api.scaleintelligence.co/v1/read/ledger")
    .header("Scale-Key", key).header("Scale-Scope", "tenant/<id>")
    .json(&LedgerInput { /* the fields of the page */ }).send().await?.json().await?;

MCP tool#

The MCP tool si.read.ledger takes the same input and returns the same card. The tool only reads data. An MCP host that renders cards draws this card from ui://scale-intelligence/cards/Ledger. The tool’s page describes it.

POST /v1/read/ledger
Scale-Scope: …
Scale-As-True-On: …
Scale-As-Known-On: …
Scale-Key: …
content-type: application/json

{
  "strategy": "…",
  "window": {
    "from": "…",
    "to": "…"
  }
}

Without a key, this page shows the request only. The request body is LedgerInput, and the route returns a card whose body is Ledger.

Claims#

claim	state	route or tool
The platform serves the route /v1/read/ledger at contract 0476e35e6e275db5.	target	`/v1/read/ledger`