Accounts

Finance · 3 операції

GETList finance accounts/api/finance-accountPOSTCreate finance account/api/finance-accountPUTUpdate finance account/api/finance-account/{id}

GET

List finance accounts

/api/finance-account

Money accounts (cash desks, bank accounts, cards) that finance operations go through.

list_finance_accounts

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

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

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

accountIdsnumber[]—

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

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

availablebooleanOnly accounts the requester's role may use (operation and payout selects).

Відповідь · 200

application/json

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

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

dataobject4 поля

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

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

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

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

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

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

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

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

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

roleIdsnumber[]обовʼязковийRoles that may use the account in operations and payouts.

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

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

Помилки400401403429500

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

const response = await fetch("https://your-school.rist.pro/api/finance-account?nameOfAccount=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/finance-account",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    params={
        "nameOfAccount": "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,
    "accounts": [
      {
        "accountId": 1,
        "nameOfAccount": "string",
        "note": "string",
        "order": 0,
        "isArchival": false,
        "roleIds": [
          1
        ],
        "updatedAt": "2026-11-09T14:30:00",
        "createdAt": "2026-11-09T14:30:00"
      }
    ]
  }
}

POST

Create finance account

/api/finance-account

Add a money account (name, optional note).

create_finance_account

Тіло запиту

application/json · object

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

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

roleIdsnumber[]Roles that may use the account; replaces the stored list. Fail-closed: none means nobody.мін. 1

Відповідь · 201

application/json

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

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

dataobject8 полів

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

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

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

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

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

roleIdsnumber[]обовʼязковийRoles that may use the account in operations and payouts.

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

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

Помилки400401403429500

curl -X POST "https://your-school.rist.pro/api/finance-account" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "nameOfAccount": "string",
    "note": "string",
    "roleIds": [
      1
    ]
  }'

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

import os
import requests

response = requests.post(
    "https://your-school.rist.pro/api/finance-account",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    json={
        "nameOfAccount": "string",
        "note": "string",
        "roleIds": [
            1
        ]
    },
)
response.raise_for_status()
data = response.json()["data"]

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

{
  "statusCode": 201,
  "message": "Operation completed successfully",
  "data": {
    "accountId": 1,
    "nameOfAccount": "string",
    "note": "string",
    "order": 0,
    "isArchival": false,
    "roleIds": [
      1
    ],
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00"
  }
}

PUT

Update finance account

/api/finance-account/{id}

Change name or note of a money account; name is always required.

update_finance_account

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

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

Тіло запиту

application/json · object

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

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

roleIdsnumber[]Roles that may use the account; replaces the stored list. Fail-closed: none means nobody.мін. 1

Відповідь · 200

application/json

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

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

dataobject8 полів

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

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

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

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

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

roleIdsnumber[]обовʼязковийRoles that may use the account in operations and payouts.

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

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

Помилки400401403429500

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

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

import os
import requests

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

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

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "accountId": 1,
    "nameOfAccount": "string",
    "note": "string",
    "order": 0,
    "isArchival": false,
    "roleIds": [
      1
    ],
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00"
  }
}