Salt la conținutul principal
GET
Sintetizează un scenariu

Autorizări

Authorization
string
header
obligatoriu

O cheie API creată în setările ThinkOut. O cheie citește un singur spațiu de lucru.

Parametri cale

id
string<uuid>
obligatoriu

Parametri interogare

period
enum<string>

O fereastră cu nume, rezolvată față de ziua locală a spațiului de lucru și întoarsă în răspuns. Are prioritate față de from și to. O fereastră cu nume, rezolvată pe server. last_30_days și last_90_days se termină azi și includ ziua de azi; last_12_months începe în ziua de după azi minus douăsprezece luni. next_month, next_quarter și next_year acoperă întreaga lună, întregul trimestru sau întregul an calendaristic următor.

Opțiuni disponibile:
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
from
string<date>

Prima zi a ferestrei, inclusiv. Trimite-o împreună cu to. Omite period, from și to pentru fereastra implicită.

to
string<date>

Ultima zi a ferestrei, inclusiv. Trimite-o împreună cu from. Omite period, from și to pentru fereastra implicită.

interval
enum<string>
implicit:month

Intervalul în care sunt grupate rândurile. month pentru fiecare lună calendaristică, total pentru întreaga fereastră ca un singur interval. Intervalul de timp pentru rândurile de buget și de scenariu, care sunt lunare. total raportează întreaga fereastră ca un singur interval, ca coloana Total de pe ecranul de bugete.

Opțiuni disponibile:
month,
total
group_by
enum<string>

category pentru câte un rând pe categorie pe interval. Omite-l pentru câte un rând pe interval.

Opțiuni disponibile:
category
category_id
string<uuid>[]

Doar aceste categorii și categoriile imbricate sub ele. Separate prin virgulă pentru mai multe.

Răspuns

Tabul scenariului.

object
string
obligatoriu
Allowed value: "scenario_summary"
scenario
object
obligatoriu

Scenariul raportat.

period
object
obligatoriu

Fereastra efectiv calculată, extinsă la luni întregi.

currency
string
obligatoriu

Moneda spațiului de lucru. Sumele scenariilor nu se convertesc niciodată.

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

"RON"

group_by
enum<string> | null
obligatoriu
Opțiuni disponibile:
category,
null
has_data
boolean
obligatoriu

false când totals.inflow, totals.outflow și totals.final_balance sunt toate zero sau lipsesc.

totals
object
obligatoriu

Un interval din tabul unui scenariu, sau întreaga lui fereastră în totals. Plățile sunt negative.

data
object[]
obligatoriu

Câte un ScenarioPeriod pe interval fără group_by. Câte un ScenarioCategoryRow pe categorie pe interval cu group_by=category.

Un interval din tabul unui scenariu, sau întreaga lui fereastră în totals. Plățile sunt negative.