/api/inkle/bookkeeping/group/{group_id}/entity/{entity_id}/interactive_report/variance_explanation/

get

https://api.inkle.io/api/inkle/bookkeeping/group/{group_id}/entity/{entity_id}/interactive_report/variance_explanation/

Get an AI-generated explanation of why a category's (or computed row's) variance changed vs.
the comparison period. If neither category_uuid nor synthetic_row_name is passed, returns a
9-12 sentence overview of the whole report instead.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

entity_id

uuid

required

group_id

uuid

required

Query Params

accounting_method

string

required

Accounting method: ACCRUAL or CASH

category_uuid

string

UUID of the TransactionCategory node (from the report tree's 'uuid' field) to explain. For a computed row (identifier is null in the report response) pass synthetic_row_name instead. If neither category_uuid nor synthetic_row_name is passed, a 9-12 sentence overview of the whole report is returned instead of a single row's explanation.

comparison_report_type

string

required

Comparison type: PREVIOUS_PERIOD or PREVIOUS_YEAR

end_date

string

required

Report period end date (YYYY-MM-DD)

force_regenerate

boolean

If true, bypass any already-stored explanation for this category/row and force a fresh agent call, overwriting the stored explanation. Default false returns the already-stored explanation if one exists.

is_variance_report

boolean

Must match the is_variance_report value passed to interactive_report/new/ when the report being explained was loaded — it changes the PREVIOUS_PERIOD comparison date range and thus the report's cache key; a mismatch means the cached report won't be found.

report_type

string

required

Report type: BALANCE_SHEET, INCOME_STATEMENT, or CASH_FLOW

show_non_zero_accounts

boolean

Whether to only include non-zero accounts

start_date

string

required

Report period start date (YYYY-MM-DD)

synthetic_row_name

string

Name of a computed/synthetic report row with no real category (e.g. 'Gross Profit', 'Net Income', 'Liability & Equity', 'Operating Activities') — the row's 'name' field from the report response when its 'identifier' is null. Use instead of category_uuid for such rows. Omit both this and category_uuid to get a whole-report overview.

Response

200

No response body

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here!