Get expense group balances
well_get_expense_group_balancesGet who owes whom in one shared-expense group: each member's balance and the fewest transfers that settle the group. It writes nothing.
balances gives each member's balance as a signed decimal string in the group's currency: above zero the group owes the member, below zero the member owes the group. The balances sum to zero. transfers lists the fewest payments that bring every balance to zero, each with from_person_id, to_person_id, their names and amount. An empty transfers means the group is settled. Well computes these figures from every expense and repayment of the group: state them as returned.
Read outcome: read, or refused with reason group_not_found (no such group in this workspace) or too_many_rows (the group is too large to compute in one read).
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 |
|---|---|---|---|
| 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. | |
| expense_group_id | Yes | The group, a row of `well_list_expense_groups`. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | ||
| group | No | ||
| reason | No | ||
| outcome | No | ||
| success | Yes | ||
| balances | No | ||
| transfers | 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. | |
| 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. |