FinanceCounterparties and projects

Counterparties and projects

Finance · 2 operations

GET

List counterparties

/api/counterparty

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

list_counterparties

Query parameters · 6

pagenumbermin 1 · default 1
pageSizenumber1–250 · default 20
counterpartyIdsnumber[]—
categoryIdnumber—
nameOfCounterpartystringrequiredlength max 150
isArchivalobjectrequireddefault false

Response · 200

application/json

statusCodenumberrequiredexample 200
messagestringrequired—
dataobject4 fields
totalnumberrequired—
totalPagesnumberrequired—
currentPagenumberrequired—
counterpartiesobject[]required8 fields
counterpartyIdnumberrequired—
nameOfCounterpartystringrequired—
categoryIdnumberrequired—
notestringrequirednullable—
ordernumberrequired—
isArchivalbooleanrequired—
updatedAtstringrequiredformat YYYY-MM-DDTHH:mm:ss
createdAtstringrequiredformat YYYY-MM-DDTHH:mm:ss
Errors400401403429500
curl "https://your-school.rist.pro/api/counterparty?nameOfCounterparty=string&isArchival=false" \
  -H "Authorization: Bearer $RIST_API_KEY"
Response example · 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

Query parameters · 5

pagenumbermin 1 · default 1
pageSizenumber1–250 · default 20
nameOfProjectstringrequiredlength max 150
isArchivalobjectrequireddefault false
projectIdsnumber[]required—

Response · 200

application/json

statusCodenumberrequiredexample 200
messagestringrequired—
dataobject4 fields
totalnumberrequired—
totalPagesnumberrequired—
currentPagenumberrequired—
projectsobject[]required7 fields
projectIdnumberrequired—
nameOfProjectstringrequired—
notestringrequirednullable—
ordernumberrequired—
isArchivalbooleanrequired—
updatedAtstringrequiredformat YYYY-MM-DDTHH:mm:ss
createdAtstringrequiredformat YYYY-MM-DDTHH:mm:ss
Errors400401403429500
curl "https://your-school.rist.pro/api/project?nameOfProject=string&isArchival=false&projectIds=1" \
  -H "Authorization: Bearer $RIST_API_KEY"
Response example · 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"
      }
    ]
  }
}