Перейти к содержимому

Получение информации по долгам

GET
/v1/debt-stats
curl --request GET \
--url 'https://api-admin.billz.ai/v1/debt-stats?min_amount=0&max_amount=0' \
--header 'Authorization: Bearer <token>' \
--header 'platform-id: 7d4a4c38-dd84-4902-b744-0488b80a4c01'

Коды ошибок: 400 — ошибка валидации входных данных; 401, 403, 429, 500 — общие для всех методов. Форматы тела и семантика — Коды ответов и ошибки.

customer_id
string format: uuid

Идентификатор клиента

search
string

Поиск

status
string

fully_paid, unpaid, overdue, partial_paid

start_date
string

Начало периода

end_date
string

Конец периода

min_amount
number format: double
0

Минимальная сумма

max_amount
number format: double
0

Максимальная сумма

shop_ids
Array<string>

Магазины

repayment_date_start
string

Начало периода даты погашения

repayment_date_end
string

Конец периода даты погашения

user_id
string
payment_type
string

Фильтр по типам оплаты

platform-id
string
default: 7d4a4c38-dd84-4902-b744-0488b80a4c01

Идентификатор платформы. Для интеграций используется статичное значение.

Успешный ответ

Media typeapplication/json
object
total

Общее количество

number format: double
total_debt_amount

Общая сумма задолженности

number format: double
total_unpaid_amount

Неоплаченная сумма

number format: double
total_paid_amount

Оплаченная сумма

number format: double
total_system_paid_amount

Системная оплата

number format: double
number_of_debtors

Количество должников

integer format: int32
number_of_paid_debtors

Должники, погасившие долг

integer format: int32
number_of_overdue_debtors

Должники с просрочкой

integer format: int32
number_of_debts

Количество долгов

integer format: int32
number_of_paid_debts

Погашенные долги

integer format: int32
number_of_unpaid_debts

Неоплаченные долги

integer format: int32
number_of_overdue_debts

Просроченные долги

integer format: int32
number_of_partially_paid_debts

Частично оплаченные долги

integer format: int32
payment_type_stats

Разбивка по типам оплаты

Array<object>
nullable
object
payment_type_id
string
amount
string
name
string
Examplegenerated
{
"total": 1,
"total_debt_amount": 1,
"total_unpaid_amount": 1,
"total_paid_amount": 1,
"total_system_paid_amount": 1,
"number_of_debtors": 1,
"number_of_paid_debtors": 1,
"number_of_overdue_debtors": 1,
"number_of_debts": 1,
"number_of_paid_debts": 1,
"number_of_unpaid_debts": 1,
"number_of_overdue_debts": 1,
"number_of_partially_paid_debts": 1,
"payment_type_stats": [
{
"payment_type_id": "example",
"amount": "example",
"name": "example"
}
]
}