K-φ (K-Phi) Run Scenario API

openapi: 3.2.0
info:
  title: K-φ Run Scenario API
  version: 1.0.0
  description: 'Read your K-φ data (statements, cash, forecasts, scenarios) and save scenarios. The tenant always comes from the credential. Every response is { data, meta }; every error { error: { code, message } }.'
tags:
- name: Run Scenario
paths:
  /api/v1/run_scenario:
    get:
      operationId: get_run_scenario
      summary: Run a what-if scenario
      x-audience: data
      description: '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.'
      x-scope: read:forecast
      x-extension-only: false
      security:
      - bearer: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                  meta:
                    type: object
                    properties:
                      api:
                        type: string
                      capability:
                        type: string
                      at:
                        type: string
        '401':
          description: No or invalid credential
        '403':
          description: Scope, extension or Builder Mode refused
        '422':
          description: The capability refused the input
        '429':
          description: Rate or daily quota reached
      parameters:
      - name: version
        in: query
        required: false
        description: '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.'
        schema:
          type: string
      - name: period
        in: query
        required: false
        description: Filter to a single period (YYYY-MM). Omit to include all periods in the version.
        schema:
          type: string
      - name: entity
        in: query
        required: false
        description: Filter to a single entity code. Omit for consolidated view across all entities.
        schema:
          type: string
      - name: bu
        in: query
        required: false
        description: Filter to a single business unit. Omit for all BUs.
        schema:
          type: string
      - name: levers
        in: query
        required: false
        description: The levers to simulate.
        schema:
          type: string
      - name: scenario_id
        in: query
        required: false
        description: A saved scenario (kphi_list_scenarios) instead of levers.
        schema:
          type: string
      - name: horizon
        in: query
        required: false
        description: Months, 1-24, default 12.
        schema:
          type: integer
      tags:
      - Run Scenario
    post:
      operationId: post_run_scenario
      summary: Run a what-if scenario
      x-audience: data
      description: '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.'
      x-scope: read:forecast
      x-extension-only: false
      security:
      - bearer: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                  meta:
                    type: object
                    properties:
                      api:
                        type: string
                      capability:
                        type: string
                      at:
                        type: string
        '401':
          description: No or invalid credential
        '403':
          description: Scope, extension or Builder Mode refused
        '422':
          description: The capability refused the input
        '429':
          description: Rate or daily quota reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                version:
                  type: string
                  description: '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.'
                period:
                  type: string
                  description: Filter to a single period (YYYY-MM). Omit to include all periods in the version.
                entity:
                  type: string
                  description: Filter to a single entity code. Omit for consolidated view across all entities.
                bu:
                  type: string
                  description: Filter to a single business unit. Omit for all BUs.
                levers:
                  type: array
                  items:
                    type: object
                    properties:
                      type:
                        type: string
                      params:
                        type: object
                    required:
                    - type
                  description: The levers to simulate.
                scenario_id:
                  type: string
                  description: A saved scenario (kphi_list_scenarios) instead of levers.
                horizon:
                  type: integer
                  description: Months, 1-24, default 12.
              additionalProperties: false
      tags:
      - Run Scenario
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: API key, OAuth access token, extension key (kphix_…) or extension session token (kxs1.…)
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key with the gl:ingest scope (ERP connectors)
x-scopes:
  gl:ingest: Push GL data from an ERP (/api/gl/mappings, /api/gl/schema, /api/gl/ingest)
  mcp:tools: All read scopes (read:gl read:cash read:forecast read:sheets read:data)
  mcp:write: All MCP write scopes (write:scenarios write:config write:data write:sheets)
  read:gl: Read statements, KPIs, ratios, GL lines, versions, dimensions, variance, data lake, FX rates and FP&A settings
  read:cash: Read bank positions, transactions, balance history, cash forecast, AR/AP
  read:forecast: Read forecasts, budgets, scenarios (levers, list, run) and valuations
  read:sheets: Read the Google Sheets registered as inputs of the account, each tab as JSON (/api/v1/sheets/…), and their webhooks' deliveries (2026-11-02)
  write:sheets: 'Register and remove the Google Sheets the account serves as JSON (read only: K-φ never writes to a sheet), and the webhooks told when one changes'
  read:data: 'Read the Data library (/api/v1/data/…): market, macro and public series with their source and licence (2026-11-03)'
  write:vars: 'Define, load and remove the account''s own variables (var.<CODE>) of the Data library, and nothing else: never the books (2026-11-05)'
  write:scenarios: Save scenarios (Simulation page)
  write:config: 'Change tenant configuration: flow rules, classification overrides, budget versions and templates, valuation refresh'
  write:data: 'Import rows from a spreadsheet Claude read (Excel in, 2026-10-29): cash forecasts, a GL version, a bank statement; preview first, then commit'
  run:build: 'Call the BUILD''s functions that only read (POST /api/v1/fn/<name>): the logic the account built, served as an API (2026-10-29)'
  run:build:write: 'Also call the BUILD''s functions that change data (declared "writes": true in its kphi.json)'
x-limits:
  per_ip_per_min: 200
  extension_per_min: 120
  extension_per_day: 20000