FinanceCounterparties and projects

Counterparties and projects

Finance · 2 операції

GET

List counterparties

/api/counterparty

Counterparties (suppliers, landlords and other non-student payers or payees) of finance operations.

list_counterparties

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

pagenumberмін. 1 · за замовчуванням 1
pageSizenumber1–250 · за замовчуванням 20
counterpartyIdsnumber[]—
categoryIdnumber—
nameOfCounterpartystringобовʼязковийдовжина макс. 150
isArchivalobjectобовʼязковийза замовчуванням false

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200
messagestringобовʼязковий—
dataobject4 поля
totalnumberобовʼязковий—
totalPagesnumberобовʼязковий—
currentPagenumberобовʼязковий—
counterpartiesobject[]обовʼязковий8 полів
counterpartyIdnumberобовʼязковий—
nameOfCounterpartystringобовʼязковий—
categoryIdnumberобовʼязковий—
notestringобовʼязковийможе бути null—
ordernumberобовʼязковий—
isArchivalbooleanобовʼязковий—
updatedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
Помилки400401403429500
curl "https://your-school.rist.pro/api/counterparty?nameOfCounterparty=string&isArchival=false" \
  -H "Authorization: Bearer $RIST_API_KEY"
Приклад відповіді · 200
{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "total": 0,
    "totalPages": 0,
    "currentPage": 0,
    "counterparties": [
      {
        "counterpartyId": 1,
        "nameOfCounterparty": "string",
        "categoryId": 1,
        "note": "string",
        "order": 0,
        "isArchival": false,
        "updatedAt": "2026-11-09T14:30:00",
        "createdAt": "2026-11-09T14:30:00"
      }
    ]
  }
}
GET

Projects that finance operations can be attributed to.

list_finance_projects

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

pagenumberмін. 1 · за замовчуванням 1
pageSizenumber1–250 · за замовчуванням 20
nameOfProjectstringобовʼязковийдовжина макс. 150
isArchivalobjectобовʼязковийза замовчуванням false
projectIdsnumber[]обовʼязковий—

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200
messagestringобовʼязковий—
dataobject4 поля
totalnumberобовʼязковий—
totalPagesnumberобовʼязковий—
currentPagenumberобовʼязковий—
projectsobject[]обовʼязковий7 полів
projectIdnumberобовʼязковий—
nameOfProjectstringобовʼязковий—
notestringобовʼязковийможе бути null—
ordernumberобовʼязковий—
isArchivalbooleanобовʼязковий—
updatedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
createdAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss
Помилки400401403429500
curl "https://your-school.rist.pro/api/project?nameOfProject=string&isArchival=false&projectIds=1" \
  -H "Authorization: Bearer $RIST_API_KEY"
Приклад відповіді · 200
{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": {
    "total": 0,
    "totalPages": 0,
    "currentPage": 0,
    "projects": [
      {
        "projectId": 1,
        "nameOfProject": "string",
        "note": "string",
        "order": 0,
        "isArchival": false,
        "updatedAt": "2026-11-09T14:30:00",
        "createdAt": "2026-11-09T14:30:00"
      }
    ]
  }
}