Create invoice template
well_create_invoice_templateStart building a reusable invoice template from one of the user's own invoices, a PDF already uploaded to this workspace.
Pass the document_id of that PDF. The build reads every page's text, fonts, colours, rules and boxes, marks which of them carry the invoice's data, and assembles a template that copies everything else from the page. It renders the template back and compares it against the original; a template that fails a check goes back for repair, and only one that passes every check is judged by a reviewer. The PDF may run over several pages of one size, at most 30, and must carry a real text layer: a scanned image fails the job with that reason.
This returns as soon as the job is queued; it does not wait for the template. Asking twice for the same PDF while a build runs returns the same job. A build that cannot finish within its time and cost limits stops without a template; offer the built-in designs instead. A build waits its turn when the service is busy, and one that never gets a turn before the queue's last delivery also ends without a template.
A finished template is NOT usable yet. It lands awaiting review, and only the user's own keep, after seeing it beside their invoice, makes it the workspace's design: call well_create_workspace_invoice_design only once the user said to keep it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| document_id | Yes | The user's own invoice PDF the template is modelled on. | |
| 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. | |
| 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. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | ||
| success | Yes | ||
| refusal_reason | No | The WellError code when the write 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. | |
| 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. | |
| enrichment_task_id | No | The queued job, for correlating its later result. | |
| conversation_id_note | No | Present only when the server opened a fresh lane, stating that no choice recorded earlier was read. | |
| reference_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. |