Get workspace invoice design offer
well_get_workspace_invoice_design_offerRead what a built invoice template would reuse from the invoice it was built from, before the user keeps it as the workspace's design.
Pass the template's document_id. The result lists the logo cut from the invoice (logo_present), the legal mentions text printed on it (legal_mentions, one line per line), the company that issued the invoice (issuer_name), and issuer_relation: own_company when that company is the workspace's own, other_company when it is a different company such as a supplier, unknown when nothing proves whose invoice it was. starts_kept is true only for own_company.
Show the user this list in plain words BEFORE the keep: the mentions text itself, the issuer's name, and, when issuer_relation is not own_company, say that the invoice is not the workspace's own. Ask whether to keep or remove the logo and whether to keep or remove the mentions; for other_company or unknown, both start as removed. When legal_mentions_unverified is true, the reading found no mentions on an invoice that is not the workspace's own, yet the template may still print a footer copied from it: tell the user so, and offer a revision that removes that footer before the keep. Then call well_create_workspace_invoice_design with the answers, the same issuer_relation and the same offer_token. This tool changes nothing.
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 |
|---|---|---|---|
| document_id | Yes | The built template the user may keep. | |
| 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. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | ||
| success | Yes | ||
| issuer_name | No | The company that issued the invoice, as the page names it. | |
| offer_token | No | Names this offer. Pass it unchanged to the keep: a keep with another token is refused. | |
| starts_kept | No | Whether the logo and the mentions start as kept: only for the workspace's own invoice. | |
| logo_present | No | Whether a logo was cut from the invoice. | |
| legal_mentions | No | The legal mentions printed on the invoice, or null when it prints none. | |
| refusal_reason | No | The WellError code when the read is refused. | |
| 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. | |
| issuer_relation | No | Whether that company is the workspace's own, another company, or unproven. | |
| 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. | |
| template_document_id | No | ||
| 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. | |
| legal_mentions_unverified | No | True when the invoice is not the workspace's own and the reading found no legal mentions on it: the template may still print a footer copied from the invoice. |