Delete document derived records
well_delete_document_derived_recordsDelete the transactions and payslips a deleted document created (soft delete). A statement's import creates transactions; a payslip file creates its payslip.
Use this tool only as the next_step of well_delete_document, once the person said yes to deleting those rows too, in their request or after Well asked. Never call it unasked.
REQUIRED: document_id, the id of the deleted document.
A row stays when it falls in a closed period or has no date, a connected tool also synced it, a ledger entry books it, it is matched to an invoice, a receipt or a payslip, or an expense note or a shared-expense repayment points at it. The call fails and deletes nothing when the document is still in Well or none of its rows can go. The person confirms on a card before anything is removed.
Returns { success: true, document_id, removed: { transactions, payslips }, kept: { transactions, payslips } }, where kept counts the rows that stayed per reason, or { success: false, error } on failure.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| document_id | Yes | The deleted document whose transactions and payslips to delete. | |
| 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 |
|---|---|---|---|
| code | No | ||
| kept | No | ||
| error | No | ||
| removed | No | ||
| success | Yes | ||
| document_id | No | ||
| reply_lines | 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. | |
| near_candidates | No | ||
| 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. | |
| near_candidates_truncated | No |