Заголовки запроса API токен сервисного пользователя в формате Bearer. Получите токен в панели администратора школы. Формат: Bearer YOUR_TOKEN.
Уникальный идентификатор продавца в системе. Используется для разграничения доступа между разными продавцами.
Уникальный идентификатор школы в системе. Определяет контекст выполнения операции.
GET /saas/v2/invoice/list/raw
Все параметры фильтрации необязательны. Параметры-массивы передаются повторением параметра в строке запроса:
userIds=1&userIds=2. Диапазоны (*Range) передаются как вложенные параметры, например
createdAtDateRange[from] и createdAtDateRange[to].
Параметры запроса Пагинация Количество записей, которые нужно пропустить. По умолчанию 0.
Номер страницы (альтернатива skip). Начинается с 1.
Количество записей на странице. От 1 до 1000. По умолчанию 100.
Фильтрация Фильтр по ID пользователей.
Фильтр по типу счёта: Regular, InstallmentPay, InstallmentInit, SubscriptionPay, SubscriptionInit.
Поиск (по пользователю/идентификаторам). Максимум 50 символов, пробелы по краям обрезаются.
Диапазон дат создания счёта. Show Свойства createdAtDateRange
Начало диапазона (ISO 8601). Должно быть ≤ to.
Конец диапазона (ISO 8601). Должно быть ≥ from.
Диапазон итоговой суммы счёта. Должно быть задано хотя бы одно из полей. Show Свойства totalAmountRange
Фильтр по UTM-меткам счёта. Массив пар «ключ-значение». Каждый элемент: { "key": "utm_source", "value": "google" }
(key и value — непустые строки).
Фильтр по связанному платежу. Статусы платежа: Created, WaitingPay, WaitingForBinding, Processing, Completed,
BindingCompleted, Canceled.
Актуальные (текущие) статусы платежа — те же значения, что и statuses.
Поля ответа Постраничный список счетов (компактная проекция). Полная структура — invoice в справочнике
payment Массив счетов. Тип счёта (см. фильтр types).
Статус счёта: Active, Canceled.
Валюта: Free, Exes, Rub, Uzs, Kzt, Usd, Eur.
Дата создания (ISO 8601).
Дата истечения (ISO 8601).
Покупатель: id, tgId, login, email, phone, fullName.
Позиции счёта: массив объектов { productId, courseId, totalPrice, discountAmount }.
Общее количество записей.
Общее количество страниц.
Признак последней страницы.
Параметры следующей страницы (skip, take, page).
Параметры предыдущей страницы (skip, take, page).
curl --location 'https://api.exode.biz/saas/v2/invoice/list/raw?take=20&types=Regular' \ --header 'Seller-Id: {{ sellerId }}' \ --header 'School-Id: {{ schoolId }}' \ --header 'Authorization: Bearer YOUR_TOKEN'
{ "success" : true , "code" : 200 , "payload" : { "page" : 1 , "count" : 1 , "pages" : 1 , "isFirst" : true , "isLast" : true , "items" : [ { "invoiceId" : 7001 , "invoiceUuid" : "b1f2c3d4-..." , "type" : "Regular" , "status" : "Active" , "totalAmount" : 1990 , "discountAmount" : 0 , "currency" : "Rub" , "createdAt" : "2025-01-15T10:30:00Z" , "expireAt" : null , "user" : { "id" : 123 , "tgId" : null , "login" : "[email protected] " , "email" : "[email protected] " , "phone" : "+9876543210" , "fullName" : "John Doe" }, "products" : [ { "productId" : 200 , "courseId" : 10 , "totalPrice" : 1990 , "discountAmount" : 0 } ] } ], "next" : { "skip" : 20 , "take" : 20 , "page" : 2 }, "prev" : { "skip" : 0 , "take" : 20 , "page" : 1 } } }
Требования к правам доступа Требуется аутентификация по токену и право на просмотр продаж (SellerSales).
