Read a period's accounting-tool export status
well_get_period_ledger_export_statusShow which of a fiscal period's journal entries are already on the connected accounting tool and which are not, grouped by journal type, checked against the tool's own records. It sends nothing and needs no close run. Use it for a closed month: entries leave draft only when the month closes.
Each tile carries journal_type, entry_count, exported_count and missing_on_connector. missing_on_connector: null means the tool's records were not read, so the state is unknown: never say the entries are there. already_sent: true means every entry is confirmed on the tool.
write_scope says whether Well can post to the tool: available; ungranted (the connection is missing the scope to post: tell the user to reconnect); absent (no accounting tool is connected, or Well cannot send entries to the one connected yet). This read never sends the entries: the push stays behind the export card of the month's close.
Take fiscal_year and fiscal_period from a well_list_period_unmatched_invoices or well_list_periods entry; never derive them from a calendar month yourself.
success: false means the status is UNKNOWN. Never say the entries were sent on a failed 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 |
|---|---|---|---|
| fiscal_year | Yes | The fiscal year of the period. | |
| 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. | |
| fiscal_period | Yes | The fiscal period, month 1-12. | |
| 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 | ||
| tiles | Yes | ||
| success | Yes | ||
| fiscal_year | Yes | ||
| write_scope | No | ||
| already_sent | Yes | ||
| fiscal_period | Yes | ||
| connector_slug | 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. | |
| 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. |