API - Список платежів

Ліміти

Ліміти стосуються лише методу отримання списку платежів.

Період Ліміт запитів
1 хв 10
1 година 100
24 години 1000

Документація в кабінеті SalesDrive, API-ключі

Документація по API з описом доступна у вашому кабінеті SalesDrive:

Створити API-ключ з правами читання платежів:

Авторизація

У запитах по отриманню списку платежів - передавайте заголовок:

Приклад запитів для отримання списку платежів

Вхідні платежі після 01.07.2025:

GET https://yourdomain.salesdrive.me/api/payment/list/?page=1&limit=50&filter[date][from]=2025-07-01&type=incoming

Параметри запиту, фільтри

Параметр Опис
page Сторінка
limit Кількість результатів на сторінці (максимум 100), за замовчуванням 30
type all - усі (за замовчуванням), incoming - вхідні, outcoming - вихідні
filter масив фільтрів
Фільтри
Ви можете фільтрувати документи по будь-яких полях.
Нижче наведені найбільш популярні фільтри:
filter[updateAt][from] Дата оновлення від (формат: "РРРР-ММ-ДД ГГ:ХХ:СС")
filter[updateAt][to] Дата оновлення до (формат: "РРРР-ММ-ДД ГГ:ХХ:СС")
filter[date][from] Дата від (формат: "РРРР-ММ-ДД ГГ:ХХ:СС")
filter[date][to] Дата до (формат: "РРРР-ММ-ДД ГГ:ХХ:СС")
filter[createdAt][from] Дата створення від (формат: "РРРР-ММ-ДД ГГ:ХХ:СС")
filter[createdAt][to] Дата створення до (формат: "РРРР-ММ-ДД ГГ:ХХ:СС")
filter[organizationId] ID організації

Формат даних, що повертаються

Поле Опис
data Масив із даними
pagination[currentPage] Поточна сторінка
pagination[pageCount] Кількість сторінок
pagination[perPage] Кількість результатів на сторінці
totals[count] Усього знайдено документів
totals[sum] Сума знайдених документів
status "success" - успіх, "error" - помилка
message повідомлення з описом помилки (якщо виникла помилка)

Реєстрація в SalesDrive

.salesdrive.me

Реєструючись, ви погоджуєтеся на обробку персональних даних і приймаєте умови публічного договору (оферти).