Rate Statement Conversion
rate_statementReport how well a previously converted bank statement was parsed: submit a 1-5 rating, optionally with structured feedback (only accepted when the rating is 3 or below) and use-case tags. Calling this again for the same document updates your existing rating and clears any previous feedback tied to it. Returns the stored rating state in the response — there is no separate tool to read your own rating back. Every response includes a "summary" field: use it as the single source of truth for what happened.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rating | Yes | 1-5 star rating for this conversion | |
| feedback | No | Free-text feedback. Only accepted when rating is 3 or below. | |
| use_case | No | Tags describing what you use the converted data for. | |
| document_id | Yes | Document ID (from convert_statement or list_statements) | |
| export_format | No | Which output format you exported this conversion to (csv, xlsx, qbo, or xero). | |
| use_case_other | No | Free-text use case, for when "other" is among the use_case tags. | |
| feedback_categories | No | Structured feedback categories. Only accepted when rating is 3 or below. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hint | No | ||
| error | No | ||
| rating | No | ||
| status | Yes | ||
| message | No | ||
| summary | No | ||
| useCase | No | ||
| documentId | No | ||
| hasFeedback | No | ||
| useCaseOther | No |