Citește o categorie - ThinkOut Developers

GET

/

categories

/

{id}

Citește o categorie

curl --request GET \
  --url https://api.thinkout.io/v1/categories/{id} \
  --header 'Authorization: Bearer <token>'

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

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

{
  "object": "category",
  "id": "3b4c5d6e-7f80-4a1b-9c2d-3e4f5a6b7c8d",
  "name": "Telecom",
  "code": null,
  "direction": "outflow",
  "activity": "operating",
  "parent_id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d",
  "position": 2,
  "color": "#1b7fe4",
  "created_at": "2024-01-01T10:00:00Z",
  "updated_at": "2024-01-01T10:00:00Z"
}

{
  "error": {
    "type": "authentication",
    "code": "unauthorized",
    "message": "Invalid API key.",
    "param": null,
    "request_id": "req_01J8ZT4Q7Y6M3K"
  }
}

{
  "error": {
    "type": "not_found",
    "code": "resource_not_found",
    "message": "No transaction with id 8f1c0a4e-2b1d-4c8e-9f3a-7d6e5c4b3a21.",
    "param": "id",
    "request_id": "req_01J8ZT4Q7Y6M3K"
  }
}

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

Răspuns

Categoria.

object

string

obligatoriu

Allowed value: "category"

id

string<uuid>

obligatoriu

name

string

obligatoriu

Exemplu:

"Telecom"

code

string | null

obligatoriu

Identificatorul categoriei în șablonul din care a fost creat acest spațiu de lucru. null pentru o categorie creată de cineva.

Doar uncategorized_inflows și uncategorized_outflows merită tratate special. Ele marchează cele două categorii în care stau banii neclasificați, există în fiecare spațiu de lucru, iar ThinkOut refuză să le șteargă. Orice alt cod depinde de șablonul folosit.

Exemplu:

"uncategorized_outflows"

direction

enum<string>

obligatoriu

Dacă banii intră sau ies. Pe o tranzacție sau pe o previziune urmează semnul lui amount și nu îl poate contrazice niciodată. Există ca răspunsurile să poată fi grupate și citite fără să inspectezi semnele.

Opțiuni disponibile:

inflow,

outflow

activity

enum<string>

obligatoriu

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

Opțiuni disponibile:

operating,

investing,

financing

parent_id

string<uuid> | null

obligatoriu

null pentru categoriile de nivel superior.

position

integer

obligatoriu

Ordinea între categoriile de pe același nivel, ca în ThinkOut.

color

string | null

obligatoriu

Culoare hex cu litere mici, ca în ThinkOut.

Pattern: ^#[0-9a-f]{6}$

Exemplu:

"#1b7fe4"

created_at

string<date-time>

obligatoriu

updated_at

string<date-time>

obligatoriu

⌘I

Citește o categorie

curl --request GET \
  --url https://api.thinkout.io/v1/categories/{id} \
  --header 'Authorization: Bearer <token>'

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

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

{
  "object": "category",
  "id": "3b4c5d6e-7f80-4a1b-9c2d-3e4f5a6b7c8d",
  "name": "Telecom",
  "code": null,
  "direction": "outflow",
  "activity": "operating",
  "parent_id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d",
  "position": 2,
  "color": "#1b7fe4",
  "created_at": "2024-01-01T10:00:00Z",
  "updated_at": "2024-01-01T10:00:00Z"
}

{
  "error": {
    "type": "authentication",
    "code": "unauthorized",
    "message": "Invalid API key.",
    "param": null,
    "request_id": "req_01J8ZT4Q7Y6M3K"
  }
}

{
  "error": {
    "type": "not_found",
    "code": "resource_not_found",
    "message": "No transaction with id 8f1c0a4e-2b1d-4c8e-9f3a-7d6e5c4b3a21.",
    "param": "id",
    "request_id": "req_01J8ZT4Q7Y6M3K"
  }
}