Run a what-if scenario on the tenant's ledger and forecast, and return the P&L and the cash forecast, baseline vs scenario

Run a what-if scenario on the tenant's ledger and forecast, and return the P&L and the cash forecast, baseline vs scenario. Give either levers ([{ type, params }], see kphi_scenario_levers) or the id of a saved scenario. Returns: the pro forma P&L over the horizon (revenue, COGS, gross margin, payroll, other opex, EBITDA, D&A, EBIT, interest, tax, net income) for the baseline and the scenario; the P&L per month (baseline and scenario); the cash impact per month and cumulated; and the cash forecast (baseline closing cash per month, and the scenario's = baseline + cumulated cash impact). Computes only; nothing is saved (use kphi_save_scenario, with the same levers and scope). The result is a PROJECTION — K-Φ's forecast summed over the horizon — not actuals: present summary_table verbatim, with its scope line, and lever_classes when a lever's account class matters. version is required when more than one exists.

get/api/v1/run_scenario

Request

  • Base URL: https://k-phi.com (the document declares no server; this is the origin it was published from)
  • URL: https://k-phi.com/api/v1/run_scenario
  • Auth: HTTP bearer

Query parameters

versionstring

GL version label (e.g. "2026-06"), from kphi_list_versions. Required when more than one version exists: without it the tool answers needs_version with the list instead of picking one.

periodstring

Filter to a single period (YYYY-MM). Omit to include all periods in the version.

entitystring

Filter to a single entity code. Omit for consolidated view across all entities.

bustring

Filter to a single business unit. Omit for all BUs.

leversstring

The levers to simulate.

scenario_idstring

A saved scenario (kphi_list_scenarios) instead of levers.

horizoninteger

Months, 1-24, default 12.

Response

OK

dataobject

Changes

No recorded changes to this operation across all 1 revision of this API.