Update invoice design
well_update_invoice_designSet one invoice's design: the layout it prints in, the ink, the language, whether a customer-portal address is printed, and which note, tax rate and payment means back the payment-terms, tax-regime, legal-mentions and payment-means rows.
REQUIRED: invoice_id. OPTIONAL (only pass fields you are changing; an omitted field is left unchanged):
design_layout, design_theme, design_locale, design_customer_portal — a choice from the closed set
well_show_invoice_designreturns underlayoutsand the inline field options.design_payment_terms_note_id, design_tax_rate_id, design_legal_mentions_note_id, design_payment_means_id — the UUID of a note / tax rate / payment means ALREADY in this workspace, or null to clear the choice. A record from another workspace, or one that does not exist, is refused rather than silently ignored.
When a person selects a listed payment account, pass that account's payment_means_id as design_payment_means_id. Never call with only invoice_id: no design fields means nothing is saved. This does not mint a customer-portal address — it records the PREFERENCE a later mint reads. Call well_show_invoice_design first to see which payment means can carry one today.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| invoice_id | Yes | The UUID of the invoice to update. | |
| design_theme | No | ||
| workspace_id | No | Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several — a write lands in exactly one workspace and this call would not say which. | |
| design_layout | No | ||
| design_locale | No | ||
| 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. | |
| idempotency_key | No | Optional client-supplied key. A retried write with the same key returns the original result instead of re-applying the operation. | |
| 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. | |
| design_tax_rate_id | No | ||
| design_customer_portal | No | ||
| design_payment_means_id | No | ||
| design_payment_terms_note_id | No | ||
| design_legal_mentions_note_id | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | ||
| error | No | ||
| success | Yes | ||
| invoice_id | No | ||
| failure_class | No | ||
| 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. | |
| 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. |