Render a monthly pivot
well_render_monthly_pivotPut a table of amounts per company and per month onto the monthly-pivot card: one row per company with its logo and name, an optional category column, then one column per month. The running month is drawn apart, at the end, marked as in progress.
This tool measures nothing. Pass a pivot another tool measured, as it is: for subscriptions, the pivots entry of well_measure_subscriptions for the currency you drew the trend in. Never build or edit the rows yourself.
The server reads the running month from its own clock, in UTC, and draws the month_count complete months before it (12 by default). It resolves each row's company from company_id, so the card shows the company's logo and name. A row with a null company_id and a label_means_id is a bank label tied to no company: it is drawn from its name. A payee the company read cannot reach is drawn from the name and domain on its row, as the measure returned them. A row with a null category is drawn as uncategorised.
REFUSED rather than drawn:
more than 50 rows, or two rows for one company or one label
a row with both or neither of
company_idandlabel_means_id, or a label row with nonamean amount keyed outside the drawn months, or keyed by anything but
YYYY-MM, or a negative amount. A measure that ran just before the month changed is refused on its oldest month: run it againa
company_idthis workspace cannot read and whose row carries noname(success: falsenames the ids)a
currencyoutside ISO-4217
A month with no amount draws an empty cell, which reads as "no payment", never as zero.
When the token authorizes one workspace, call this directly — no workspace call is needed first. When it authorizes several, this read will not guess which one you mean: pass workspace_id on the call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rows | Yes | One row per company. | |
| currency | Yes | ISO-4217 code every amount is denominated in. Checked against the catalog, not its shape. | |
| month_count | No | The complete months drawn before the running month. Defaults to 12. | |
| show_totals | No | Draw a totals row under the companies. | |
| workspace_id | No | Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several: this read reports one workspace's own figures and will not choose which. | |
| rows_truncated | No | True when more rows existed than the measure listed. | |
| conversation_id | No | The conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation. | |
| workspace_scope | No | Restrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rows | Yes | ||
| error | No | ||
| months | Yes | ||
| success | Yes | ||
| currency | Yes | ||
| computed_by | Yes | ||
| month_count | Yes | ||
| show_totals | Yes | ||
| current_month | Yes | ||
| rows_truncated | Yes | ||
| conversation_id | No | The conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation. | |
| newly_connected | No | Tools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later. | |
| resolved_workspace | No | The workspace that answered, when the caller named none and the token authorizes several. | |
| unknown_company_ids | No | ||
| conversation_id_note | No | Present only when the server opened a fresh lane, stating that no choice recorded earlier was read. | |
| conversation_id_source | No | Where the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened. |