List payments for a receipt
well_list_receipt_candidatesList the payments a stored receipt may belong to, so the member picks the right one. Call it when the member asks to attach a receipt or an invoice they sent (« rattache-le », "attach it"). It writes nothing.
The document_id is the id of the stored document the member sent. You hold it in the "Attached Document" block of the turn that carries the file. On a later turn (« rattache-le »), take it from the first row of the "Documents this conversation received earlier" block: those are the files this conversation sent, newest first. If you hold no document_id from either block, ask the member which document they mean. Never guess an id, and never take one from a query on the documents records: that table also holds files a connector synced and files other members sent. Always name the receipt the result reads (receipt: supplier, amount, date) in your line, and when it does not match what the member described, say so before anything else.
Read outcome first. It decides the whole reply:
candidates: 1 to 3 payments fit (for example two payments of the same amount on the same day, or matches Well is not sure of). Show each payment (date, payee, amount; add the time or the card when two lines would read the same) as a numbered choice, then one last choice for none of them (none_option). Ask the member to answer with the number. Never pick a payment yourself, even when only one is listed. On WhatsApp the numbered list is drawn under your text, and it names the receipt: write one short line and do not repeat the list.no_candidates: no payment fits yet. Say the receipt stays in Well as a document and that Well attaches it on its own when its payment appears. Ask nothing.already_linked: the receipt already sits onlinked_transaction(or a sure match names it and Well attaches it within the hour). Say it is already attached and name that payment. Do not callwell_link_receipt_to_transaction.extraction_pending: Well is still reading the document. Say so in one line and that you will look again in a moment. Ask nothing, list nothing, and call nothing else for it.ask_document_kind: Well read no receipt or invoice in this document. Ask the member, in one numbered question, what it is: a receipt, a supplier invoice, or something else (document_kinds, in that order). Do not list payments.
When the member answers with the number of a payment, call well_link_receipt_to_transaction with this document_id and that payment's transaction_id. That answer is the member's consent: ask for no other confirmation. When the member picks the last choice (none of them), call nothing: the receipt stays a document, and Well attaches it when a confirmed match appears.
A payment that already holds another document, or that another invoice already settles, is never listed.
Each candidate carries source: provisional_match (the matcher's unsure match), review_candidate (listed by the open reconciliation review) or amount_and_date (same amount and currency, paid near the receipt date). The order is the ranking; keep it.
success: false means the read failed. No payment list exists, so never say the receipt has no payment.
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 stored document of the receipt or invoice the member sent. | |
| 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 | ||
| outcome | No | ||
| receipt | No | ||
| success | Yes | ||
| candidates | No | ||
| document_id | No | ||
| none_option | No | ||
| document_kinds | 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. | |
| document_attached | No | ||
| linked_transaction | No | ||
| 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. |