Sintetizează previziunile

Totaluri peste previziunile cu dată, pe interval de timp și cel mult încă o dimensiune. Trimite period, sau atât from, cât și to.

amount însumează ce a fost planificat, iar remaining_amount partea neacoperită încă de tranzacții. Se numără orice stare dacă status nu restrânge, așa că o previziune realizată se adaugă la amount și nu adaugă nimic la remaining_amount. Sumele se convertesc în currency la cursul din data fiecărei previziuni. Intervalele sunt aliniate la calendar și tăiate la fereastra cerută. totals acoperă întreaga fereastră.

Rândurile grupate sunt ordonate după amount în valoare absolută, cel mai mare primul. Un interval păstrează cel mult 50 de grupuri; restul se strâng într-un singur rând etichetat other. Previziunile fără partener sau fără etichetă ajung într-un rând none, iar o previziune cu mai multe etichete se numără o dată pentru fiecare etichetă. Aici category_id acoperă și subcategoriile.

GET

forecasts

summary

Sintetizează previziunile

curl --request GET \
  --url https://api.thinkout.io/v1/forecasts/summary \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.thinkout.io/v1/forecasts/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://api.thinkout.io/v1/forecasts/summary");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "object": "forecast_summary",
  "period": {
    "from": "2023-12-25",
    "to": "2023-12-25",
    "macro": "this_month",
    "interval": "month"
  },
  "conversion": {
    "applied": true,
    "currency": "RON",
    "basis": "transaction_date"
  },
  "group_by": "category",
  "has_data": true,
  "totals": {
    "currency": "RON",
    "amount": "-1250.00",
    "remaining_amount": "-1250.00",
    "count": 123
  },
  "data": [
    {
      "period_start": "2023-12-25",
      "period_end": "2023-12-25",
      "group": {
        "dimension": "category",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "label": "Telecom"
      },
      "currency": "RON",
      "amount": "-1250.00",
      "remaining_amount": "-1250.00",
      "count": 123
    }
  ]
}

{
  "error": {
    "type": "invalid_request",
    "code": "invalid_parameter",
    "message": "direction must be 'inflow' or 'outflow'",
    "param": "direction",
    "request_id": "0HNF8K3QJL2VM:00000001"
  }
}

{
  "error": {
    "type": "authentication",
    "code": "unauthorized",
    "message": "Missing, malformed, unknown or revoked API key",
    "param": null,
    "request_id": "0HNF8K3QJL2VM:00000001"
  }
}

{
  "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"
  }
}

{
  "error": {
    "type": "invalid_request",
    "code": "too_many_groups",
    "message": "Grouping by counterparty over this period produces 1240 groups. The maximum is 1000. Narrow the period or the filters.",
    "param": "group_by",
    "request_id": "0HNF8K3QJL2VM:00000001"
  }
}

{
  "error": {
    "type": "rate_limit",
    "code": "rate_limited",
    "message": "Too many requests",
    "param": null,
    "request_id": "0HNF8K3QJL2VM:00000001"
  }
}

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.

string<date>

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

interval

enum<string>

implicit:month

Intervalul de timp în care sunt grupate rândurile. Intervalul de timp pentru rândurile unui raport.

Opțiuni disponibile:

day,

week,

month

group_by

enum<string>

O a doua dimensiune de grupare, pe lângă intervalul de timp. Omite-o pentru un singur rând per interval. La fel ca GroupDimension, plus statusul previziunii. Previziunile nu au cont.

Opțiuni disponibile:

category,

counterparty,

label,

activity,

direction,

status

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 rândurile din aceste categorii. Separate prin virgulă pentru mai multe. Pe /transactions se potrivește și cu o tranzacție împărțită ale cărei bucăți sunt în una dintre ele. Subcategoriile sunt incluse doar pe sinteze.

label_id

string<uuid>[]

Doar rândurile care poartă cel puțin una dintre aceste etichete. Separate prin virgulă pentru mai multe.

counterparty_id

string<uuid>[]

Doar rândurile atribuite acestor parteneri. 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

activity

enum<string>[]

Doar rândurile a căror categorie se află în aceste secțiuni ale situației fluxurilor de numerar. Separate prin virgulă pentru mai multe.

Secțiunea din situația fluxurilor de numerar căreia îi aparține categoria.

Opțiuni disponibile:

operating,

investing,

financing

status

enum<string>

realised este completă. partial are tranzacții asociate. overdue are data înainte de azi și niciuna. planned are data azi sau mai târziu și niciuna.

Opțiuni disponibile:

planned,

overdue,

partial,

realised

Răspuns

Sinteza.

object

string

obligatoriu

Allowed value: "forecast_summary"

period

object

obligatoriu

Fereastra efectiv calculată.

Show child attributes

conversion

object

obligatoriu

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

Show child attributes

group_by

enum<string> | null

obligatoriu

La fel ca GroupDimension, plus statusul previziunii. Previziunile nu au cont.

Opțiuni disponibile:

category,

counterparty,

label,

activity,

direction,

status

has_data

boolean

obligatoriu

false când nicio previziune nu s-a potrivit.

totals

object

obligatoriu

Întreaga fereastră însumată, peste aceleași previziuni ca rândurile.

Show child attributes

data

object[]

obligatoriu

Show child attributes

Sintetizează previziunile

curl --request GET \
  --url https://api.thinkout.io/v1/forecasts/summary \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.thinkout.io/v1/forecasts/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://api.thinkout.io/v1/forecasts/summary");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "object": "forecast_summary",
  "period": {
    "from": "2023-12-25",
    "to": "2023-12-25",
    "macro": "this_month",
    "interval": "month"
  },
  "conversion": {
    "applied": true,
    "currency": "RON",
    "basis": "transaction_date"
  },
  "group_by": "category",
  "has_data": true,
  "totals": {
    "currency": "RON",
    "amount": "-1250.00",
    "remaining_amount": "-1250.00",
    "count": 123
  },
  "data": [
    {
      "period_start": "2023-12-25",
      "period_end": "2023-12-25",
      "group": {
        "dimension": "category",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "label": "Telecom"
      },
      "currency": "RON",
      "amount": "-1250.00",
      "remaining_amount": "-1250.00",
      "count": 123
    }
  ]
}

{
  "error": {
    "type": "invalid_request",
    "code": "invalid_parameter",
    "message": "direction must be 'inflow' or 'outflow'",
    "param": "direction",
    "request_id": "0HNF8K3QJL2VM:00000001"
  }
}

{
  "error": {
    "type": "authentication",
    "code": "unauthorized",
    "message": "Missing, malformed, unknown or revoked API key",
    "param": null,
    "request_id": "0HNF8K3QJL2VM:00000001"
  }
}

{
  "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"
  }
}

{
  "error": {
    "type": "invalid_request",
    "code": "too_many_groups",
    "message": "Grouping by counterparty over this period produces 1240 groups. The maximum is 1000. Narrow the period or the filters.",
    "param": "group_by",
    "request_id": "0HNF8K3QJL2VM:00000001"
  }
}

{
  "error": {
    "type": "rate_limit",
    "code": "rate_limited",
    "message": "Too many requests",
    "param": null,
    "request_id": "0HNF8K3QJL2VM:00000001"
  }
}

Primii pași

MCP

API REST

Referință API

Sintetizează previziunile

Autorizări

Parametri interogare

Răspuns