well_preview_invoice_design - Well

Draw invoice designs with the given settings, as the sheet markup the PDF path prints. The invoice-design card calls this when it opens and when a setting changes; it changes nothing.

REQUIRED: layout, theme, locale — the choices well_show_invoice_design returns. OPTIONAL: invoice_id (the invoice being designed: its parties, lines, totals and reference are drawn instead of a sample), payment_means_id (with invoice_id, the chosen account whose coordinates the draft prints), layouts (further designs to draw with the same settings), tax (the chosen regime's percent, whether it exempts, and its name), payment_terms_note_id (the chosen payment-terms note: its full text prints with its variables filled, as on the PDF), payment_means_label (only for a payment means that prints bank coordinates), legal_mentions_note_id (the chosen legal-mentions note: its full text prints with its variables filled, as on the PDF).

Returns data.sheets, one entry per design with its layout, its paper and its sheet_html. The requested layout comes first. The dark theme is a class the mounting page puts on the sheet's wrapper, so sheet_html is the same for both themes.

Name	Required	Description
`tax`	No	The chosen tax regime.
`theme`	Yes	The ink the page is printed in.
`layout`	Yes	The design to draw: one of the compiled designs.
`locale`	Yes	The language and number format of the page.
`layouts`	No	Further designs to draw with the same settings, beside `layout`.
`invoice_id`	No	The invoice being designed. Without it, a sample invoice is drawn.
`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.
`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.
`payment_means_id`	No	The chosen payment means. With invoice_id, the draft prints its coordinates.
`payment_means_label`	No	The chosen payment means' name, only when it prints bank coordinates.
`payment_terms_note_id`	No	The chosen payment-terms note. Its full text prints with its variables filled, as on the PDF.
`legal_mentions_note_id`	No	The chosen legal-mentions note. Its full text prints with its variables filled, as on the PDF.

Name

Required

Description

Default

tax

The chosen tax regime.

theme

Yes

The ink the page is printed in.

layout

Yes

The design to draw: one of the compiled designs.

locale

Yes

The language and number format of the page.

layouts

Further designs to draw with the same settings, beside `layout`.

invoice_id

The invoice being designed. Without it, a sample invoice is drawn.

workspace_id

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.

conversation_id

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

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.

payment_means_id

The chosen payment means. With invoice_id, the draft prints its coordinates.

payment_means_label

The chosen payment means' name, only when it prints bank coordinates.

payment_terms_note_id

The chosen payment-terms note. Its full text prints with its variables filled, as on the PDF.

legal_mentions_note_id

The chosen legal-mentions note. Its full text prints with its variables filled, as on the PDF.

Name	Required	Description
`data`	No
`error`	No
`success`	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.
`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.

Name

Required

Description

Default

data

error

success

Yes

conversation_id

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

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

The workspace that answered, when the caller named none and the token authorizes several.

conversation_id_note

Present only when the server opened a fresh lane, stating that no choice recorded earlier was read.

conversation_id_source

Where the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened.

Previous value: -"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. Start the reply with 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."New value: +"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."

Added value: +{ + "description": "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.", + "enum": [ + "family" + ], + "type": "string" +}

Added value: +{ + "description": "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. Start the reply with 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.", + "items": { + "additionalProperties": false, + "properties": { + "name": { + "type": "string" + }, + "service_id": { + "type": "string" + } + }, + "required": [ + "name", + "service_id" + ], + "type": "object" + }, + "type": "array" +}

Well

Preview invoice design

Input Schema

Output Schema

Schema Changelog

TDQS

Glama MCP Gateway

Resources