Articles and categories

Finance · 4 операції

GETList finance articles/api/articleGETList finance categories/api/categoryPOSTCreate finance article/api/articlePUTUpdate finance article/api/article/{id}

GET

List finance articles

/api/article

Income and expense articles with the operation types each applies to.

list_finance_articles

Параметри запиту · 6

pagenumberмін. 1 · за замовчуванням 1

pageSizenumber1–250 · за замовчуванням 20

nameOfArticlestringобовʼязковийдовжина макс. 150

isArchivalobjectобовʼязковийза замовчуванням false

articleIdsnumber[]обовʼязковий—

typeOfOperationstringОдне з: INCOME TRANSFER ADJUSTMENT EXPENSES REFUND ACCOUNT_TRANSFER

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200

messagestringобовʼязковий—

dataobject4 поля

totalnumberобовʼязковий—

totalPagesnumberобовʼязковий—

currentPagenumberобовʼязковий—

articlesobject[]обовʼязковий8 полів

articleIdnumberобовʼязковий—

nameOfArticlestringобовʼязковий—

typesOfFinanceOperationobjectобовʼязковий—

notestringобовʼязковийможе бути null—

ordernumberобовʼязковий—

isArchivalbooleanобовʼязковий—

updatedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss

createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss

Помилки400401403429500

curl "https://your-school.rist.pro/api/article?nameOfArticle=string&isArchival=false&articleIds=1" \
  -H "Authorization: Bearer $RIST_API_KEY"

const response = await fetch("https://your-school.rist.pro/api/article?nameOfArticle=string&isArchival=false&articleIds=1", {
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
  },
});
const { data } = await response.json();

import os
import requests

response = requests.get(
    "https://your-school.rist.pro/api/article",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    params={
        "nameOfArticle": "string",
        "isArchival": False,
        "articleIds": [
            1
        ]
    },
)
response.raise_for_status()
data = response.json()["data"]

Приклад відповіді · 200

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "total": 0,
    "totalPages": 0,
    "currentPage": 0,
    "articles": [
      {
        "articleId": 1,
        "nameOfArticle": "string",
        "typesOfFinanceOperation": {},
        "note": "string",
        "order": 0,
        "isArchival": false,
        "updatedAt": "2026-11-09T14:30:00",
        "createdAt": "2026-11-09T14:30:00"
      }
    ]
  }
}

GET

List finance categories

/api/category

Categories of finance operations.

list_finance_categories

Параметри запиту · 6

pagenumberмін. 1 · за замовчуванням 1

pageSizenumber1–250 · за замовчуванням 20

categoryIdsnumber[]—

typestringОдне з: INCOME EXPENSES

nameOfCategorystringобовʼязковийдовжина макс. 150

isArchivalobjectобовʼязковийза замовчуванням false

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200

messagestringобовʼязковий—

dataobject4 поля

totalnumberобовʼязковий—

totalPagesnumberобовʼязковий—

currentPagenumberобовʼязковий—

categoriesobject[]обовʼязковий8 полів

categoryIdnumberобовʼязковий—

nameOfCategorystringобовʼязковий—

typestringобовʼязковийОдне з: INCOME EXPENSES

notestringобовʼязковийможе бути null—

ordernumberобовʼязковий—

isArchivalbooleanобовʼязковий—

updatedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss

createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss

Помилки400401403429500

curl "https://your-school.rist.pro/api/category?nameOfCategory=string&isArchival=false" \
  -H "Authorization: Bearer $RIST_API_KEY"

const response = await fetch("https://your-school.rist.pro/api/category?nameOfCategory=string&isArchival=false", {
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
  },
});
const { data } = await response.json();

import os
import requests

response = requests.get(
    "https://your-school.rist.pro/api/category",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    params={
        "nameOfCategory": "string",
        "isArchival": False
    },
)
response.raise_for_status()
data = response.json()["data"]

Приклад відповіді · 200

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "total": 0,
    "totalPages": 0,
    "currentPage": 0,
    "categories": [
      {
        "categoryId": 1,
        "nameOfCategory": "string",
        "type": "INCOME",
        "note": "string",
        "order": 0,
        "isArchival": false,
        "updatedAt": "2026-11-09T14:30:00",
        "createdAt": "2026-11-09T14:30:00"
      }
    ]
  }
}

POST

Create finance article

/api/article

Add an income or expense article (name, operation types it applies to, optional note).

create_finance_article

Тіло запиту

application/json · object

nameOfArticlestringобовʼязковийдовжина 1–150

typesOfFinanceOperationstring[]обовʼязковийОдне з: INCOME TRANSFER ADJUSTMENT EXPENSES REFUND ACCOUNT_TRANSFERелементів мін. 1

notestringобовʼязковийможе бути nullдовжина макс. 1500

Відповідь · 201

application/json

statusCodenumberобовʼязковийприклад 201

messagestringобовʼязковий—

dataobject8 полів

articleIdnumberобовʼязковий—

nameOfArticlestringобовʼязковий—

typesOfFinanceOperationobjectобовʼязковий—

notestringобовʼязковийможе бути null—

ordernumberобовʼязковий—

isArchivalbooleanобовʼязковий—

updatedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss

createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss

Помилки400401403429500

curl -X POST "https://your-school.rist.pro/api/article" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "nameOfArticle": "string",
    "typesOfFinanceOperation": [
      "INCOME"
    ],
    "note": "string"
  }'

const response = await fetch("https://your-school.rist.pro/api/article", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "nameOfArticle": "string",
    "typesOfFinanceOperation": [
      "INCOME"
    ],
    "note": "string"
  }),
});
const { data } = await response.json();

import os
import requests

response = requests.post(
    "https://your-school.rist.pro/api/article",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    json={
        "nameOfArticle": "string",
        "typesOfFinanceOperation": [
            "INCOME"
        ],
        "note": "string"
    },
)
response.raise_for_status()
data = response.json()["data"]

Приклад відповіді · 201

{
  "statusCode": 201,
  "message": "Operation completed successfully",
  "data": {
    "articleId": 1,
    "nameOfArticle": "string",
    "typesOfFinanceOperation": {},
    "note": "string",
    "order": 0,
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00"
  }
}

PUT

Update finance article

/api/article/{id}

Change a finance article; name and operation types are always required, the types list is replaced.

update_finance_article

Параметри шляху · 1

idnumberобовʼязковий—

Тіло запиту

application/json · object

nameOfArticlestringобовʼязковийдовжина 1–150

typesOfFinanceOperationstring[]обовʼязковийОдне з: INCOME TRANSFER ADJUSTMENT EXPENSES REFUND ACCOUNT_TRANSFERелементів мін. 1

notestringобовʼязковийможе бути nullдовжина макс. 1500

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200

messagestringобовʼязковий—

dataobject8 полів

articleIdnumberобовʼязковий—

nameOfArticlestringобовʼязковий—

typesOfFinanceOperationobjectобовʼязковий—

notestringобовʼязковийможе бути null—

ordernumberобовʼязковий—

isArchivalbooleanобовʼязковий—

updatedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss

createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss

Помилки400401403429500

curl -X PUT "https://your-school.rist.pro/api/article/1" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "nameOfArticle": "string",
    "typesOfFinanceOperation": [
      "INCOME"
    ],
    "note": "string"
  }'

const response = await fetch("https://your-school.rist.pro/api/article/1", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "nameOfArticle": "string",
    "typesOfFinanceOperation": [
      "INCOME"
    ],
    "note": "string"
  }),
});
const { data } = await response.json();

import os
import requests

response = requests.put(
    "https://your-school.rist.pro/api/article/1",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    json={
        "nameOfArticle": "string",
        "typesOfFinanceOperation": [
            "INCOME"
        ],
        "note": "string"
    },
)
response.raise_for_status()
data = response.json()["data"]

Приклад відповіді · 200

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "articleId": 1,
    "nameOfArticle": "string",
    "typesOfFinanceOperation": {},
    "note": "string",
    "order": 0,
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00"
  }
}