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

post

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

Export the variance report to a multi-tab Excel workbook: a Flux Summary tab, the report tab
(with an AI-explanation column), and one Vendor tab per category selected in the export modal.
The report tree is read from cache (no recomputation), but any category/synthetic row/overview
without a cached explanation is generated live, in parallel, before the workbook is built.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

entity_id

uuid

required

group_id

uuid

required

Body Params

report_type

string

required

Report type: BALANCE_SHEET, INCOME_STATEMENT, or CASH_FLOW

start_date

string

required

Report period start date (YYYY-MM-DD)

end_date

string

required

Report period end date (YYYY-MM-DD)

accounting_method

string

required

Accounting method: ACCRUAL or CASH

comparison_report_type

string

required

Comparison type: PREVIOUS_PERIOD or PREVIOUS_YEAR

show_non_zero_accounts

boolean | null

Defaults to true

Whether to only include non-zero accounts

category_uuids_for_vendor_tab

array of strings | null

Defaults to null

UUIDs of the categories the user multi-selected in the export modal. One 'Vendor -

Category Uuids For Vendor Tab

folder_id

string | null

Defaults to null

Folder UUID to save the exported file into; defaults to the entity's unsorted/Financials folder if omitted

export_to_mail

boolean | null

Defaults to false

If true, email the exported workbook to the requesting user's own email address as an attachment instead of returning it synchronously; the file is still uploaded to the entity's Financials folder in the background. Returns immediately with a confirmation message rather than document_id/download_url.

is_variance_report

boolean | null

Defaults to false

Must match the is_variance_report value passed to interactive_report/new/ when the report being exported 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.

Response

200

No response body

Language

Credentials

Loading…

Response

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