Skip to main content
GET
Get a scenario

Authorizations

Authorization
string
header
required

A workspace API key created in ThinkOut settings. One key reads one workspace.

Path Parameters

id
string<uuid>
required

Response

The scenario.

object
string
required
Allowed value: "scenario"
id
string<uuid>
required
name
string
required
Example:

"Pessimistic"

type
enum<string>
required

dynamic is the cash flow, actual and still expected, with the scenario's edits on top, and moves with the data. snapshot is a copy of the cash flow taken when the scenario was created, then edited. blank holds only the amounts typed into it, starting from its initial balance.

Available options:
dynamic,
snapshot,
blank
from
string<date>
required

First day of the scenario's first month.

to
string<date>
required

Last day of the scenario's last month.

initial_balance
string | null
required

The balance a snapshot or blank scenario starts from. null for a dynamic scenario, which starts from the cash flow's balance.

Pattern: ^-?[0-9]+\.[0-9]{2}$
Example:

"-1250.00"

currency
string
required

The workspace currency. Every scenario amount is in it.

Pattern: ^[A-Z]{3}$
Example:

"RON"

created_at
string<date-time>
required
updated_at
string<date-time>
required

Equal to created_at until the scenario is first changed.