Sintetizează cash flow-ul

Ce arată ecranul de cash flow, descompus, pe interval de timp și cel mult încă o dimensiune. Trimite period, sau atât from, cât și to.

Fiecare interval are o parte realizată și o parte previzionată. Partea realizată o formează tranzacțiile datate în interval, numărate cum le numără /transactions/summary: transferurile între conturile proprii ale spațiului de lucru și mișcările excluse sunt lăsate deoparte, iar tranzacțiile împărțite se numără prin bucățile lor. Partea previzionată este suma rămasă a previziunilor nerealizate datate în interval. O previziune acoperită parțial se numără doar cu ce mai este așteptat, iar tranzacțiile asociate ei se numără ca realizate. inflow, outflow și net adună cele două părți și coincid cu ecranul.

Previziunile datate înainte de azi și încă nerealizate sunt restante. Ele sunt lăsate în afara rândurilor, dacă nu este trimis include_overdue=true. totals.overdue_inflow și totals.overdue_outflow raportează mereu suma rămasă a previziunilor restante pe care rândurile nu le-au numărat.

Sumele se convertesc în currency la cursul din data fiecărei mișcări. Intervalele sunt aliniate la calendar și tăiate la fereastra cerută. totals acoperă întreaga fereastră.

Rândurile grupate doar pe interval poartă și soldul de început, conturile deschise, transferurile, mișcările excluse și soldul de final ale intervalului. Soldul de final al unui interval viitor este soldul proiectat. Cele cinci sunt null când este trimis group_by sau direction.

Un filtru bank_id sau account_id restrânge partea realizată și soldurile, niciodată previziunile, care nu au cont și acoperă mereu întregul spațiu de lucru. Un bank_id care nu se potrivește cu niciun cont întoarce rezultatul gol: niciun rând și totaluri zero. group_by=account este respins cu 400 din același motiv.

Rândurile grupate sunt ordonate după net î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. Tranzacțiile și previziunile fără partener sau fără etichetă ajung într-un rând none, iar una cu mai multe etichete se numără o dată pentru fiecare etichetă. Aici category_id acoperă și subcategoriile.

Filtrele se combină cu AND; un filtru care acceptă o listă își combină valorile cu OR.

Cash flow pe luni pentru trimestrul următor

GET /cash-flow/summary?period=next_quarter&interval=month

Încasări așteptate pe partener luna viitoare

GET /cash-flow/summary?period=next_month&group_by=counterparty&direction=inflow

GET

cash-flow

summary

Sintetizează cash flow-ul

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

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

fetch('https://api.thinkout.io/v1/cash-flow/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/cash-flow/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": "cash_flow_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",
  "bank_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "account_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "forecast_scope": "workspace",
  "include_overdue": true,
  "has_data": true,
  "totals": {
    "currency": "RON",
    "actual_inflow": "-1250.00",
    "actual_outflow": "-1250.00",
    "actual_count": 123,
    "forecast_inflow": "-1250.00",
    "forecast_outflow": "-1250.00",
    "forecast_count": 123,
    "inflow": "-1250.00",
    "outflow": "-1250.00",
    "net": "-1250.00",
    "overdue_inflow": "-1250.00",
    "overdue_outflow": "-1250.00",
    "starting_balance": "-1250.00",
    "opened_accounts": "-1250.00",
    "transfers": "-1250.00",
    "excluded": "-1250.00",
    "final_balance": "-1250.00"
  },
  "data": [
    {
      "period_start": "2023-12-25",
      "period_end": "2023-12-25",
      "group": {
        "dimension": "category",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "label": "Telecom"
      },
      "currency": "RON",
      "actual_inflow": "-1250.00",
      "actual_outflow": "-1250.00",
      "actual_count": 123,
      "forecast_inflow": "-1250.00",
      "forecast_outflow": "-1250.00",
      "forecast_count": 123,
      "inflow": "-1250.00",
      "outflow": "-1250.00",
      "net": "-1250.00",
      "starting_balance": "-1250.00",
      "opened_accounts": "-1250.00",
      "transfers": "-1250.00",
      "excluded": "-1250.00",
      "final_balance": "-1250.00"
    }
  ]
}

{
  "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. O dimensiune după care se grupează rândurile de cash flow, pe lângă intervalul de timp. Nu există account, pentru că previziunile nu au cont.

Opțiuni disponibile:

category,

counterparty,

label,

activity,

direction

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"

bank_id

string<uuid>[]

Doar rândurile de pe conturile alimentate de aceste conexiuni bancare. Separate prin virgulă pentru mai multe.

account_id

string<uuid>[]

Doar rândurile de pe aceste conturi. Separate prin virgulă pentru mai multe.

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

include_overdue

boolean

implicit:false

Dacă previziunile restante, cele datate înainte de azi și încă nerealizate, se numără în rândurile intervalelor în care cad. Dezactivat, ele apar doar în totals.overdue_inflow și totals.overdue_outflow.

Răspuns

Sinteza.

object

string

obligatoriu

Allowed value: "cash_flow_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

O dimensiune după care se grupează rândurile de cash flow, pe lângă intervalul de timp. Nu există account, pentru că previziunile nu au cont.

Opțiuni disponibile:

category,

counterparty,

label,

activity,

direction

bank_ids

string<uuid>[]

obligatoriu

Filtrul bank_id întors în răspuns, gol când nu a fost trimis.

account_ids

string<uuid>[]

obligatoriu

Filtrul account_id întors în răspuns, gol când nu a fost trimis.

forecast_scope

string

obligatoriu

Ce acoperă partea previzionată și totalurile restante. Mereu întregul spațiu de lucru: o previziune nu are cont, așa că bank_ids și account_ids restrâng doar partea realizată și soldurile.

Allowed value: "workspace"

include_overdue

boolean

obligatoriu

Dacă previziunile restante au fost numărate în rânduri, așa cum s-a cerut.

has_data

boolean

obligatoriu

false când nicio tranzacție și nicio previziune nu s-au potrivit.

totals

object

obligatoriu

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

Show child attributes

data

object[]

obligatoriu

Show child attributes

Sintetizează cash flow-ul

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

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

fetch('https://api.thinkout.io/v1/cash-flow/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/cash-flow/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": "cash_flow_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",
  "bank_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "account_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "forecast_scope": "workspace",
  "include_overdue": true,
  "has_data": true,
  "totals": {
    "currency": "RON",
    "actual_inflow": "-1250.00",
    "actual_outflow": "-1250.00",
    "actual_count": 123,
    "forecast_inflow": "-1250.00",
    "forecast_outflow": "-1250.00",
    "forecast_count": 123,
    "inflow": "-1250.00",
    "outflow": "-1250.00",
    "net": "-1250.00",
    "overdue_inflow": "-1250.00",
    "overdue_outflow": "-1250.00",
    "starting_balance": "-1250.00",
    "opened_accounts": "-1250.00",
    "transfers": "-1250.00",
    "excluded": "-1250.00",
    "final_balance": "-1250.00"
  },
  "data": [
    {
      "period_start": "2023-12-25",
      "period_end": "2023-12-25",
      "group": {
        "dimension": "category",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "label": "Telecom"
      },
      "currency": "RON",
      "actual_inflow": "-1250.00",
      "actual_outflow": "-1250.00",
      "actual_count": 123,
      "forecast_inflow": "-1250.00",
      "forecast_outflow": "-1250.00",
      "forecast_count": 123,
      "inflow": "-1250.00",
      "outflow": "-1250.00",
      "net": "-1250.00",
      "starting_balance": "-1250.00",
      "opened_accounts": "-1250.00",
      "transfers": "-1250.00",
      "excluded": "-1250.00",
      "final_balance": "-1250.00"
    }
  ]
}

{
  "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ă cash flow-ul

Autorizări

Parametri interogare

Răspuns