Show accounting settings
well_show_accounting_settingsDraw the accounting-setup card so the USER reviews and confirms the workspace's accounting settings: country of incorporation, incorporation date, tax ID, fiscal year start, base currency, and accounting framework.
This is the tool for every step that asks the user to complete, review, or CONFIRM the accounting settings — the close-books settings step, an onboarding "set up your books" step. It DRAWS the card, shows each row's provenance and the stored "Suggested" fills, lets the user edit what is wrong, and waits for their Confirm. Reach for it directly on such a step; do NOT read the settings first with the silent tool and then decide to draw — drawing the card IS the step.
The card gates its Confirm on the required set (fiscal year start and base currency by default; widen it with required when a step needs more). ONLY when a step needs the values WITHOUT the user seeing a card (a silent gate check) call well_get_accounting_settings instead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| title | No | Heading for the accounting-setup card, OVERRIDING the default wording. Use it to frame the step in its flow (e.g. "Confirm your accounting settings for the close"). At most 120 characters. Omit for the default wording. | |
| required | No | The card fields the user MUST fill before Confirm is enabled, as an exact list from ["country","incorporation_date","tax_id","fiscal_year_start_month","base_currency","accounting_framework"]. Omit to gate on the default set ["fiscal_year_start_month","base_currency"]; widen it when a step needs more (never narrow below the default). | |
| subtitle | No | Supporting line under the card's heading. At most 240 characters. Omit for the 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. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | ||
| success | Yes | ||
| required | No | ||
| settings | No | ||
| next_step | No | What to do with the card this result renders. Added by the dispatcher when the card asks for a click. | |
| suggestions | 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. | |
| 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. |