Record an expense repayment
well_create_expense_settlementRecord one repayment in a shared-expense group: a member paid another member back. It records what already happened: it moves no money, writes only inside Well and sends nothing.
from_person_id paid to_person_id the amount (a plain decimal in the group's currency) on settled_on (YYYY-MM-DD), by method_code. Both must be members of the group.
Call it only after the person said yes to recording this repayment, in this conversation.
Read outcome: written with expense_group_settlement_id, or refused means nothing was written. reason names why: group_not_found (no such group in this workspace), person_not_found (a person id names no person of this workspace), not_a_member, payer_not_a_member, from_not_a_member or to_not_a_member (that person is not a member of the group: add them first), currency_mismatch (the group holds one other currency), invalid_amount, invalid_weight, no_shares, duplicate_share, same_person, already_a_member, caller_not_a_member or caller_not_a_person_here (the call names no person of this workspace).
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 |
|---|---|---|---|
| amount | Yes | The amount repaid, a plain decimal in the group's currency. | |
| currency | Yes | The group's currency. | |
| settled_on | Yes | The day of the repayment, YYYY-MM-DD. | |
| method_code | Yes | How the member paid back. | |
| to_person_id | Yes | The member who was paid back. | |
| 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. | |
| from_person_id | Yes | The member who paid back. | |
| 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. | |
| expense_group_id | Yes | The group, a row of `well_list_expense_groups`. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | ||
| reason | No | ||
| outcome | No | ||
| success | Yes | ||
| 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. | |
| expense_group_id | No | ||
| 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. | |
| expense_group_settlement_id | No |