Add a shared expense
well_create_expense_lineAdd one expense to a shared-expense group: who paid, how much, and how it splits between members. It writes only inside Well and sends nothing.
payer_person_id paid amount (a plain decimal in the group's currency). shares lists every member who owes a part, each with a whole weight: equal weights split equally, a weight of 2 owes twice a weight of 1. The payer is in shares when they owe a part too. The line and its shares are written together, or not at all. Well splits the amount exactly by weight: never compute the parts yourself.
Call it only after the person said yes to this expense and its split, in this conversation.
Read outcome: written with expense_line_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 | What the payer paid, a plain decimal such as 90 or 12.50, in the group's currency. | |
| shares | Yes | Every member who owes a part, each once. | |
| currency | Yes | The group's currency. | |
| document_id | No | The receipt in this workspace, when one is on file. | |
| 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. | |
| payer_person_id | Yes | The member who paid. | |
| 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. | |
| expense_line_id | 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. | |
| 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. |