Получение списка долгов
const url = 'https://api-admin.billz.ai/v1/debt?page=1&limit=5&min_amount=0&max_amount=0';const options = { method: 'GET', headers: { 'platform-id': '7d4a4c38-dd84-4902-b744-0488b80a4c01', Authorization: 'Bearer <token>' }};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://api-admin.billz.ai/v1/debt?page=1&limit=5&min_amount=0&max_amount=0' \ --header 'Authorization: Bearer <token>' \ --header 'platform-id: 7d4a4c38-dd84-4902-b744-0488b80a4c01'Коды ошибок: 400 — ошибка валидации входных данных; 401, 403, 429, 500 — общие для всех методов. Форматы тела и семантика — Коды ответов и ошибки.
Authorizations
Заголовок раздела «Authorizations»Parameters
Заголовок раздела «Parameters»Query Parameters
Заголовок раздела «Query Parameters»Номер страницы; <= 1000
Example
1Размер страницы; <= 1000
Example
5Поиск; не более 100 символов
fully_paid, unpaid, overdue, partial_paid; иное значение — 400
Начало периода
Конец периода
Если непустой — должен быть валидным UUID, иначе 400
Минимальная сумма; не может быть больше максимальной
Максимальная сумма
Магазины; не более 100 элементов
Начало периода даты погашения
Конец периода даты погашения
Должен быть валидным UUID
Время в UTC
При true в каждый долг догружаются транзакции
Не используется
Не используется
Не используется
Header Parameters
Заголовок раздела «Header Parameters»Идентификатор платформы. Для интеграций используется статичное значение.
Responses
Заголовок раздела «Responses»Успешный ответ
object
Количество долгов
Список долгов
object
ID долга
ID заказа
Номер заказа
Внешний идентификатор долга
Сумма долга
Комментарий
Дата погашения
Создатель
object
Дата создания
Дата удаления
Статус: fully_paid, unpaid, overdue, partial_paid
Клиент
object
Оплаченная сумма
Магазин
object
Дата обновления
Текстовые описания платежей
Дата создания с TZ
Дата погашения с TZ
Контактные телефоны
Заполняется только при with_transactions=true. Поля: id, external_id, debt_id, comment, shop, created_by, created_at, payments (id, amount, payment_type), amount, customer, source_type, source_id, cashbox_id
Examplegenerated
{ "count": 1, "data": [ { "id": "example", "order_id": "example", "order_number": "example", "external_id": "example", "amount": 1, "comment": "example", "repayment_date": "example", "created_by": { "id": "example", "name": "example", "first_name": "example", "last_name": "example" }, "created_at": "example", "deleted_at": "example", "status": "example", "customer": { "id": "example", "name": "example", "first_name": "example", "last_name": "example" }, "paid_amount": 1, "shop": { "id": "example", "name": "example" }, "updated_at": "example", "payments": [ "example" ], "created_at_tz": "example", "repayment_at_tz": "example", "contact_phones": [ "example" ], "transactions": [ "example" ], "source_type": "example", "source_id": 1, "source_item_id": 1 } ]}