Salt la conținutul principal
GET
Sintetizează bugetele

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 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. Obligatoriu împreună cu to, dacă nu este trimis period.

to
string<date>

Ultima zi a ferestrei, inclusiv. Obligatoriu împreună cu from, dacă nu este trimis period.

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 direcție pe interval.

Opțiuni disponibile:
category
currency
string

Moneda în care se raportează. Implicit moneda spațiului de lucru. Un cod necunoscut este respins. Cod de monedă alfabetic ISO 4217.

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

"RON"

category_id
string<uuid>[]

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

direction
enum<string>

Dacă banii intră sau ies. Pe o tranzacție sau o previziune urmează semnul lui amount.

Opțiuni disponibile:
inflow,
outflow

Răspuns

Sinteza.

object
string
obligatoriu
Allowed value: "budgets_summary"
period
object
obligatoriu

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

conversion
object
obligatoriu

Ce s-a făcut pentru ca sumele să fie comparabile.

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

false când în fereastră nu este nimic bugetat, mișcat sau așteptat, spre deosebire de cifrele care dau zero.

totals
object
obligatoriu

Coloana Total din tabul Planificare pentru fiecare direcție, pe întreaga fereastră și pe aceleași categorii ca rândurile.

data
object[]
obligatoriu
balances
object[]
obligatoriu

Rândul de sold final din tabul Planificare, câte o intrare pe lună. Gol cu interval=total, group_by, category_id sau direction.