Баланс

Получение информации о балансе, лимитах и истории операций.

Пополнение баланса

Для пополнения баланса обратитесь к сопровождающему менеджеру или напишите на info@fraim.ru.

Текущий баланс и лимиты

Возвращает текущий баланс пользователя по типам, суточные лимиты и информацию о лицензии.

Пример ответа

{
  "balance": {
    "tenders": 995,
    "contracts": 100,
    "protocols": 50
  },
  "limits": {
    "tenders": {
      "entity_type": "tender",
      "date": "2024-01-20",
      "current": 5,
      "limit": 1000,
      "remaining": 995,
      "reset_at": "2024-01-21T00:00:00"
    },
    "contracts": {
      "entity_type": "contract",
      "date": "2024-01-20",
      "current": 0,
      "limit": 100,
      "remaining": 100,
      "reset_at": "2024-01-21T00:00:00"
    },
    "protocols": {
      "entity_type": "protocol",
      "date": "2024-01-20",
      "current": 0,
      "limit": 50,
      "remaining": 50,
      "reset_at": "2024-01-21T00:00:00"
    }
  },
  "license": {
    "end_date": "2024-12-31T23:59:59",
    "active": true
  },
  "last_updated": "2024-01-20T14:30:00"
}

Поля ответа

Поле	Тип	Описание
`balance.tenders`	integer	Баланс тендеров
`balance.contracts`	integer	Баланс контрактов
`balance.protocols`	integer	Баланс протоколов
`limits`	object	Суточные лимиты по типам
`license.active`	boolean	Активна ли лицензия
`license.end_date`	datetime	Дата окончания лицензии

История операций

Возвращает историю списаний и пополнений баланса.

Пример ответа

{
  "transactions": [
    {
      "id": 1234,
      "amount": -5,
      "transaction_type": "debit",
      "description": "Получение тендеров по фильтру #123",
      "balance_type": "tenders",
      "entity_id": 12345,
      "entity_type": "tender",
      "filter_id": 123,
      "created_at": "2024-01-20T14:30:00"
    },
    {
      "id": 1233,
      "amount": 1000,
      "transaction_type": "credit",
      "description": "Пополнение баланса",
      "balance_type": "tenders",
      "created_at": "2024-01-15T10:00:00"
    }
  ],
  "total": 150
}

Поля ответа

Поле	Тип	Описание
`amount`	integer	Сумма (положительная — пополнение, отрицательная — списание)
`transaction_type`	string	Тип: debit (списание) или credit (пополнение)
`balance_type`	string	Тип баланса: tenders, contracts, protocols
`entity_type`	string	Тип сущности: tender, contract, protocol
`description`	string	Описание операции
`created_at`	datetime	Дата и время операции

Списание баланса

Баланс списывается автоматически при запросе тендеров:

curl -X GET "https://zakupki.fraim.ru/api/v2/tenders?filter_id=123" \
  -H "X-API-Token: your_api_token_here"

Ответ содержит информацию о списании:

{
  "total": 150,
  "new_tenders_count": 5,
  "remaining_balance": 995,
  "items": [...]
}