K-φ (K-Phi) Get Balance Sheet API

openapi: 3.2.0
info:
  title: K-φ Get Balance Sheet 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: Get Balance Sheet
paths:
  /api/v1/get_balance_sheet:
    get:
      operationId: get_get_balance_sheet
      summary: Balance sheet
      x-audience: data
      description: Get the balance sheet computed by the K-φ engine (assets, liabilities, equity by category with per-account detail lines). The B/S is a snapshot of the latest period in scope. Set summary_only=true to get section totals without per-account lines.
      x-scope: read:gl
      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: summary_only
        in: query
        required: false
        description: If true, return only section/total rows (cat set), skipping per-account detail.
        schema:
          type: boolean
      tags:
      - Get Balance Sheet
    post:
      operationId: post_get_balance_sheet
      summary: Balance sheet
      x-audience: data
      description: Get the balance sheet computed by the K-φ engine (assets, liabilities, equity by category with per-account detail lines). The B/S is a snapshot of the latest period in scope. Set summary_only=true to get section totals without per-account lines.
      x-scope: read:gl
      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.
                summary_only:
                  type: boolean
                  description: If true, return only section/total rows (cat set), skipping per-account detail.
              additionalProperties: false
      tags:
      - Get Balance Sheet
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