Bonuses

Teachers · 10 операцій

GETGet teacher bonuses/api/teacher/{id}/bonusesGETGet bonus coverage of teachers/api/teacher/bonus-coverageGETList system bonuses/api/bonus-templateGETGet system bonus/api/bonus-template/{id}POSTCreate system bonus/api/bonus-templatePOSTAssign system bonus to teachers/api/bonus/templatePOSTCreate teacher bonus/api/bonusPUTUpdate system bonus/api/bonus-template/{id}PATCHArchive system bonus/api/bonus-template/archive/{id}PATCHUpdate teacher bonus/api/bonus/{id}

GET

Get bonus coverage of teachers

/api/teacher/bonus-coverage

All active teachers with their active bonus rules, to spot teachers without a bonus. Amounts are present only when the role may see bonus amounts.

get_teacher_bonus_coverage

Відповідь · 200

application/json

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

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

dataanyПоля data ще не описані.

Помилки401403429500

curl "https://your-school.rist.pro/api/teacher/bonus-coverage" \
  -H "Authorization: Bearer $RIST_API_KEY"

const response = await fetch("https://your-school.rist.pro/api/teacher/bonus-coverage", {
  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/teacher/bonus-coverage",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
)
response.raise_for_status()
data = response.json()["data"]

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

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": …
}

GET

Add a system bonus to assign to teachers with POST /api/bonus/template. Terms: nameOfBonus; type (cannot be changed later): VOLUME = amountPerLesson for every lesson of a period, taken from the highest tier of minutes taught in it (tiers [{totalMinutes, amountPerLesson}], period DAY/WEEK/MONTH); VOLUME_ONCE = one-off sum per period by minutes reached (tiers, period); LESSON_COUNT = one-off sum by lessons per WEEK or MONTH (tiers, totalMinutes holds the lesson count); STUDENT_TENURE = one-off sum when a student reaches N lessons with the teacher (tiers, totalMinutes holds N); ON_TIME_CONDUCT = per-lesson sum from the first tier whose totalMinutes is not below the minutes from lesson end to conducting (values may be negative); CONVERSION = amountPerLesson per converted trial lesson; TIME_RANGE = amountPerLesson per lesson starting within timeRanges [{timeFrom, timeTo}] in minutes from midnight; STUDENT_CLASS = classAmounts [{classOfStudentId, amountPerLesson}]; TEACHING_PROGRAM = programAmounts [{teachingProgramId, amountPerLesson}]; SUBJECT = subjectAmounts [{subjectId, amountPerLesson}] instead of subjectIds; TYPE_OF_LESSON = typeOfLessonAmounts [{typeOfLessonId, amountPerLesson}] instead of typeOfLessonIds. Also typeOfLessonIds and subjectIds it applies to, durationOfLesson or null, presence PRESENT / ABSENT / PRESENT_OR_ABSENT / CANCELED for which lessons count (default any conducted).

create_bonus_template

Тіло запиту

application/json · object

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

typestringDefaults to VOLUME. Cannot be changed after creation.Одне з: VOLUME VOLUME_ONCE CONVERSION TIME_RANGE STUDENT_CLASS ON_TIME_CONDUCT LESSON_COUNT STUDENT_TENURE TEACHING_PROGRAM SUBJECT TYPE_OF_LESSON

periodstringобовʼязковийможе бути nullОдне з: DAY WEEK MONTH

presencestringможе бути nullОдне з: CANCELED PRESENT ABSENT PRESENT_OR_ABSENT

amountPerLessonnumberможе бути nullмін. 1

timeRangesobject[]може бути nullелементів мін. 12 поля

timeFromnumberобовʼязковий0–1439

timeTonumberобовʼязковий0–1439

typeOfLessonIdsnumber[]обовʼязковиймін. 1 · елементів мін. 1

subjectIdsnumber[]обовʼязковиймін. 1 · елементів мін. 1

durationOfLessonnumberобовʼязковийможе бути nullмін. 1

tiersobject[]обовʼязковийелементів мін. 12 поля

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

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

classAmountsobject[]може бути nullелементів мін. 12 поля

classOfStudentIdnumberобовʼязковиймін. 1

amountPerLessonnumberобовʼязковиймін. 1

programAmountsobject[]може бути nullелементів мін. 12 поля

teachingProgramIdnumberобовʼязковиймін. 1

amountPerLessonnumberобовʼязковиймін. 1

subjectAmountsobject[]може бути nullелементів мін. 12 поля

subjectIdnumberобовʼязковиймін. 1

amountPerLessonnumberобовʼязковиймін. 1

typeOfLessonAmountsobject[]може бути nullелементів мін. 12 поля

typeOfLessonIdnumberобовʼязковиймін. 1

amountPerLessonnumberобовʼязковиймін. 1

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

Відповідь · 201

application/json

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

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

dataanyПоля data ще не описані.

Помилки400401403429500

curl -X POST "https://your-school.rist.pro/api/bonus-template" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "nameOfBonus": "string",
    "type": "VOLUME",
    "period": "DAY",
    "presence": "CANCELED",
    "amountPerLesson": 1,
    "timeRanges": [
      {
        "timeFrom": 0,
        "timeTo": 0
      }
    ],
    "typeOfLessonIds": [
      1
    ],
    "subjectIds": [
      1
    ],
    "durationOfLesson": 1,
    "tiers": [
      {
        "totalMinutes": 0,
        "amountPerLesson": 0
      }
    ],
    "classAmounts": [
      {
        "classOfStudentId": 1,
        "amountPerLesson": 1
      }
    ],
    "programAmounts": [
      {
        "teachingProgramId": 1,
        "amountPerLesson": 1
      }
    ],
    "subjectAmounts": [
      {
        "subjectId": 1,
        "amountPerLesson": 1
      }
    ],
    "typeOfLessonAmounts": [
      {
        "typeOfLessonId": 1,
        "amountPerLesson": 1
      }
    ],
    "note": "string"
  }'

const response = await fetch("https://your-school.rist.pro/api/bonus-template", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "nameOfBonus": "string",
    "type": "VOLUME",
    "period": "DAY",
    "presence": "CANCELED",
    "amountPerLesson": 1,
    "timeRanges": [
      {
        "timeFrom": 0,
        "timeTo": 0
      }
    ],
    "typeOfLessonIds": [
      1
    ],
    "subjectIds": [
      1
    ],
    "durationOfLesson": 1,
    "tiers": [
      {
        "totalMinutes": 0,
        "amountPerLesson": 0
      }
    ],
    "classAmounts": [
      {
        "classOfStudentId": 1,
        "amountPerLesson": 1
      }
    ],
    "programAmounts": [
      {
        "teachingProgramId": 1,
        "amountPerLesson": 1
      }
    ],
    "subjectAmounts": [
      {
        "subjectId": 1,
        "amountPerLesson": 1
      }
    ],
    "typeOfLessonAmounts": [
      {
        "typeOfLessonId": 1,
        "amountPerLesson": 1
      }
    ],
    "note": "string"
  }),
});
const { data } = await response.json();

import os
import requests

response = requests.post(
    "https://your-school.rist.pro/api/bonus-template",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    json={
        "nameOfBonus": "string",
        "type": "VOLUME",
        "period": "DAY",
        "presence": "CANCELED",
        "amountPerLesson": 1,
        "timeRanges": [
            {
                "timeFrom": 0,
                "timeTo": 0
            }
        ],
        "typeOfLessonIds": [
            1
        ],
        "subjectIds": [
            1
        ],
        "durationOfLesson": 1,
        "tiers": [
            {
                "totalMinutes": 0,
                "amountPerLesson": 0
            }
        ],
        "classAmounts": [
            {
                "classOfStudentId": 1,
                "amountPerLesson": 1
            }
        ],
        "programAmounts": [
            {
                "teachingProgramId": 1,
                "amountPerLesson": 1
            }
        ],
        "subjectAmounts": [
            {
                "subjectId": 1,
                "amountPerLesson": 1
            }
        ],
        "typeOfLessonAmounts": [
            {
                "typeOfLessonId": 1,
                "amountPerLesson": 1
            }
        ],
        "note": "string"
    },
)
response.raise_for_status()
data = response.json()["data"]

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

{
  "statusCode": 201,
  "message": "Operation completed successfully",
  "data": …
}

POST

Assign system bonus to teachers

/api/bonus/template

Give a system bonus to several teachers at once (bonusTemplateId, teacherIds, optional dateStart and dateEnd as YYYY-MM-DD, note). Teachers who already have it are skipped.

assign_bonus_template

Тіло запиту

application/json · object

bonusTemplateIdnumberобовʼязковиймін. 1

teacherIdsnumber[]обовʼязковиймін. 1 · елементів мін. 1

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

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

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

Відповідь · 200

application/json

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

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

dataobject[]16 полів

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

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

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

bonusTemplateIdnumberобовʼязковийможе бути nullTemplate the terms below are taken from; null for a personal bonus.

overriddenTermsstring[]обовʼязковийTemplate terms overridden for this teacher (field names); empty for a personal bonus.

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

typestringобовʼязковийОдне з: VOLUME VOLUME_ONCE CONVERSION TIME_RANGE STUDENT_CLASS ON_TIME_CONDUCT LESSON_COUNT STUDENT_TENURE TEACHING_PROGRAM SUBJECT TYPE_OF_LESSON

periodstringобовʼязковийможе бути nullОдне з: DAY WEEK MONTH

presencestringобовʼязковийWhich lessons the bonus counts by student attendance.Одне з: CANCELED PRESENT ABSENT PRESENT_OR_ABSENT

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

dateStartstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss

dateEndstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss

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

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

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

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

Помилки400401403429500

curl -X POST "https://your-school.rist.pro/api/bonus/template" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "bonusTemplateId": 1,
    "teacherIds": [
      1
    ],
    "dateStart": "string",
    "dateEnd": "string",
    "note": "string"
  }'

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

import os
import requests

response = requests.post(
    "https://your-school.rist.pro/api/bonus/template",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    json={
        "bonusTemplateId": 1,
        "teacherIds": [
            1
        ],
        "dateStart": "string",
        "dateEnd": "string",
        "note": "string"
    },
)
response.raise_for_status()
data = response.json()["data"]

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

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": [
    {
      "amountPerLesson": 0,
      "bonusId": 1,
      "teacherId": 1,
      "bonusTemplateId": 1,
      "overriddenTerms": [
        "string"
      ],
      "nameOfBonus": "string",
      "type": "VOLUME",
      "period": "DAY",
      "presence": "CANCELED",
      "durationOfLesson": 0,
      "dateStart": "2026-11-09T14:30:00",
      "dateEnd": "2026-11-09T14:30:00",
      "note": "string",
      "isArchival": false,
      "updatedAt": "2026-11-09T14:30:00",
      "createdAt": "2026-11-09T14:30:00"
    }
  ]
}

POST

Create teacher bonus

/api/bonus

Add a personal bonus to one teacher (teacherId, optional dateStart and dateEnd as YYYY-MM-DD, note). Prefer a system bonus when several teachers share the terms. Terms: nameOfBonus; type (cannot be changed later): VOLUME = amountPerLesson for every lesson of a period, taken from the highest tier of minutes taught in it (tiers [{totalMinutes, amountPerLesson}], period DAY/WEEK/MONTH); VOLUME_ONCE = one-off sum per period by minutes reached (tiers, period); LESSON_COUNT = one-off sum by lessons per WEEK or MONTH (tiers, totalMinutes holds the lesson count); STUDENT_TENURE = one-off sum when a student reaches N lessons with the teacher (tiers, totalMinutes holds N); ON_TIME_CONDUCT = per-lesson sum from the first tier whose totalMinutes is not below the minutes from lesson end to conducting (values may be negative); CONVERSION = amountPerLesson per converted trial lesson; TIME_RANGE = amountPerLesson per lesson starting within timeRanges [{timeFrom, timeTo}] in minutes from midnight; STUDENT_CLASS = classAmounts [{classOfStudentId, amountPerLesson}]; TEACHING_PROGRAM = programAmounts [{teachingProgramId, amountPerLesson}]; SUBJECT = subjectAmounts [{subjectId, amountPerLesson}] instead of subjectIds; TYPE_OF_LESSON = typeOfLessonAmounts [{typeOfLessonId, amountPerLesson}] instead of typeOfLessonIds. Also typeOfLessonIds and subjectIds it applies to, durationOfLesson or null, presence PRESENT / ABSENT / PRESENT_OR_ABSENT / CANCELED for which lessons count (default any conducted).

create_teacher_bonus

Тіло запиту

application/json · object

teacherIdnumberобовʼязковиймін. 1

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

periodstringобовʼязковийможе бути nullОдне з: DAY WEEK MONTH

presencestringможе бути nullОдне з: CANCELED PRESENT ABSENT PRESENT_OR_ABSENT

amountPerLessonnumberможе бути nullмін. 1

timeRangesobject[]може бути nullелементів мін. 12 поля

timeFromnumberобовʼязковий0–1439

timeTonumberобовʼязковий0–1439

typeOfLessonIdsnumber[]обовʼязковиймін. 1 · елементів мін. 1

subjectIdsnumber[]обовʼязковиймін. 1 · елементів мін. 1

durationOfLessonnumberобовʼязковийможе бути nullмін. 1

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

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

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

tiersobject[]обовʼязковийелементів мін. 12 поля

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

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

classAmountsobject[]може бути nullелементів мін. 12 поля

classOfStudentIdnumberобовʼязковиймін. 1

amountPerLessonnumberобовʼязковиймін. 1

programAmountsobject[]може бути nullелементів мін. 12 поля

teachingProgramIdnumberобовʼязковиймін. 1

amountPerLessonnumberобовʼязковиймін. 1

subjectAmountsobject[]може бути nullелементів мін. 12 поля

subjectIdnumberобовʼязковиймін. 1

amountPerLessonnumberобовʼязковиймін. 1

typeOfLessonAmountsobject[]може бути nullелементів мін. 12 поля

typeOfLessonIdnumberобовʼязковиймін. 1

amountPerLessonnumberобовʼязковиймін. 1

Відповідь · 201

application/json

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

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

dataobject16 полів

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

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

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

bonusTemplateIdnumberобовʼязковийможе бути nullTemplate the terms below are taken from; null for a personal bonus.

overriddenTermsstring[]обовʼязковийTemplate terms overridden for this teacher (field names); empty for a personal bonus.

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

periodstringобовʼязковийможе бути nullОдне з: DAY WEEK MONTH

presencestringобовʼязковийWhich lessons the bonus counts by student attendance.Одне з: CANCELED PRESENT ABSENT PRESENT_OR_ABSENT

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

dateStartstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss

dateEndstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss

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

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

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

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

Помилки400401403429500

curl -X POST "https://your-school.rist.pro/api/bonus" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "teacherId": 1,
    "nameOfBonus": "string",
    "type": "VOLUME",
    "period": "DAY",
    "presence": "CANCELED",
    "amountPerLesson": 1,
    "timeRanges": [
      {
        "timeFrom": 0,
        "timeTo": 0
      }
    ],
    "typeOfLessonIds": [
      1
    ],
    "subjectIds": [
      1
    ],
    "durationOfLesson": 1,
    "dateStart": "string",
    "dateEnd": "string",
    "note": "string",
    "tiers": [
      {
        "totalMinutes": 0,
        "amountPerLesson": 0
      }
    ],
    "classAmounts": [
      {
        "classOfStudentId": 1,
        "amountPerLesson": 1
      }
    ],
    "programAmounts": [
      {
        "teachingProgramId": 1,
        "amountPerLesson": 1
      }
    ],
    "subjectAmounts": [
      {
        "subjectId": 1,
        "amountPerLesson": 1
      }
    ],
    "typeOfLessonAmounts": [
      {
        "typeOfLessonId": 1,
        "amountPerLesson": 1
      }
    ]
  }'

const response = await fetch("https://your-school.rist.pro/api/bonus", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "teacherId": 1,
    "nameOfBonus": "string",
    "type": "VOLUME",
    "period": "DAY",
    "presence": "CANCELED",
    "amountPerLesson": 1,
    "timeRanges": [
      {
        "timeFrom": 0,
        "timeTo": 0
      }
    ],
    "typeOfLessonIds": [
      1
    ],
    "subjectIds": [
      1
    ],
    "durationOfLesson": 1,
    "dateStart": "string",
    "dateEnd": "string",
    "note": "string",
    "tiers": [
      {
        "totalMinutes": 0,
        "amountPerLesson": 0
      }
    ],
    "classAmounts": [
      {
        "classOfStudentId": 1,
        "amountPerLesson": 1
      }
    ],
    "programAmounts": [
      {
        "teachingProgramId": 1,
        "amountPerLesson": 1
      }
    ],
    "subjectAmounts": [
      {
        "subjectId": 1,
        "amountPerLesson": 1
      }
    ],
    "typeOfLessonAmounts": [
      {
        "typeOfLessonId": 1,
        "amountPerLesson": 1
      }
    ]
  }),
});
const { data } = await response.json();

import os
import requests

response = requests.post(
    "https://your-school.rist.pro/api/bonus",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    json={
        "teacherId": 1,
        "nameOfBonus": "string",
        "type": "VOLUME",
        "period": "DAY",
        "presence": "CANCELED",
        "amountPerLesson": 1,
        "timeRanges": [
            {
                "timeFrom": 0,
                "timeTo": 0
            }
        ],
        "typeOfLessonIds": [
            1
        ],
        "subjectIds": [
            1
        ],
        "durationOfLesson": 1,
        "dateStart": "string",
        "dateEnd": "string",
        "note": "string",
        "tiers": [
            {
                "totalMinutes": 0,
                "amountPerLesson": 0
            }
        ],
        "classAmounts": [
            {
                "classOfStudentId": 1,
                "amountPerLesson": 1
            }
        ],
        "programAmounts": [
            {
                "teachingProgramId": 1,
                "amountPerLesson": 1
            }
        ],
        "subjectAmounts": [
            {
                "subjectId": 1,
                "amountPerLesson": 1
            }
        ],
        "typeOfLessonAmounts": [
            {
                "typeOfLessonId": 1,
                "amountPerLesson": 1
            }
        ]
    },
)
response.raise_for_status()
data = response.json()["data"]

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

{
  "statusCode": 201,
  "message": "Operation completed successfully",
  "data": {
    "amountPerLesson": 0,
    "bonusId": 1,
    "teacherId": 1,
    "bonusTemplateId": 1,
    "overriddenTerms": [
      "string"
    ],
    "nameOfBonus": "string",
    "type": "VOLUME",
    "period": "DAY",
    "presence": "CANCELED",
    "durationOfLesson": 0,
    "dateStart": "2026-11-09T14:30:00",
    "dateEnd": "2026-11-09T14:30:00",
    "note": "string",
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00"
  }
}

PUT

Update system bonus

/api/bonus-template/{id}

Rewrite a system bonus; send all terms as in POST /api/bonus-template, the type stays. It applies at once to every assigned teacher who has not overridden the terms. Terms: nameOfBonus; type (cannot be changed later): VOLUME = amountPerLesson for every lesson of a period, taken from the highest tier of minutes taught in it (tiers [{totalMinutes, amountPerLesson}], period DAY/WEEK/MONTH); VOLUME_ONCE = one-off sum per period by minutes reached (tiers, period); LESSON_COUNT = one-off sum by lessons per WEEK or MONTH (tiers, totalMinutes holds the lesson count); STUDENT_TENURE = one-off sum when a student reaches N lessons with the teacher (tiers, totalMinutes holds N); ON_TIME_CONDUCT = per-lesson sum from the first tier whose totalMinutes is not below the minutes from lesson end to conducting (values may be negative); CONVERSION = amountPerLesson per converted trial lesson; TIME_RANGE = amountPerLesson per lesson starting within timeRanges [{timeFrom, timeTo}] in minutes from midnight; STUDENT_CLASS = classAmounts [{classOfStudentId, amountPerLesson}]; TEACHING_PROGRAM = programAmounts [{teachingProgramId, amountPerLesson}]; SUBJECT = subjectAmounts [{subjectId, amountPerLesson}] instead of subjectIds; TYPE_OF_LESSON = typeOfLessonAmounts [{typeOfLessonId, amountPerLesson}] instead of typeOfLessonIds. Also typeOfLessonIds and subjectIds it applies to, durationOfLesson or null, presence PRESENT / ABSENT / PRESENT_OR_ABSENT / CANCELED for which lessons count (default any conducted).

update_bonus_template

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

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

Тіло запиту

application/json · object

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

periodstringобовʼязковийможе бути nullОдне з: DAY WEEK MONTH

presencestringможе бути nullОдне з: CANCELED PRESENT ABSENT PRESENT_OR_ABSENT

amountPerLessonnumberможе бути nullмін. 1

timeRangesobject[]може бути nullелементів мін. 12 поля

timeFromnumberобовʼязковий0–1439

timeTonumberобовʼязковий0–1439

typeOfLessonIdsnumber[]обовʼязковиймін. 1 · елементів мін. 1

subjectIdsnumber[]обовʼязковиймін. 1 · елементів мін. 1

durationOfLessonnumberобовʼязковийможе бути nullмін. 1

tiersobject[]обовʼязковийелементів мін. 12 поля

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

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

classAmountsobject[]може бути nullелементів мін. 12 поля

classOfStudentIdnumberобовʼязковиймін. 1

amountPerLessonnumberобовʼязковиймін. 1

programAmountsobject[]може бути nullелементів мін. 12 поля

teachingProgramIdnumberобовʼязковиймін. 1

amountPerLessonnumberобовʼязковиймін. 1

subjectAmountsobject[]може бути nullелементів мін. 12 поля

subjectIdnumberобовʼязковиймін. 1

amountPerLessonnumberобовʼязковиймін. 1

typeOfLessonAmountsobject[]може бути nullелементів мін. 12 поля

typeOfLessonIdnumberобовʼязковиймін. 1

amountPerLessonnumberобовʼязковиймін. 1

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

Відповідь · 200

application/json

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

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

dataanyПоля data ще не описані.

Помилки400401403429500

curl -X PUT "https://your-school.rist.pro/api/bonus-template/1" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "nameOfBonus": "string",
    "type": "VOLUME",
    "period": "DAY",
    "presence": "CANCELED",
    "amountPerLesson": 1,
    "timeRanges": [
      {
        "timeFrom": 0,
        "timeTo": 0
      }
    ],
    "typeOfLessonIds": [
      1
    ],
    "subjectIds": [
      1
    ],
    "durationOfLesson": 1,
    "tiers": [
      {
        "totalMinutes": 0,
        "amountPerLesson": 0
      }
    ],
    "classAmounts": [
      {
        "classOfStudentId": 1,
        "amountPerLesson": 1
      }
    ],
    "programAmounts": [
      {
        "teachingProgramId": 1,
        "amountPerLesson": 1
      }
    ],
    "subjectAmounts": [
      {
        "subjectId": 1,
        "amountPerLesson": 1
      }
    ],
    "typeOfLessonAmounts": [
      {
        "typeOfLessonId": 1,
        "amountPerLesson": 1
      }
    ],
    "note": "string"
  }'

const response = await fetch("https://your-school.rist.pro/api/bonus-template/1", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "nameOfBonus": "string",
    "type": "VOLUME",
    "period": "DAY",
    "presence": "CANCELED",
    "amountPerLesson": 1,
    "timeRanges": [
      {
        "timeFrom": 0,
        "timeTo": 0
      }
    ],
    "typeOfLessonIds": [
      1
    ],
    "subjectIds": [
      1
    ],
    "durationOfLesson": 1,
    "tiers": [
      {
        "totalMinutes": 0,
        "amountPerLesson": 0
      }
    ],
    "classAmounts": [
      {
        "classOfStudentId": 1,
        "amountPerLesson": 1
      }
    ],
    "programAmounts": [
      {
        "teachingProgramId": 1,
        "amountPerLesson": 1
      }
    ],
    "subjectAmounts": [
      {
        "subjectId": 1,
        "amountPerLesson": 1
      }
    ],
    "typeOfLessonAmounts": [
      {
        "typeOfLessonId": 1,
        "amountPerLesson": 1
      }
    ],
    "note": "string"
  }),
});
const { data } = await response.json();

import os
import requests

response = requests.put(
    "https://your-school.rist.pro/api/bonus-template/1",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    json={
        "nameOfBonus": "string",
        "type": "VOLUME",
        "period": "DAY",
        "presence": "CANCELED",
        "amountPerLesson": 1,
        "timeRanges": [
            {
                "timeFrom": 0,
                "timeTo": 0
            }
        ],
        "typeOfLessonIds": [
            1
        ],
        "subjectIds": [
            1
        ],
        "durationOfLesson": 1,
        "tiers": [
            {
                "totalMinutes": 0,
                "amountPerLesson": 0
            }
        ],
        "classAmounts": [
            {
                "classOfStudentId": 1,
                "amountPerLesson": 1
            }
        ],
        "programAmounts": [
            {
                "teachingProgramId": 1,
                "amountPerLesson": 1
            }
        ],
        "subjectAmounts": [
            {
                "subjectId": 1,
                "amountPerLesson": 1
            }
        ],
        "typeOfLessonAmounts": [
            {
                "typeOfLessonId": 1,
                "amountPerLesson": 1
            }
        ],
        "note": "string"
    },
)
response.raise_for_status()
data = response.json()["data"]

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

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": …
}

PATCH

Archive system bonus

/api/bonus-template/archive/{id}

Archive (isArchival=true) or restore (isArchival=false) a system bonus. Archiving also ends today every active teacher bonus assigned from it; restoring does not bring those back.

archive_bonus_template

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

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

Тіло запиту

application/json · object

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

Відповідь · 200

application/json

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

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

dataanyПоля data ще не описані.

Помилки400401403429500

curl -X PATCH "https://your-school.rist.pro/api/bonus-template/archive/1" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "isArchival": false
  }'

const response = await fetch("https://your-school.rist.pro/api/bonus-template/archive/1", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "isArchival": false
  }),
});
const { data } = await response.json();

import os
import requests

response = requests.patch(
    "https://your-school.rist.pro/api/bonus-template/archive/1",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    json={
        "isArchival": False
    },
)
response.raise_for_status()
data = response.json()["data"]

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

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": …
}

PATCH

Update teacher bonus

/api/bonus/{id}

Change a teacher bonus (path id is the bonusId from GET /api/teacher/{id}/bonuses). Send only the fields to change; the type cannot change. Changing the terms of a bonus from a system bonus overrides them for this teacher only.

update_teacher_bonus

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

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

Тіло запиту

application/json · object

teacherIdnumberмін. 1

nameOfBonusstringдовжина 1–150

periodstringможе бути nullОдне з: DAY WEEK MONTH

presencestringможе бути nullОдне з: CANCELED PRESENT ABSENT PRESENT_OR_ABSENT

amountPerLessonnumberможе бути nullмін. 1

timeRangesobject[]може бути nullелементів мін. 12 поля

timeFromnumberобовʼязковий0–1439

timeTonumberобовʼязковий0–1439

typeOfLessonIdsnumber[]мін. 1 · елементів мін. 1

subjectIdsnumber[]мін. 1 · елементів мін. 1

durationOfLessonnumberможе бути nullмін. 1

dateStartstringможе бути null—

dateEndstringможе бути null—

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

tiersobject[]елементів мін. 12 поля

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

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

classAmountsobject[]може бути nullелементів мін. 12 поля

classOfStudentIdnumberобовʼязковиймін. 1

amountPerLessonnumberобовʼязковиймін. 1

programAmountsobject[]може бути nullелементів мін. 12 поля

teachingProgramIdnumberобовʼязковиймін. 1

amountPerLessonnumberобовʼязковиймін. 1

subjectAmountsobject[]може бути nullелементів мін. 12 поля

subjectIdnumberобовʼязковиймін. 1

amountPerLessonnumberобовʼязковиймін. 1

typeOfLessonAmountsobject[]може бути nullелементів мін. 12 поля

typeOfLessonIdnumberобовʼязковиймін. 1

amountPerLessonnumberобовʼязковиймін. 1

Відповідь · 200

application/json

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

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

dataobject16 полів

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

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

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

bonusTemplateIdnumberобовʼязковийможе бути nullTemplate the terms below are taken from; null for a personal bonus.

overriddenTermsstring[]обовʼязковийTemplate terms overridden for this teacher (field names); empty for a personal bonus.

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

periodstringобовʼязковийможе бути nullОдне з: DAY WEEK MONTH

presencestringобовʼязковийWhich lessons the bonus counts by student attendance.Одне з: CANCELED PRESENT ABSENT PRESENT_OR_ABSENT

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

dateStartstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss

dateEndstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss

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

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

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

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

Помилки400401403429500

curl -X PATCH "https://your-school.rist.pro/api/bonus/1" \
  -H "Authorization: Bearer $RIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "teacherId": 1,
    "nameOfBonus": "string",
    "type": "VOLUME",
    "period": "DAY",
    "presence": "CANCELED",
    "amountPerLesson": 1,
    "timeRanges": [
      {
        "timeFrom": 0,
        "timeTo": 0
      }
    ],
    "typeOfLessonIds": [
      1
    ],
    "subjectIds": [
      1
    ],
    "durationOfLesson": 1,
    "dateStart": "string",
    "dateEnd": "string",
    "note": "string",
    "tiers": [
      {
        "totalMinutes": 0,
        "amountPerLesson": 0
      }
    ],
    "classAmounts": [
      {
        "classOfStudentId": 1,
        "amountPerLesson": 1
      }
    ],
    "programAmounts": [
      {
        "teachingProgramId": 1,
        "amountPerLesson": 1
      }
    ],
    "subjectAmounts": [
      {
        "subjectId": 1,
        "amountPerLesson": 1
      }
    ],
    "typeOfLessonAmounts": [
      {
        "typeOfLessonId": 1,
        "amountPerLesson": 1
      }
    ]
  }'

const response = await fetch("https://your-school.rist.pro/api/bonus/1", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "teacherId": 1,
    "nameOfBonus": "string",
    "type": "VOLUME",
    "period": "DAY",
    "presence": "CANCELED",
    "amountPerLesson": 1,
    "timeRanges": [
      {
        "timeFrom": 0,
        "timeTo": 0
      }
    ],
    "typeOfLessonIds": [
      1
    ],
    "subjectIds": [
      1
    ],
    "durationOfLesson": 1,
    "dateStart": "string",
    "dateEnd": "string",
    "note": "string",
    "tiers": [
      {
        "totalMinutes": 0,
        "amountPerLesson": 0
      }
    ],
    "classAmounts": [
      {
        "classOfStudentId": 1,
        "amountPerLesson": 1
      }
    ],
    "programAmounts": [
      {
        "teachingProgramId": 1,
        "amountPerLesson": 1
      }
    ],
    "subjectAmounts": [
      {
        "subjectId": 1,
        "amountPerLesson": 1
      }
    ],
    "typeOfLessonAmounts": [
      {
        "typeOfLessonId": 1,
        "amountPerLesson": 1
      }
    ]
  }),
});
const { data } = await response.json();

import os
import requests

response = requests.patch(
    "https://your-school.rist.pro/api/bonus/1",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
    json={
        "teacherId": 1,
        "nameOfBonus": "string",
        "type": "VOLUME",
        "period": "DAY",
        "presence": "CANCELED",
        "amountPerLesson": 1,
        "timeRanges": [
            {
                "timeFrom": 0,
                "timeTo": 0
            }
        ],
        "typeOfLessonIds": [
            1
        ],
        "subjectIds": [
            1
        ],
        "durationOfLesson": 1,
        "dateStart": "string",
        "dateEnd": "string",
        "note": "string",
        "tiers": [
            {
                "totalMinutes": 0,
                "amountPerLesson": 0
            }
        ],
        "classAmounts": [
            {
                "classOfStudentId": 1,
                "amountPerLesson": 1
            }
        ],
        "programAmounts": [
            {
                "teachingProgramId": 1,
                "amountPerLesson": 1
            }
        ],
        "subjectAmounts": [
            {
                "subjectId": 1,
                "amountPerLesson": 1
            }
        ],
        "typeOfLessonAmounts": [
            {
                "typeOfLessonId": 1,
                "amountPerLesson": 1
            }
        ]
    },
)
response.raise_for_status()
data = response.json()["data"]

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

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "amountPerLesson": 0,
    "bonusId": 1,
    "teacherId": 1,
    "bonusTemplateId": 1,
    "overriddenTerms": [
      "string"
    ],
    "nameOfBonus": "string",
    "type": "VOLUME",
    "period": "DAY",
    "presence": "CANCELED",
    "durationOfLesson": 0,
    "dateStart": "2026-11-09T14:30:00",
    "dateEnd": "2026-11-09T14:30:00",
    "note": "string",
    "isArchival": false,
    "updatedAt": "2026-11-09T14:30:00",
    "createdAt": "2026-11-09T14:30:00"
  }
}

Bonuses

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

Відповідь · 200

Відповідь · 200

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

Відповідь · 200

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

Відповідь · 200

Тіло запиту

Відповідь · 201

Тіло запиту

Відповідь · 200

Тіло запиту

Відповідь · 201

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

Тіло запиту

Відповідь · 200

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

Тіло запиту

Відповідь · 200

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

Тіло запиту

Відповідь · 200