> ## Documentation Index
> Fetch the complete documentation index at: https://developers.thinkout.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Summarise scenarios

> The scenarios screen's Summary tab: per month, the cash flow's final balance beside each
scenario's. Give `period`, or both `from` and `to`, or neither for the tab's own window,
this month and the twelve after it.

The window widens to whole months. `cash_flow_final_balance` is the cash flow's final
balance as the cash flow screen shows it, projected for months that end after today.
A scenario's `final_balance` is its starting balance plus its net result, as its own
tab shows it, and is `null` in months outside the scenario's. The cash flow's final
balance also carries opened accounts, transfers and excluded movements, so a scenario's
final balance can differ from it even in months the scenario does not change.

With `interval=total` there is one row, with the balances at the end of the window.
Amounts are in the workspace currency and are never converted.

**The cash flow and every scenario, month by month, for the next year**

```http
GET /scenarios/summary
```




## OpenAPI

````yaml /openapi/v1.yaml get /scenarios/summary
openapi: 3.1.0
info:
  title: ThinkOut API
  version: '1.0'
  description: >
    Read access to the data of a ThinkOut workspace.


    Every endpoint in version 1 is a `GET`. Lists share one envelope and page
    with a cursor

    wherever they can grow. Every response carries `X-RateLimit-Limit`,
    `X-RateLimit-Remaining`

    and `X-RateLimit-Reset`.


    Version 1 changes additively: new endpoints, optional parameters, response
    fields and enum

    values can appear at any time. Tolerate unknown fields and never treat an
    enum as closed.
  contact:
    name: ThinkOut developer support
    url: https://developers.thinkout.io/guides/support
servers:
  - url: https://api.thinkout.io/v1
security:
  - apiKey: []
tags:
  - name: Banks
    description: The workspace's bank connections and the state of each one.
  - name: Accounts
    description: Manual, bank-synced and delegated accounts with computed balances.
  - name: Transactions
    description: Booked and pending movements on the workspace's accounts.
  - name: Categories
    description: The workspace category tree, split by direction and business activity.
  - name: Counterparties
    description: Customers and suppliers that transactions and forecasts are attributed to.
  - name: Labels
    description: Free-form tags grouped by label type.
  - name: Forecasts
    description: Planned inflows and outflows and the transactions that realised them.
  - name: Budgets
    description: >-
      Monthly budgets per category beside what has moved and what is still
      expected, as the budgets screen shows them.
  - name: Scenarios
    description: >-
      The what-ifs built on the scenarios screen and the figures the screen
      shows for them.
  - name: Reports
    description: >-
      Totals rather than rows. Summaries over transactions, forecasts and cash
      flow, and balances per account.
paths:
  /scenarios/summary:
    get:
      tags:
        - Scenarios
      summary: Summarise scenarios
      description: >
        The scenarios screen's Summary tab: per month, the cash flow's final
        balance beside each

        scenario's. Give `period`, or both `from` and `to`, or neither for the
        tab's own window,

        this month and the twelve after it.


        The window widens to whole months. `cash_flow_final_balance` is the cash
        flow's final

        balance as the cash flow screen shows it, projected for months that end
        after today.

        A scenario's `final_balance` is its starting balance plus its net
        result, as its own

        tab shows it, and is `null` in months outside the scenario's. The cash
        flow's final

        balance also carries opened accounts, transfers and excluded movements,
        so a scenario's

        final balance can differ from it even in months the scenario does not
        change.


        With `interval=total` there is one row, with the balances at the end of
        the window.

        Amounts are in the workspace currency and are never converted.


        **The cash flow and every scenario, month by month, for the next year**


        ```http

        GET /scenarios/summary

        ```
      operationId: summariseScenarios
      parameters:
        - $ref: '#/components/parameters/period'
        - $ref: '#/components/parameters/window_from'
        - $ref: '#/components/parameters/window_to'
        - $ref: '#/components/parameters/planning_interval'
      responses:
        '200':
          description: The Summary tab.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScenariosSummary'
              example:
                object: scenarios_summary
                period:
                  from: '2026-11-01'
                  to: '2027-01-31'
                  macro: null
                  interval: month
                currency: RON
                data:
                  - period_start: '2026-11-01'
                    period_end: '2026-11-30'
                    currency: RON
                    cash_flow_final_balance: '239843.75'
                    scenarios:
                      - id: 2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f
                        name: Pessimistic
                        final_balance: '228659.50'
                      - id: 7d8e9f0a-1b2c-4d3e-8f4a-5b6c7d8e9f0a
                        name: Hiring two developers
                        final_balance: null
                  - period_start: '2026-12-01'
                    period_end: '2026-12-31'
                    currency: RON
                    cash_flow_final_balance: '251210.40'
                    scenarios:
                      - id: 2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f
                        name: Pessimistic
                        final_balance: '240659.50'
                      - id: 7d8e9f0a-1b2c-4d3e-8f4a-5b6c7d8e9f0a
                        name: Hiring two developers
                        final_balance: null
                  - period_start: '2027-01-01'
                    period_end: '2027-01-31'
                    currency: RON
                    cash_flow_final_balance: '266480.90'
                    scenarios:
                      - id: 2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f
                        name: Pessimistic
                        final_balance: '247159.50'
                      - id: 7d8e9f0a-1b2c-4d3e-8f4a-5b6c7d8e9f0a
                        name: Hiring two developers
                        final_balance: '236000.00'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    period:
      name: period
      in: query
      description: >-
        A named window, resolved against the workspace's local day and echoed in
        the response. Takes precedence over `from` and `to`.
      schema:
        $ref: '#/components/schemas/PeriodMacro'
    window_from:
      name: from
      in: query
      description: >-
        First day of the window, inclusive. Give it with `to`. Leave out
        `period`, `from` and `to` for the default window.
      schema:
        type: string
        format: date
    window_to:
      name: to
      in: query
      description: >-
        Last day of the window, inclusive. Give it with `from`. Leave out
        `period`, `from` and `to` for the default window.
      schema:
        type: string
        format: date
    planning_interval:
      name: interval
      in: query
      description: >-
        The period rows are grouped into. `month` for each calendar month,
        `total` for the whole window as one period.
      schema:
        $ref: '#/components/schemas/PlanningInterval'
  schemas:
    ScenariosSummary:
      type: object
      required:
        - object
        - period
        - currency
        - data
      properties:
        object:
          type: string
          const: scenarios_summary
        period:
          $ref: '#/components/schemas/ResolvedPlanningPeriod'
        currency:
          $ref: '#/components/schemas/Currency'
          description: The workspace currency. Scenario amounts are never converted.
        data:
          type: array
          items:
            $ref: '#/components/schemas/ScenariosSummaryRow'
    PeriodMacro:
      type: string
      description: >-
        A named window resolved on the server. `last_30_days` and `last_90_days`
        end today and include it; `last_12_months` starts the day after today
        minus twelve months. `next_month`, `next_quarter` and `next_year` cover
        the whole next calendar month, quarter or year.
      enum:
        - this_month
        - last_month
        - this_quarter
        - last_quarter
        - this_year
        - last_year
        - month_to_date
        - quarter_to_date
        - year_to_date
        - last_30_days
        - last_90_days
        - last_12_months
        - next_month
        - next_quarter
        - next_year
    PlanningInterval:
      type: string
      description: >-
        A period bucket for budget and scenario rows, which are monthly. `total`
        reports the whole window as one period, as the budgets screen's Total
        column does.
      enum:
        - month
        - total
      default: month
    ResolvedPlanningPeriod:
      type: object
      description: The window actually computed, widened to whole months.
      required:
        - from
        - to
        - macro
        - interval
      properties:
        from:
          type: string
          format: date
          description: First day of the first month.
        to:
          type: string
          format: date
          description: Last day of the last month.
        macro:
          oneOf:
            - $ref: '#/components/schemas/PeriodMacro'
            - type: 'null'
          description: >-
            The macro that produced the window, or `null` when the dates were
            given directly or the endpoint's default window applied.
        interval:
          $ref: '#/components/schemas/PlanningInterval'
    Currency:
      type: string
      description: ISO 4217 alphabetic currency code.
      pattern: ^[A-Z]{3}$
      example: RON
    ScenariosSummaryRow:
      type: object
      description: One period of the Summary tab.
      required:
        - period_start
        - period_end
        - currency
        - cash_flow_final_balance
        - scenarios
      properties:
        period_start:
          type: string
          format: date
        period_end:
          type: string
          format: date
        currency:
          $ref: '#/components/schemas/Currency'
        cash_flow_final_balance:
          $ref: '#/components/schemas/Money'
          description: >-
            The cash flow's balance at the end of the period, projected when the
            period ends after today.
        scenarios:
          type: array
          description: >-
            Every scenario in the workspace with its balance at the end of the
            period.
          items:
            $ref: '#/components/schemas/ScenarioFinalBalance'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - param
            - request_id
          properties:
            type:
              type: string
              enum:
                - invalid_request
                - authentication
                - not_found
                - rate_limit
                - server
            code:
              type: string
              description: >
                Stable machine-readable reason. Branch on this, not on
                `message`. One of

                `invalid_parameter`, `invalid_cursor`, `limit_out_of_range`,
                `invalid_expand`,

                `as_of_in_future`, `unauthorized`, `forbidden`,
                `resource_not_found`,

                `too_many_groups`, `period_too_long`, `rate_limited`,
                `internal_error`.
            message:
              type: string
              description: Human-readable explanation. Wording may change.
            param:
              type:
                - string
                - 'null'
              description: The query parameter at fault, when there is one.
            request_id:
              type: string
              description: Quote this when contacting support.
    Money:
      type: string
      description: >-
        Decimal amount as a string with two decimals. Negative means an outflow
        on transactions, forecasts and report figures.
      pattern: ^-?[0-9]+\.[0-9]{2}$
      example: '-1250.00'
    ScenarioFinalBalance:
      type: object
      required:
        - id
        - name
        - final_balance
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          example: Pessimistic
        final_balance:
          oneOf:
            - $ref: '#/components/schemas/Money'
            - type: 'null'
          description: >-
            The scenario's balance at the end of the period, as its tab shows
            it. `null` in a period outside the scenario's months.
  responses:
    BadRequest:
      description: A parameter is invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request
              code: invalid_parameter
              message: direction must be 'inflow' or 'outflow'
              param: direction
              request_id: 0HNF8K3QJL2VM:00000001
    Unauthorized:
      description: The API key is missing, malformed, unknown or revoked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: authentication
              code: unauthorized
              message: Missing, malformed, unknown or revoked API key
              param: null
              request_id: 0HNF8K3QJL2VM:00000001
    Forbidden:
      description: >-
        The key is valid but the company's ThinkOut plan does not include the
        API.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: authentication
              code: forbidden
              message: >-
                The API is not included in this company's ThinkOut plan. Contact
                support@thinkout.io to enable it.
              param: null
              request_id: 0HNF8K3QJL2VM:00000001
    RateLimited:
      description: >-
        More than 120 requests in the current minute for this key. Wait for the
        seconds in `Retry-After`.
      headers:
        Retry-After:
          schema:
            type: integer
          description: Seconds until the minute window resets.
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Requests allowed per minute.
        X-RateLimit-Remaining:
          schema:
            type: integer
          description: Requests left in the current minute.
        X-RateLimit-Reset:
          schema:
            type: integer
          description: Seconds until the minute window resets.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: rate_limit
              code: rate_limited
              message: Too many requests
              param: null
              request_id: 0HNF8K3QJL2VM:00000001
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        A workspace API key created in ThinkOut settings. One key reads one
        workspace.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.